...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/ssmcontacts"
Overview
Examples
Constants

Overview ▾

Package ssmcontacts provides the client and types for making API requests to 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.

See https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03 for more information on this service.

See ssmcontacts package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/ssmcontacts/

Using the Client

To contact AWS Systems Manager Incident Manager Contacts with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Systems Manager Incident Manager Contacts client SSMContacts for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ssmcontacts/#New

The stub package, ssmcontactsiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type SSMContacts
func New(p client.ConfigProvider, cfgs ...*aws.Config) *SSMContacts
func (c *SSMContacts) AcceptPage(input *AcceptPageInput) (*AcceptPageOutput, error)
func (c *SSMContacts) AcceptPageRequest(input *AcceptPageInput) (req *request.Request, output *AcceptPageOutput)
func (c *SSMContacts) AcceptPageWithContext(ctx aws.Context, input *AcceptPageInput, opts ...request.Option) (*AcceptPageOutput, error)
func (c *SSMContacts) ActivateContactChannel(input *ActivateContactChannelInput) (*ActivateContactChannelOutput, error)
func (c *SSMContacts) ActivateContactChannelRequest(input *ActivateContactChannelInput) (req *request.Request, output *ActivateContactChannelOutput)
func (c *SSMContacts) ActivateContactChannelWithContext(ctx aws.Context, input *ActivateContactChannelInput, opts ...request.Option) (*ActivateContactChannelOutput, error)
func (c *SSMContacts) CreateContact(input *CreateContactInput) (*CreateContactOutput, error)
func (c *SSMContacts) CreateContactChannel(input *CreateContactChannelInput) (*CreateContactChannelOutput, error)
func (c *SSMContacts) CreateContactChannelRequest(input *CreateContactChannelInput) (req *request.Request, output *CreateContactChannelOutput)
func (c *SSMContacts) CreateContactChannelWithContext(ctx aws.Context, input *CreateContactChannelInput, opts ...request.Option) (*CreateContactChannelOutput, error)
func (c *SSMContacts) CreateContactRequest(input *CreateContactInput) (req *request.Request, output *CreateContactOutput)
func (c *SSMContacts) CreateContactWithContext(ctx aws.Context, input *CreateContactInput, opts ...request.Option) (*CreateContactOutput, error)
func (c *SSMContacts) DeactivateContactChannel(input *DeactivateContactChannelInput) (*DeactivateContactChannelOutput, error)
func (c *SSMContacts) DeactivateContactChannelRequest(input *DeactivateContactChannelInput) (req *request.Request, output *DeactivateContactChannelOutput)
func (c *SSMContacts) DeactivateContactChannelWithContext(ctx aws.Context, input *DeactivateContactChannelInput, opts ...request.Option) (*DeactivateContactChannelOutput, error)
func (c *SSMContacts) DeleteContact(input *DeleteContactInput) (*DeleteContactOutput, error)
func (c *SSMContacts) DeleteContactChannel(input *DeleteContactChannelInput) (*DeleteContactChannelOutput, error)
func (c *SSMContacts) DeleteContactChannelRequest(input *DeleteContactChannelInput) (req *request.Request, output *DeleteContactChannelOutput)
func (c *SSMContacts) DeleteContactChannelWithContext(ctx aws.Context, input *DeleteContactChannelInput, opts ...request.Option) (*DeleteContactChannelOutput, error)
func (c *SSMContacts) DeleteContactRequest(input *DeleteContactInput) (req *request.Request, output *DeleteContactOutput)
func (c *SSMContacts) DeleteContactWithContext(ctx aws.Context, input *DeleteContactInput, opts ...request.Option) (*DeleteContactOutput, error)
func (c *SSMContacts) DescribeEngagement(input *DescribeEngagementInput) (*DescribeEngagementOutput, error)
func (c *SSMContacts) DescribeEngagementRequest(input *DescribeEngagementInput) (req *request.Request, output *DescribeEngagementOutput)
func (c *SSMContacts) DescribeEngagementWithContext(ctx aws.Context, input *DescribeEngagementInput, opts ...request.Option) (*DescribeEngagementOutput, error)
func (c *SSMContacts) DescribePage(input *DescribePageInput) (*DescribePageOutput, error)
func (c *SSMContacts) DescribePageRequest(input *DescribePageInput) (req *request.Request, output *DescribePageOutput)
func (c *SSMContacts) DescribePageWithContext(ctx aws.Context, input *DescribePageInput, opts ...request.Option) (*DescribePageOutput, error)
func (c *SSMContacts) GetContact(input *GetContactInput) (*GetContactOutput, error)
func (c *SSMContacts) GetContactChannel(input *GetContactChannelInput) (*GetContactChannelOutput, error)
func (c *SSMContacts) GetContactChannelRequest(input *GetContactChannelInput) (req *request.Request, output *GetContactChannelOutput)
func (c *SSMContacts) GetContactChannelWithContext(ctx aws.Context, input *GetContactChannelInput, opts ...request.Option) (*GetContactChannelOutput, error)
func (c *SSMContacts) GetContactPolicy(input *GetContactPolicyInput) (*GetContactPolicyOutput, error)
func (c *SSMContacts) GetContactPolicyRequest(input *GetContactPolicyInput) (req *request.Request, output *GetContactPolicyOutput)
func (c *SSMContacts) GetContactPolicyWithContext(ctx aws.Context, input *GetContactPolicyInput, opts ...request.Option) (*GetContactPolicyOutput, error)
func (c *SSMContacts) GetContactRequest(input *GetContactInput) (req *request.Request, output *GetContactOutput)
func (c *SSMContacts) GetContactWithContext(ctx aws.Context, input *GetContactInput, opts ...request.Option) (*GetContactOutput, error)
func (c *SSMContacts) ListContactChannels(input *ListContactChannelsInput) (*ListContactChannelsOutput, error)
func (c *SSMContacts) ListContactChannelsPages(input *ListContactChannelsInput, fn func(*ListContactChannelsOutput, bool) bool) error
func (c *SSMContacts) ListContactChannelsPagesWithContext(ctx aws.Context, input *ListContactChannelsInput, fn func(*ListContactChannelsOutput, bool) bool, opts ...request.Option) error
func (c *SSMContacts) ListContactChannelsRequest(input *ListContactChannelsInput) (req *request.Request, output *ListContactChannelsOutput)
func (c *SSMContacts) ListContactChannelsWithContext(ctx aws.Context, input *ListContactChannelsInput, opts ...request.Option) (*ListContactChannelsOutput, error)
func (c *SSMContacts) ListContacts(input *ListContactsInput) (*ListContactsOutput, error)
func (c *SSMContacts) ListContactsPages(input *ListContactsInput, fn func(*ListContactsOutput, bool) bool) error
func (c *SSMContacts) ListContactsPagesWithContext(ctx aws.Context, input *ListContactsInput, fn func(*ListContactsOutput, bool) bool, opts ...request.Option) error
func (c *SSMContacts) ListContactsRequest(input *ListContactsInput) (req *request.Request, output *ListContactsOutput)
func (c *SSMContacts) ListContactsWithContext(ctx aws.Context, input *ListContactsInput, opts ...request.Option) (*ListContactsOutput, error)
func (c *SSMContacts) ListEngagements(input *ListEngagementsInput) (*ListEngagementsOutput, error)
func (c *SSMContacts) ListEngagementsPages(input *ListEngagementsInput, fn func(*ListEngagementsOutput, bool) bool) error
func (c *SSMContacts) ListEngagementsPagesWithContext(ctx aws.Context, input *ListEngagementsInput, fn func(*ListEngagementsOutput, bool) bool, opts ...request.Option) error
func (c *SSMContacts) ListEngagementsRequest(input *ListEngagementsInput) (req *request.Request, output *ListEngagementsOutput)
func (c *SSMContacts) ListEngagementsWithContext(ctx aws.Context, input *ListEngagementsInput, opts ...request.Option) (*ListEngagementsOutput, error)
func (c *SSMContacts) ListPageReceipts(input *ListPageReceiptsInput) (*ListPageReceiptsOutput, error)
func (c *SSMContacts) ListPageReceiptsPages(input *ListPageReceiptsInput, fn func(*ListPageReceiptsOutput, bool) bool) error
func (c *SSMContacts) ListPageReceiptsPagesWithContext(ctx aws.Context, input *ListPageReceiptsInput, fn func(*ListPageReceiptsOutput, bool) bool, opts ...request.Option) error
func (c *SSMContacts) ListPageReceiptsRequest(input *ListPageReceiptsInput) (req *request.Request, output *ListPageReceiptsOutput)
func (c *SSMContacts) ListPageReceiptsWithContext(ctx aws.Context, input *ListPageReceiptsInput, opts ...request.Option) (*ListPageReceiptsOutput, error)
func (c *SSMContacts) ListPagesByContact(input *ListPagesByContactInput) (*ListPagesByContactOutput, error)
func (c *SSMContacts) ListPagesByContactPages(input *ListPagesByContactInput, fn func(*ListPagesByContactOutput, bool) bool) error
func (c *SSMContacts) ListPagesByContactPagesWithContext(ctx aws.Context, input *ListPagesByContactInput, fn func(*ListPagesByContactOutput, bool) bool, opts ...request.Option) error
func (c *SSMContacts) ListPagesByContactRequest(input *ListPagesByContactInput) (req *request.Request, output *ListPagesByContactOutput)
func (c *SSMContacts) ListPagesByContactWithContext(ctx aws.Context, input *ListPagesByContactInput, opts ...request.Option) (*ListPagesByContactOutput, error)
func (c *SSMContacts) ListPagesByEngagement(input *ListPagesByEngagementInput) (*ListPagesByEngagementOutput, error)
func (c *SSMContacts) ListPagesByEngagementPages(input *ListPagesByEngagementInput, fn func(*ListPagesByEngagementOutput, bool) bool) error
func (c *SSMContacts) ListPagesByEngagementPagesWithContext(ctx aws.Context, input *ListPagesByEngagementInput, fn func(*ListPagesByEngagementOutput, bool) bool, opts ...request.Option) error
func (c *SSMContacts) ListPagesByEngagementRequest(input *ListPagesByEngagementInput) (req *request.Request, output *ListPagesByEngagementOutput)
func (c *SSMContacts) ListPagesByEngagementWithContext(ctx aws.Context, input *ListPagesByEngagementInput, opts ...request.Option) (*ListPagesByEngagementOutput, error)
func (c *SSMContacts) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
func (c *SSMContacts) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
func (c *SSMContacts) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
func (c *SSMContacts) PutContactPolicy(input *PutContactPolicyInput) (*PutContactPolicyOutput, error)
func (c *SSMContacts) PutContactPolicyRequest(input *PutContactPolicyInput) (req *request.Request, output *PutContactPolicyOutput)
func (c *SSMContacts) PutContactPolicyWithContext(ctx aws.Context, input *PutContactPolicyInput, opts ...request.Option) (*PutContactPolicyOutput, error)
func (c *SSMContacts) SendActivationCode(input *SendActivationCodeInput) (*SendActivationCodeOutput, error)
func (c *SSMContacts) SendActivationCodeRequest(input *SendActivationCodeInput) (req *request.Request, output *SendActivationCodeOutput)
func (c *SSMContacts) SendActivationCodeWithContext(ctx aws.Context, input *SendActivationCodeInput, opts ...request.Option) (*SendActivationCodeOutput, error)
func (c *SSMContacts) StartEngagement(input *StartEngagementInput) (*StartEngagementOutput, error)
func (c *SSMContacts) StartEngagementRequest(input *StartEngagementInput) (req *request.Request, output *StartEngagementOutput)
func (c *SSMContacts) StartEngagementWithContext(ctx aws.Context, input *StartEngagementInput, opts ...request.Option) (*StartEngagementOutput, error)
func (c *SSMContacts) StopEngagement(input *StopEngagementInput) (*StopEngagementOutput, error)
func (c *SSMContacts) StopEngagementRequest(input *StopEngagementInput) (req *request.Request, output *StopEngagementOutput)
func (c *SSMContacts) StopEngagementWithContext(ctx aws.Context, input *StopEngagementInput, opts ...request.Option) (*StopEngagementOutput, error)
func (c *SSMContacts) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
func (c *SSMContacts) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
func (c *SSMContacts) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
func (c *SSMContacts) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
func (c *SSMContacts) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
func (c *SSMContacts) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
func (c *SSMContacts) UpdateContact(input *UpdateContactInput) (*UpdateContactOutput, error)
func (c *SSMContacts) UpdateContactChannel(input *UpdateContactChannelInput) (*UpdateContactChannelOutput, error)
func (c *SSMContacts) UpdateContactChannelRequest(input *UpdateContactChannelInput) (req *request.Request, output *UpdateContactChannelOutput)
func (c *SSMContacts) UpdateContactChannelWithContext(ctx aws.Context, input *UpdateContactChannelInput, opts ...request.Option) (*UpdateContactChannelOutput, error)
func (c *SSMContacts) UpdateContactRequest(input *UpdateContactInput) (req *request.Request, output *UpdateContactOutput)
func (c *SSMContacts) UpdateContactWithContext(ctx aws.Context, input *UpdateContactInput, opts ...request.Option) (*UpdateContactOutput, error)
func AcceptCodeValidation_Values() []string
func AcceptType_Values() []string
func ActivationStatus_Values() []string
func ChannelType_Values() []string
func ContactType_Values() []string
func ReceiptType_Values() []string
func ValidationExceptionReason_Values() []string
type AcceptPageInput
type AcceptPageOutput
type AccessDeniedException
type ActivateContactChannelInput
type ActivateContactChannelOutput
type ChannelTargetInfo
type ConflictException
type Contact
type ContactChannel
type ContactChannelAddress
type ContactTargetInfo
type CreateContactChannelInput
type CreateContactChannelOutput
type CreateContactInput
type CreateContactOutput
type DataEncryptionException
type DeactivateContactChannelInput
type DeactivateContactChannelOutput
type DeleteContactChannelInput
type DeleteContactChannelOutput
type DeleteContactInput
type DeleteContactOutput
type DescribeEngagementInput
type DescribeEngagementOutput
type DescribePageInput
type DescribePageOutput
type Engagement
type GetContactChannelInput
type GetContactChannelOutput
type GetContactInput
type GetContactOutput
type GetContactPolicyInput
type GetContactPolicyOutput
type InternalServerException
type ListContactChannelsInput
type ListContactChannelsOutput
type ListContactsInput
type ListContactsOutput
type ListEngagementsInput
type ListEngagementsOutput
type ListPageReceiptsInput
type ListPageReceiptsOutput
type ListPagesByContactInput
type ListPagesByContactOutput
type ListPagesByEngagementInput
type ListPagesByEngagementOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type Page
type Plan
type PutContactPolicyInput
type PutContactPolicyOutput
type Receipt
type ResourceNotFoundException
type SendActivationCodeInput
type SendActivationCodeOutput
type ServiceQuotaExceededException
type Stage
type StartEngagementInput
type StartEngagementOutput
type StopEngagementInput
type StopEngagementOutput
type Tag
type TagResourceInput
type TagResourceOutput
type Target
type ThrottlingException
type TimeRange
type UntagResourceInput
type UntagResourceOutput
type UpdateContactChannelInput
type UpdateContactChannelOutput
type UpdateContactInput
type UpdateContactOutput
type ValidationException
type ValidationExceptionField

