ssmcontacts

package module
v1.26.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 31, 2025 License: Apache-2.0 Imports: 45 Imported by: 7

Documentation

Overview

Package ssmcontacts provides the API client, operations, and parameter types for AWS Systems Manager Incident Manager Contacts.

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-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

View Source 
const ServiceAPIVersion = "2021-05-03"
View Source 
const ServiceID = "SSM Contacts"

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 deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.16.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.19.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.19.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AcceptPageInput 

type AcceptPageInput struct {

	// A 6-digit code used to acknowledge the page.
	//
	// This member is required.
	AcceptCode *string

	// The type indicates if the page was DELIVERED or READ .
	//
	// This member is required.
	AcceptType types.AcceptType

	// The Amazon Resource Name (ARN) of the engagement to a contact channel.
	//
	// This member is required.
	PageId *string

	// An optional field that Incident Manager uses to ENFORCE AcceptCode validation
	// when acknowledging an page. Acknowledgement can occur by replying to a page, or
	// when entering the AcceptCode in the console. Enforcing AcceptCode validation
	// causes Incident Manager to verify that the code entered by the user matches the
	// code sent by Incident Manager with the page.
	//
	// Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode
	// validation causes Incident Manager to accept any value entered for the
	// AcceptCode .
	AcceptCodeValidation types.AcceptCodeValidation

	// The ARN of the contact channel.
	ContactChannelId *string

	// Information provided by the user when the user acknowledges the page.
	Note *string
	// contains filtered or unexported fields
}

type AcceptPageOutput 

type AcceptPageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ActivateContactChannelInput 

type ActivateContactChannelInput struct {

	// The code sent to the contact channel when it was created in the contact.
	//
	// This member is required.
	ActivationCode *string

	// The Amazon Resource Name (ARN) of the contact channel.
	//
	// This member is required.
	ContactChannelId *string
	// contains filtered or unexported fields
}

type ActivateContactChannelOutput 

type ActivateContactChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.19.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.19.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

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 Contacts.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AcceptPage 

func (c *Client) AcceptPage(ctx context.Context, params *AcceptPageInput, optFns ...func(*Options)) (*AcceptPageOutput, error)

Used to acknowledge an engagement to a contact channel during an incident.

func (*Client) ActivateContactChannel 

func (c *Client) ActivateContactChannel(ctx context.Context, params *ActivateContactChannelInput, optFns ...func(*Options)) (*ActivateContactChannelOutput, error)

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

func (*Client) CreateContact 

func (c *Client) CreateContact(ctx context.Context, params *CreateContactInput, optFns ...func(*Options)) (*CreateContactOutput, error)

Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.

func (*Client) CreateContactChannel 

func (c *Client) CreateContactChannel(ctx context.Context, params *CreateContactChannelInput, optFns ...func(*Options)) (*CreateContactChannelOutput, error)

A contact channel is the method that Incident Manager uses to engage your contact.

func (*Client) CreateRotation added in v1.15.0 

func (c *Client) CreateRotation(ctx context.Context, params *CreateRotationInput, optFns ...func(*Options)) (*CreateRotationOutput, error)

Creates a rotation in an on-call schedule.

func (*Client) CreateRotationOverride added in v1.15.0 

func (c *Client) CreateRotationOverride(ctx context.Context, params *CreateRotationOverrideInput, optFns ...func(*Options)) (*CreateRotationOverrideOutput, error)

Creates an override for a rotation in an on-call schedule.

func (*Client) DeactivateContactChannel 

func (c *Client) DeactivateContactChannel(ctx context.Context, params *DeactivateContactChannelInput, optFns ...func(*Options)) (*DeactivateContactChannelOutput, error)

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

func (*Client) DeleteContact 

func (c *Client) DeleteContact(ctx context.Context, params *DeleteContactInput, optFns ...func(*Options)) (*DeleteContactOutput, error)

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.

func (*Client) DeleteContactChannel 

func (c *Client) DeleteContactChannel(ctx context.Context, params *DeleteContactChannelInput, optFns ...func(*Options)) (*DeleteContactChannelOutput, error)

To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.

func (*Client) DeleteRotation added in v1.15.0 

func (c *Client) DeleteRotation(ctx context.Context, params *DeleteRotationInput, optFns ...func(*Options)) (*DeleteRotationOutput, error)

Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.

func (*Client) DeleteRotationOverride added in v1.15.0 

func (c *Client) DeleteRotationOverride(ctx context.Context, params *DeleteRotationOverrideInput, optFns ...func(*Options)) (*DeleteRotationOverrideOutput, error)

Deletes an existing override for an on-call rotation.

func (*Client) DescribeEngagement 

func (c *Client) DescribeEngagement(ctx context.Context, params *DescribeEngagementInput, optFns ...func(*Options)) (*DescribeEngagementOutput, error)

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

func (*Client) DescribePage 

func (c *Client) DescribePage(ctx context.Context, params *DescribePageInput, optFns ...func(*Options)) (*DescribePageOutput, error)

Lists details of the engagement to a contact channel.

func (*Client) GetContact 

func (c *Client) GetContact(ctx context.Context, params *GetContactInput, optFns ...func(*Options)) (*GetContactOutput, error)

Retrieves information about the specified contact or escalation plan.

func (*Client) GetContactChannel 

func (c *Client) GetContactChannel(ctx context.Context, params *GetContactChannelInput, optFns ...func(*Options)) (*GetContactChannelOutput, error)

List details about a specific contact channel.

func (*Client) GetContactPolicy 

func (c *Client) GetContactPolicy(ctx context.Context, params *GetContactPolicyInput, optFns ...func(*Options)) (*GetContactPolicyOutput, error)

Retrieves the resource policies attached to the specified contact or escalation plan.

func (*Client) GetRotation added in v1.15.0 

func (c *Client) GetRotation(ctx context.Context, params *GetRotationInput, optFns ...func(*Options)) (*GetRotationOutput, error)

Retrieves information about an on-call rotation.

func (*Client) GetRotationOverride added in v1.15.0 

func (c *Client) GetRotationOverride(ctx context.Context, params *GetRotationOverrideInput, optFns ...func(*Options)) (*GetRotationOverrideOutput, error)

Retrieves information about an override to an on-call rotation.

func (*Client) ListContactChannels 

