Documentation ¶
Overview ¶
Package ssmincidents provides the API client, operations, and parameter types for AWS Systems Manager Incident Manager.
AWS Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their AWS-hosted applications. An incident is any unplanned interruption or reduction in quality of services. Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func (c *Client) CreateReplicationSet(ctx context.Context, params *CreateReplicationSetInput, ...) (*CreateReplicationSetOutput, error)
- func (c *Client) CreateResponsePlan(ctx context.Context, params *CreateResponsePlanInput, optFns ...func(*Options)) (*CreateResponsePlanOutput, error)
- func (c *Client) CreateTimelineEvent(ctx context.Context, params *CreateTimelineEventInput, ...) (*CreateTimelineEventOutput, error)
- func (c *Client) DeleteIncidentRecord(ctx context.Context, params *DeleteIncidentRecordInput, ...) (*DeleteIncidentRecordOutput, error)
- func (c *Client) DeleteReplicationSet(ctx context.Context, params *DeleteReplicationSetInput, ...) (*DeleteReplicationSetOutput, error)
- func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, ...) (*DeleteResourcePolicyOutput, error)
- func (c *Client) DeleteResponsePlan(ctx context.Context, params *DeleteResponsePlanInput, optFns ...func(*Options)) (*DeleteResponsePlanOutput, error)
- func (c *Client) DeleteTimelineEvent(ctx context.Context, params *DeleteTimelineEventInput, ...) (*DeleteTimelineEventOutput, error)
- func (c *Client) GetIncidentRecord(ctx context.Context, params *GetIncidentRecordInput, optFns ...func(*Options)) (*GetIncidentRecordOutput, error)
- func (c *Client) GetReplicationSet(ctx context.Context, params *GetReplicationSetInput, optFns ...func(*Options)) (*GetReplicationSetOutput, error)
- func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, ...) (*GetResourcePoliciesOutput, error)
- func (c *Client) GetResponsePlan(ctx context.Context, params *GetResponsePlanInput, optFns ...func(*Options)) (*GetResponsePlanOutput, error)
- func (c *Client) GetTimelineEvent(ctx context.Context, params *GetTimelineEventInput, optFns ...func(*Options)) (*GetTimelineEventOutput, error)
- func (c *Client) ListIncidentRecords(ctx context.Context, params *ListIncidentRecordsInput, ...) (*ListIncidentRecordsOutput, error)
- func (c *Client) ListRelatedItems(ctx context.Context, params *ListRelatedItemsInput, optFns ...func(*Options)) (*ListRelatedItemsOutput, error)
- func (c *Client) ListReplicationSets(ctx context.Context, params *ListReplicationSetsInput, ...) (*ListReplicationSetsOutput, error)
- func (c *Client) ListResponsePlans(ctx context.Context, params *ListResponsePlansInput, optFns ...func(*Options)) (*ListResponsePlansOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTimelineEvents(ctx context.Context, params *ListTimelineEventsInput, optFns ...func(*Options)) (*ListTimelineEventsOutput, error)
- func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)
- func (c *Client) StartIncident(ctx context.Context, params *StartIncidentInput, optFns ...func(*Options)) (*StartIncidentOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateDeletionProtection(ctx context.Context, params *UpdateDeletionProtectionInput, ...) (*UpdateDeletionProtectionOutput, error)
- func (c *Client) UpdateIncidentRecord(ctx context.Context, params *UpdateIncidentRecordInput, ...) (*UpdateIncidentRecordOutput, error)
- func (c *Client) UpdateRelatedItems(ctx context.Context, params *UpdateRelatedItemsInput, optFns ...func(*Options)) (*UpdateRelatedItemsOutput, error)
- func (c *Client) UpdateReplicationSet(ctx context.Context, params *UpdateReplicationSetInput, ...) (*UpdateReplicationSetOutput, error)
- func (c *Client) UpdateResponsePlan(ctx context.Context, params *UpdateResponsePlanInput, optFns ...func(*Options)) (*UpdateResponsePlanOutput, error)
- func (c *Client) UpdateTimelineEvent(ctx context.Context, params *UpdateTimelineEventInput, ...) (*UpdateTimelineEventOutput, error)
- type CreateReplicationSetInput
- type CreateReplicationSetOutput
- type CreateResponsePlanInput
- type CreateResponsePlanOutput
- type CreateTimelineEventInput
- type CreateTimelineEventOutput
- type DeleteIncidentRecordInput
- type DeleteIncidentRecordOutput
- type DeleteReplicationSetInput
- type DeleteReplicationSetOutput
- type DeleteResourcePolicyInput
- type DeleteResourcePolicyOutput
- type DeleteResponsePlanInput
- type DeleteResponsePlanOutput
- type DeleteTimelineEventInput
- type DeleteTimelineEventOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetIncidentRecordInput
- type GetIncidentRecordOutput
- type GetReplicationSetAPIClient
- type GetReplicationSetInput
- type GetReplicationSetOutput
- type GetResourcePoliciesAPIClient
- type GetResourcePoliciesInput
- type GetResourcePoliciesOutput
- type GetResourcePoliciesPaginator
- type GetResourcePoliciesPaginatorOptions
- type GetResponsePlanInput
- type GetResponsePlanOutput
- type GetTimelineEventInput
- type GetTimelineEventOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListIncidentRecordsAPIClient
- type ListIncidentRecordsInput
- type ListIncidentRecordsOutput
- type ListIncidentRecordsPaginator
- type ListIncidentRecordsPaginatorOptions
- type ListRelatedItemsAPIClient
- type ListRelatedItemsInput
- type ListRelatedItemsOutput
- type ListRelatedItemsPaginator
- type ListRelatedItemsPaginatorOptions
- type ListReplicationSetsAPIClient
- type ListReplicationSetsInput
- type ListReplicationSetsOutput
- type ListReplicationSetsPaginator
- type ListReplicationSetsPaginatorOptions
- type ListResponsePlansAPIClient
- type ListResponsePlansInput
- type ListResponsePlansOutput
- type ListResponsePlansPaginator
- type ListResponsePlansPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTimelineEventsAPIClient
- type ListTimelineEventsInput
- type ListTimelineEventsOutput
- type ListTimelineEventsPaginator
- type ListTimelineEventsPaginatorOptions
- type Options
- type PutResourcePolicyInput
- type PutResourcePolicyOutput
- type ResolveEndpoint
- type StartIncidentInput
- type StartIncidentOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateDeletionProtectionInput
- type UpdateDeletionProtectionOutput
- type UpdateIncidentRecordInput
- type UpdateIncidentRecordOutput
- type UpdateRelatedItemsInput
- type UpdateRelatedItemsOutput
- type UpdateReplicationSetInput
- type UpdateReplicationSetOutput
- type UpdateResponsePlanInput
- type UpdateResponsePlanOutput
- type UpdateTimelineEventInput
- type UpdateTimelineEventOutput
- type WaitForReplicationSetActiveWaiter
- type WaitForReplicationSetActiveWaiterOptions
- type WaitForReplicationSetDeletedWaiter
- type WaitForReplicationSetDeletedWaiterOptions
Constants ¶
const ServiceAPIVersion = "2018-05-10"
const ServiceID = "SSM Incidents"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Systems Manager Incident Manager.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateReplicationSet ¶
func (c *Client) CreateReplicationSet(ctx context.Context, params *CreateReplicationSetInput, optFns ...func(*Options)) (*CreateReplicationSetOutput, error)
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
func (*Client) CreateResponsePlan ¶
func (c *Client) CreateResponsePlan(ctx context.Context, params *CreateResponsePlanInput, optFns ...func(*Options)) (*CreateResponsePlanOutput, error)
Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.
func (*Client) CreateTimelineEvent ¶
func (c *Client) CreateTimelineEvent(ctx context.Context, params *CreateTimelineEventInput, optFns ...func(*Options)) (*CreateTimelineEventOutput, error)
Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.
func (*Client) DeleteIncidentRecord ¶
func (c *Client) DeleteIncidentRecord(ctx context.Context, params *DeleteIncidentRecordInput, optFns ...func(*Options)) (*DeleteIncidentRecordOutput, error)
Delete an incident record from Incident Manager.
func (*Client) DeleteReplicationSet ¶
func (c *Client) DeleteReplicationSet(ctx context.Context, params *DeleteReplicationSetInput, optFns ...func(*Options)) (*DeleteReplicationSetOutput, error)
Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
func (*Client) DeleteResourcePolicy ¶
func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)
Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.
func (*Client) DeleteResponsePlan ¶
func (c *Client) DeleteResponsePlan(ctx context.Context, params *DeleteResponsePlanInput, optFns ...func(*Options)) (*DeleteResponsePlanOutput, error)
Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.
func (*Client) DeleteTimelineEvent ¶
func (c *Client) DeleteTimelineEvent(ctx context.Context, params *DeleteTimelineEventInput, optFns ...func(*Options)) (*DeleteTimelineEventOutput, error)
Deletes a timeline event from an incident.
func (*Client) GetIncidentRecord ¶
func (c *Client) GetIncidentRecord(ctx context.Context, params *GetIncidentRecordInput, optFns ...func(*Options)) (*GetIncidentRecordOutput, error)
Returns the details of the specified incident record.
func (*Client) GetReplicationSet ¶
func (c *Client) GetReplicationSet(ctx context.Context, params *GetReplicationSetInput, optFns ...func(*Options)) (*GetReplicationSetOutput, error)
Retrieve your Incident Manager replication set.
func (*Client) GetResourcePolicies ¶
func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
Retrieves the resource policies attached to the specified response plan.
func (*Client) GetResponsePlan ¶
func (c *Client) GetResponsePlan(ctx context.Context, params *GetResponsePlanInput, optFns ...func(*Options)) (*GetResponsePlanOutput, error)
Retrieves the details of the specified response plan.
func (*Client) GetTimelineEvent ¶
func (c *Client) GetTimelineEvent(ctx context.Context, params *GetTimelineEventInput, optFns ...func(*Options)) (*GetTimelineEventOutput, error)
Retrieves a timeline event based on its ID and incident record.
func (*Client) ListIncidentRecords ¶
func (c *Client) ListIncidentRecords(ctx context.Context, params *ListIncidentRecordsInput, optFns ...func(*Options)) (*ListIncidentRecordsOutput, error)
Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.
func (*Client) ListRelatedItems ¶
func (c *Client) ListRelatedItems(ctx context.Context, params *ListRelatedItemsInput, optFns ...func(*Options)) (*ListRelatedItemsOutput, error)
List all related items for an incident record.
func (*Client) ListReplicationSets ¶
func (c *Client) ListReplicationSets(ctx context.Context, params *ListReplicationSetsInput, optFns ...func(*Options)) (*ListReplicationSetsOutput, error)
Lists details about the replication set configured in your account.
func (*Client) ListResponsePlans ¶
func (c *Client) ListResponsePlans(ctx context.Context, params *ListResponsePlansInput, optFns ...func(*Options)) (*ListResponsePlansOutput, error)
Lists all response plans in your account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags that are attached to the specified response plan.
func (*Client) ListTimelineEvents ¶
func (c *Client) ListTimelineEvents(ctx context.Context, params *ListTimelineEventsInput, optFns ...func(*Options)) (*ListTimelineEventsOutput, error)
Lists timeline events of the specified incident record.
func (*Client) PutResourcePolicy ¶
func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)
Adds a resource policy to the specified response plan.
func (*Client) StartIncident ¶
func (c *Client) StartIncident(ctx context.Context, params *StartIncidentInput, optFns ...func(*Options)) (*StartIncidentOutput, error)
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds a tag to a response plan.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes a tag from a resource.
func (*Client) UpdateDeletionProtection ¶
func (c *Client) UpdateDeletionProtection(ctx context.Context, params *UpdateDeletionProtectionInput, optFns ...func(*Options)) (*UpdateDeletionProtectionOutput, error)
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
func (*Client) UpdateIncidentRecord ¶
func (c *Client) UpdateIncidentRecord(ctx context.Context, params *UpdateIncidentRecordInput, optFns ...func(*Options)) (*UpdateIncidentRecordOutput, error)
Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat (https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact).
func (*Client) UpdateRelatedItems ¶
func (c *Client) UpdateRelatedItems(ctx context.Context, params *UpdateRelatedItemsInput, optFns ...func(*Options)) (*UpdateRelatedItemsOutput, error)
Add or remove related items from the related items tab of an incident record.
func (*Client) UpdateReplicationSet ¶
func (c *Client) UpdateReplicationSet(ctx context.Context, params *UpdateReplicationSetInput, optFns ...func(*Options)) (*UpdateReplicationSetOutput, error)
Add or delete Regions from your replication set.
func (*Client) UpdateResponsePlan ¶
func (c *Client) UpdateResponsePlan(ctx context.Context, params *UpdateResponsePlanInput, optFns ...func(*Options)) (*UpdateResponsePlanOutput, error)
Updates the specified response plan.
func (*Client) UpdateTimelineEvent ¶
func (c *Client) UpdateTimelineEvent(ctx context.Context, params *UpdateTimelineEventInput, optFns ...func(*Options)) (*UpdateTimelineEventOutput, error)
Updates a timeline event. You can update events of type Custom Event.
type CreateReplicationSetInput ¶
type CreateReplicationSetInput struct { // The Regions that Incident Manager replicates your data to. You can have up to // three Regions in your replication set. // // This member is required. Regions map[string]types.RegionMapInputValue // A token ensuring that the action is called only once with the specified details. ClientToken *string }
type CreateReplicationSetOutput ¶
type CreateReplicationSetOutput struct { // The Amazon Resource Name (ARN) of the replication set. // // This member is required. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateResponsePlanInput ¶
type CreateResponsePlanInput struct { // Details used to create an incident when using this response plan. // // This member is required. IncidentTemplate *types.IncidentTemplate // The short format name of the response plan. Can't include spaces. // // This member is required. Name *string // The actions that the response plan starts at the beginning of an incident. Actions []types.Action // The AWS Chatbot chat channel used for collaboration during an incident. ChatChannel types.ChatChannel // A token ensuring that the action is called only once with the specified details. ClientToken *string // The long format of the response plan name. This field can contain spaces. DisplayName *string // The contacts and escalation plans that the response plan engages during an // incident. Engagements []string // A list of tags that you are adding to the response plan. Tags map[string]string }
type CreateResponsePlanOutput ¶
type CreateResponsePlanOutput struct { // The Amazon Resource Name (ARN) of the response plan. // // This member is required. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateTimelineEventInput ¶
type CreateTimelineEventInput struct { // A token ensuring that the action is called only once with the specified details. // // This member is required. ClientToken *string // A short description of the event. // // This member is required. EventData *string // The time that the event occurred. // // This member is required. EventTime *time.Time // The type of the event. You can create timeline events of type Custom Event. // // This member is required. EventType *string // The Amazon Resource Name (ARN) of the incident record you are adding the event // to. // // This member is required. IncidentRecordArn *string }
type CreateTimelineEventOutput ¶
type CreateTimelineEventOutput struct { // The ID of the event for easy reference later. // // This member is required. EventId *string // The ARN of the incident record that you added the event to. // // This member is required. IncidentRecordArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteIncidentRecordInput ¶
type DeleteIncidentRecordInput struct { // The Amazon Resource Name (ARN) of the incident record you are deleting. // // This member is required. Arn *string }
type DeleteIncidentRecordOutput ¶
type DeleteIncidentRecordOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteReplicationSetInput ¶
type DeleteReplicationSetInput struct { // The Amazon Resource Name (ARN) of the replication set you're deleting. // // This member is required. Arn *string }
type DeleteReplicationSetOutput ¶
type DeleteReplicationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteResourcePolicyOutput ¶
type DeleteResourcePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteResponsePlanInput ¶
type DeleteResponsePlanInput struct { // The Amazon Resource Name (ARN) of the response plan. // // This member is required. Arn *string }
type DeleteResponsePlanOutput ¶
type DeleteResponsePlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteTimelineEventInput ¶
type DeleteTimelineEventInput struct { // The ID of the event you are updating. You can find this by using // ListTimelineEvents. // // This member is required. EventId *string // The Amazon Resource Name (ARN) of the incident that the event is part of. // // This member is required. IncidentRecordArn *string }
type DeleteTimelineEventOutput ¶
type DeleteTimelineEventOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetIncidentRecordInput ¶
type GetIncidentRecordInput struct { // The Amazon Resource Name (ARN) of the incident record. // // This member is required. Arn *string }
type GetIncidentRecordOutput ¶
type GetIncidentRecordOutput struct { // Details structure of the incident record. // // This member is required. IncidentRecord *types.IncidentRecord // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetReplicationSetAPIClient ¶
type GetReplicationSetAPIClient interface {
GetReplicationSet(context.Context, *GetReplicationSetInput, ...func(*Options)) (*GetReplicationSetOutput, error)
}
GetReplicationSetAPIClient is a client that implements the GetReplicationSet operation.
type GetReplicationSetInput ¶
type GetReplicationSetInput struct { // The Amazon Resource Name (ARN) of the replication set you want to retrieve. // // This member is required. Arn *string }
type GetReplicationSetOutput ¶
type GetReplicationSetOutput struct { // Details of the replication set. // // This member is required. ReplicationSet *types.ReplicationSet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetResourcePoliciesAPIClient ¶
type GetResourcePoliciesAPIClient interface {
GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error)
}
GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies operation.
type GetResourcePoliciesInput ¶
type GetResourcePoliciesInput struct { // The Amazon Resource Name (ARN) of the response plan with the attached resource // policy. // // This member is required. ResourceArn *string // The maximum number of resource policies to display per page of results. MaxResults *int32 // The pagination token to continue to the next page of results. NextToken *string }
type GetResourcePoliciesOutput ¶
type GetResourcePoliciesOutput struct { // Details about the resource policy attached to the response plan. // // This member is required. ResourcePolicies []types.ResourcePolicy // The pagination token to continue to the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetResourcePoliciesPaginator ¶
type GetResourcePoliciesPaginator struct {
// contains filtered or unexported fields
}
GetResourcePoliciesPaginator is a paginator for GetResourcePolicies
func NewGetResourcePoliciesPaginator ¶
func NewGetResourcePoliciesPaginator(client GetResourcePoliciesAPIClient, params *GetResourcePoliciesInput, optFns ...func(*GetResourcePoliciesPaginatorOptions)) *GetResourcePoliciesPaginator
NewGetResourcePoliciesPaginator returns a new GetResourcePoliciesPaginator
func (*GetResourcePoliciesPaginator) HasMorePages ¶
func (p *GetResourcePoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourcePoliciesPaginator) NextPage ¶
func (p *GetResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
NextPage retrieves the next GetResourcePolicies page.
type GetResourcePoliciesPaginatorOptions ¶
type GetResourcePoliciesPaginatorOptions struct { // The maximum number of resource policies to display per page of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetResourcePoliciesPaginatorOptions is the paginator options for GetResourcePolicies
type GetResponsePlanInput ¶
type GetResponsePlanInput struct { // The Amazon Resource Name (ARN) of the response plan. // // This member is required. Arn *string }
type GetResponsePlanOutput ¶
type GetResponsePlanOutput struct { // The ARN of the response plan. // // This member is required. Arn *string // Details used to create the incident when using this response plan. // // This member is required. IncidentTemplate *types.IncidentTemplate // The short format name of the response plan. Can't contain spaces. // // This member is required. Name *string // The actions that this response plan takes at the beginning of the incident. Actions []types.Action // The AWS Chatbot chat channel used for collaboration during an incident. ChatChannel types.ChatChannel // The long format name of the response plan. Can contain spaces. DisplayName *string // The contacts and escalation plans that the response plan engages during an // incident. Engagements []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetTimelineEventInput ¶
type GetTimelineEventInput struct { // The ID of the event. You can get an event's ID when you create it or by using // ListTimelineEvents. // // This member is required. EventId *string // The Amazon Resource Name (ARN) of the incident that the timeline event is part // of. // // This member is required. IncidentRecordArn *string }
type GetTimelineEventOutput ¶
type GetTimelineEventOutput struct { // Details about the timeline event. // // This member is required. Event *types.TimelineEvent // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListIncidentRecordsAPIClient ¶
type ListIncidentRecordsAPIClient interface {
ListIncidentRecords(context.Context, *ListIncidentRecordsInput, ...func(*Options)) (*ListIncidentRecordsOutput, error)
}
ListIncidentRecordsAPIClient is a client that implements the ListIncidentRecords operation.
type ListIncidentRecordsInput ¶
type ListIncidentRecordsInput struct { // Filter the list of incident records you are searching through. You can filter on // the following keys: // // * creationTime // // * impact // // * status // // * createdBy Filters []types.Filter // The maximum number of results per page. MaxResults *int32 // The pagination token to continue to the next page of results. NextToken *string }
type ListIncidentRecordsOutput ¶
type ListIncidentRecordsOutput struct { // The details of each listed incident record. // // This member is required. IncidentRecordSummaries []types.IncidentRecordSummary // The pagination token to continue to the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListIncidentRecordsPaginator ¶
type ListIncidentRecordsPaginator struct {
// contains filtered or unexported fields
}
ListIncidentRecordsPaginator is a paginator for ListIncidentRecords
func NewListIncidentRecordsPaginator ¶
func NewListIncidentRecordsPaginator(client ListIncidentRecordsAPIClient, params *ListIncidentRecordsInput, optFns ...func(*ListIncidentRecordsPaginatorOptions)) *ListIncidentRecordsPaginator
NewListIncidentRecordsPaginator returns a new ListIncidentRecordsPaginator
func (*ListIncidentRecordsPaginator) HasMorePages ¶
func (p *ListIncidentRecordsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListIncidentRecordsPaginator) NextPage ¶
func (p *ListIncidentRecordsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIncidentRecordsOutput, error)
NextPage retrieves the next ListIncidentRecords page.
type ListIncidentRecordsPaginatorOptions ¶
type ListIncidentRecordsPaginatorOptions struct { // The maximum number of results per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListIncidentRecordsPaginatorOptions is the paginator options for ListIncidentRecords
type ListRelatedItemsAPIClient ¶
type ListRelatedItemsAPIClient interface {
ListRelatedItems(context.Context, *ListRelatedItemsInput, ...func(*Options)) (*ListRelatedItemsOutput, error)
}
ListRelatedItemsAPIClient is a client that implements the ListRelatedItems operation.
type ListRelatedItemsInput ¶
type ListRelatedItemsInput struct { // The Amazon Resource Name (ARN) of the incident record that you are listing // related items for. // // This member is required. IncidentRecordArn *string // The maximum number of related items per page. MaxResults *int32 // The pagination token to continue to the next page of results. NextToken *string }
type ListRelatedItemsOutput ¶
type ListRelatedItemsOutput struct { // Details about each related item. // // This member is required. RelatedItems []types.RelatedItem // The pagination token to continue to the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListRelatedItemsPaginator ¶
type ListRelatedItemsPaginator struct {
// contains filtered or unexported fields
}
ListRelatedItemsPaginator is a paginator for ListRelatedItems
func NewListRelatedItemsPaginator ¶
func NewListRelatedItemsPaginator(client ListRelatedItemsAPIClient, params *ListRelatedItemsInput, optFns ...func(*ListRelatedItemsPaginatorOptions)) *ListRelatedItemsPaginator
NewListRelatedItemsPaginator returns a new ListRelatedItemsPaginator
func (*ListRelatedItemsPaginator) HasMorePages ¶
func (p *ListRelatedItemsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRelatedItemsPaginator) NextPage ¶
func (p *ListRelatedItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRelatedItemsOutput, error)
NextPage retrieves the next ListRelatedItems page.
type ListRelatedItemsPaginatorOptions ¶
type ListRelatedItemsPaginatorOptions struct { // The maximum number of related items per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRelatedItemsPaginatorOptions is the paginator options for ListRelatedItems
type ListReplicationSetsAPIClient ¶
type ListReplicationSetsAPIClient interface {
ListReplicationSets(context.Context, *ListReplicationSetsInput, ...func(*Options)) (*ListReplicationSetsOutput, error)
}
ListReplicationSetsAPIClient is a client that implements the ListReplicationSets operation.
type ListReplicationSetsOutput ¶
type ListReplicationSetsOutput struct { // The Amazon Resource Name (ARN) of the list replication set. // // This member is required. ReplicationSetArns []string // The pagination token to continue to the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListReplicationSetsPaginator ¶
type ListReplicationSetsPaginator struct {
// contains filtered or unexported fields
}
ListReplicationSetsPaginator is a paginator for ListReplicationSets
func NewListReplicationSetsPaginator ¶
func NewListReplicationSetsPaginator(client ListReplicationSetsAPIClient, params *ListReplicationSetsInput, optFns ...func(*ListReplicationSetsPaginatorOptions)) *ListReplicationSetsPaginator
NewListReplicationSetsPaginator returns a new ListReplicationSetsPaginator
func (*ListReplicationSetsPaginator) HasMorePages ¶
func (p *ListReplicationSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListReplicationSetsPaginator) NextPage ¶
func (p *ListReplicationSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReplicationSetsOutput, error)
NextPage retrieves the next ListReplicationSets page.
type ListReplicationSetsPaginatorOptions ¶
type ListReplicationSetsPaginatorOptions struct { // The maximum number of results per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListReplicationSetsPaginatorOptions is the paginator options for ListReplicationSets
type ListResponsePlansAPIClient ¶
type ListResponsePlansAPIClient interface {
ListResponsePlans(context.Context, *ListResponsePlansInput, ...func(*Options)) (*ListResponsePlansOutput, error)
}
ListResponsePlansAPIClient is a client that implements the ListResponsePlans operation.
type ListResponsePlansInput ¶
type ListResponsePlansOutput ¶
type ListResponsePlansOutput struct { // Details of each response plan. // // This member is required. ResponsePlanSummaries []types.ResponsePlanSummary // The pagination token to continue to the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListResponsePlansPaginator ¶
type ListResponsePlansPaginator struct {
// contains filtered or unexported fields
}
ListResponsePlansPaginator is a paginator for ListResponsePlans
func NewListResponsePlansPaginator ¶
func NewListResponsePlansPaginator(client ListResponsePlansAPIClient, params *ListResponsePlansInput, optFns ...func(*ListResponsePlansPaginatorOptions)) *ListResponsePlansPaginator
NewListResponsePlansPaginator returns a new ListResponsePlansPaginator
func (*ListResponsePlansPaginator) HasMorePages ¶
func (p *ListResponsePlansPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResponsePlansPaginator) NextPage ¶
func (p *ListResponsePlansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResponsePlansOutput, error)
NextPage retrieves the next ListResponsePlans page.
type ListResponsePlansPaginatorOptions ¶
type ListResponsePlansPaginatorOptions struct { // The maximum number of response plans per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResponsePlansPaginatorOptions is the paginator options for ListResponsePlans
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the response plan. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A list of tags for the response plan. // // This member is required. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTimelineEventsAPIClient ¶
type ListTimelineEventsAPIClient interface {
ListTimelineEvents(context.Context, *ListTimelineEventsInput, ...func(*Options)) (*ListTimelineEventsOutput, error)
}
ListTimelineEventsAPIClient is a client that implements the ListTimelineEvents operation.
type ListTimelineEventsInput ¶
type ListTimelineEventsInput struct { // The Amazon Resource Name (ARN) of the incident that the event is part of. // // This member is required. IncidentRecordArn *string // Filters the timeline events based on the provided conditional values. You can // filter timeline events using the following keys: // // * eventTime // // * eventType Filters []types.Filter // The maximum number of results per page. MaxResults *int32 // The pagination token to continue to the next page of results. NextToken *string // Sort by the specified key value pair. SortBy types.TimelineEventSort // Sorts the order of timeline events by the value specified in the sortBy field. SortOrder types.SortOrder }
type ListTimelineEventsOutput ¶
type ListTimelineEventsOutput struct { // Details about each event that occurred during the incident. // // This member is required. EventSummaries []types.EventSummary // The pagination token to continue to the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTimelineEventsPaginator ¶
type ListTimelineEventsPaginator struct {
// contains filtered or unexported fields
}
ListTimelineEventsPaginator is a paginator for ListTimelineEvents
func NewListTimelineEventsPaginator ¶
func NewListTimelineEventsPaginator(client ListTimelineEventsAPIClient, params *ListTimelineEventsInput, optFns ...func(*ListTimelineEventsPaginatorOptions)) *ListTimelineEventsPaginator
NewListTimelineEventsPaginator returns a new ListTimelineEventsPaginator
func (*ListTimelineEventsPaginator) HasMorePages ¶
func (p *ListTimelineEventsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTimelineEventsPaginator) NextPage ¶
func (p *ListTimelineEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTimelineEventsOutput, error)
NextPage retrieves the next ListTimelineEvents page.
type ListTimelineEventsPaginatorOptions ¶
type ListTimelineEventsPaginatorOptions struct { // The maximum number of results per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTimelineEventsPaginatorOptions is the paginator options for ListTimelineEvents
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
type PutResourcePolicyInput ¶
type PutResourcePolicyOutput ¶
type PutResourcePolicyOutput struct { // The ID of the resource policy. // // This member is required. PolicyId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartIncidentInput ¶
type StartIncidentInput struct { // The Amazon Resource Name (ARN) of the response plan that pre-defines summary, // chat channels, SNS topics, runbooks, title, and impact of the incident. // // This member is required. ResponsePlanArn *string // A token ensuring that the action is called only once with the specified details. ClientToken *string // Defines the impact to the customers. Providing an impact overwrites the impact // provided by a response plan. Possible impacts: // // * 1 - Critical impact, this // typically relates to full application failure that impacts many to all // customers. // // * 2 - High impact, partial application failure with impact to many // customers. // // * 3 - Medium impact, the application is providing reduced service to // customers. // // * 4 - Low impact, customer might aren't impacted by the problem // yet. // // * 5 - No impact, customers aren't currently impacted but urgent action is // needed to avoid impact. Impact *int32 // Add related items to the incident for other responders to use. Related items are // AWS resources, external links, or files uploaded to an S3 bucket. RelatedItems []types.RelatedItem // Provide a title for the incident. Providing a title overwrites the title // provided by the response plan. Title *string // Details of what created the incident record in Incident Manager. TriggerDetails *types.TriggerDetails }
type StartIncidentOutput ¶
type StartIncidentOutput struct { // The ARN of the newly created incident record. // // This member is required. IncidentRecordArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDeletionProtectionInput ¶
type UpdateDeletionProtectionInput struct { // The Amazon Resource Name (ARN) of the replication set you're updating. // // This member is required. Arn *string // Details if deletion protection is enabled or disabled in your account. // // This member is required. DeletionProtected *bool // A token ensuring that the action is called only once with the specified details. ClientToken *string }
type UpdateDeletionProtectionOutput ¶
type UpdateDeletionProtectionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateIncidentRecordInput ¶
type UpdateIncidentRecordInput struct { // The Amazon Resource Name (ARN) of the incident record you are updating. // // This member is required. Arn *string // The AWS Chatbot chat channel for responders to collaborate in. ChatChannel types.ChatChannel // A token ensuring that the action is called only once with the specified details. ClientToken *string // Defines the impact to customers and applications. Providing an impact overwrites // the impact provided by the response plan. Possible impacts: // // * 1 - Critical // impact, this typically relates to full application failure that impacts many to // all customers. // // * 2 - High impact, partial application failure with impact to // many customers. // // * 3 - Medium impact, the application is providing reduced // service to customers. // // * 4 - Low impact, customer might aren't impacted by the // problem yet. // // * 5 - No impact, customers aren't currently impacted but urgent // action is needed to avoid impact. Impact *int32 // The SNS targets that AWS Chatbot uses to notify the chat channel of updates to // an incident. You can also make updates to the incident through the chat channel // using the SNS topics. Using multiple SNS topics creates redundancy in the case // that a Region is down during the incident. NotificationTargets []types.NotificationTargetItem // The status of the incident. An incident can be Open or Resolved. Status types.IncidentRecordStatus // The summary describes what has happened during the incident. Summary *string // The title of the incident is a brief and easily recognizable. Title *string }
type UpdateIncidentRecordOutput ¶
type UpdateIncidentRecordOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRelatedItemsInput ¶
type UpdateRelatedItemsInput struct { // The Amazon Resource Name (ARN) of the incident record you are updating related // items in. // // This member is required. IncidentRecordArn *string // Details about the item you are adding or deleting. // // This member is required. RelatedItemsUpdate types.RelatedItemsUpdate // A token ensuring that the action is called only once with the specified details. ClientToken *string }
type UpdateRelatedItemsOutput ¶
type UpdateRelatedItemsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateReplicationSetInput ¶
type UpdateReplicationSetInput struct { // An action to add or delete a Region. // // This member is required. Actions []types.UpdateReplicationSetAction // The Amazon Resource Name (ARN) of the replication set you're updating. // // This member is required. Arn *string // A token ensuring that the action is called only once with the specified details. ClientToken *string }
type UpdateReplicationSetOutput ¶
type UpdateReplicationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateResponsePlanInput ¶
type UpdateResponsePlanInput struct { // The Amazon Resource Name (ARN) of the response plan. // // This member is required. Arn *string // The actions that this response plan takes at the beginning of an incident. Actions []types.Action // The AWS Chatbot chat channel used for collaboration during an incident. ChatChannel types.ChatChannel // A token ensuring that the action is called only once with the specified details. ClientToken *string // The long format name of the response plan. Can't contain spaces. DisplayName *string // The contacts and escalation plans that Incident Manager engages at the start of // the incident. Engagements []string // Used to create only one incident record for an incident. IncidentTemplateDedupeString *string // Defines the impact to the customers. Providing an impact overwrites the impact // provided by a response plan. Possible impacts: // // * 5 - Severe impact // // * 4 - High // impact // // * 3 - Medium impact // // * 2 - Low impact // // * 1 - No impact IncidentTemplateImpact *int32 // The SNS targets that AWS Chatbot uses to notify the chat channels and perform // actions on the incident record. IncidentTemplateNotificationTargets []types.NotificationTargetItem // A brief summary of the incident. This typically contains what has happened, // what's currently happening, and next steps. IncidentTemplateSummary *string // The short format name of the incident. Can't contain spaces. IncidentTemplateTitle *string }
type UpdateResponsePlanOutput ¶
type UpdateResponsePlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateTimelineEventInput ¶
type UpdateTimelineEventInput struct { // A token ensuring that the action is called only once with the specified details. // // This member is required. ClientToken *string // The ID of the event you are updating. You can find this by using // ListTimelineEvents. // // This member is required. EventId *string // The Amazon Resource Name (ARN) of the incident that the timeline event is part // of. // // This member is required. IncidentRecordArn *string // A short description of the event. EventData *string // The time that the event occurred. EventTime *time.Time // The type of the event. You can update events of type Custom Event. EventType *string }
type UpdateTimelineEventOutput ¶
type UpdateTimelineEventOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type WaitForReplicationSetActiveWaiter ¶
type WaitForReplicationSetActiveWaiter struct {
// contains filtered or unexported fields
}
WaitForReplicationSetActiveWaiter defines the waiters for WaitForReplicationSetActive
func NewWaitForReplicationSetActiveWaiter ¶
func NewWaitForReplicationSetActiveWaiter(client GetReplicationSetAPIClient, optFns ...func(*WaitForReplicationSetActiveWaiterOptions)) *WaitForReplicationSetActiveWaiter
NewWaitForReplicationSetActiveWaiter constructs a WaitForReplicationSetActiveWaiter.
func (*WaitForReplicationSetActiveWaiter) Wait ¶
func (w *WaitForReplicationSetActiveWaiter) Wait(ctx context.Context, params *GetReplicationSetInput, maxWaitDur time.Duration, optFns ...func(*WaitForReplicationSetActiveWaiterOptions)) error
Wait calls the waiter function for WaitForReplicationSetActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type WaitForReplicationSetActiveWaiterOptions ¶
type WaitForReplicationSetActiveWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // WaitForReplicationSetActiveWaiter will use default minimum delay of 30 seconds. // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or set // to zero, WaitForReplicationSetActiveWaiter will use default max delay of 30 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. By // default service-modeled logic will populate this option. This option can thus be // used to define a custom waiter state with fall-back to service-modeled waiter // state mutators.The function returns an error in case of a failure state. In case // of retry state, this function returns a bool value of true and nil error, while // in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReplicationSetInput, *GetReplicationSetOutput, error) (bool, error) }
WaitForReplicationSetActiveWaiterOptions are waiter options for WaitForReplicationSetActiveWaiter
type WaitForReplicationSetDeletedWaiter ¶
type WaitForReplicationSetDeletedWaiter struct {
// contains filtered or unexported fields
}
WaitForReplicationSetDeletedWaiter defines the waiters for WaitForReplicationSetDeleted
func NewWaitForReplicationSetDeletedWaiter ¶
func NewWaitForReplicationSetDeletedWaiter(client GetReplicationSetAPIClient, optFns ...func(*WaitForReplicationSetDeletedWaiterOptions)) *WaitForReplicationSetDeletedWaiter
NewWaitForReplicationSetDeletedWaiter constructs a WaitForReplicationSetDeletedWaiter.
func (*WaitForReplicationSetDeletedWaiter) Wait ¶
func (w *WaitForReplicationSetDeletedWaiter) Wait(ctx context.Context, params *GetReplicationSetInput, maxWaitDur time.Duration, optFns ...func(*WaitForReplicationSetDeletedWaiterOptions)) error
Wait calls the waiter function for WaitForReplicationSetDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type WaitForReplicationSetDeletedWaiterOptions ¶
type WaitForReplicationSetDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // WaitForReplicationSetDeletedWaiter will use default minimum delay of 30 seconds. // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or set // to zero, WaitForReplicationSetDeletedWaiter will use default max delay of 30 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. By // default service-modeled logic will populate this option. This option can thus be // used to define a custom waiter state with fall-back to service-modeled waiter // state mutators.The function returns an error in case of a failure state. In case // of retry state, this function returns a bool value of true and nil error, while // in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReplicationSetInput, *GetReplicationSetOutput, error) (bool, error) }
WaitForReplicationSetDeletedWaiterOptions are waiter options for WaitForReplicationSetDeletedWaiter
Source Files ¶
- api_client.go
- api_op_CreateReplicationSet.go
- api_op_CreateResponsePlan.go
- api_op_CreateTimelineEvent.go
- api_op_DeleteIncidentRecord.go
- api_op_DeleteReplicationSet.go
- api_op_DeleteResourcePolicy.go
- api_op_DeleteResponsePlan.go
- api_op_DeleteTimelineEvent.go
- api_op_GetIncidentRecord.go
- api_op_GetReplicationSet.go
- api_op_GetResourcePolicies.go
- api_op_GetResponsePlan.go
- api_op_GetTimelineEvent.go
- api_op_ListIncidentRecords.go
- api_op_ListRelatedItems.go
- api_op_ListReplicationSets.go
- api_op_ListResponsePlans.go
- api_op_ListTagsForResource.go
- api_op_ListTimelineEvents.go
- api_op_PutResourcePolicy.go
- api_op_StartIncident.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateDeletionProtection.go
- api_op_UpdateIncidentRecord.go
- api_op_UpdateRelatedItems.go
- api_op_UpdateReplicationSet.go
- api_op_UpdateResponsePlan.go
- api_op_UpdateTimelineEvent.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go