Constants ▾

const (
    // AcceptCodeValidationIgnore is a AcceptCodeValidation enum value
    AcceptCodeValidationIgnore = "IGNORE"

    // AcceptCodeValidationEnforce is a AcceptCodeValidation enum value
    AcceptCodeValidationEnforce = "ENFORCE"
)
const (
    // AcceptTypeDelivered is a AcceptType enum value
    AcceptTypeDelivered = "DELIVERED"

    // AcceptTypeRead is a AcceptType enum value
    AcceptTypeRead = "READ"
)
const (
    // ActivationStatusActivated is a ActivationStatus enum value
    ActivationStatusActivated = "ACTIVATED"

    // ActivationStatusNotActivated is a ActivationStatus enum value
    ActivationStatusNotActivated = "NOT_ACTIVATED"
)
const (
    // ChannelTypeSms is a ChannelType enum value
    ChannelTypeSms = "SMS"

    // ChannelTypeVoice is a ChannelType enum value
    ChannelTypeVoice = "VOICE"

    // ChannelTypeEmail is a ChannelType enum value
    ChannelTypeEmail = "EMAIL"
)
const (
    // ContactTypePersonal is a ContactType enum value
    ContactTypePersonal = "PERSONAL"

    // ContactTypeEscalation is a ContactType enum value
    ContactTypeEscalation = "ESCALATION"
)
const (
    // ReceiptTypeDelivered is a ReceiptType enum value
    ReceiptTypeDelivered = "DELIVERED"

    // ReceiptTypeError is a ReceiptType enum value
    ReceiptTypeError = "ERROR"

    // ReceiptTypeRead is a ReceiptType enum value
    ReceiptTypeRead = "READ"

    // ReceiptTypeSent is a ReceiptType enum value
    ReceiptTypeSent = "SENT"

    // ReceiptTypeStop is a ReceiptType enum value
    ReceiptTypeStop = "STOP"
)
const (
    // ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
    ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"

    // ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
    ValidationExceptionReasonCannotParse = "CANNOT_PARSE"

    // ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
    ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

    // ValidationExceptionReasonOther is a ValidationExceptionReason enum value
    ValidationExceptionReasonOther = "OTHER"
)
const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // You don't have sufficient access to perform this operation.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    //
    // Updating or deleting a resource causes an inconsistent state.
    ErrCodeConflictException = "ConflictException"

    // ErrCodeDataEncryptionException for service response error code
    // "DataEncryptionException".
    //
    // The operation failed to due an encryption key error.
    ErrCodeDataEncryptionException = "DataEncryptionException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    //
    // Unexpected error occurred while processing the request.
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // Request references a resource that doesn't exist.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceQuotaExceededException for service response error code
    // "ServiceQuotaExceededException".
    //
    // Request would cause a service quota to be exceeded.
    ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

    // ErrCodeThrottlingException for service response error code
    // "ThrottlingException".
    //
    // The request was denied due to request throttling.
    ErrCodeThrottlingException = "ThrottlingException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // The input fails to satisfy the constraints specified by an Amazon Web Services
    // service.
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "SSM Contacts" // Name of service.
    EndpointsID = "ssm-contacts" // ID to lookup a service endpoint with.
    ServiceID   = "SSM Contacts" // ServiceID is a unique identifier of a specific service.
)

Service information constants

func AcceptCodeValidation_Values

func AcceptCodeValidation_Values() []string

AcceptCodeValidation_Values returns all elements of the AcceptCodeValidation enum

func AcceptType_Values

func AcceptType_Values() []string

AcceptType_Values returns all elements of the AcceptType enum

func ActivationStatus_Values

func ActivationStatus_Values() []string

ActivationStatus_Values returns all elements of the ActivationStatus enum

func ChannelType_Values

func ChannelType_Values() []string

ChannelType_Values returns all elements of the ChannelType enum

func ContactType_Values

func ContactType_Values() []string

ContactType_Values returns all elements of the ContactType enum

func ReceiptType_Values

func ReceiptType_Values() []string

ReceiptType_Values returns all elements of the ReceiptType enum

func ValidationExceptionReason_Values

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

type AcceptPageInput