func (c *Client) ListContactChannels(ctx context.Context, params *ListContactChannelsInput, optFns ...func(*Options)) (*ListContactChannelsOutput, error)

Lists all contact channels for the specified contact.

func (*Client) ListContacts 

func (c *Client) ListContacts(ctx context.Context, params *ListContactsInput, optFns ...func(*Options)) (*ListContactsOutput, error)

Lists all contacts and escalation plans in Incident Manager.

func (*Client) ListEngagements 

func (c *Client) ListEngagements(ctx context.Context, params *ListEngagementsInput, optFns ...func(*Options)) (*ListEngagementsOutput, error)

Lists all engagements that have happened in an incident.

func (*Client) ListPageReceipts 

func (c *Client) ListPageReceipts(ctx context.Context, params *ListPageReceiptsInput, optFns ...func(*Options)) (*ListPageReceiptsOutput, error)

Lists all of the engagements to contact channels that have been acknowledged.

func (*Client) ListPageResolutions added in v1.15.0 

func (c *Client) ListPageResolutions(ctx context.Context, params *ListPageResolutionsInput, optFns ...func(*Options)) (*ListPageResolutionsOutput, error)

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.

func (*Client) ListPagesByContact 

func (c *Client) ListPagesByContact(ctx context.Context, params *ListPagesByContactInput, optFns ...func(*Options)) (*ListPagesByContactOutput, error)

Lists the engagements to a contact's contact channels.

func (*Client) ListPagesByEngagement 

func (c *Client) ListPagesByEngagement(ctx context.Context, params *ListPagesByEngagementInput, optFns ...func(*Options)) (*ListPagesByEngagementOutput, error)

Lists the engagements to contact channels that occurred by engaging a contact.

func (*Client) ListPreviewRotationShifts added in v1.15.0 

func (c *Client) ListPreviewRotationShifts(ctx context.Context, params *ListPreviewRotationShiftsInput, optFns ...func(*Options)) (*ListPreviewRotationShiftsOutput, error)

Returns a list of shifts based on rotation configuration parameters.

The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

func (*Client) ListRotationOverrides added in v1.15.0 

func (c *Client) ListRotationOverrides(ctx context.Context, params *ListRotationOverridesInput, optFns ...func(*Options)) (*ListRotationOverridesOutput, error)

Retrieves a list of overrides currently specified for an on-call rotation.

func (*Client) ListRotationShifts added in v1.15.0 

func (c *Client) ListRotationShifts(ctx context.Context, params *ListRotationShiftsInput, optFns ...func(*Options)) (*ListRotationShiftsOutput, error)

Returns a list of shifts generated by an existing rotation in the system.

func (*Client) ListRotations added in v1.15.0 

func (c *Client) ListRotations(ctx context.Context, params *ListRotationsInput, optFns ...func(*Options)) (*ListRotationsOutput, error)

Retrieves a list of on-call rotations.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags of an escalation plan or contact.

func (*Client) Options added in v1.20.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutContactPolicy 

func (c *Client) PutContactPolicy(ctx context.Context, params *PutContactPolicyInput, optFns ...func(*Options)) (*PutContactPolicyOutput, error)

Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.

func (*Client) SendActivationCode 

func (c *Client) SendActivationCode(ctx context.Context, params *SendActivationCodeInput, optFns ...func(*Options)) (*SendActivationCodeOutput, error)

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.

func (*Client) StartEngagement 

func (c *Client) StartEngagement(ctx context.Context, params *StartEngagementInput, optFns ...func(*Options)) (*StartEngagementOutput, error)

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

func (*Client) StopEngagement 

func (c *Client) StopEngagement(ctx context.Context, params *StopEngagementInput, optFns ...func(*Options)) (*StopEngagementOutput, error)

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from the specified resource.

func (*Client) UpdateContact 

func (c *Client) UpdateContact(ctx context.Context, params *UpdateContactInput, optFns ...func(*Options)) (*UpdateContactOutput, error)

Updates the contact or escalation plan specified.

func (*Client) UpdateContactChannel 

func (c *Client) UpdateContactChannel(ctx context.Context, params *UpdateContactChannelInput, optFns ...func(*Options)) (*UpdateContactChannelOutput, error)

Updates a contact's contact channel.

func (*Client) UpdateRotation added in v1.15.0 

func (c *Client) UpdateRotation(ctx context.Context, params *UpdateRotationInput, optFns ...func(*Options)) (*UpdateRotationOutput, error)

Updates the information specified for an on-call rotation.

type CreateContactChannelInput 

type CreateContactChannelInput struct {

	// The Amazon Resource Name (ARN) of the contact you are adding the contact
	// channel to.
	//
	// This member is required.
	ContactId *string

	// The details that Incident Manager uses when trying to engage the contact
	// channel. The format is dependent on the type of the contact channel. The
	// following are the expected formats:
	//
	//   - SMS - '+' followed by the country code and phone number
	//
	//   - VOICE - '+' followed by the country code and phone number
	//
	//   - EMAIL - any standard email format
	//
	// This member is required.
	DeliveryAddress *types.ContactChannelAddress

	// The name of the contact channel.
	//
	// This member is required.
	Name *string

	// Incident Manager supports three types of contact channels:
	//
	//   - SMS
	//
	//   - VOICE
	//
	//   - EMAIL
	//
	// This member is required.
	Type types.ChannelType

	// If you want to activate the channel at a later time, you can choose to defer
	// activation. Incident Manager can't engage your contact channel until it has been
	// activated.
	DeferActivation *bool

	// A token ensuring that the operation is called only once with the specified
	// details.
	IdempotencyToken *string
	// contains filtered or unexported fields
}

type CreateContactChannelOutput 