type AcceptPageInput struct {

    // The accept code is a 6-digit code used to acknowledge the page.
    //
    // AcceptCode is a required field
    AcceptCode *string `min:"6" type:"string" required:"true"`

    // 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 *string `type:"string" enum:"AcceptCodeValidation"`

    // The type indicates if the page was DELIVERED or READ.
    //
    // AcceptType is a required field
    AcceptType *string `type:"string" required:"true" enum:"AcceptType"`

    // The ARN of the contact channel.
    ContactChannelId *string `min:"1" type:"string"`

    // Information provided by the user when the user acknowledges the page.
    Note *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the engagement to a contact channel.
    //
    // PageId is a required field
    PageId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (AcceptPageInput) GoString

func (s AcceptPageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptPageInput) SetAcceptCode

func (s *AcceptPageInput) SetAcceptCode(v string) *AcceptPageInput

SetAcceptCode sets the AcceptCode field's value.

func (*AcceptPageInput) SetAcceptCodeValidation

func (s *AcceptPageInput) SetAcceptCodeValidation(v string) *AcceptPageInput

SetAcceptCodeValidation sets the AcceptCodeValidation field's value.

func (*AcceptPageInput) SetAcceptType

func (s *AcceptPageInput) SetAcceptType(v string) *AcceptPageInput

SetAcceptType sets the AcceptType field's value.

func (*AcceptPageInput) SetContactChannelId

func (s *AcceptPageInput) SetContactChannelId(v string) *AcceptPageInput

SetContactChannelId sets the ContactChannelId field's value.

func (*AcceptPageInput) SetNote

func (s *AcceptPageInput) SetNote(v string) *AcceptPageInput

SetNote sets the Note field's value.

func (*AcceptPageInput) SetPageId

func (s *AcceptPageInput) SetPageId(v string) *AcceptPageInput

SetPageId sets the PageId field's value.

func (AcceptPageInput) String

func (s AcceptPageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptPageInput) Validate

func (s *AcceptPageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AcceptPageOutput

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

func (AcceptPageOutput) GoString

func (s AcceptPageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AcceptPageOutput) String

func (s AcceptPageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessDeniedException

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

You don't have sufficient access to perform this operation.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivateContactChannelInput

type ActivateContactChannelInput struct {

    // The code sent to the contact channel when it was created in the contact.
    //
    // ActivationCode is a required field
    ActivationCode *string `min:"6" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the contact channel.
    //
    // ContactChannelId is a required field
    ContactChannelId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ActivateContactChannelInput) GoString

func (s ActivateContactChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateContactChannelInput) SetActivationCode

func (s *ActivateContactChannelInput) SetActivationCode(v string) *ActivateContactChannelInput

SetActivationCode sets the ActivationCode field's value.

func (*ActivateContactChannelInput) SetContactChannelId

func (s *ActivateContactChannelInput) SetContactChannelId(v string) *ActivateContactChannelInput

SetContactChannelId sets the ContactChannelId field's value.

func (ActivateContactChannelInput) String

func (s ActivateContactChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateContactChannelInput) Validate

func (s *ActivateContactChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActivateContactChannelOutput

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

func (ActivateContactChannelOutput) GoString

func (s ActivateContactChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ActivateContactChannelOutput) String

func (s ActivateContactChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChannelTargetInfo

type ChannelTargetInfo struct {

    // The Amazon Resource Name (ARN) of the contact channel.
    //
    // ContactChannelId is a required field
    ContactChannelId *string `min:"1" type:"string" required:"true"`

    // The number of minutes to wait to retry sending engagement in the case the
    // engagement initially fails.
    RetryIntervalInMinutes *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Information about the contact channel that Incident Manager uses to engage the contact.

func (ChannelTargetInfo) GoString

func (s ChannelTargetInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelTargetInfo) SetContactChannelId

func (s *ChannelTargetInfo) SetContactChannelId(v string) *ChannelTargetInfo

SetContactChannelId sets the ContactChannelId field's value.

func (*ChannelTargetInfo) SetRetryIntervalInMinutes

func (s *ChannelTargetInfo) SetRetryIntervalInMinutes(v int64) *ChannelTargetInfo

SetRetryIntervalInMinutes sets the RetryIntervalInMinutes field's value.

func (ChannelTargetInfo) String

func (s ChannelTargetInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelTargetInfo) Validate

func (s *ChannelTargetInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException

type ConflictException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`

    // Identifier of the resource in use
    //
    // ResourceId is a required field
    ResourceId *string `type:"string" required:"true"`

    // ype of the resource in use
    //
    // ResourceType is a required field
    ResourceType *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Updating or deleting a resource causes an inconsistent state.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Contact

type Contact struct {

    // The unique and identifiable alias of the contact or escalation plan.
    //
    // Alias is a required field
    Alias *string `min:"1" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the contact or escalation plan.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The full name of the contact or escalation plan.
    DisplayName *string `type:"string"`

    // Refers to the type of contact. A single contact is type PERSONAL and an escalation
    // plan is type ESCALATION.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"ContactType"`
    // contains filtered or unexported fields
}

A personal contact or escalation plan that Incident Manager engages during an incident.

func (Contact) GoString

func (s Contact) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Contact) SetAlias

func (s *Contact) SetAlias(v string) *Contact

SetAlias sets the Alias field's value.

func (*Contact) SetContactArn

func (s *Contact) SetContactArn(v string) *Contact

SetContactArn sets the ContactArn field's value.

func (*Contact) SetDisplayName

func (s *Contact) SetDisplayName(v string) *Contact

SetDisplayName sets the DisplayName field's value.

func (*Contact) SetType

func (s *Contact) SetType(v string) *Contact

SetType sets the Type field's value.

func (Contact) String

func (s Contact) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContactChannel

type ContactChannel struct {

    // A Boolean value describing if the contact channel has been activated or not.
    // If the contact channel isn't activated, Incident Manager can't engage the
    // contact through it.
    //
    // ActivationStatus is a required field
    ActivationStatus *string `type:"string" required:"true" enum:"ActivationStatus"`

    // The ARN of the contact that contains the contact channel.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the contact channel.
    //
    // ContactChannelArn is a required field
    ContactChannelArn *string `min:"1" type:"string" required:"true"`

    // The details that Incident Manager uses when trying to engage the contact
    // channel.
    //
    // DeliveryAddress is a required field
    DeliveryAddress *ContactChannelAddress `type:"structure" required:"true"`

    // The name of the contact channel.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The type of the contact channel. Incident Manager supports three contact
    // methods:
    //
    //    * SMS
    //
    //    * VOICE
    //
    //    * EMAIL
    Type *string `type:"string" enum:"ChannelType"`
    // contains filtered or unexported fields
}

The method that Incident Manager uses to engage a contact.

func (ContactChannel) GoString

func (s ContactChannel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContactChannel) SetActivationStatus

func (s *ContactChannel) SetActivationStatus(v string) *ContactChannel

SetActivationStatus sets the ActivationStatus field's value.

func (*ContactChannel) SetContactArn

func (s *ContactChannel) SetContactArn(v string) *ContactChannel

SetContactArn sets the ContactArn field's value.

func (*ContactChannel) SetContactChannelArn

func (s *ContactChannel) SetContactChannelArn(v string) *ContactChannel

SetContactChannelArn sets the ContactChannelArn field's value.

func (*ContactChannel) SetDeliveryAddress

func (s *ContactChannel) SetDeliveryAddress(v *ContactChannelAddress) *ContactChannel

SetDeliveryAddress sets the DeliveryAddress field's value.

func (*ContactChannel) SetName

func (s *ContactChannel) SetName(v string) *ContactChannel

SetName sets the Name field's value.

func (*ContactChannel) SetType

func (s *ContactChannel) SetType(v string) *ContactChannel

SetType sets the Type field's value.

func (ContactChannel) String

func (s ContactChannel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContactChannelAddress

type ContactChannelAddress struct {

    // 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
    SimpleAddress *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

The details that Incident Manager uses when trying to engage the contact channel.

func (ContactChannelAddress) GoString

func (s ContactChannelAddress) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContactChannelAddress) SetSimpleAddress

func (s *ContactChannelAddress) SetSimpleAddress(v string) *ContactChannelAddress

SetSimpleAddress sets the SimpleAddress field's value.

func (ContactChannelAddress) String

func (s ContactChannelAddress) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContactChannelAddress) Validate

func (s *ContactChannelAddress) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContactTargetInfo

type ContactTargetInfo struct {

    // The Amazon Resource Name (ARN) of the contact.
    ContactId *string `min:"1" type:"string"`

    // A Boolean value determining if the contact's acknowledgement stops the progress
    // of stages in the plan.
    //
    // IsEssential is a required field
    IsEssential *bool `type:"boolean" required:"true"`
    // contains filtered or unexported fields
}

The contact that Incident Manager is engaging during an incident.

func (ContactTargetInfo) GoString

func (s ContactTargetInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContactTargetInfo) SetContactId

func (s *ContactTargetInfo) SetContactId(v string) *ContactTargetInfo

SetContactId sets the ContactId field's value.

func (*ContactTargetInfo) SetIsEssential

func (s *ContactTargetInfo) SetIsEssential(v bool) *ContactTargetInfo

SetIsEssential sets the IsEssential field's value.

func (ContactTargetInfo) String

func (s ContactTargetInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContactTargetInfo) Validate

func (s *ContactTargetInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateContactChannelInput

type CreateContactChannelInput struct {

    // The Amazon Resource Name (ARN) of the contact you are adding the contact
    // channel to.
    //
    // ContactId is a required field
    ContactId *string `min:"1" type:"string" required:"true"`

    // 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 `type:"boolean"`

    // 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
    //
    // DeliveryAddress is a required field
    DeliveryAddress *ContactChannelAddress `type:"structure" required:"true"`

    // A token ensuring that the operation is called only once with the specified
    // details.
    IdempotencyToken *string `type:"string" idempotencyToken:"true"`

    // The name of the contact channel.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // Incident Manager supports three types of contact channels:
    //
    //    * SMS
    //
    //    * VOICE
    //
    //    * EMAIL
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"ChannelType"`
    // contains filtered or unexported fields
}

func (CreateContactChannelInput) GoString

func (s CreateContactChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactChannelInput) SetContactId

func (s *CreateContactChannelInput) SetContactId(v string) *CreateContactChannelInput

SetContactId sets the ContactId field's value.

func (*CreateContactChannelInput) SetDeferActivation

func (s *CreateContactChannelInput) SetDeferActivation(v bool) *CreateContactChannelInput

SetDeferActivation sets the DeferActivation field's value.

func (*CreateContactChannelInput) SetDeliveryAddress

func (s *CreateContactChannelInput) SetDeliveryAddress(v *ContactChannelAddress) *CreateContactChannelInput

SetDeliveryAddress sets the DeliveryAddress field's value.

func (*CreateContactChannelInput) SetIdempotencyToken

func (s *CreateContactChannelInput) SetIdempotencyToken(v string) *CreateContactChannelInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateContactChannelInput) SetName

func (s *CreateContactChannelInput) SetName(v string) *CreateContactChannelInput

SetName sets the Name field's value.

func (*CreateContactChannelInput) SetType

func (s *CreateContactChannelInput) SetType(v string) *CreateContactChannelInput

SetType sets the Type field's value.

func (CreateContactChannelInput) String

func (s CreateContactChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactChannelInput) Validate

func (s *CreateContactChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateContactChannelOutput

type CreateContactChannelOutput struct {

    // The Amazon Resource Name (ARN) of the contact channel.
    //
    // ContactChannelArn is a required field
    ContactChannelArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateContactChannelOutput) GoString

func (s CreateContactChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactChannelOutput) SetContactChannelArn

func (s *CreateContactChannelOutput) SetContactChannelArn(v string) *CreateContactChannelOutput

SetContactChannelArn sets the ContactChannelArn field's value.

func (CreateContactChannelOutput) String

func (s CreateContactChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContactInput

type CreateContactInput struct {

    // The short name to quickly identify a contact or escalation plan. The contact
    // alias must be unique and identifiable.
    //
    // Alias is a required field
    Alias *string `min:"1" type:"string" required:"true"`

    // The full name of the contact or escalation plan.
    DisplayName *string `type:"string"`

    // A token ensuring that the operation is called only once with the specified
    // details.
    IdempotencyToken *string `type:"string" idempotencyToken:"true"`

    // 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.
    //
    // Plan is a required field
    Plan *Plan `type:"structure" required:"true"`

    // Adds a tag to the target. You can only tag resources created in the first
    // Region of your replication set.
    Tags []*Tag `type:"list"`

    // To create an escalation plan use ESCALATION. To create a contact use PERSONAL.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"ContactType"`
    // contains filtered or unexported fields
}

func (CreateContactInput) GoString

func (s CreateContactInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactInput) SetAlias

func (s *CreateContactInput) SetAlias(v string) *CreateContactInput

SetAlias sets the Alias field's value.

func (*CreateContactInput) SetDisplayName

func (s *CreateContactInput) SetDisplayName(v string) *CreateContactInput

SetDisplayName sets the DisplayName field's value.

func (*CreateContactInput) SetIdempotencyToken

func (s *CreateContactInput) SetIdempotencyToken(v string) *CreateContactInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateContactInput) SetPlan

func (s *CreateContactInput) SetPlan(v *Plan) *CreateContactInput

SetPlan sets the Plan field's value.

func (*CreateContactInput) SetTags

func (s *CreateContactInput) SetTags(v []*Tag) *CreateContactInput

SetTags sets the Tags field's value.

func (*CreateContactInput) SetType

func (s *CreateContactInput) SetType(v string) *CreateContactInput

SetType sets the Type field's value.

func (CreateContactInput) String

func (s CreateContactInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactInput) Validate

func (s *CreateContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateContactOutput

type CreateContactOutput struct {

    // The Amazon Resource Name (ARN) of the created contact or escalation plan.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateContactOutput) GoString

func (s CreateContactOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactOutput) SetContactArn

func (s *CreateContactOutput) SetContactArn(v string) *CreateContactOutput

SetContactArn sets the ContactArn field's value.

func (CreateContactOutput) String

func (s CreateContactOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataEncryptionException

type DataEncryptionException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

The operation failed to due an encryption key error.

func (*DataEncryptionException) Code

func (s *DataEncryptionException) Code() string

Code returns the exception type name.

func (*DataEncryptionException) Error

func (s *DataEncryptionException) Error() string

func (DataEncryptionException) GoString

func (s DataEncryptionException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataEncryptionException) Message

func (s *DataEncryptionException) Message() string

Message returns the exception's message.

func (*DataEncryptionException) OrigErr

func (s *DataEncryptionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DataEncryptionException) RequestID

func (s *DataEncryptionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DataEncryptionException) StatusCode

func (s *DataEncryptionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DataEncryptionException) String

func (s DataEncryptionException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeactivateContactChannelInput

type DeactivateContactChannelInput struct {

    // The Amazon Resource Name (ARN) of the contact channel you're deactivating.
    //
    // ContactChannelId is a required field
    ContactChannelId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeactivateContactChannelInput) GoString

func (s DeactivateContactChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateContactChannelInput) SetContactChannelId

func (s *DeactivateContactChannelInput) SetContactChannelId(v string) *DeactivateContactChannelInput

SetContactChannelId sets the ContactChannelId field's value.

func (DeactivateContactChannelInput) String

func (s DeactivateContactChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateContactChannelInput) Validate

func (s *DeactivateContactChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeactivateContactChannelOutput

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

func (DeactivateContactChannelOutput) GoString

func (s DeactivateContactChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeactivateContactChannelOutput) String

func (s DeactivateContactChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteContactChannelInput

type DeleteContactChannelInput struct {

    // The Amazon Resource Name (ARN) of the contact channel.
    //
    // ContactChannelId is a required field
    ContactChannelId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteContactChannelInput) GoString

func (s DeleteContactChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContactChannelInput) SetContactChannelId

func (s *DeleteContactChannelInput) SetContactChannelId(v string) *DeleteContactChannelInput

SetContactChannelId sets the ContactChannelId field's value.

func (DeleteContactChannelInput) String

func (s DeleteContactChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContactChannelInput) Validate

func (s *DeleteContactChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteContactChannelOutput

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

func (DeleteContactChannelOutput) GoString

func (s DeleteContactChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteContactChannelOutput) String

func (s DeleteContactChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteContactInput

type DeleteContactInput struct {

    // The Amazon Resource Name (ARN) of the contact that you're deleting.
    //
    // ContactId is a required field
    ContactId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteContactInput) GoString

func (s DeleteContactInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContactInput) SetContactId

func (s *DeleteContactInput) SetContactId(v string) *DeleteContactInput

SetContactId sets the ContactId field's value.

func (DeleteContactInput) String

func (s DeleteContactInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContactInput) Validate

func (s *DeleteContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteContactOutput

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

func (DeleteContactOutput) GoString

func (s DeleteContactOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteContactOutput) String

func (s DeleteContactOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEngagementInput

type DescribeEngagementInput struct {

    // The Amazon Resource Name (ARN) of the engagement you want the details of.
    //
    // EngagementId is a required field
    EngagementId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeEngagementInput) GoString

func (s DescribeEngagementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngagementInput) SetEngagementId

func (s *DescribeEngagementInput) SetEngagementId(v string) *DescribeEngagementInput

SetEngagementId sets the EngagementId field's value.

func (DescribeEngagementInput) String

func (s DescribeEngagementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngagementInput) Validate

func (s *DescribeEngagementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEngagementOutput

type DescribeEngagementOutput struct {

    // The ARN of the escalation plan or contacts involved in the engagement.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The secure content of the message that was sent to the contact. Use this
    // field for engagements to VOICE and EMAIL.
    //
    // Content is a required field
    Content *string `min:"1" type:"string" required:"true"`

    // The ARN of the engagement.
    //
    // EngagementArn is a required field
    EngagementArn *string `min:"1" type:"string" required:"true"`

    // The ARN of the incident in which the engagement occurred.
    IncidentId *string `type:"string"`

    // The insecure content of the message that was sent to the contact. Use this
    // field for engagements to SMS.
    PublicContent *string `min:"1" type:"string"`

    // The insecure subject of the message that was sent to the contact. Use this
    // field for engagements to SMS.
    PublicSubject *string `min:"1" type:"string"`

    // The user that started the engagement.
    //
    // Sender is a required field
    Sender *string `type:"string" required:"true"`

    // The time that the engagement started.
    StartTime *time.Time `type:"timestamp"`

    // The time that the engagement ended.
    StopTime *time.Time `type:"timestamp"`

    // The secure subject of the message that was sent to the contact. Use this
    // field for engagements to VOICE and EMAIL.
    //
    // Subject is a required field
    Subject *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeEngagementOutput) GoString

func (s DescribeEngagementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngagementOutput) SetContactArn

func (s *DescribeEngagementOutput) SetContactArn(v string) *DescribeEngagementOutput

SetContactArn sets the ContactArn field's value.

func (*DescribeEngagementOutput) SetContent

func (s *DescribeEngagementOutput) SetContent(v string) *DescribeEngagementOutput

SetContent sets the Content field's value.

func (*DescribeEngagementOutput) SetEngagementArn

func (s *DescribeEngagementOutput) SetEngagementArn(v string) *DescribeEngagementOutput

SetEngagementArn sets the EngagementArn field's value.

func (*DescribeEngagementOutput) SetIncidentId

func (s *DescribeEngagementOutput) SetIncidentId(v string) *DescribeEngagementOutput

SetIncidentId sets the IncidentId field's value.

func (*DescribeEngagementOutput) SetPublicContent

func (s *DescribeEngagementOutput) SetPublicContent(v string) *DescribeEngagementOutput

SetPublicContent sets the PublicContent field's value.

func (*DescribeEngagementOutput) SetPublicSubject

func (s *DescribeEngagementOutput) SetPublicSubject(v string) *DescribeEngagementOutput

SetPublicSubject sets the PublicSubject field's value.

func (*DescribeEngagementOutput) SetSender

func (s *DescribeEngagementOutput) SetSender(v string) *DescribeEngagementOutput

SetSender sets the Sender field's value.

func (*DescribeEngagementOutput) SetStartTime

func (s *DescribeEngagementOutput) SetStartTime(v time.Time) *DescribeEngagementOutput

SetStartTime sets the StartTime field's value.

func (*DescribeEngagementOutput) SetStopTime

func (s *DescribeEngagementOutput) SetStopTime(v time.Time) *DescribeEngagementOutput

SetStopTime sets the StopTime field's value.

func (*DescribeEngagementOutput) SetSubject

func (s *DescribeEngagementOutput) SetSubject(v string) *DescribeEngagementOutput

SetSubject sets the Subject field's value.

func (DescribeEngagementOutput) String

func (s DescribeEngagementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePageInput

type DescribePageInput struct {

    // The ID of the engagement to a contact channel.
    //
    // PageId is a required field
    PageId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribePageInput) GoString

func (s DescribePageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePageInput) SetPageId

func (s *DescribePageInput) SetPageId(v string) *DescribePageInput

SetPageId sets the PageId field's value.

func (DescribePageInput) String

func (s DescribePageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePageInput) Validate

func (s *DescribePageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePageOutput

type DescribePageOutput struct {

    // The ARN of the contact that was engaged.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The secure content of the message that was sent to the contact. Use this
    // field for engagements to VOICE and EMAIL.
    //
    // Content is a required field
    Content *string `min:"1" type:"string" required:"true"`

    // The time that the contact channel received the engagement.
    DeliveryTime *time.Time `type:"timestamp"`

    // The ARN of the engagement that engaged the contact channel.
    //
    // EngagementArn is a required field
    EngagementArn *string `min:"1" type:"string" required:"true"`

    // The ARN of the incident that engaged the contact channel.
    IncidentId *string `type:"string"`

    // The Amazon Resource Name (ARN) of the engagement to a contact channel.
    //
    // PageArn is a required field
    PageArn *string `min:"1" type:"string" required:"true"`

    // The insecure content of the message that was sent to the contact. Use this
    // field for engagements to SMS.
    PublicContent *string `min:"1" type:"string"`

    // The insecure subject of the message that was sent to the contact. Use this
    // field for engagements to SMS.
    PublicSubject *string `min:"1" type:"string"`

    // The time that the contact channel acknowledged the engagement.
    ReadTime *time.Time `type:"timestamp"`

    // The user that started the engagement.
    //
    // Sender is a required field
    Sender *string `type:"string" required:"true"`

    // The time the engagement was sent to the contact channel.
    SentTime *time.Time `type:"timestamp"`

    // The secure subject of the message that was sent to the contact. Use this
    // field for engagements to VOICE and EMAIL.
    //
    // Subject is a required field
    Subject *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribePageOutput) GoString

func (s DescribePageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePageOutput) SetContactArn

func (s *DescribePageOutput) SetContactArn(v string) *DescribePageOutput

SetContactArn sets the ContactArn field's value.

func (*DescribePageOutput) SetContent

func (s *DescribePageOutput) SetContent(v string) *DescribePageOutput

SetContent sets the Content field's value.

func (*DescribePageOutput) SetDeliveryTime

func (s *DescribePageOutput) SetDeliveryTime(v time.Time) *DescribePageOutput

SetDeliveryTime sets the DeliveryTime field's value.

func (*DescribePageOutput) SetEngagementArn

func (s *DescribePageOutput) SetEngagementArn(v string) *DescribePageOutput

SetEngagementArn sets the EngagementArn field's value.

func (*DescribePageOutput) SetIncidentId

func (s *DescribePageOutput) SetIncidentId(v string) *DescribePageOutput

SetIncidentId sets the IncidentId field's value.

func (*DescribePageOutput) SetPageArn

func (s *DescribePageOutput) SetPageArn(v string) *DescribePageOutput

SetPageArn sets the PageArn field's value.

func (*DescribePageOutput) SetPublicContent

func (s *DescribePageOutput) SetPublicContent(v string) *DescribePageOutput

SetPublicContent sets the PublicContent field's value.

func (*DescribePageOutput) SetPublicSubject

func (s *DescribePageOutput) SetPublicSubject(v string) *DescribePageOutput

SetPublicSubject sets the PublicSubject field's value.

func (*DescribePageOutput) SetReadTime

func (s *DescribePageOutput) SetReadTime(v time.Time) *DescribePageOutput

SetReadTime sets the ReadTime field's value.

func (*DescribePageOutput) SetSender

func (s *DescribePageOutput) SetSender(v string) *DescribePageOutput

SetSender sets the Sender field's value.

func (*DescribePageOutput) SetSentTime

func (s *DescribePageOutput) SetSentTime(v time.Time) *DescribePageOutput

SetSentTime sets the SentTime field's value.

func (*DescribePageOutput) SetSubject

func (s *DescribePageOutput) SetSubject(v string) *DescribePageOutput

SetSubject sets the Subject field's value.

func (DescribePageOutput) String

func (s DescribePageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Engagement

type Engagement struct {

    // The ARN of the escalation plan or contact that Incident Manager is engaging.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the engagement.
    //
    // EngagementArn is a required field
    EngagementArn *string `min:"1" type:"string" required:"true"`

    // The ARN of the incident that's engaging the contact.
    IncidentId *string `type:"string"`

    // The user that started the engagement.
    //
    // Sender is a required field
    Sender *string `type:"string" required:"true"`

    // The time that the engagement began.
    StartTime *time.Time `type:"timestamp"`

    // The time that the engagement ended.
    StopTime *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.

func (Engagement) GoString

func (s Engagement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Engagement) SetContactArn

func (s *Engagement) SetContactArn(v string) *Engagement

SetContactArn sets the ContactArn field's value.

func (*Engagement) SetEngagementArn

func (s *Engagement) SetEngagementArn(v string) *Engagement

SetEngagementArn sets the EngagementArn field's value.

func (*Engagement) SetIncidentId

func (s *Engagement) SetIncidentId(v string) *Engagement

SetIncidentId sets the IncidentId field's value.

func (*Engagement) SetSender

func (s *Engagement) SetSender(v string) *Engagement

SetSender sets the Sender field's value.

func (*Engagement) SetStartTime

func (s *Engagement) SetStartTime(v time.Time) *Engagement

SetStartTime sets the StartTime field's value.

func (*Engagement) SetStopTime

func (s *Engagement) SetStopTime(v time.Time) *Engagement

SetStopTime sets the StopTime field's value.

func (Engagement) String

func (s Engagement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContactChannelInput

type GetContactChannelInput struct {

    // The Amazon Resource Name (ARN) of the contact channel you want information
    // about.
    //
    // ContactChannelId is a required field
    ContactChannelId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetContactChannelInput) GoString

func (s GetContactChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactChannelInput) SetContactChannelId

func (s *GetContactChannelInput) SetContactChannelId(v string) *GetContactChannelInput

SetContactChannelId sets the ContactChannelId field's value.

func (GetContactChannelInput) String

func (s GetContactChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactChannelInput) Validate

func (s *GetContactChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetContactChannelOutput

type GetContactChannelOutput struct {

    // A Boolean value indicating if the contact channel has been activated or not.
    ActivationStatus *string `type:"string" enum:"ActivationStatus"`

    // The ARN of the contact that the channel belongs to.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The ARN of the contact channel.
    //
    // ContactChannelArn is a required field
    ContactChannelArn *string `min:"1" type:"string" required:"true"`

    // The details that Incident Manager uses when trying to engage the contact
    // channel.
    //
    // DeliveryAddress is a required field
    DeliveryAddress *ContactChannelAddress `type:"structure" required:"true"`

    // The name of the contact channel
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The type of contact channel. The type is SMS, VOICE, or EMAIL.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"ChannelType"`
    // contains filtered or unexported fields
}

func (GetContactChannelOutput) GoString

func (s GetContactChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactChannelOutput) SetActivationStatus

func (s *GetContactChannelOutput) SetActivationStatus(v string) *GetContactChannelOutput

SetActivationStatus sets the ActivationStatus field's value.

func (*GetContactChannelOutput) SetContactArn

func (s *GetContactChannelOutput) SetContactArn(v string) *GetContactChannelOutput

SetContactArn sets the ContactArn field's value.

func (*GetContactChannelOutput) SetContactChannelArn

func (s *GetContactChannelOutput) SetContactChannelArn(v string) *GetContactChannelOutput

SetContactChannelArn sets the ContactChannelArn field's value.

func (*GetContactChannelOutput) SetDeliveryAddress

func (s *GetContactChannelOutput) SetDeliveryAddress(v *ContactChannelAddress) *GetContactChannelOutput

SetDeliveryAddress sets the DeliveryAddress field's value.

func (*GetContactChannelOutput) SetName

func (s *GetContactChannelOutput) SetName(v string) *GetContactChannelOutput

SetName sets the Name field's value.

func (*GetContactChannelOutput) SetType

func (s *GetContactChannelOutput) SetType(v string) *GetContactChannelOutput

SetType sets the Type field's value.

func (GetContactChannelOutput) String

func (s GetContactChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContactInput

type GetContactInput struct {

    // The Amazon Resource Name (ARN) of the contact or escalation plan.
    //
    // ContactId is a required field
    ContactId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetContactInput) GoString

func (s GetContactInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactInput) SetContactId

func (s *GetContactInput) SetContactId(v string) *GetContactInput

SetContactId sets the ContactId field's value.

func (GetContactInput) String

func (s GetContactInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactInput) Validate

func (s *GetContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetContactOutput

type GetContactOutput struct {

    // The alias of the contact or escalation plan. The alias is unique and identifiable.
    //
    // Alias is a required field
    Alias *string `min:"1" type:"string" required:"true"`

    // The ARN of the contact or escalation plan.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The full name of the contact or escalation plan.
    DisplayName *string `type:"string"`

    // Details about the specific timing or stages and targets of the escalation
    // plan or engagement plan.
    //
    // Plan is a required field
    Plan *Plan `type:"structure" required:"true"`

    // The type of contact, either PERSONAL or ESCALATION.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"ContactType"`
    // contains filtered or unexported fields
}

func (GetContactOutput) GoString

func (s GetContactOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactOutput) SetAlias

func (s *GetContactOutput) SetAlias(v string) *GetContactOutput

SetAlias sets the Alias field's value.

func (*GetContactOutput) SetContactArn

func (s *GetContactOutput) SetContactArn(v string) *GetContactOutput

SetContactArn sets the ContactArn field's value.

func (*GetContactOutput) SetDisplayName

func (s *GetContactOutput) SetDisplayName(v string) *GetContactOutput

SetDisplayName sets the DisplayName field's value.

func (*GetContactOutput) SetPlan

func (s *GetContactOutput) SetPlan(v *Plan) *GetContactOutput

SetPlan sets the Plan field's value.

func (*GetContactOutput) SetType

func (s *GetContactOutput) SetType(v string) *GetContactOutput

SetType sets the Type field's value.

func (GetContactOutput) String

func (s GetContactOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContactPolicyInput

type GetContactPolicyInput struct {

    // The Amazon Resource Name (ARN) of the contact or escalation plan.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetContactPolicyInput) GoString

func (s GetContactPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactPolicyInput) SetContactArn

func (s *GetContactPolicyInput) SetContactArn(v string) *GetContactPolicyInput

SetContactArn sets the ContactArn field's value.

func (GetContactPolicyInput) String

func (s GetContactPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactPolicyInput) Validate

func (s *GetContactPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetContactPolicyOutput

type GetContactPolicyOutput struct {

    // The ARN of the contact or escalation plan.
    ContactArn *string `min:"1" type:"string"`

    // Details about the resource policy attached to the contact or escalation plan.
    Policy *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetContactPolicyOutput) GoString

func (s GetContactPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactPolicyOutput) SetContactArn

func (s *GetContactPolicyOutput) SetContactArn(v string) *GetContactPolicyOutput

SetContactArn sets the ContactArn field's value.

func (*GetContactPolicyOutput) SetPolicy

func (s *GetContactPolicyOutput) SetPolicy(v string) *GetContactPolicyOutput

SetPolicy sets the Policy field's value.

func (GetContactPolicyOutput) String

func (s GetContactPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`

    // Advice to clients on when the call can be safely retried
    RetryAfterSeconds *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Unexpected error occurred while processing the request.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListContactChannelsInput

type ListContactChannelsInput struct {

    // The Amazon Resource Name (ARN) of the contact.
    //
    // ContactId is a required field
    ContactId *string `min:"1" type:"string" required:"true"`

    // The maximum number of contact channels per page.
    MaxResults *int64 `type:"integer"`

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

func (ListContactChannelsInput) GoString

func (s ListContactChannelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContactChannelsInput) SetContactId

func (s *ListContactChannelsInput) SetContactId(v string) *ListContactChannelsInput

SetContactId sets the ContactId field's value.

func (*ListContactChannelsInput) SetMaxResults

func (s *ListContactChannelsInput) SetMaxResults(v int64) *ListContactChannelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListContactChannelsInput) SetNextToken

func (s *ListContactChannelsInput) SetNextToken(v string) *ListContactChannelsInput

SetNextToken sets the NextToken field's value.

func (ListContactChannelsInput) String

func (s ListContactChannelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContactChannelsInput) Validate

func (s *ListContactChannelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListContactChannelsOutput

type ListContactChannelsOutput struct {

    // A list of contact channels related to the specified contact.
    //
    // ContactChannels is a required field
    ContactChannels []*ContactChannel `type:"list" required:"true"`

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

func (ListContactChannelsOutput) GoString

func (s ListContactChannelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContactChannelsOutput) SetContactChannels

func (s *ListContactChannelsOutput) SetContactChannels(v []*ContactChannel) *ListContactChannelsOutput

SetContactChannels sets the ContactChannels field's value.

func (*ListContactChannelsOutput) SetNextToken

func (s *ListContactChannelsOutput) SetNextToken(v string) *ListContactChannelsOutput

SetNextToken sets the NextToken field's value.

func (ListContactChannelsOutput) String

func (s ListContactChannelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListContactsInput

type ListContactsInput struct {

    // Used to list only contacts who's aliases start with the specified prefix.
    AliasPrefix *string `min:"1" type:"string"`

    // The maximum number of contacts and escalation plans per page of results.
    MaxResults *int64 `type:"integer"`

    // The pagination token to continue to the next page of results.
    NextToken *string `type:"string"`

    // The type of contact. A contact is type PERSONAL and an escalation plan is
    // type ESCALATION.
    Type *string `type:"string" enum:"ContactType"`
    // contains filtered or unexported fields
}

func (ListContactsInput) GoString

func (s ListContactsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContactsInput) SetAliasPrefix

func (s *ListContactsInput) SetAliasPrefix(v string) *ListContactsInput

SetAliasPrefix sets the AliasPrefix field's value.

func (*ListContactsInput) SetMaxResults

func (s *ListContactsInput) SetMaxResults(v int64) *ListContactsInput

SetMaxResults sets the MaxResults field's value.

func (*ListContactsInput) SetNextToken

func (s *ListContactsInput) SetNextToken(v string) *ListContactsInput

SetNextToken sets the NextToken field's value.

func (*ListContactsInput) SetType

func (s *ListContactsInput) SetType(v string) *ListContactsInput

SetType sets the Type field's value.

func (ListContactsInput) String

func (s ListContactsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContactsInput) Validate

func (s *ListContactsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListContactsOutput

type ListContactsOutput struct {

    // A list of the contacts and escalation plans in your Incident Manager account.
    Contacts []*Contact `type:"list"`

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

func (ListContactsOutput) GoString

func (s ListContactsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContactsOutput) SetContacts

func (s *ListContactsOutput) SetContacts(v []*Contact) *ListContactsOutput

SetContacts sets the Contacts field's value.

func (*ListContactsOutput) SetNextToken

func (s *ListContactsOutput) SetNextToken(v string) *ListContactsOutput

SetNextToken sets the NextToken field's value.

func (ListContactsOutput) String

func (s ListContactsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEngagementsInput

type ListEngagementsInput struct {

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

    // The maximum number of engagements per page of results.
    MaxResults *int64 `type:"integer"`

    // The pagination token to continue to the next page of results.
    NextToken *string `type:"string"`

    // The time range to lists engagements for an incident.
    TimeRangeValue *TimeRange `type:"structure"`
    // contains filtered or unexported fields
}

func (ListEngagementsInput) GoString

func (s ListEngagementsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEngagementsInput) SetIncidentId

func (s *ListEngagementsInput) SetIncidentId(v string) *ListEngagementsInput

SetIncidentId sets the IncidentId field's value.

func (*ListEngagementsInput) SetMaxResults

func (s *ListEngagementsInput) SetMaxResults(v int64) *ListEngagementsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEngagementsInput) SetNextToken

func (s *ListEngagementsInput) SetNextToken(v string) *ListEngagementsInput

SetNextToken sets the NextToken field's value.

func (*ListEngagementsInput) SetTimeRangeValue

func (s *ListEngagementsInput) SetTimeRangeValue(v *TimeRange) *ListEngagementsInput

SetTimeRangeValue sets the TimeRangeValue field's value.

func (ListEngagementsInput) String

func (s ListEngagementsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEngagementsOutput

type ListEngagementsOutput struct {

    // A list of each engagement that occurred during the specified time range of
    // an incident.
    //
    // Engagements is a required field
    Engagements []*Engagement `type:"list" required:"true"`

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

func (ListEngagementsOutput) GoString

func (s ListEngagementsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEngagementsOutput) SetEngagements

func (s *ListEngagementsOutput) SetEngagements(v []*Engagement) *ListEngagementsOutput

SetEngagements sets the Engagements field's value.

func (*ListEngagementsOutput) SetNextToken

func (s *ListEngagementsOutput) SetNextToken(v string) *ListEngagementsOutput

SetNextToken sets the NextToken field's value.

func (ListEngagementsOutput) String

func (s ListEngagementsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPageReceiptsInput

type ListPageReceiptsInput struct {

    // The maximum number of acknowledgements per page of results.
    MaxResults *int64 `type:"integer"`

    // The pagination token to continue to the next page of results.
    NextToken *string `type:"string"`

    // The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
    //
    // PageId is a required field
    PageId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListPageReceiptsInput) GoString

func (s ListPageReceiptsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPageReceiptsInput) SetMaxResults

func (s *ListPageReceiptsInput) SetMaxResults(v int64) *ListPageReceiptsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPageReceiptsInput) SetNextToken

func (s *ListPageReceiptsInput) SetNextToken(v string) *ListPageReceiptsInput

SetNextToken sets the NextToken field's value.

func (*ListPageReceiptsInput) SetPageId

func (s *ListPageReceiptsInput) SetPageId(v string) *ListPageReceiptsInput

SetPageId sets the PageId field's value.

func (ListPageReceiptsInput) String

func (s ListPageReceiptsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPageReceiptsInput) Validate

func (s *ListPageReceiptsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPageReceiptsOutput

type ListPageReceiptsOutput struct {

    // The pagination token to continue to the next page of results.
    NextToken *string `type:"string"`

    // A list of each acknowledgement.
    Receipts []*Receipt `type:"list"`
    // contains filtered or unexported fields
}

func (ListPageReceiptsOutput) GoString

func (s ListPageReceiptsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPageReceiptsOutput) SetNextToken

func (s *ListPageReceiptsOutput) SetNextToken(v string) *ListPageReceiptsOutput

SetNextToken sets the NextToken field's value.

func (*ListPageReceiptsOutput) SetReceipts

func (s *ListPageReceiptsOutput) SetReceipts(v []*Receipt) *ListPageReceiptsOutput

SetReceipts sets the Receipts field's value.

func (ListPageReceiptsOutput) String

func (s ListPageReceiptsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPagesByContactInput

type ListPagesByContactInput struct {

    // The Amazon Resource Name (ARN) of the contact you are retrieving engagements
    // for.
    //
    // ContactId is a required field
    ContactId *string `min:"1" type:"string" required:"true"`

    // The maximum number of engagements to contact channels to list per page of
    // results.
    MaxResults *int64 `type:"integer"`

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

func (ListPagesByContactInput) GoString

func (s ListPagesByContactInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPagesByContactInput) SetContactId

func (s *ListPagesByContactInput) SetContactId(v string) *ListPagesByContactInput

SetContactId sets the ContactId field's value.

func (*ListPagesByContactInput) SetMaxResults

func (s *ListPagesByContactInput) SetMaxResults(v int64) *ListPagesByContactInput

SetMaxResults sets the MaxResults field's value.

func (*ListPagesByContactInput) SetNextToken

func (s *ListPagesByContactInput) SetNextToken(v string) *ListPagesByContactInput

SetNextToken sets the NextToken field's value.

func (ListPagesByContactInput) String

func (s ListPagesByContactInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPagesByContactInput) Validate

func (s *ListPagesByContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPagesByContactOutput

type ListPagesByContactOutput struct {

    // The pagination token to continue to the next page of results.
    NextToken *string `type:"string"`

    // The list of engagements to a contact's contact channel.
    //
    // Pages is a required field
    Pages []*Page `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListPagesByContactOutput) GoString

func (s ListPagesByContactOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPagesByContactOutput) SetNextToken

func (s *ListPagesByContactOutput) SetNextToken(v string) *ListPagesByContactOutput

SetNextToken sets the NextToken field's value.

func (*ListPagesByContactOutput) SetPages

func (s *ListPagesByContactOutput) SetPages(v []*Page) *ListPagesByContactOutput

SetPages sets the Pages field's value.

func (ListPagesByContactOutput) String

func (s ListPagesByContactOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPagesByEngagementInput

type ListPagesByEngagementInput struct {

    // The Amazon Resource Name (ARN) of the engagement.
    //
    // EngagementId is a required field
    EngagementId *string `min:"1" type:"string" required:"true"`

    // The maximum number of engagements to contact channels to list per page of
    // results.
    MaxResults *int64 `type:"integer"`

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

func (ListPagesByEngagementInput) GoString

func (s ListPagesByEngagementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPagesByEngagementInput) SetEngagementId

func (s *ListPagesByEngagementInput) SetEngagementId(v string) *ListPagesByEngagementInput

SetEngagementId sets the EngagementId field's value.

func (*ListPagesByEngagementInput) SetMaxResults

func (s *ListPagesByEngagementInput) SetMaxResults(v int64) *ListPagesByEngagementInput

SetMaxResults sets the MaxResults field's value.

func (*ListPagesByEngagementInput) SetNextToken

func (s *ListPagesByEngagementInput) SetNextToken(v string) *ListPagesByEngagementInput

SetNextToken sets the NextToken field's value.

func (ListPagesByEngagementInput) String

func (s ListPagesByEngagementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPagesByEngagementInput) Validate

func (s *ListPagesByEngagementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPagesByEngagementOutput

type ListPagesByEngagementOutput struct {

    // The pagination token to continue to the next page of results.
    NextToken *string `type:"string"`

    // The list of engagements to contact channels.
    //
    // Pages is a required field
    Pages []*Page `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListPagesByEngagementOutput) GoString

func (s ListPagesByEngagementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPagesByEngagementOutput) SetNextToken

func (s *ListPagesByEngagementOutput) SetNextToken(v string) *ListPagesByEngagementOutput

SetNextToken sets the NextToken field's value.

func (*ListPagesByEngagementOutput) SetPages

func (s *ListPagesByEngagementOutput) SetPages(v []*Page) *ListPagesByEngagementOutput

SetPages sets the Pages field's value.

func (ListPagesByEngagementOutput) String

func (s ListPagesByEngagementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

    // The Amazon Resource Name (ARN) of the contact or escalation plan.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

    // The tags related to the contact or escalation plan.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Page

type Page struct {

    // The ARN of the contact that Incident Manager is engaging.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // The time the message was delivered to the contact channel.
    DeliveryTime *time.Time `type:"timestamp"`

    // The ARN of the engagement that this page is part of.
    //
    // EngagementArn is a required field
    EngagementArn *string `min:"1" type:"string" required:"true"`

    // The ARN of the incident that's engaging the contact channel.
    IncidentId *string `type:"string"`

    // The Amazon Resource Name (ARN) of the page to the contact channel.
    //
    // PageArn is a required field
    PageArn *string `min:"1" type:"string" required:"true"`

    // The time that the contact channel acknowledged engagement.
    ReadTime *time.Time `type:"timestamp"`

    // The user that started the engagement.
    //
    // Sender is a required field
    Sender *string `type:"string" required:"true"`

    // The time that Incident Manager engaged the contact channel.
    SentTime *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Incident Manager engaging a contact's contact channel.

func (Page) GoString

func (s Page) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Page) SetContactArn

func (s *Page) SetContactArn(v string) *Page

SetContactArn sets the ContactArn field's value.

func (*Page) SetDeliveryTime

func (s *Page) SetDeliveryTime(v time.Time) *Page

SetDeliveryTime sets the DeliveryTime field's value.

func (*Page) SetEngagementArn

func (s *Page) SetEngagementArn(v string) *Page

SetEngagementArn sets the EngagementArn field's value.

func (*Page) SetIncidentId

func (s *Page) SetIncidentId(v string) *Page

SetIncidentId sets the IncidentId field's value.

func (*Page) SetPageArn

func (s *Page) SetPageArn(v string) *Page

SetPageArn sets the PageArn field's value.

func (*Page) SetReadTime

func (s *Page) SetReadTime(v time.Time) *Page

SetReadTime sets the ReadTime field's value.

func (*Page) SetSender

func (s *Page) SetSender(v string) *Page

SetSender sets the Sender field's value.

func (*Page) SetSentTime

func (s *Page) SetSentTime(v time.Time) *Page

SetSentTime sets the SentTime field's value.

func (Page) String

func (s Page) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Plan

type Plan struct {

    // A list of stages that the escalation plan or engagement plan uses to engage
    // contacts and contact methods.
    //
    // Stages is a required field
    Stages []*Stage `type:"list" required:"true"`
    // contains filtered or unexported fields
}

The stages that an escalation plan or engagement plan engages contacts and contact methods in.

func (Plan) GoString

func (s Plan) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Plan) SetStages

func (s *Plan) SetStages(v []*Stage) *Plan

SetStages sets the Stages field's value.

func (Plan) String

func (s Plan) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Plan) Validate

func (s *Plan) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutContactPolicyInput

type PutContactPolicyInput struct {

    // The Amazon Resource Name (ARN) of the contact or escalation plan.
    //
    // ContactArn is a required field
    ContactArn *string `min:"1" type:"string" required:"true"`

    // Details of the resource policy.
    //
    // Policy is a required field
    Policy *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (PutContactPolicyInput) GoString

func (s PutContactPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutContactPolicyInput) SetContactArn

func (s *PutContactPolicyInput) SetContactArn(v string) *PutContactPolicyInput

SetContactArn sets the ContactArn field's value.

func (*PutContactPolicyInput) SetPolicy

func (s *PutContactPolicyInput) SetPolicy(v string) *PutContactPolicyInput

SetPolicy sets the Policy field's value.

func (PutContactPolicyInput) String

func (s PutContactPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutContactPolicyInput) Validate

func (s *PutContactPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutContactPolicyOutput

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

func (PutContactPolicyOutput) GoString

func (s PutContactPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutContactPolicyOutput) String

func (s PutContactPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Receipt

type Receipt struct {

    // The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.
    ContactChannelArn *string `min:"1" type:"string"`

    // Information provided during the page acknowledgement.
    ReceiptInfo *string `min:"1" type:"string"`

    // The time receipt was SENT, DELIVERED, or READ.
    //
    // ReceiptTime is a required field
    ReceiptTime *time.Time `type:"timestamp" required:"true"`

    // The type follows the engagement cycle, SENT, DELIVERED, and READ.
    //
    // ReceiptType is a required field
    ReceiptType *string `type:"string" required:"true" enum:"ReceiptType"`
    // contains filtered or unexported fields
}

Records events during an engagement.

func (Receipt) GoString

func (s Receipt) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Receipt) SetContactChannelArn

func (s *Receipt) SetContactChannelArn(v string) *Receipt

SetContactChannelArn sets the ContactChannelArn field's value.

func (*Receipt) SetReceiptInfo

func (s *Receipt) SetReceiptInfo(v string) *Receipt

SetReceiptInfo sets the ReceiptInfo field's value.

func (*Receipt) SetReceiptTime

func (s *Receipt) SetReceiptTime(v time.Time) *Receipt

SetReceiptTime sets the ReceiptTime field's value.

func (*Receipt) SetReceiptType

func (s *Receipt) SetReceiptType(v string) *Receipt

SetReceiptType sets the ReceiptType field's value.

func (Receipt) String

func (s Receipt) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`

    // Hypothetical resource identifier that was not found
    //
    // ResourceId is a required field
    ResourceId *string `type:"string" required:"true"`

    // Hypothetical resource type that was not found
    //
    // ResourceType is a required field
    ResourceType *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Request references a resource that doesn't exist.

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SSMContacts

type SSMContacts struct {
    *client.Client
}

SSMContacts provides the API operation methods for making requests to AWS Systems Manager Incident Manager Contacts. See this package's package overview docs for details on the service.

SSMContacts methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SSMContacts

New creates a new instance of the SSMContacts client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a SSMContacts client from just a session.
svc := ssmcontacts.New(mySession)

// Create a SSMContacts client with additional configuration
svc := ssmcontacts.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SSMContacts) AcceptPage

func (c *SSMContacts) AcceptPage(input *AcceptPageInput) (*AcceptPageOutput, error)

AcceptPage API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation AcceptPage for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPage

Example (Shared00)

To accept a page during and engagement The following accept-page operation uses an accept code sent to the contact channel to accept a page.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.AcceptPageInput{
    AcceptCode: aws.String("425440"),
    AcceptType: aws.String("READ"),
    PageId:     aws.String("arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"),
}

result, err := svc.AcceptPage(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) AcceptPageRequest

func (c *SSMContacts) AcceptPageRequest(input *AcceptPageInput) (req *request.Request, output *AcceptPageOutput)

AcceptPageRequest generates a "aws/request.Request" representing the client's request for the AcceptPage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AcceptPage for more information on using the AcceptPage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AcceptPageRequest method.
req, resp := client.AcceptPageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPage

func (*SSMContacts) AcceptPageWithContext

func (c *SSMContacts) AcceptPageWithContext(ctx aws.Context, input *AcceptPageInput, opts ...request.Option) (*AcceptPageOutput, error)

AcceptPageWithContext is the same as AcceptPage with the addition of the ability to pass a context and additional request options.

See AcceptPage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ActivateContactChannel

func (c *SSMContacts) ActivateContactChannel(input *ActivateContactChannelInput) (*ActivateContactChannelOutput, error)

ActivateContactChannel API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ActivateContactChannel for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ActivateContactChannel

Example (Shared00)

Activate a contact's contact channel The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ActivateContactChannelInput{
    ActivationCode:   aws.String("466136"),
    ContactChannelId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"),
}

result, err := svc.ActivateContactChannel(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ActivateContactChannelRequest

func (c *SSMContacts) ActivateContactChannelRequest(input *ActivateContactChannelInput) (req *request.Request, output *ActivateContactChannelOutput)

ActivateContactChannelRequest generates a "aws/request.Request" representing the client's request for the ActivateContactChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivateContactChannel for more information on using the ActivateContactChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ActivateContactChannelRequest method.
req, resp := client.ActivateContactChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ActivateContactChannel

func (*SSMContacts) ActivateContactChannelWithContext

func (c *SSMContacts) ActivateContactChannelWithContext(ctx aws.Context, input *ActivateContactChannelInput, opts ...request.Option) (*ActivateContactChannelOutput, error)

ActivateContactChannelWithContext is the same as ActivateContactChannel with the addition of the ability to pass a context and additional request options.

See ActivateContactChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) CreateContact

func (c *SSMContacts) CreateContact(input *CreateContactInput) (*CreateContactOutput, error)

CreateContact API operation for AWS Systems Manager Incident Manager Contacts.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation CreateContact for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ConflictException
Updating or deleting a resource causes an inconsistent state.

* InternalServerException
Unexpected error occurred while processing the request.

* ServiceQuotaExceededException
Request would cause a service quota to be exceeded.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

* DataEncryptionException
The operation failed to due an encryption key error.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContact

Example (Shared00)

To create a contact The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.CreateContactInput{
    Alias:       aws.String("akuam"),
    DisplayName: aws.String("Akua Mansa"),
    Plan:        &ssmcontacts.Plan{},
    Type:        aws.String("PERSONAL"),
}

result, err := svc.CreateContact(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeConflictException:
            fmt.Println(ssmcontacts.ErrCodeConflictException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeServiceQuotaExceededException:
            fmt.Println(ssmcontacts.ErrCodeServiceQuotaExceededException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) CreateContactChannel

func (c *SSMContacts) CreateContactChannel(input *CreateContactChannelInput) (*CreateContactChannelOutput, error)

CreateContactChannel API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation CreateContactChannel for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ConflictException
Updating or deleting a resource causes an inconsistent state.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannel

Example (Shared00)

To create a contact channel Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.CreateContactChannelInput{
    ContactId: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"),
    DeliveryAddress: &ssmcontacts.ContactChannelAddress{
        SimpleAddress: aws.String("+15005550199"),
    },
    Name: aws.String("akuas sms-test"),
    Type: aws.String("SMS"),
}

result, err := svc.CreateContactChannel(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeConflictException:
            fmt.Println(ssmcontacts.ErrCodeConflictException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) CreateContactChannelRequest

func (c *SSMContacts) CreateContactChannelRequest(input *CreateContactChannelInput) (req *request.Request, output *CreateContactChannelOutput)

CreateContactChannelRequest generates a "aws/request.Request" representing the client's request for the CreateContactChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateContactChannel for more information on using the CreateContactChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateContactChannelRequest method.
req, resp := client.CreateContactChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannel

func (*SSMContacts) CreateContactChannelWithContext

func (c *SSMContacts) CreateContactChannelWithContext(ctx aws.Context, input *CreateContactChannelInput, opts ...request.Option) (*CreateContactChannelOutput, error)

CreateContactChannelWithContext is the same as CreateContactChannel with the addition of the ability to pass a context and additional request options.

See CreateContactChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) CreateContactRequest

func (c *SSMContacts) CreateContactRequest(input *CreateContactInput) (req *request.Request, output *CreateContactOutput)

CreateContactRequest generates a "aws/request.Request" representing the client's request for the CreateContact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateContact for more information on using the CreateContact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateContactRequest method.
req, resp := client.CreateContactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContact

func (*SSMContacts) CreateContactWithContext

func (c *SSMContacts) CreateContactWithContext(ctx aws.Context, input *CreateContactInput, opts ...request.Option) (*CreateContactOutput, error)

CreateContactWithContext is the same as CreateContact with the addition of the ability to pass a context and additional request options.

See CreateContact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) DeactivateContactChannel

func (c *SSMContacts) DeactivateContactChannel(input *DeactivateContactChannelInput) (*DeactivateContactChannelOutput, error)

DeactivateContactChannel API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation DeactivateContactChannel for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeactivateContactChannel

Example (Shared00)

To deactivate a contact channel The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time using the activate-contact-channel operation.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.DeactivateContactChannelInput{
    ContactChannelId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"),
}

result, err := svc.DeactivateContactChannel(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) DeactivateContactChannelRequest

func (c *SSMContacts) DeactivateContactChannelRequest(input *DeactivateContactChannelInput) (req *request.Request, output *DeactivateContactChannelOutput)

DeactivateContactChannelRequest generates a "aws/request.Request" representing the client's request for the DeactivateContactChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeactivateContactChannel for more information on using the DeactivateContactChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeactivateContactChannelRequest method.
req, resp := client.DeactivateContactChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeactivateContactChannel

func (*SSMContacts) DeactivateContactChannelWithContext

func (c *SSMContacts) DeactivateContactChannelWithContext(ctx aws.Context, input *DeactivateContactChannelInput, opts ...request.Option) (*DeactivateContactChannelOutput, error)

DeactivateContactChannelWithContext is the same as DeactivateContactChannel with the addition of the ability to pass a context and additional request options.

See DeactivateContactChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) DeleteContact

func (c *SSMContacts) DeleteContact(input *DeleteContactInput) (*DeleteContactOutput, error)

DeleteContact API operation for AWS Systems Manager Incident Manager Contacts.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation DeleteContact for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContact

Example (Shared00)

To delete a contact The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.DeleteContactInput{
    ContactId: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"),
}

result, err := svc.DeleteContact(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) DeleteContactChannel

func (c *SSMContacts) DeleteContactChannel(input *DeleteContactChannelInput) (*DeleteContactChannelOutput, error)

DeleteContactChannel API operation for AWS Systems Manager Incident Manager Contacts.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation DeleteContactChannel for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContactChannel

Example (Shared00)

To delete a contact channel The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact channel will not be paged during an incident.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.DeleteContactChannelInput{
    ContactChannelId: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"),
}

result, err := svc.DeleteContactChannel(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) DeleteContactChannelRequest

func (c *SSMContacts) DeleteContactChannelRequest(input *DeleteContactChannelInput) (req *request.Request, output *DeleteContactChannelOutput)

DeleteContactChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteContactChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteContactChannel for more information on using the DeleteContactChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteContactChannelRequest method.
req, resp := client.DeleteContactChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContactChannel

func (*SSMContacts) DeleteContactChannelWithContext

func (c *SSMContacts) DeleteContactChannelWithContext(ctx aws.Context, input *DeleteContactChannelInput, opts ...request.Option) (*DeleteContactChannelOutput, error)

DeleteContactChannelWithContext is the same as DeleteContactChannel with the addition of the ability to pass a context and additional request options.

See DeleteContactChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) DeleteContactRequest

func (c *SSMContacts) DeleteContactRequest(input *DeleteContactInput) (req *request.Request, output *DeleteContactOutput)

DeleteContactRequest generates a "aws/request.Request" representing the client's request for the DeleteContact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteContact for more information on using the DeleteContact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteContactRequest method.
req, resp := client.DeleteContactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContact

func (*SSMContacts) DeleteContactWithContext

func (c *SSMContacts) DeleteContactWithContext(ctx aws.Context, input *DeleteContactInput, opts ...request.Option) (*DeleteContactOutput, error)

DeleteContactWithContext is the same as DeleteContact with the addition of the ability to pass a context and additional request options.

See DeleteContact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) DescribeEngagement

func (c *SSMContacts) DescribeEngagement(input *DescribeEngagementInput) (*DescribeEngagementOutput, error)

DescribeEngagement API operation for AWS Systems Manager Incident Manager Contacts.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation DescribeEngagement for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribeEngagement

Example (Shared00)

To describe the details of an engagement The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.DescribeEngagementInput{
    EngagementId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"),
}

result, err := svc.DescribeEngagement(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) DescribeEngagementRequest

func (c *SSMContacts) DescribeEngagementRequest(input *DescribeEngagementInput) (req *request.Request, output *DescribeEngagementOutput)

DescribeEngagementRequest generates a "aws/request.Request" representing the client's request for the DescribeEngagement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEngagement for more information on using the DescribeEngagement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEngagementRequest method.
req, resp := client.DescribeEngagementRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribeEngagement

func (*SSMContacts) DescribeEngagementWithContext

func (c *SSMContacts) DescribeEngagementWithContext(ctx aws.Context, input *DescribeEngagementInput, opts ...request.Option) (*DescribeEngagementOutput, error)

DescribeEngagementWithContext is the same as DescribeEngagement with the addition of the ability to pass a context and additional request options.

See DescribeEngagement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) DescribePage

func (c *SSMContacts) DescribePage(input *DescribePageInput) (*DescribePageOutput, error)

DescribePage API operation for AWS Systems Manager Incident Manager Contacts.

Lists details of the engagement to a contact channel.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation DescribePage for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribePage

Example (Shared00)

To list the details of a page to a contact channel The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.DescribePageInput{
    PageId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"),
}

result, err := svc.DescribePage(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) DescribePageRequest

func (c *SSMContacts) DescribePageRequest(input *DescribePageInput) (req *request.Request, output *DescribePageOutput)

DescribePageRequest generates a "aws/request.Request" representing the client's request for the DescribePage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePage for more information on using the DescribePage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePageRequest method.
req, resp := client.DescribePageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribePage

func (*SSMContacts) DescribePageWithContext

func (c *SSMContacts) DescribePageWithContext(ctx aws.Context, input *DescribePageInput, opts ...request.Option) (*DescribePageOutput, error)

DescribePageWithContext is the same as DescribePage with the addition of the ability to pass a context and additional request options.

See DescribePage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) GetContact

func (c *SSMContacts) GetContact(input *GetContactInput) (*GetContactOutput, error)

GetContact API operation for AWS Systems Manager Incident Manager Contacts.

Retrieves information about the specified contact or escalation plan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation GetContact for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

* DataEncryptionException
The operation failed to due an encryption key error.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContact

Example (Shared00)

Example 1: To describe a contact plan The following get-contact example describes a contact.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.GetContactInput{
    ContactId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"),
}

result, err := svc.GetContact(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

Example (Shared01)

Example 2: To describe an escalation plan The following get-contact example describes an escalation plan.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.GetContactInput{
    ContactId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"),
}

result, err := svc.GetContact(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) GetContactChannel

func (c *SSMContacts) GetContactChannel(input *GetContactChannelInput) (*GetContactChannelOutput, error)

GetContactChannel API operation for AWS Systems Manager Incident Manager Contacts.

List details about a specific contact channel.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation GetContactChannel for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactChannel

Example (Shared00)

To list the details of a contact channel The following get-contact-channel example lists the details of a contact channel.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.GetContactChannelInput{
    ContactChannelId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"),
}

result, err := svc.GetContactChannel(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) GetContactChannelRequest

func (c *SSMContacts) GetContactChannelRequest(input *GetContactChannelInput) (req *request.Request, output *GetContactChannelOutput)

GetContactChannelRequest generates a "aws/request.Request" representing the client's request for the GetContactChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetContactChannel for more information on using the GetContactChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetContactChannelRequest method.
req, resp := client.GetContactChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactChannel

func (*SSMContacts) GetContactChannelWithContext

func (c *SSMContacts) GetContactChannelWithContext(ctx aws.Context, input *GetContactChannelInput, opts ...request.Option) (*GetContactChannelOutput, error)

GetContactChannelWithContext is the same as GetContactChannel with the addition of the ability to pass a context and additional request options.

See GetContactChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) GetContactPolicy

func (c *SSMContacts) GetContactPolicy(input *GetContactPolicyInput) (*GetContactPolicyOutput, error)

GetContactPolicy API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation GetContactPolicy for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactPolicy

Example (Shared00)

To list the resource policies of a contact The following get-contact-policy example lists the resource policies associated with the specified contact.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.GetContactPolicyInput{
    ContactArn: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"),
}

result, err := svc.GetContactPolicy(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) GetContactPolicyRequest

func (c *SSMContacts) GetContactPolicyRequest(input *GetContactPolicyInput) (req *request.Request, output *GetContactPolicyOutput)

GetContactPolicyRequest generates a "aws/request.Request" representing the client's request for the GetContactPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetContactPolicy for more information on using the GetContactPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetContactPolicyRequest method.
req, resp := client.GetContactPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactPolicy

func (*SSMContacts) GetContactPolicyWithContext

func (c *SSMContacts) GetContactPolicyWithContext(ctx aws.Context, input *GetContactPolicyInput, opts ...request.Option) (*GetContactPolicyOutput, error)

GetContactPolicyWithContext is the same as GetContactPolicy with the addition of the ability to pass a context and additional request options.

See GetContactPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) GetContactRequest

func (c *SSMContacts) GetContactRequest(input *GetContactInput) (req *request.Request, output *GetContactOutput)

GetContactRequest generates a "aws/request.Request" representing the client's request for the GetContact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetContact for more information on using the GetContact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetContactRequest method.
req, resp := client.GetContactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContact

func (*SSMContacts) GetContactWithContext

func (c *SSMContacts) GetContactWithContext(ctx aws.Context, input *GetContactInput, opts ...request.Option) (*GetContactOutput, error)

GetContactWithContext is the same as GetContact with the addition of the ability to pass a context and additional request options.

See GetContact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListContactChannels

func (c *SSMContacts) ListContactChannels(input *ListContactChannelsInput) (*ListContactChannelsOutput, error)

ListContactChannels API operation for AWS Systems Manager Incident Manager Contacts.

Lists all contact channels for the specified contact.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ListContactChannels for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContactChannels

Example (Shared00)

To list the contact channels of a contact The following list-contact-channels example lists the available contact channels of the specified contact.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ListContactChannelsInput{
    ContactId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"),
}

result, err := svc.ListContactChannels(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ListContactChannelsPages

func (c *SSMContacts) ListContactChannelsPages(input *ListContactChannelsInput, fn func(*ListContactChannelsOutput, bool) bool) error

ListContactChannelsPages iterates over the pages of a ListContactChannels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListContactChannels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListContactChannels operation.
pageNum := 0
err := client.ListContactChannelsPages(params,
    func(page *ssmcontacts.ListContactChannelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSMContacts) ListContactChannelsPagesWithContext

func (c *SSMContacts) ListContactChannelsPagesWithContext(ctx aws.Context, input *ListContactChannelsInput, fn func(*ListContactChannelsOutput, bool) bool, opts ...request.Option) error

ListContactChannelsPagesWithContext same as ListContactChannelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListContactChannelsRequest

func (c *SSMContacts) ListContactChannelsRequest(input *ListContactChannelsInput) (req *request.Request, output *ListContactChannelsOutput)

ListContactChannelsRequest generates a "aws/request.Request" representing the client's request for the ListContactChannels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListContactChannels for more information on using the ListContactChannels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListContactChannelsRequest method.
req, resp := client.ListContactChannelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContactChannels

func (*SSMContacts) ListContactChannelsWithContext

func (c *SSMContacts) ListContactChannelsWithContext(ctx aws.Context, input *ListContactChannelsInput, opts ...request.Option) (*ListContactChannelsOutput, error)

ListContactChannelsWithContext is the same as ListContactChannels with the addition of the ability to pass a context and additional request options.

See ListContactChannels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListContacts

func (c *SSMContacts) ListContacts(input *ListContactsInput) (*ListContactsOutput, error)

ListContacts API operation for AWS Systems Manager Incident Manager Contacts.

Lists all contacts and escalation plans in Incident Manager.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ListContacts for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContacts

Example (Shared00)

To list all escalation plans and contacts The following list-contacts example lists the contacts and escalation plans in your account.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ListContactsInput{}

result, err := svc.ListContacts(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ListContactsPages

func (c *SSMContacts) ListContactsPages(input *ListContactsInput, fn func(*ListContactsOutput, bool) bool) error

ListContactsPages iterates over the pages of a ListContacts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListContacts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListContacts operation.
pageNum := 0
err := client.ListContactsPages(params,
    func(page *ssmcontacts.ListContactsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSMContacts) ListContactsPagesWithContext

func (c *SSMContacts) ListContactsPagesWithContext(ctx aws.Context, input *ListContactsInput, fn func(*ListContactsOutput, bool) bool, opts ...request.Option) error

ListContactsPagesWithContext same as ListContactsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListContactsRequest

func (c *SSMContacts) ListContactsRequest(input *ListContactsInput) (req *request.Request, output *ListContactsOutput)

ListContactsRequest generates a "aws/request.Request" representing the client's request for the ListContacts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListContacts for more information on using the ListContacts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListContactsRequest method.
req, resp := client.ListContactsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContacts

func (*SSMContacts) ListContactsWithContext

func (c *SSMContacts) ListContactsWithContext(ctx aws.Context, input *ListContactsInput, opts ...request.Option) (*ListContactsOutput, error)

ListContactsWithContext is the same as ListContacts with the addition of the ability to pass a context and additional request options.

See ListContacts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListEngagements

func (c *SSMContacts) ListEngagements(input *ListEngagementsInput) (*ListEngagementsOutput, error)

ListEngagements API operation for AWS Systems Manager Incident Manager Contacts.

Lists all engagements that have happened in an incident.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ListEngagements for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListEngagements

Example (Shared00)

To list all engagements The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements for a single incident.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ListEngagementsInput{}

result, err := svc.ListEngagements(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ListEngagementsPages

func (c *SSMContacts) ListEngagementsPages(input *ListEngagementsInput, fn func(*ListEngagementsOutput, bool) bool) error

ListEngagementsPages iterates over the pages of a ListEngagements operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEngagements method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListEngagements operation.
pageNum := 0
err := client.ListEngagementsPages(params,
    func(page *ssmcontacts.ListEngagementsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSMContacts) ListEngagementsPagesWithContext

func (c *SSMContacts) ListEngagementsPagesWithContext(ctx aws.Context, input *ListEngagementsInput, fn func(*ListEngagementsOutput, bool) bool, opts ...request.Option) error

ListEngagementsPagesWithContext same as ListEngagementsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListEngagementsRequest

func (c *SSMContacts) ListEngagementsRequest(input *ListEngagementsInput) (req *request.Request, output *ListEngagementsOutput)

ListEngagementsRequest generates a "aws/request.Request" representing the client's request for the ListEngagements operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEngagements for more information on using the ListEngagements API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListEngagementsRequest method.
req, resp := client.ListEngagementsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListEngagements

func (*SSMContacts) ListEngagementsWithContext

func (c *SSMContacts) ListEngagementsWithContext(ctx aws.Context, input *ListEngagementsInput, opts ...request.Option) (*ListEngagementsOutput, error)

ListEngagementsWithContext is the same as ListEngagements with the addition of the ability to pass a context and additional request options.

See ListEngagements for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListPageReceipts

func (c *SSMContacts) ListPageReceipts(input *ListPageReceiptsInput) (*ListPageReceiptsOutput, error)

ListPageReceipts API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ListPageReceipts for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPageReceipts

Example (Shared00)

To list page receipts The following command-name example lists whether a page was received or not by a contact.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ListPageReceiptsInput{
    PageId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"),
}

result, err := svc.ListPageReceipts(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ListPageReceiptsPages

func (c *SSMContacts) ListPageReceiptsPages(input *ListPageReceiptsInput, fn func(*ListPageReceiptsOutput, bool) bool) error

ListPageReceiptsPages iterates over the pages of a ListPageReceipts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPageReceipts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPageReceipts operation.
pageNum := 0
err := client.ListPageReceiptsPages(params,
    func(page *ssmcontacts.ListPageReceiptsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSMContacts) ListPageReceiptsPagesWithContext

func (c *SSMContacts) ListPageReceiptsPagesWithContext(ctx aws.Context, input *ListPageReceiptsInput, fn func(*ListPageReceiptsOutput, bool) bool, opts ...request.Option) error

ListPageReceiptsPagesWithContext same as ListPageReceiptsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListPageReceiptsRequest

func (c *SSMContacts) ListPageReceiptsRequest(input *ListPageReceiptsInput) (req *request.Request, output *ListPageReceiptsOutput)

ListPageReceiptsRequest generates a "aws/request.Request" representing the client's request for the ListPageReceipts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPageReceipts for more information on using the ListPageReceipts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPageReceiptsRequest method.
req, resp := client.ListPageReceiptsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPageReceipts

func (*SSMContacts) ListPageReceiptsWithContext

func (c *SSMContacts) ListPageReceiptsWithContext(ctx aws.Context, input *ListPageReceiptsInput, opts ...request.Option) (*ListPageReceiptsOutput, error)

ListPageReceiptsWithContext is the same as ListPageReceipts with the addition of the ability to pass a context and additional request options.

See ListPageReceipts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListPagesByContact

func (c *SSMContacts) ListPagesByContact(input *ListPagesByContactInput) (*ListPagesByContactOutput, error)

ListPagesByContact API operation for AWS Systems Manager Incident Manager Contacts.

Lists the engagements to a contact's contact channels.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ListPagesByContact for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByContact

Example (Shared00)

To list pages by contact The following list-pages-by-contact example lists all pages to the specified contact.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ListPagesByContactInput{
    ContactId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"),
}

result, err := svc.ListPagesByContact(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ListPagesByContactPages

func (c *SSMContacts) ListPagesByContactPages(input *ListPagesByContactInput, fn func(*ListPagesByContactOutput, bool) bool) error

ListPagesByContactPages iterates over the pages of a ListPagesByContact operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPagesByContact method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPagesByContact operation.
pageNum := 0
err := client.ListPagesByContactPages(params,
    func(page *ssmcontacts.ListPagesByContactOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSMContacts) ListPagesByContactPagesWithContext

func (c *SSMContacts) ListPagesByContactPagesWithContext(ctx aws.Context, input *ListPagesByContactInput, fn func(*ListPagesByContactOutput, bool) bool, opts ...request.Option) error

ListPagesByContactPagesWithContext same as ListPagesByContactPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListPagesByContactRequest

func (c *SSMContacts) ListPagesByContactRequest(input *ListPagesByContactInput) (req *request.Request, output *ListPagesByContactOutput)

ListPagesByContactRequest generates a "aws/request.Request" representing the client's request for the ListPagesByContact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPagesByContact for more information on using the ListPagesByContact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPagesByContactRequest method.
req, resp := client.ListPagesByContactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByContact

func (*SSMContacts) ListPagesByContactWithContext

func (c *SSMContacts) ListPagesByContactWithContext(ctx aws.Context, input *ListPagesByContactInput, opts ...request.Option) (*ListPagesByContactOutput, error)

ListPagesByContactWithContext is the same as ListPagesByContact with the addition of the ability to pass a context and additional request options.

See ListPagesByContact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListPagesByEngagement

func (c *SSMContacts) ListPagesByEngagement(input *ListPagesByEngagementInput) (*ListPagesByEngagementOutput, error)

ListPagesByEngagement API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ListPagesByEngagement for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByEngagement

Example (Shared00)

To list pages to contact channels started from an engagement. The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ListPagesByEngagementInput{
    EngagementId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0"),
}

result, err := svc.ListPagesByEngagement(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ListPagesByEngagementPages

func (c *SSMContacts) ListPagesByEngagementPages(input *ListPagesByEngagementInput, fn func(*ListPagesByEngagementOutput, bool) bool) error

ListPagesByEngagementPages iterates over the pages of a ListPagesByEngagement operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPagesByEngagement method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPagesByEngagement operation.
pageNum := 0
err := client.ListPagesByEngagementPages(params,
    func(page *ssmcontacts.ListPagesByEngagementOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSMContacts) ListPagesByEngagementPagesWithContext

func (c *SSMContacts) ListPagesByEngagementPagesWithContext(ctx aws.Context, input *ListPagesByEngagementInput, fn func(*ListPagesByEngagementOutput, bool) bool, opts ...request.Option) error

ListPagesByEngagementPagesWithContext same as ListPagesByEngagementPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListPagesByEngagementRequest

func (c *SSMContacts) ListPagesByEngagementRequest(input *ListPagesByEngagementInput) (req *request.Request, output *ListPagesByEngagementOutput)

ListPagesByEngagementRequest generates a "aws/request.Request" representing the client's request for the ListPagesByEngagement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPagesByEngagement for more information on using the ListPagesByEngagement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPagesByEngagementRequest method.
req, resp := client.ListPagesByEngagementRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByEngagement

func (*SSMContacts) ListPagesByEngagementWithContext

func (c *SSMContacts) ListPagesByEngagementWithContext(ctx aws.Context, input *ListPagesByEngagementInput, opts ...request.Option) (*ListPagesByEngagementOutput, error)

ListPagesByEngagementWithContext is the same as ListPagesByEngagement with the addition of the ability to pass a context and additional request options.

See ListPagesByEngagement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) ListTagsForResource

func (c *SSMContacts) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Systems Manager Incident Manager Contacts.

Lists the tags of an escalation plan or contact.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation ListTagsForResource for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ThrottlingException
The request was denied due to request throttling.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

* InternalServerException
Unexpected error occurred while processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResource

Example (Shared00)

To list tags for a contact The following list-tags-for-resource example lists the tags of the specified contact.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.ListTagsForResourceInput{
    ResourceARN: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"),
}

result, err := svc.ListTagsForResource(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) ListTagsForResourceRequest

func (c *SSMContacts) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResource

func (*SSMContacts) ListTagsForResourceWithContext

func (c *SSMContacts) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) PutContactPolicy

func (c *SSMContacts) PutContactPolicy(input *PutContactPolicyInput) (*PutContactPolicyOutput, error)

PutContactPolicy API operation for AWS Systems Manager Incident Manager Contacts.

Adds a resource to the specified contact or escalation plan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation PutContactPolicy for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ConflictException
Updating or deleting a resource causes an inconsistent state.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* InternalServerException
Unexpected error occurred while processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/PutContactPolicy

Example (Shared00)

To share a contact and engagements The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related engagements with the principal.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.PutContactPolicyInput{
    ContactArn: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"),
    Policy:     aws.String("{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}"),
}

result, err := svc.PutContactPolicy(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeConflictException:
            fmt.Println(ssmcontacts.ErrCodeConflictException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) PutContactPolicyRequest

func (c *SSMContacts) PutContactPolicyRequest(input *PutContactPolicyInput) (req *request.Request, output *PutContactPolicyOutput)

PutContactPolicyRequest generates a "aws/request.Request" representing the client's request for the PutContactPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutContactPolicy for more information on using the PutContactPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutContactPolicyRequest method.
req, resp := client.PutContactPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/PutContactPolicy

func (*SSMContacts) PutContactPolicyWithContext

func (c *SSMContacts) PutContactPolicyWithContext(ctx aws.Context, input *PutContactPolicyInput, opts ...request.Option) (*PutContactPolicyOutput, error)

PutContactPolicyWithContext is the same as PutContactPolicy with the addition of the ability to pass a context and additional request options.

See PutContactPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) SendActivationCode

func (c *SSMContacts) SendActivationCode(input *SendActivationCodeInput) (*SendActivationCodeOutput, error)

SendActivationCode API operation for AWS Systems Manager Incident Manager Contacts.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation SendActivationCode for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ServiceQuotaExceededException
Request would cause a service quota to be exceeded.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/SendActivationCode

Example (Shared00)

To send an activation code The following send-activation-code example sends an activation code and message to the specified contact channel.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.SendActivationCodeInput{
    ContactChannelId: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"),
}

result, err := svc.SendActivationCode(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeServiceQuotaExceededException:
            fmt.Println(ssmcontacts.ErrCodeServiceQuotaExceededException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) SendActivationCodeRequest

func (c *SSMContacts) SendActivationCodeRequest(input *SendActivationCodeInput) (req *request.Request, output *SendActivationCodeOutput)

SendActivationCodeRequest generates a "aws/request.Request" representing the client's request for the SendActivationCode operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendActivationCode for more information on using the SendActivationCode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SendActivationCodeRequest method.
req, resp := client.SendActivationCodeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/SendActivationCode

func (*SSMContacts) SendActivationCodeWithContext

func (c *SSMContacts) SendActivationCodeWithContext(ctx aws.Context, input *SendActivationCodeInput, opts ...request.Option) (*SendActivationCodeOutput, error)

SendActivationCodeWithContext is the same as SendActivationCode with the addition of the ability to pass a context and additional request options.

See SendActivationCode for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) StartEngagement

func (c *SSMContacts) StartEngagement(input *StartEngagementInput) (*StartEngagementOutput, error)

StartEngagement API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation StartEngagement for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StartEngagement

Example (Shared00)

Example 1: To page a contact's contact channels The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels. Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to track who started the engagement.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.StartEngagementInput{
    ContactId:     aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"),
    Content:       aws.String("Testing engagements"),
    PublicContent: aws.String("Testing engagements"),
    PublicSubject: aws.String("test"),
    Sender:        aws.String("tester"),
    Subject:       aws.String("test"),
}

result, err := svc.StartEngagement(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

Example (Shared01)

Example 2: To page a contact in the provided escalation plan. The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their engagement plan.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.StartEngagementInput{
    ContactId:     aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"),
    Content:       aws.String("Testing engagements"),
    PublicContent: aws.String("Testing engagements"),
    PublicSubject: aws.String("test"),
    Sender:        aws.String("tester"),
    Subject:       aws.String("test"),
}

result, err := svc.StartEngagement(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) StartEngagementRequest

func (c *SSMContacts) StartEngagementRequest(input *StartEngagementInput) (req *request.Request, output *StartEngagementOutput)

StartEngagementRequest generates a "aws/request.Request" representing the client's request for the StartEngagement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartEngagement for more information on using the StartEngagement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartEngagementRequest method.
req, resp := client.StartEngagementRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StartEngagement

func (*SSMContacts) StartEngagementWithContext

func (c *SSMContacts) StartEngagementWithContext(ctx aws.Context, input *StartEngagementInput, opts ...request.Option) (*StartEngagementOutput, error)

StartEngagementWithContext is the same as StartEngagement with the addition of the ability to pass a context and additional request options.

See StartEngagement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) StopEngagement

func (c *SSMContacts) StopEngagement(input *StopEngagementInput) (*StopEngagementOutput, error)

StopEngagement API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation StopEngagement for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* InternalServerException
Unexpected error occurred while processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StopEngagement

Example (Shared00)

To stop an engagement The following stop-engagement example stops an engagement from paging further contacts and contact channels.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.StopEngagementInput{
    EngagementId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"),
}

result, err := svc.StopEngagement(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) StopEngagementRequest

func (c *SSMContacts) StopEngagementRequest(input *StopEngagementInput) (req *request.Request, output *StopEngagementOutput)

StopEngagementRequest generates a "aws/request.Request" representing the client's request for the StopEngagement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopEngagement for more information on using the StopEngagement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopEngagementRequest method.
req, resp := client.StopEngagementRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StopEngagement

func (*SSMContacts) StopEngagementWithContext

func (c *SSMContacts) StopEngagementWithContext(ctx aws.Context, input *StopEngagementInput, opts ...request.Option) (*StopEngagementOutput, error)

StopEngagementWithContext is the same as StopEngagement with the addition of the ability to pass a context and additional request options.

See StopEngagement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) TagResource

func (c *SSMContacts) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Systems Manager Incident Manager Contacts.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation TagResource for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ThrottlingException
The request was denied due to request throttling.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* InternalServerException
Unexpected error occurred while processing the request.

* ServiceQuotaExceededException
Request would cause a service quota to be exceeded.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/TagResource

Example (Shared00)

To tag a contact The following tag-resource example tags a specified contact with the provided tag key value pair.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.TagResourceInput{
    ResourceARN: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"),
    Tags: []*ssmcontacts.Tag{
        {
            Key:   aws.String("group1"),
            Value: aws.String("1"),
        },
    },
}

result, err := svc.TagResource(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeServiceQuotaExceededException:
            fmt.Println(ssmcontacts.ErrCodeServiceQuotaExceededException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) TagResourceRequest

func (c *SSMContacts) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/TagResource

func (*SSMContacts) TagResourceWithContext

func (c *SSMContacts) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) UntagResource

func (c *SSMContacts) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Systems Manager Incident Manager Contacts.

Removes tags from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation UntagResource for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ThrottlingException
The request was denied due to request throttling.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

* InternalServerException
Unexpected error occurred while processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UntagResource

Example (Shared00)

To remove tags from a contact The following untag-resource example removes the group1 tag from the specified contact.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.UntagResourceInput{
    ResourceARN: aws.String("arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"),
    TagKeys: []*string{
        aws.String("group1"),
    },
}

result, err := svc.UntagResource(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) UntagResourceRequest

func (c *SSMContacts) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UntagResource

func (*SSMContacts) UntagResourceWithContext

func (c *SSMContacts) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) UpdateContact

func (c *SSMContacts) UpdateContact(input *UpdateContactInput) (*UpdateContactOutput, error)

UpdateContact API operation for AWS Systems Manager Incident Manager Contacts.

Updates the contact or escalation plan specified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation UpdateContact for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ServiceQuotaExceededException
Request would cause a service quota to be exceeded.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

* DataEncryptionException
The operation failed to due an encryption key error.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContact

Example (Shared00)

To update the engagement plan of contact The following update-contact example updates the engagement plan of the contact Akua to include the three types of contacts channels. This is done after creating contact channels for Akua.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.UpdateContactInput{
    ContactId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"),
    Plan: &ssmcontacts.Plan{
        Stages: []*ssmcontacts.Stage{
            {
                DurationInMinutes: aws.Int64(5),
                Targets: []*ssmcontacts.Target{
                    {
                        ChannelTargetInfo: &ssmcontacts.ChannelTargetInfo{
                            ContactChannelId:       aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65"),
                            RetryIntervalInMinutes: aws.Int64(1),
                        },
                    },
                },
            },
            {
                DurationInMinutes: aws.Int64(5),
                Targets: []*ssmcontacts.Target{
                    {
                        ChannelTargetInfo: &ssmcontacts.ChannelTargetInfo{
                            ContactChannelId:       aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad"),
                            RetryIntervalInMinutes: aws.Int64(1),
                        },
                    },
                },
            },
            {
                DurationInMinutes: aws.Int64(5),
                Targets: []*ssmcontacts.Target{
                    {
                        ChannelTargetInfo: &ssmcontacts.ChannelTargetInfo{
                            ContactChannelId:       aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a"),
                            RetryIntervalInMinutes: aws.Int64(1),
                        },
                    },
                },
            },
        },
    },
}

result, err := svc.UpdateContact(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeServiceQuotaExceededException:
            fmt.Println(ssmcontacts.ErrCodeServiceQuotaExceededException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) UpdateContactChannel

func (c *SSMContacts) UpdateContactChannel(input *UpdateContactChannelInput) (*UpdateContactChannelOutput, error)

UpdateContactChannel API operation for AWS Systems Manager Incident Manager Contacts.

Updates a contact's contact channel.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Systems Manager Incident Manager Contacts's API operation UpdateContactChannel for usage and error information.

Returned Error Types:

* AccessDeniedException
You don't have sufficient access to perform this operation.

* ConflictException
Updating or deleting a resource causes an inconsistent state.

* DataEncryptionException
The operation failed to due an encryption key error.

* InternalServerException
Unexpected error occurred while processing the request.

* ResourceNotFoundException
Request references a resource that doesn't exist.

* ThrottlingException
The request was denied due to request throttling.

* ValidationException
The input fails to satisfy the constraints specified by an Amazon Web Services
service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContactChannel

Example (Shared00)

To update a contact channel The following update-contact-channel example updates the name and delivery address of a contact channel.

Code:

svc := ssmcontacts.New(session.New())
input := &ssmcontacts.UpdateContactChannelInput{
    ContactChannelId: aws.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad"),
    DeliveryAddress: &ssmcontacts.ContactChannelAddress{
        SimpleAddress: aws.String("+15005550198"),
    },
    Name: aws.String("akuas voice channel"),
}

result, err := svc.UpdateContactChannel(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case ssmcontacts.ErrCodeAccessDeniedException:
            fmt.Println(ssmcontacts.ErrCodeAccessDeniedException, aerr.Error())
        case ssmcontacts.ErrCodeConflictException:
            fmt.Println(ssmcontacts.ErrCodeConflictException, aerr.Error())
        case ssmcontacts.ErrCodeDataEncryptionException:
            fmt.Println(ssmcontacts.ErrCodeDataEncryptionException, aerr.Error())
        case ssmcontacts.ErrCodeInternalServerException:
            fmt.Println(ssmcontacts.ErrCodeInternalServerException, aerr.Error())
        case ssmcontacts.ErrCodeResourceNotFoundException:
            fmt.Println(ssmcontacts.ErrCodeResourceNotFoundException, aerr.Error())
        case ssmcontacts.ErrCodeThrottlingException:
            fmt.Println(ssmcontacts.ErrCodeThrottlingException, aerr.Error())
        case ssmcontacts.ErrCodeValidationException:
            fmt.Println(ssmcontacts.ErrCodeValidationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*SSMContacts) UpdateContactChannelRequest

func (c *SSMContacts) UpdateContactChannelRequest(input *UpdateContactChannelInput) (req *request.Request, output *UpdateContactChannelOutput)

UpdateContactChannelRequest generates a "aws/request.Request" representing the client's request for the UpdateContactChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateContactChannel for more information on using the UpdateContactChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateContactChannelRequest method.
req, resp := client.UpdateContactChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContactChannel

func (*SSMContacts) UpdateContactChannelWithContext

func (c *SSMContacts) UpdateContactChannelWithContext(ctx aws.Context, input *UpdateContactChannelInput, opts ...request.Option) (*UpdateContactChannelOutput, error)

UpdateContactChannelWithContext is the same as UpdateContactChannel with the addition of the ability to pass a context and additional request options.

See UpdateContactChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSMContacts) UpdateContactRequest

func (c *SSMContacts) UpdateContactRequest(input *UpdateContactInput) (req *request.Request, output *UpdateContactOutput)

UpdateContactRequest generates a "aws/request.Request" representing the client's request for the UpdateContact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateContact for more information on using the UpdateContact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateContactRequest method.
req, resp := client.UpdateContactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContact

func (*SSMContacts) UpdateContactWithContext

func (c *SSMContacts) UpdateContactWithContext(ctx aws.Context, input *UpdateContactInput, opts ...request.Option) (*UpdateContactOutput, error)

UpdateContactWithContext is the same as UpdateContact with the addition of the ability to pass a context and additional request options.

See UpdateContact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type SendActivationCodeInput

type SendActivationCodeInput struct {

    // The Amazon Resource Name (ARN) of the contact channel.
    //
    // ContactChannelId is a required field
    ContactChannelId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (SendActivationCodeInput) GoString

func (s SendActivationCodeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendActivationCodeInput) SetContactChannelId

func (s *SendActivationCodeInput) SetContactChannelId(v string) *SendActivationCodeInput

SetContactChannelId sets the ContactChannelId field's value.

func (SendActivationCodeInput) String

func (s SendActivationCodeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendActivationCodeInput) Validate

func (s *SendActivationCodeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendActivationCodeOutput

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

func (SendActivationCodeOutput) GoString

func (s SendActivationCodeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SendActivationCodeOutput) String

func (s SendActivationCodeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`

    // Service Quotas requirement to identify originating service
    //
    // QuotaCode is a required field
    QuotaCode *string `type:"string" required:"true"`

    // Identifier of the resource affected
    ResourceId *string `type:"string"`

    // Type of the resource affected
    ResourceType *string `type:"string"`

    // Service Quotas requirement to identify originating quota
    //
    // ServiceCode is a required field
    ServiceCode *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Code

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Stage

type Stage struct {

    // The time to wait until beginning the next stage. The duration can only be
    // set to 0 if a target is specified.
    //
    // DurationInMinutes is a required field
    DurationInMinutes *int64 `type:"integer" required:"true"`

    // The contacts or contact methods that the escalation plan or engagement plan
    // is engaging.
    //
    // Targets is a required field
    Targets []*Target `type:"list" required:"true"`
    // contains filtered or unexported fields
}

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

func (Stage) GoString

func (s Stage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Stage) SetDurationInMinutes

func (s *Stage) SetDurationInMinutes(v int64) *Stage

SetDurationInMinutes sets the DurationInMinutes field's value.

func (*Stage) SetTargets

func (s *Stage) SetTargets(v []*Target) *Stage

SetTargets sets the Targets field's value.

func (Stage) String

func (s Stage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Stage) Validate

func (s *Stage) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEngagementInput

type StartEngagementInput struct {

    // The Amazon Resource Name (ARN) of the contact being engaged.
    //
    // ContactId is a required field
    ContactId *string `min:"1" type:"string" required:"true"`

    // The secure content of the message that was sent to the contact. Use this
    // field for engagements to VOICE or EMAIL.
    //
    // Content is a required field
    Content *string `min:"1" type:"string" required:"true"`

    // A token ensuring that the operation is called only once with the specified
    // details.
    IdempotencyToken *string `type:"string" idempotencyToken:"true"`

    // The ARN of the incident that the engagement is part of.
    IncidentId *string `type:"string"`

    // The insecure content of the message that was sent to the contact. Use this
    // field for engagements to SMS.
    PublicContent *string `min:"1" type:"string"`

    // The insecure subject of the message that was sent to the contact. Use this
    // field for engagements to SMS.
    PublicSubject *string `min:"1" type:"string"`

    // The user that started the engagement.
    //
    // Sender is a required field
    Sender *string `type:"string" required:"true"`

    // The secure subject of the message that was sent to the contact. Use this
    // field for engagements to VOICE or EMAIL.
    //
    // Subject is a required field
    Subject *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StartEngagementInput) GoString

func (s StartEngagementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEngagementInput) SetContactId

func (s *StartEngagementInput) SetContactId(v string) *StartEngagementInput

SetContactId sets the ContactId field's value.

func (*StartEngagementInput) SetContent

func (s *StartEngagementInput) SetContent(v string) *StartEngagementInput

SetContent sets the Content field's value.

func (*StartEngagementInput) SetIdempotencyToken

func (s *StartEngagementInput) SetIdempotencyToken(v string) *StartEngagementInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*StartEngagementInput) SetIncidentId

func (s *StartEngagementInput) SetIncidentId(v string) *StartEngagementInput

SetIncidentId sets the IncidentId field's value.

func (*StartEngagementInput) SetPublicContent

func (s *StartEngagementInput) SetPublicContent(v string) *StartEngagementInput

SetPublicContent sets the PublicContent field's value.

func (*StartEngagementInput) SetPublicSubject

func (s *StartEngagementInput) SetPublicSubject(v string) *StartEngagementInput

SetPublicSubject sets the PublicSubject field's value.

func (*StartEngagementInput) SetSender

func (s *StartEngagementInput) SetSender(v string) *StartEngagementInput

SetSender sets the Sender field's value.

func (*StartEngagementInput) SetSubject

func (s *StartEngagementInput) SetSubject(v string) *StartEngagementInput

SetSubject sets the Subject field's value.

func (StartEngagementInput) String

func (s StartEngagementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEngagementInput) Validate

func (s *StartEngagementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEngagementOutput

type StartEngagementOutput struct {

    // The ARN of the engagement.
    //
    // EngagementArn is a required field
    EngagementArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StartEngagementOutput) GoString

func (s StartEngagementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEngagementOutput) SetEngagementArn

func (s *StartEngagementOutput) SetEngagementArn(v string) *StartEngagementOutput

SetEngagementArn sets the EngagementArn field's value.

func (StartEngagementOutput) String

func (s StartEngagementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopEngagementInput

type StopEngagementInput struct {

    // The Amazon Resource Name (ARN) of the engagement.
    //
    // EngagementId is a required field
    EngagementId *string `min:"1" type:"string" required:"true"`

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

func (StopEngagementInput) GoString

func (s StopEngagementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopEngagementInput) SetEngagementId

func (s *StopEngagementInput) SetEngagementId(v string) *StopEngagementInput

SetEngagementId sets the EngagementId field's value.

func (*StopEngagementInput) SetReason

func (s *StopEngagementInput) SetReason(v string) *StopEngagementInput

SetReason sets the Reason field's value.

func (StopEngagementInput) String

func (s StopEngagementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopEngagementInput) Validate

func (s *StopEngagementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopEngagementOutput

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

func (StopEngagementOutput) GoString

func (s StopEngagementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopEngagementOutput) String

func (s StopEngagementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

    // Name of the object key.
    Key *string `min:"1" type:"string"`

    // Value of the tag.
    Value *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

A container of a key-value name pair.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

    // The Amazon Resource Name (ARN) of the contact or escalation plan.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`

    // A list of tags that you are adding to the contact or escalation plan.
    //
    // Tags is a required field
    Tags []*Tag `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Target

type Target struct {

    // Information about the contact channel Incident Manager is engaging.
    ChannelTargetInfo *ChannelTargetInfo `type:"structure"`

    // Information about the contact that Incident Manager is engaging.
    ContactTargetInfo *ContactTargetInfo `type:"structure"`
    // contains filtered or unexported fields
}

The contact or contact channel that's being engaged.

func (Target) GoString

func (s Target) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Target) SetChannelTargetInfo

func (s *Target) SetChannelTargetInfo(v *ChannelTargetInfo) *Target

SetChannelTargetInfo sets the ChannelTargetInfo field's value.

func (*Target) SetContactTargetInfo

func (s *Target) SetContactTargetInfo(v *ContactTargetInfo) *Target

SetContactTargetInfo sets the ContactTargetInfo field's value.

func (Target) String

func (s Target) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Target) Validate

func (s *Target) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ThrottlingException

type ThrottlingException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`

    // Service Quotas requirement to identify originating service
    QuotaCode *string `type:"string"`

    // Advice to clients on when the call can be safely retried
    RetryAfterSeconds *int64 `type:"integer"`

    // Service Quotas requirement to identify originating quota
    ServiceCode *string `type:"string"`
    // contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeRange

type TimeRange struct {

    // The end of the time range.
    EndTime *time.Time `type:"timestamp"`

    // The start of the time range.
    StartTime *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

A range of between two set times

func (TimeRange) GoString

func (s TimeRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeRange) SetEndTime

func (s *TimeRange) SetEndTime(v time.Time) *TimeRange

SetEndTime sets the EndTime field's value.

func (*TimeRange) SetStartTime

func (s *TimeRange) SetStartTime(v time.Time) *TimeRange

SetStartTime sets the StartTime field's value.

func (TimeRange) String

func (s TimeRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

    // The Amazon Resource Name (ARN) of the contact or escalation plan.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`

    // The key of the tag that you want to remove.
    //
    // TagKeys is a required field
    TagKeys []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateContactChannelInput

type UpdateContactChannelInput struct {

    // The Amazon Resource Name (ARN) of the contact channel you want to update.
    //
    // ContactChannelId is a required field
    ContactChannelId *string `min:"1" type:"string" required:"true"`

    // The details that Incident Manager uses when trying to engage the contact
    // channel.
    DeliveryAddress *ContactChannelAddress `type:"structure"`

    // The name of the contact channel.
    Name *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (UpdateContactChannelInput) GoString

func (s UpdateContactChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContactChannelInput) SetContactChannelId

func (s *UpdateContactChannelInput) SetContactChannelId(v string) *UpdateContactChannelInput

SetContactChannelId sets the ContactChannelId field's value.

func (*UpdateContactChannelInput) SetDeliveryAddress

func (s *UpdateContactChannelInput) SetDeliveryAddress(v *ContactChannelAddress) *UpdateContactChannelInput

SetDeliveryAddress sets the DeliveryAddress field's value.

func (*UpdateContactChannelInput) SetName

func (s *UpdateContactChannelInput) SetName(v string) *UpdateContactChannelInput

SetName sets the Name field's value.

func (UpdateContactChannelInput) String

func (s UpdateContactChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContactChannelInput) Validate

func (s *UpdateContactChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateContactChannelOutput

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

func (UpdateContactChannelOutput) GoString

func (s UpdateContactChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateContactChannelOutput) String

func (s UpdateContactChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateContactInput

type UpdateContactInput struct {

    // The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
    //
    // ContactId is a required field
    ContactId *string `min:"1" type:"string" required:"true"`

    // The full name of the contact or escalation plan.
    DisplayName *string `type:"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 *Plan `type:"structure"`
    // contains filtered or unexported fields
}

func (UpdateContactInput) GoString

func (s UpdateContactInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContactInput) SetContactId

func (s *UpdateContactInput) SetContactId(v string) *UpdateContactInput

SetContactId sets the ContactId field's value.

func (*UpdateContactInput) SetDisplayName

func (s *UpdateContactInput) SetDisplayName(v string) *UpdateContactInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateContactInput) SetPlan

func (s *UpdateContactInput) SetPlan(v *Plan) *UpdateContactInput

SetPlan sets the Plan field's value.

func (UpdateContactInput) String

func (s UpdateContactInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContactInput) Validate

func (s *UpdateContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateContactOutput

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

func (UpdateContactOutput) GoString

func (s UpdateContactOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateContactOutput) String

func (s UpdateContactOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // The fields that caused the error
    Fields []*ValidationExceptionField `type:"list"`

    Message_ *string `locationName:"Message" type:"string"`

    // Reason the request failed validation
    Reason *string `type:"string" enum:"ValidationExceptionReason"`
    // contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField

type ValidationExceptionField struct {

    // Information about what caused the field to cause an exception.
    //
    // Message is a required field
    Message *string `type:"string" required:"true"`

    // The name of the field that caused the exception.
    //
    // Name is a required field
    Name *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides information about which field caused the exception.

func (ValidationExceptionField) GoString

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".