type CreateContactChannelOutput struct {

	// The Amazon Resource Name (ARN) of the contact channel.
	//
	// This member is required.
	ContactChannelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateContactInput 

type CreateContactInput struct {

	// The short name to quickly identify a contact or escalation plan. The contact
	// alias must be unique and identifiable.
	//
	// This member is required.
	Alias *string

	// A list of stages. A contact has an engagement plan with stages that contact
	// specified contact channels. An escalation plan uses stages that contact
	// specified contacts.
	//
	// This member is required.
	Plan *types.Plan

	// To create an escalation plan use ESCALATION . To create a contact use PERSONAL .
	//
	// This member is required.
	Type types.ContactType

	// The full name of the contact or escalation plan.
	DisplayName *string

	// A token ensuring that the operation is called only once with the specified
	// details.
	IdempotencyToken *string

	// Adds a tag to the target. You can only tag resources created in the first
	// Region of your replication set.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateContactOutput 

type CreateContactOutput struct {

	// The Amazon Resource Name (ARN) of the created contact or escalation plan.
	//
	// This member is required.
	ContactArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRotationInput added in v1.15.0 

type CreateRotationInput struct {

	// The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
	//
	// The order that you list the contacts in is their shift order in the rotation
	// schedule. To change the order of the contact's shifts, use the UpdateRotationoperation.
	//
	// This member is required.
	ContactIds []string

	// The name of the rotation.
	//
	// This member is required.
	Name *string

	// Information about the rule that specifies when a shift's team members rotate.
	//
	// This member is required.
	Recurrence *types.RecurrenceSettings

	// The time zone to base the rotation’s activity on in Internet Assigned Numbers
	// Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
	// "Asia/Seoul". For more information, see the [Time Zone Database]on the IANA website.
	//
	// Designators for time zones that don’t support Daylight Savings Time rules, such
	// as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not
	// supported.
	//
	// [Time Zone Database]: https://www.iana.org/time-zones
	//
	// This member is required.
	TimeZoneId *string

	// A token that ensures that the operation is called only once with the specified
	// details.
	IdempotencyToken *string

	// The date and time that the rotation goes into effect.
	StartTime *time.Time

	// Optional metadata to assign to the rotation. Tags enable you to categorize a
	// resource in different ways, such as by purpose, owner, or environment. For more
	// information, see [Tagging Incident Manager resources]in the Incident Manager User Guide.
	//
	// [Tagging Incident Manager resources]: https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateRotationOutput added in v1.15.0 

type CreateRotationOutput struct {

	// The Amazon Resource Name (ARN) of the created rotation.
	//
	// This member is required.
	RotationArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRotationOverrideInput added in v1.15.0 

type CreateRotationOverrideInput struct {

	// The date and time when the override ends.
	//
	// This member is required.
	EndTime *time.Time

	// The Amazon Resource Names (ARNs) of the contacts to replace those in the
	// current on-call rotation with.
	//
	// If you want to include any current team members in the override shift, you must
	// include their ARNs in the new contact ID list.
	//
	// This member is required.
	NewContactIds []string

	// The Amazon Resource Name (ARN) of the rotation to create an override for.
	//
	// This member is required.
	RotationId *string

	// The date and time when the override goes into effect.
	//
	// This member is required.
	StartTime *time.Time

	// A token that ensures that the operation is called only once with the specified
	// details.
	IdempotencyToken *string
	// contains filtered or unexported fields
}

type CreateRotationOverrideOutput added in v1.15.0 

type CreateRotationOverrideOutput struct {

	// The Amazon Resource Name (ARN) of the created rotation override.
	//
	// This member is required.
	RotationOverrideId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeactivateContactChannelInput 

type DeactivateContactChannelInput struct {

	// The Amazon Resource Name (ARN) of the contact channel you're deactivating.
	//
	// This member is required.
	ContactChannelId *string
	// contains filtered or unexported fields
}

type DeactivateContactChannelOutput 

type DeactivateContactChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteContactChannelInput 

type DeleteContactChannelInput struct {

	// The Amazon Resource Name (ARN) of the contact channel.
	//
	// This member is required.
	ContactChannelId *string
	// contains filtered or unexported fields
}

type DeleteContactChannelOutput 

type DeleteContactChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteContactInput 

type DeleteContactInput struct {

	// The Amazon Resource Name (ARN) of the contact that you're deleting.
	//
	// This member is required.
	ContactId *string
	// contains filtered or unexported fields
}

type DeleteContactOutput 

type DeleteContactOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRotationInput added in v1.15.0 

type DeleteRotationInput struct {

	// The Amazon Resource Name (ARN) of the on-call rotation to delete.
	//
	// This member is required.
	RotationId *string
	// contains filtered or unexported fields
}

type DeleteRotationOutput added in v1.15.0 

type DeleteRotationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRotationOverrideInput added in v1.15.0 

type DeleteRotationOverrideInput struct {

	// The Amazon Resource Name (ARN) of the rotation that was overridden.
	//
	// This member is required.
	RotationId *string

	// The Amazon Resource Name (ARN) of the on-call rotation override to delete.
	//
	// This member is required.
	RotationOverrideId *string
	// contains filtered or unexported fields
}

type DeleteRotationOverrideOutput added in v1.15.0 

type DeleteRotationOverrideOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEngagementInput 

type DescribeEngagementInput struct {

	// The Amazon Resource Name (ARN) of the engagement you want the details of.
	//
	// This member is required.
	EngagementId *string
	// contains filtered or unexported fields
}

type DescribeEngagementOutput 

type DescribeEngagementOutput struct {

	// The ARN of the escalation plan or contacts involved in the engagement.
	//
	// This member is required.
	ContactArn *string

	// The secure content of the message that was sent to the contact. Use this field
	// for engagements to VOICE and EMAIL .
	//
	// This member is required.
	Content *string

	// The ARN of the engagement.
	//
	// This member is required.
	EngagementArn *string

	// The user that started the engagement.
	//
	// This member is required.
	Sender *string

	// The secure subject of the message that was sent to the contact. Use this field
	// for engagements to VOICE and EMAIL .
	//
	// This member is required.
	Subject *string

	// The ARN of the incident in which the engagement occurred.
	IncidentId *string

	// The insecure content of the message that was sent to the contact. Use this
	// field for engagements to SMS .
	PublicContent *string

	// The insecure subject of the message that was sent to the contact. Use this
	// field for engagements to SMS .
	PublicSubject *string

	// The time that the engagement started.
	StartTime *time.Time

	// The time that the engagement ended.
	StopTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePageInput 

type DescribePageInput struct {

	// The ID of the engagement to a contact channel.
	//
	// This member is required.
	PageId *string
	// contains filtered or unexported fields
}

type DescribePageOutput 

type DescribePageOutput struct {

	// The ARN of the contact that was engaged.
	//
	// This member is required.
	ContactArn *string

	// The secure content of the message that was sent to the contact. Use this field
	// for engagements to VOICE and EMAIL .
	//
	// This member is required.
	Content *string

	// The ARN of the engagement that engaged the contact channel.
	//
	// This member is required.
	EngagementArn *string

	// The Amazon Resource Name (ARN) of the engagement to a contact channel.
	//
	// This member is required.
	PageArn *string

	// The user that started the engagement.
	//
	// This member is required.
	Sender *string

	// The secure subject of the message that was sent to the contact. Use this field
	// for engagements to VOICE and EMAIL .
	//
	// This member is required.
	Subject *string

	// The time that the contact channel received the engagement.
	DeliveryTime *time.Time

	// The ARN of the incident that engaged the contact channel.
	IncidentId *string

	// The insecure content of the message that was sent to the contact. Use this
	// field for engagements to SMS .
	PublicContent *string

	// The insecure subject of the message that was sent to the contact. Use this
	// field for engagements to SMS .
	PublicSubject *string

	// The time that the contact channel acknowledged the engagement.
	ReadTime *time.Time

	// The time the engagement was sent to the contact channel.
	SentTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.16.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.16.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.16.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

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 EndpointResolverV2 added in v1.16.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.16.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetContactChannelInput 

type GetContactChannelInput struct {

	// The Amazon Resource Name (ARN) of the contact channel you want information
	// about.
	//
	// This member is required.
	ContactChannelId *string
	// contains filtered or unexported fields
}

type GetContactChannelOutput 

type GetContactChannelOutput struct {

	// The ARN of the contact that the channel belongs to.
	//
	// This member is required.
	ContactArn *string

	// The ARN of the contact channel.
	//
	// This member is required.
	ContactChannelArn *string

	// The details that Incident Manager uses when trying to engage the contact
	// channel.
	//
	// This member is required.
	DeliveryAddress *types.ContactChannelAddress

	// The name of the contact channel
	//
	// This member is required.
	Name *string

	// The type of contact channel. The type is SMS , VOICE , or EMAIL .
	//
	// This member is required.
	Type types.ChannelType

	// A Boolean value indicating if the contact channel has been activated or not.
	ActivationStatus types.ActivationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetContactInput 

type GetContactInput struct {

	// The Amazon Resource Name (ARN) of the contact or escalation plan.
	//
	// This member is required.
	ContactId *string
	// contains filtered or unexported fields
}

type GetContactOutput 

type GetContactOutput struct {

	// The alias of the contact or escalation plan. The alias is unique and
	// identifiable.
	//
	// This member is required.
	Alias *string

	// The ARN of the contact or escalation plan.
	//
	// This member is required.
	ContactArn *string

	// Details about the specific timing or stages and targets of the escalation plan
	// or engagement plan.
	//
	// This member is required.
	Plan *types.Plan

	// The type of contact, either PERSONAL or ESCALATION .
	//
	// This member is required.
	Type types.ContactType

	// The full name of the contact or escalation plan.
	DisplayName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetContactPolicyInput 

type GetContactPolicyInput struct {

	// The Amazon Resource Name (ARN) of the contact or escalation plan.
	//
	// This member is required.
	ContactArn *string
	// contains filtered or unexported fields
}

type GetContactPolicyOutput 

type GetContactPolicyOutput struct {

	// The ARN of the contact or escalation plan.
	ContactArn *string

	// Details about the resource policy attached to the contact or escalation plan.
	Policy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRotationInput added in v1.15.0 

type GetRotationInput struct {

	// The Amazon Resource Name (ARN) of the on-call rotation to retrieve information
	// about.
	//
	// This member is required.
	RotationId *string
	// contains filtered or unexported fields
}

type GetRotationOutput added in v1.15.0 

type GetRotationOutput struct {

	// The Amazon Resource Names (ARNs) of the contacts assigned to the on-call
	// rotation team.
	//
	// This member is required.
	ContactIds []string

	// The name of the on-call rotation.
	//
	// This member is required.
	Name *string

	// Specifies how long a rotation lasts before restarting at the beginning of the
	// shift order.
	//
	// This member is required.
	Recurrence *types.RecurrenceSettings

	// The Amazon Resource Name (ARN) of the on-call rotation.
	//
	// This member is required.
	RotationArn *string

	// The specified start time for the on-call rotation.
	//
	// This member is required.
	StartTime *time.Time

	// The time zone that the rotation’s activity is based on, in Internet Assigned
	// Numbers Authority (IANA) format.
	//
	// This member is required.
	TimeZoneId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRotationOverrideInput added in v1.15.0 

type GetRotationOverrideInput struct {

	// The Amazon Resource Name (ARN) of the overridden rotation to retrieve
	// information about.
	//
	// This member is required.
	RotationId *string

	// The Amazon Resource Name (ARN) of the on-call rotation override to retrieve
	// information about.
	//
	// This member is required.
	RotationOverrideId *string
	// contains filtered or unexported fields
}

type GetRotationOverrideOutput added in v1.15.0 

type GetRotationOverrideOutput struct {

	// The date and time when the override was created.
	CreateTime *time.Time

	// The date and time when the override ends.
	EndTime *time.Time

	// The Amazon Resource Names (ARNs) of the contacts assigned to the override of
	// the on-call rotation.
	NewContactIds []string

	// The Amazon Resource Name (ARN) of the on-call rotation that was overridden.
	RotationArn *string

	// The Amazon Resource Name (ARN) of the override to an on-call rotation.
	RotationOverrideId *string

	// The date and time when the override goes into effect.
	StartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListContactChannelsAPIClient 

type ListContactChannelsAPIClient interface {
	ListContactChannels(context.Context, *ListContactChannelsInput, ...func(*Options)) (*ListContactChannelsOutput, error)
}

ListContactChannelsAPIClient is a client that implements the ListContactChannels operation.

type ListContactChannelsInput 

type ListContactChannelsInput struct {

	// The Amazon Resource Name (ARN) of the contact.
	//
	// This member is required.
	ContactId *string

	// The maximum number of contact channels per page.
	MaxResults *int32

	// The pagination token to continue to the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListContactChannelsOutput 

type ListContactChannelsOutput struct {

	// A list of contact channels related to the specified contact.
	//
	// This member is required.
	ContactChannels []types.ContactChannel

	// The pagination token to continue to the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListContactChannelsPaginator 

type ListContactChannelsPaginator struct {
	// contains filtered or unexported fields
}

ListContactChannelsPaginator is a paginator for ListContactChannels

func NewListContactChannelsPaginator 

func NewListContactChannelsPaginator(client ListContactChannelsAPIClient, params *ListContactChannelsInput, optFns ...func(*ListContactChannelsPaginatorOptions)) *ListContactChannelsPaginator

NewListContactChannelsPaginator returns a new ListContactChannelsPaginator

func (*ListContactChannelsPaginator) HasMorePages 

func (p *ListContactChannelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactChannelsPaginator) NextPage 

func (p *ListContactChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactChannelsOutput, error)

NextPage retrieves the next ListContactChannels page.

type ListContactChannelsPaginatorOptions 

type ListContactChannelsPaginatorOptions struct {
	// The maximum number of contact channels 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
}

ListContactChannelsPaginatorOptions is the paginator options for ListContactChannels

type ListContactsAPIClient 

type ListContactsAPIClient interface {
	ListContacts(context.Context, *ListContactsInput, ...func(*Options)) (*ListContactsOutput, error)
}

ListContactsAPIClient is a client that implements the ListContacts operation.

type ListContactsInput 

type ListContactsInput struct {

	// Used to list only contacts who's aliases start with the specified prefix.
	AliasPrefix *string

	// The maximum number of contacts and escalation plans per page of results.
	MaxResults *int32

	// The pagination token to continue to the next page of results.
	NextToken *string

	// The type of contact. A contact is type PERSONAL and an escalation plan is type
	// ESCALATION .
	Type types.ContactType
	// contains filtered or unexported fields
}

type ListContactsOutput 

type ListContactsOutput struct {

	// A list of the contacts and escalation plans in your Incident Manager account.
	Contacts []types.Contact

	// The pagination token to continue to the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListContactsPaginator 

type ListContactsPaginator struct {
	// contains filtered or unexported fields
}

ListContactsPaginator is a paginator for ListContacts

func NewListContactsPaginator 

func NewListContactsPaginator(client ListContactsAPIClient, params *ListContactsInput, optFns ...func(*ListContactsPaginatorOptions)) *ListContactsPaginator

NewListContactsPaginator returns a new ListContactsPaginator

func (*ListContactsPaginator) HasMorePages 

func (p *ListContactsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactsPaginator) NextPage 

func (p *ListContactsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactsOutput, error)

NextPage retrieves the next ListContacts page.

type ListContactsPaginatorOptions 

type ListContactsPaginatorOptions struct {
	// The maximum number of contacts and escalation plans 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
}

ListContactsPaginatorOptions is the paginator options for ListContacts

type ListEngagementsAPIClient 

type ListEngagementsAPIClient interface {
	ListEngagements(context.Context, *ListEngagementsInput, ...func(*Options)) (*ListEngagementsOutput, error)
}

ListEngagementsAPIClient is a client that implements the ListEngagements operation.

type ListEngagementsInput 

type ListEngagementsInput struct {

	// The Amazon Resource Name (ARN) of the incident you're listing engagements for.
	IncidentId *string

	// The maximum number of engagements per page of results.
	MaxResults *int32

	// The pagination token to continue to the next page of results.
	NextToken *string

	// The time range to lists engagements for an incident.
	TimeRangeValue *types.TimeRange
	// contains filtered or unexported fields
}

type ListEngagementsOutput 

type ListEngagementsOutput struct {

	// A list of each engagement that occurred during the specified time range of an
	// incident.
	//
	// This member is required.
	Engagements []types.Engagement

	// The pagination token to continue to the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEngagementsPaginator 

type ListEngagementsPaginator struct {
	// contains filtered or unexported fields
}

ListEngagementsPaginator is a paginator for ListEngagements

func NewListEngagementsPaginator 

func NewListEngagementsPaginator(client ListEngagementsAPIClient, params *ListEngagementsInput, optFns ...func(*ListEngagementsPaginatorOptions)) *ListEngagementsPaginator

NewListEngagementsPaginator returns a new ListEngagementsPaginator

func (*ListEngagementsPaginator) HasMorePages 

func (p *ListEngagementsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEngagementsPaginator) NextPage 

func (p *ListEngagementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEngagementsOutput, error)

NextPage retrieves the next ListEngagements page.

type ListEngagementsPaginatorOptions 

type ListEngagementsPaginatorOptions struct {
	// The maximum number of engagements 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
}

ListEngagementsPaginatorOptions is the paginator options for ListEngagements

type ListPageReceiptsAPIClient 

type ListPageReceiptsAPIClient interface {
	ListPageReceipts(context.Context, *ListPageReceiptsInput, ...func(*Options)) (*ListPageReceiptsOutput, error)
}

ListPageReceiptsAPIClient is a client that implements the ListPageReceipts operation.

type ListPageReceiptsInput 

type ListPageReceiptsInput struct {

	// The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
	//
	// This member is required.
	PageId *string

	// The maximum number of acknowledgements per page of results.
	MaxResults *int32

	// The pagination token to continue to the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPageReceiptsOutput 

type ListPageReceiptsOutput struct {

	// The pagination token to continue to the next page of results.
	NextToken *string

	// A list of each acknowledgement.
	Receipts []types.Receipt

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPageReceiptsPaginator 

type ListPageReceiptsPaginator struct {
	// contains filtered or unexported fields
}

ListPageReceiptsPaginator is a paginator for ListPageReceipts

func NewListPageReceiptsPaginator 

func NewListPageReceiptsPaginator(client ListPageReceiptsAPIClient, params *ListPageReceiptsInput, optFns ...func(*ListPageReceiptsPaginatorOptions)) *ListPageReceiptsPaginator

NewListPageReceiptsPaginator returns a new ListPageReceiptsPaginator

func (*ListPageReceiptsPaginator) HasMorePages 

func (p *ListPageReceiptsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPageReceiptsPaginator) NextPage 

func (p *ListPageReceiptsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPageReceiptsOutput, error)

NextPage retrieves the next ListPageReceipts page.

type ListPageReceiptsPaginatorOptions 

type ListPageReceiptsPaginatorOptions struct {
	// The maximum number of acknowledgements 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
}

ListPageReceiptsPaginatorOptions is the paginator options for ListPageReceipts

type ListPageResolutionsAPIClient added in v1.15.0 

type ListPageResolutionsAPIClient interface {
	ListPageResolutions(context.Context, *ListPageResolutionsInput, ...func(*Options)) (*ListPageResolutionsOutput, error)
}

ListPageResolutionsAPIClient is a client that implements the ListPageResolutions operation.

type ListPageResolutionsInput added in v1.15.0 

type ListPageResolutionsInput struct {

	// The Amazon Resource Name (ARN) of the contact engaged for the incident.
	//
	// This member is required.
	PageId *string

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPageResolutionsOutput added in v1.15.0 

type ListPageResolutionsOutput struct {

	// Information about the resolution for an engagement.
	//
	// This member is required.
	PageResolutions []types.ResolutionContact

	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPageResolutionsPaginator added in v1.15.0 

type ListPageResolutionsPaginator struct {
	// contains filtered or unexported fields
}

ListPageResolutionsPaginator is a paginator for ListPageResolutions

func NewListPageResolutionsPaginator added in v1.15.0 

func NewListPageResolutionsPaginator(client ListPageResolutionsAPIClient, params *ListPageResolutionsInput, optFns ...func(*ListPageResolutionsPaginatorOptions)) *ListPageResolutionsPaginator

NewListPageResolutionsPaginator returns a new ListPageResolutionsPaginator

func (*ListPageResolutionsPaginator) HasMorePages added in v1.15.0 

func (p *ListPageResolutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPageResolutionsPaginator) NextPage added in v1.15.0 

func (p *ListPageResolutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPageResolutionsOutput, error)

NextPage retrieves the next ListPageResolutions page.

type ListPageResolutionsPaginatorOptions added in v1.15.0 

type ListPageResolutionsPaginatorOptions struct {
	// 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
}

ListPageResolutionsPaginatorOptions is the paginator options for ListPageResolutions

type ListPagesByContactAPIClient 

type ListPagesByContactAPIClient interface {
	ListPagesByContact(context.Context, *ListPagesByContactInput, ...func(*Options)) (*ListPagesByContactOutput, error)
}

ListPagesByContactAPIClient is a client that implements the ListPagesByContact operation.

type ListPagesByContactInput 

type ListPagesByContactInput struct {

	// The Amazon Resource Name (ARN) of the contact you are retrieving engagements
	// for.
	//
	// This member is required.
	ContactId *string

	// The maximum number of engagements to contact channels to list per page of
	// results.
	MaxResults *int32

	// The pagination token to continue to the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPagesByContactOutput 

type ListPagesByContactOutput struct {

	// The list of engagements to a contact's contact channel.
	//
	// This member is required.
	Pages []types.Page

	// The pagination token to continue to the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPagesByContactPaginator 

type ListPagesByContactPaginator struct {
	// contains filtered or unexported fields
}

ListPagesByContactPaginator is a paginator for ListPagesByContact

func NewListPagesByContactPaginator 

func NewListPagesByContactPaginator(client ListPagesByContactAPIClient, params *ListPagesByContactInput, optFns ...func(*ListPagesByContactPaginatorOptions)) *ListPagesByContactPaginator

NewListPagesByContactPaginator returns a new ListPagesByContactPaginator

func (*ListPagesByContactPaginator) HasMorePages 

func (p *ListPagesByContactPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPagesByContactPaginator) NextPage 

func (p *ListPagesByContactPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPagesByContactOutput, error)

NextPage retrieves the next ListPagesByContact page.

type ListPagesByContactPaginatorOptions 

type ListPagesByContactPaginatorOptions struct {
	// The maximum number of engagements to contact channels to list 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
}

ListPagesByContactPaginatorOptions is the paginator options for ListPagesByContact

type ListPagesByEngagementAPIClient 

type ListPagesByEngagementAPIClient interface {
	ListPagesByEngagement(context.Context, *ListPagesByEngagementInput, ...func(*Options)) (*ListPagesByEngagementOutput, error)
}

ListPagesByEngagementAPIClient is a client that implements the ListPagesByEngagement operation.

type ListPagesByEngagementInput 

type ListPagesByEngagementInput struct {

	// The Amazon Resource Name (ARN) of the engagement.
	//
	// This member is required.
	EngagementId *string

	// The maximum number of engagements to contact channels to list per page of
	// results.
	MaxResults *int32

	// The pagination token to continue to the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPagesByEngagementOutput 

type ListPagesByEngagementOutput struct {

	// The list of engagements to contact channels.
	//
	// This member is required.
	Pages []types.Page

	// The pagination token to continue to the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPagesByEngagementPaginator 

type ListPagesByEngagementPaginator struct {
	// contains filtered or unexported fields
}

ListPagesByEngagementPaginator is a paginator for ListPagesByEngagement

func NewListPagesByEngagementPaginator 

func NewListPagesByEngagementPaginator(client ListPagesByEngagementAPIClient, params *ListPagesByEngagementInput, optFns ...func(*ListPagesByEngagementPaginatorOptions)) *ListPagesByEngagementPaginator

NewListPagesByEngagementPaginator returns a new ListPagesByEngagementPaginator

func (*ListPagesByEngagementPaginator) HasMorePages 

func (p *ListPagesByEngagementPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPagesByEngagementPaginator) NextPage 

func (p *ListPagesByEngagementPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPagesByEngagementOutput, error)

NextPage retrieves the next ListPagesByEngagement page.

type ListPagesByEngagementPaginatorOptions 

type ListPagesByEngagementPaginatorOptions struct {
	// The maximum number of engagements to contact channels to list 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
}

ListPagesByEngagementPaginatorOptions is the paginator options for ListPagesByEngagement

type ListPreviewRotationShiftsAPIClient added in v1.15.0 

type ListPreviewRotationShiftsAPIClient interface {
	ListPreviewRotationShifts(context.Context, *ListPreviewRotationShiftsInput, ...func(*Options)) (*ListPreviewRotationShiftsOutput, error)
}

ListPreviewRotationShiftsAPIClient is a client that implements the ListPreviewRotationShifts operation.

type ListPreviewRotationShiftsInput added in v1.15.0 

type ListPreviewRotationShiftsInput struct {

	// The date and time a rotation shift would end.
	//
	// This member is required.
	EndTime *time.Time

	// The contacts that would be assigned to a rotation.
	//
	// This member is required.
	Members []string

	// Information about how long a rotation would last before restarting at the
	// beginning of the shift order.
	//
	// This member is required.
	Recurrence *types.RecurrenceSettings

	// The time zone the rotation’s activity would be based on, in Internet Assigned
	// Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
	// "Asia/Seoul".
	//
	// This member is required.
	TimeZoneId *string

	// The maximum number of items to return for this call. The call also returns a
	// token that can be specified in a subsequent call to get the next set of results.
	MaxResults *int32

	// A token to start the list. This token is used to get the next set of results.
	NextToken *string

	// Information about changes that would be made in a rotation override.
	Overrides []types.PreviewOverride

	// The date and time a rotation would begin. The first shift is calculated from
	// this date and time.
	RotationStartTime *time.Time

	// Used to filter the range of calculated shifts before sending the response back
	// to the user.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type ListPreviewRotationShiftsOutput added in v1.15.0 

type ListPreviewRotationShiftsOutput struct {

	// The token for the next set of items to return. This token is used to get the
	// next set of results.
	NextToken *string

	// Details about a rotation shift, including times, types, and contacts.
	RotationShifts []types.RotationShift

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPreviewRotationShiftsPaginator added in v1.15.0 

type ListPreviewRotationShiftsPaginator struct {
	// contains filtered or unexported fields
}

ListPreviewRotationShiftsPaginator is a paginator for ListPreviewRotationShifts

func NewListPreviewRotationShiftsPaginator added in v1.15.0 

func NewListPreviewRotationShiftsPaginator(client ListPreviewRotationShiftsAPIClient, params *ListPreviewRotationShiftsInput, optFns ...func(*ListPreviewRotationShiftsPaginatorOptions)) *ListPreviewRotationShiftsPaginator

NewListPreviewRotationShiftsPaginator returns a new ListPreviewRotationShiftsPaginator

func (*ListPreviewRotationShiftsPaginator) HasMorePages added in v1.15.0 

func (p *ListPreviewRotationShiftsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPreviewRotationShiftsPaginator) NextPage added in v1.15.0 

func (p *ListPreviewRotationShiftsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPreviewRotationShiftsOutput, error)

NextPage retrieves the next ListPreviewRotationShifts page.

type ListPreviewRotationShiftsPaginatorOptions added in v1.15.0 

type ListPreviewRotationShiftsPaginatorOptions struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that can be specified in a subsequent call to get the next set 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
}

ListPreviewRotationShiftsPaginatorOptions is the paginator options for ListPreviewRotationShifts

type ListRotationOverridesAPIClient added in v1.15.0 

type ListRotationOverridesAPIClient interface {
	ListRotationOverrides(context.Context, *ListRotationOverridesInput, ...func(*Options)) (*ListRotationOverridesOutput, error)
}

ListRotationOverridesAPIClient is a client that implements the ListRotationOverrides operation.

type ListRotationOverridesInput added in v1.15.0 

type ListRotationOverridesInput struct {

	// The date and time for the end of a time range for listing overrides.
	//
	// This member is required.
	EndTime *time.Time

	// The Amazon Resource Name (ARN) of the rotation to retrieve information about.
	//
	// This member is required.
	RotationId *string

	// The date and time for the beginning of a time range for listing overrides.
	//
	// This member is required.
	StartTime *time.Time

	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRotationOverridesOutput added in v1.15.0 

type ListRotationOverridesOutput struct {

	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

	// A list of rotation overrides in the specified time range.
	RotationOverrides []types.RotationOverride

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRotationOverridesPaginator added in v1.15.0 

type ListRotationOverridesPaginator struct {
	// contains filtered or unexported fields
}

ListRotationOverridesPaginator is a paginator for ListRotationOverrides

func NewListRotationOverridesPaginator added in v1.15.0 

func NewListRotationOverridesPaginator(client ListRotationOverridesAPIClient, params *ListRotationOverridesInput, optFns ...func(*ListRotationOverridesPaginatorOptions)) *ListRotationOverridesPaginator

NewListRotationOverridesPaginator returns a new ListRotationOverridesPaginator

func (*ListRotationOverridesPaginator) HasMorePages added in v1.15.0 

func (p *ListRotationOverridesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRotationOverridesPaginator) NextPage added in v1.15.0 

func (p *ListRotationOverridesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRotationOverridesOutput, error)

NextPage retrieves the next ListRotationOverrides page.

type ListRotationOverridesPaginatorOptions added in v1.15.0 

type ListRotationOverridesPaginatorOptions struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set 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
}

ListRotationOverridesPaginatorOptions is the paginator options for ListRotationOverrides

type ListRotationShiftsAPIClient added in v1.15.0 

type ListRotationShiftsAPIClient interface {
	ListRotationShifts(context.Context, *ListRotationShiftsInput, ...func(*Options)) (*ListRotationShiftsOutput, error)
}

ListRotationShiftsAPIClient is a client that implements the ListRotationShifts operation.

type ListRotationShiftsInput added in v1.15.0 

type ListRotationShiftsInput struct {

	// The date and time for the end of the time range to list shifts for.
	//
	// This member is required.
	EndTime *time.Time

	// The Amazon Resource Name (ARN) of the rotation to retrieve shift information
	// about.
	//
	// This member is required.
	RotationId *string

	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string

	// The date and time for the beginning of the time range to list shifts for.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type ListRotationShiftsOutput added in v1.15.0 

type ListRotationShiftsOutput struct {

	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

	// Information about shifts that meet the filter criteria.
	RotationShifts []types.RotationShift

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRotationShiftsPaginator added in v1.15.0 

type ListRotationShiftsPaginator struct {
	// contains filtered or unexported fields
}

ListRotationShiftsPaginator is a paginator for ListRotationShifts

func NewListRotationShiftsPaginator added in v1.15.0 

func NewListRotationShiftsPaginator(client ListRotationShiftsAPIClient, params *ListRotationShiftsInput, optFns ...func(*ListRotationShiftsPaginatorOptions)) *ListRotationShiftsPaginator

NewListRotationShiftsPaginator returns a new ListRotationShiftsPaginator

func (*ListRotationShiftsPaginator) HasMorePages added in v1.15.0 

func (p *ListRotationShiftsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRotationShiftsPaginator) NextPage added in v1.15.0 

func (p *ListRotationShiftsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRotationShiftsOutput, error)

NextPage retrieves the next ListRotationShifts page.

type ListRotationShiftsPaginatorOptions added in v1.15.0 

type ListRotationShiftsPaginatorOptions struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set 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
}

ListRotationShiftsPaginatorOptions is the paginator options for ListRotationShifts

type ListRotationsAPIClient added in v1.15.0 

type ListRotationsAPIClient interface {
	ListRotations(context.Context, *ListRotationsInput, ...func(*Options)) (*ListRotationsOutput, error)
}

ListRotationsAPIClient is a client that implements the ListRotations operation.

type ListRotationsInput added in v1.15.0 

type ListRotationsInput struct {

	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string

	// A filter to include rotations in list results based on their common prefix. For
	// example, entering prod returns a list of all rotation names that begin with prod
	// , such as production and prod-1 .
	RotationNamePrefix *string
	// contains filtered or unexported fields
}

type ListRotationsOutput added in v1.15.0 

type ListRotationsOutput struct {

	// Information about rotations that meet the filter criteria.
	//
	// This member is required.
	Rotations []types.Rotation

	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRotationsPaginator added in v1.15.0 

type ListRotationsPaginator struct {
	// contains filtered or unexported fields
}

ListRotationsPaginator is a paginator for ListRotations

func NewListRotationsPaginator added in v1.15.0 

func NewListRotationsPaginator(client ListRotationsAPIClient, params *ListRotationsInput, optFns ...func(*ListRotationsPaginatorOptions)) *ListRotationsPaginator

NewListRotationsPaginator returns a new ListRotationsPaginator

func (*ListRotationsPaginator) HasMorePages added in v1.15.0 

func (p *ListRotationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRotationsPaginator) NextPage added in v1.15.0 

func (p *ListRotationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRotationsOutput, error)

NextPage retrieves the next ListRotations page.

type ListRotationsPaginatorOptions added in v1.15.0 

type ListRotationsPaginatorOptions struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set 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
}

ListRotationsPaginatorOptions is the paginator options for ListRotations

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the contact or escalation plan.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags related to the contact or escalation plan.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// 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 client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.19.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutContactPolicyInput 

type PutContactPolicyInput struct {

	// The Amazon Resource Name (ARN) of the contact or escalation plan.
	//
	// This member is required.
	ContactArn *string

	// Details of the resource policy.
	//
	// This member is required.
	Policy *string
	// contains filtered or unexported fields
}

type PutContactPolicyOutput 

type PutContactPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 SendActivationCodeInput 

type SendActivationCodeInput struct {

	// The Amazon Resource Name (ARN) of the contact channel.
	//
	// This member is required.
	ContactChannelId *string
	// contains filtered or unexported fields
}

type SendActivationCodeOutput 

type SendActivationCodeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartEngagementInput 

type StartEngagementInput struct {

	// The Amazon Resource Name (ARN) of the contact being engaged.
	//
	// This member is required.
	ContactId *string

	// The secure content of the message that was sent to the contact. Use this field
	// for engagements to VOICE or EMAIL .
	//
	// This member is required.
	Content *string

	// The user that started the engagement.
	//
	// This member is required.
	Sender *string

	// The secure subject of the message that was sent to the contact. Use this field
	// for engagements to VOICE or EMAIL .
	//
	// This member is required.
	Subject *string

	// A token ensuring that the operation is called only once with the specified
	// details.
	IdempotencyToken *string

	// The ARN of the incident that the engagement is part of.
	IncidentId *string

	// The insecure content of the message that was sent to the contact. Use this
	// field for engagements to SMS .
	PublicContent *string

	// The insecure subject of the message that was sent to the contact. Use this
	// field for engagements to SMS .
	PublicSubject *string
	// contains filtered or unexported fields
}

type StartEngagementOutput 

type StartEngagementOutput struct {

	// The ARN of the engagement.
	//
	// This member is required.
	EngagementArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopEngagementInput 

type StopEngagementInput struct {

	// The Amazon Resource Name (ARN) of the engagement.
	//
	// This member is required.
	EngagementId *string

	// The reason that you're stopping the engagement.
	Reason *string
	// contains filtered or unexported fields
}

type StopEngagementOutput 

type StopEngagementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the contact or escalation plan.
	//
	// This member is required.
	ResourceARN *string

	// A list of tags that you are adding to the contact or escalation plan.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the contact or escalation plan.
	//
	// This member is required.
	ResourceARN *string

	// The key of the tag that you want to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateContactChannelInput 

type UpdateContactChannelInput struct {

	// The Amazon Resource Name (ARN) of the contact channel you want to update.
	//
	// This member is required.
	ContactChannelId *string

	// The details that Incident Manager uses when trying to engage the contact
	// channel.
	DeliveryAddress *types.ContactChannelAddress

	// The name of the contact channel.
	Name *string
	// contains filtered or unexported fields
}

type UpdateContactChannelOutput 

type UpdateContactChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateContactInput 

type UpdateContactInput struct {

	// The Amazon Resource Name (ARN) of the contact or escalation plan you're
	// updating.
	//
	// This member is required.
	ContactId *string

	// The full name of the contact or escalation plan.
	DisplayName *string

	// A list of stages. A contact has an engagement plan with stages for specified
	// contact channels. An escalation plan uses these stages to contact specified
	// contacts.
	Plan *types.Plan
	// contains filtered or unexported fields
}

type UpdateContactOutput 

type UpdateContactOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRotationInput added in v1.15.0 

type UpdateRotationInput struct {

	// Information about how long the updated rotation lasts before restarting at the
	// beginning of the shift order.
	//
	// This member is required.
	Recurrence *types.RecurrenceSettings

	// The Amazon Resource Name (ARN) of the rotation to update.
	//
	// This member is required.
	RotationId *string

	// The Amazon Resource Names (ARNs) of the contacts to include in the updated
	// rotation.
	//
	// The order in which you list the contacts is their shift order in the rotation
	// schedule.
	ContactIds []string

	// The date and time the rotation goes into effect.
	StartTime *time.Time

	// The time zone to base the updated rotation’s activity on, in Internet Assigned
	// Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
	// "Asia/Seoul". For more information, see the [Time Zone Database]on the IANA website.
	//
	// Designators for time zones that don’t support Daylight Savings Time Rules, such
	// as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't
	// supported.
	//
	// [Time Zone Database]: https://www.iana.org/time-zones
	TimeZoneId *string
	// contains filtered or unexported fields
}

type UpdateRotationOutput added in v1.15.0 

type UpdateRotationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.