Documentation ¶
Overview ¶
Package sns provides the client and types for making API requests to Amazon Simple Notification Service.
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page (http://aws.amazon.com/sns/). For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/).
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS (https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html) in the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/).
See https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31 for more information on this service.
See sns package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sns/
Using the Client ¶
To contact Amazon Simple Notification Service 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 Amazon Simple Notification Service client SNS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sns/#New
Index ¶
- Constants
- func LanguageCodeString_Values() []string
- func NumberCapability_Values() []string
- func RouteType_Values() []string
- func SMSSandboxPhoneNumberVerificationStatus_Values() []string
- type AddPermissionInput
- func (s AddPermissionInput) GoString() string
- func (s *AddPermissionInput) SetAWSAccountId(v []*string) *AddPermissionInput
- func (s *AddPermissionInput) SetActionName(v []*string) *AddPermissionInput
- func (s *AddPermissionInput) SetLabel(v string) *AddPermissionInput
- func (s *AddPermissionInput) SetTopicArn(v string) *AddPermissionInput
- func (s AddPermissionInput) String() string
- func (s *AddPermissionInput) Validate() error
- type AddPermissionOutput
- type BatchResultErrorEntry
- func (s BatchResultErrorEntry) GoString() string
- func (s *BatchResultErrorEntry) SetCode(v string) *BatchResultErrorEntry
- func (s *BatchResultErrorEntry) SetId(v string) *BatchResultErrorEntry
- func (s *BatchResultErrorEntry) SetMessage(v string) *BatchResultErrorEntry
- func (s *BatchResultErrorEntry) SetSenderFault(v bool) *BatchResultErrorEntry
- func (s BatchResultErrorEntry) String() string
- type CheckIfPhoneNumberIsOptedOutInput
- type CheckIfPhoneNumberIsOptedOutOutput
- type ConfirmSubscriptionInput
- func (s ConfirmSubscriptionInput) GoString() string
- func (s *ConfirmSubscriptionInput) SetAuthenticateOnUnsubscribe(v string) *ConfirmSubscriptionInput
- func (s *ConfirmSubscriptionInput) SetToken(v string) *ConfirmSubscriptionInput
- func (s *ConfirmSubscriptionInput) SetTopicArn(v string) *ConfirmSubscriptionInput
- func (s ConfirmSubscriptionInput) String() string
- func (s *ConfirmSubscriptionInput) Validate() error
- type ConfirmSubscriptionOutput
- type CreatePlatformApplicationInput
- func (s CreatePlatformApplicationInput) GoString() string
- func (s *CreatePlatformApplicationInput) SetAttributes(v map[string]*string) *CreatePlatformApplicationInput
- func (s *CreatePlatformApplicationInput) SetName(v string) *CreatePlatformApplicationInput
- func (s *CreatePlatformApplicationInput) SetPlatform(v string) *CreatePlatformApplicationInput
- func (s CreatePlatformApplicationInput) String() string
- func (s *CreatePlatformApplicationInput) Validate() error
- type CreatePlatformApplicationOutput
- type CreatePlatformEndpointInput
- func (s CreatePlatformEndpointInput) GoString() string
- func (s *CreatePlatformEndpointInput) SetAttributes(v map[string]*string) *CreatePlatformEndpointInput
- func (s *CreatePlatformEndpointInput) SetCustomUserData(v string) *CreatePlatformEndpointInput
- func (s *CreatePlatformEndpointInput) SetPlatformApplicationArn(v string) *CreatePlatformEndpointInput
- func (s *CreatePlatformEndpointInput) SetToken(v string) *CreatePlatformEndpointInput
- func (s CreatePlatformEndpointInput) String() string
- func (s *CreatePlatformEndpointInput) Validate() error
- type CreatePlatformEndpointOutput
- type CreateSMSSandboxPhoneNumberInput
- func (s CreateSMSSandboxPhoneNumberInput) GoString() string
- func (s *CreateSMSSandboxPhoneNumberInput) SetLanguageCode(v string) *CreateSMSSandboxPhoneNumberInput
- func (s *CreateSMSSandboxPhoneNumberInput) SetPhoneNumber(v string) *CreateSMSSandboxPhoneNumberInput
- func (s CreateSMSSandboxPhoneNumberInput) String() string
- func (s *CreateSMSSandboxPhoneNumberInput) Validate() error
- type CreateSMSSandboxPhoneNumberOutput
- type CreateTopicInput
- func (s CreateTopicInput) GoString() string
- func (s *CreateTopicInput) SetAttributes(v map[string]*string) *CreateTopicInput
- func (s *CreateTopicInput) SetDataProtectionPolicy(v string) *CreateTopicInput
- func (s *CreateTopicInput) SetName(v string) *CreateTopicInput
- func (s *CreateTopicInput) SetTags(v []*Tag) *CreateTopicInput
- func (s CreateTopicInput) String() string
- func (s *CreateTopicInput) Validate() error
- type CreateTopicOutput
- type DeleteEndpointInput
- type DeleteEndpointOutput
- type DeletePlatformApplicationInput
- type DeletePlatformApplicationOutput
- type DeleteSMSSandboxPhoneNumberInput
- type DeleteSMSSandboxPhoneNumberOutput
- type DeleteTopicInput
- type DeleteTopicOutput
- type Endpoint
- type GetDataProtectionPolicyInput
- type GetDataProtectionPolicyOutput
- type GetEndpointAttributesInput
- type GetEndpointAttributesOutput
- type GetPlatformApplicationAttributesInput
- func (s GetPlatformApplicationAttributesInput) GoString() string
- func (s *GetPlatformApplicationAttributesInput) SetPlatformApplicationArn(v string) *GetPlatformApplicationAttributesInput
- func (s GetPlatformApplicationAttributesInput) String() string
- func (s *GetPlatformApplicationAttributesInput) Validate() error
- type GetPlatformApplicationAttributesOutput
- type GetSMSAttributesInput
- type GetSMSAttributesOutput
- type GetSMSSandboxAccountStatusInput
- type GetSMSSandboxAccountStatusOutput
- type GetSubscriptionAttributesInput
- type GetSubscriptionAttributesOutput
- type GetTopicAttributesInput
- type GetTopicAttributesOutput
- type ListEndpointsByPlatformApplicationInput
- func (s ListEndpointsByPlatformApplicationInput) GoString() string
- func (s *ListEndpointsByPlatformApplicationInput) SetNextToken(v string) *ListEndpointsByPlatformApplicationInput
- func (s *ListEndpointsByPlatformApplicationInput) SetPlatformApplicationArn(v string) *ListEndpointsByPlatformApplicationInput
- func (s ListEndpointsByPlatformApplicationInput) String() string
- func (s *ListEndpointsByPlatformApplicationInput) Validate() error
- type ListEndpointsByPlatformApplicationOutput
- func (s ListEndpointsByPlatformApplicationOutput) GoString() string
- func (s *ListEndpointsByPlatformApplicationOutput) SetEndpoints(v []*Endpoint) *ListEndpointsByPlatformApplicationOutput
- func (s *ListEndpointsByPlatformApplicationOutput) SetNextToken(v string) *ListEndpointsByPlatformApplicationOutput
- func (s ListEndpointsByPlatformApplicationOutput) String() string
- type ListOriginationNumbersInput
- func (s ListOriginationNumbersInput) GoString() string
- func (s *ListOriginationNumbersInput) SetMaxResults(v int64) *ListOriginationNumbersInput
- func (s *ListOriginationNumbersInput) SetNextToken(v string) *ListOriginationNumbersInput
- func (s ListOriginationNumbersInput) String() string
- func (s *ListOriginationNumbersInput) Validate() error
- type ListOriginationNumbersOutput
- func (s ListOriginationNumbersOutput) GoString() string
- func (s *ListOriginationNumbersOutput) SetNextToken(v string) *ListOriginationNumbersOutput
- func (s *ListOriginationNumbersOutput) SetPhoneNumbers(v []*PhoneNumberInformation) *ListOriginationNumbersOutput
- func (s ListOriginationNumbersOutput) String() string
- type ListPhoneNumbersOptedOutInput
- type ListPhoneNumbersOptedOutOutput
- func (s ListPhoneNumbersOptedOutOutput) GoString() string
- func (s *ListPhoneNumbersOptedOutOutput) SetNextToken(v string) *ListPhoneNumbersOptedOutOutput
- func (s *ListPhoneNumbersOptedOutOutput) SetPhoneNumbers(v []*string) *ListPhoneNumbersOptedOutOutput
- func (s ListPhoneNumbersOptedOutOutput) String() string
- type ListPlatformApplicationsInput
- type ListPlatformApplicationsOutput
- func (s ListPlatformApplicationsOutput) GoString() string
- func (s *ListPlatformApplicationsOutput) SetNextToken(v string) *ListPlatformApplicationsOutput
- func (s *ListPlatformApplicationsOutput) SetPlatformApplications(v []*PlatformApplication) *ListPlatformApplicationsOutput
- func (s ListPlatformApplicationsOutput) String() string
- type ListSMSSandboxPhoneNumbersInput
- func (s ListSMSSandboxPhoneNumbersInput) GoString() string
- func (s *ListSMSSandboxPhoneNumbersInput) SetMaxResults(v int64) *ListSMSSandboxPhoneNumbersInput
- func (s *ListSMSSandboxPhoneNumbersInput) SetNextToken(v string) *ListSMSSandboxPhoneNumbersInput
- func (s ListSMSSandboxPhoneNumbersInput) String() string
- func (s *ListSMSSandboxPhoneNumbersInput) Validate() error
- type ListSMSSandboxPhoneNumbersOutput
- func (s ListSMSSandboxPhoneNumbersOutput) GoString() string
- func (s *ListSMSSandboxPhoneNumbersOutput) SetNextToken(v string) *ListSMSSandboxPhoneNumbersOutput
- func (s *ListSMSSandboxPhoneNumbersOutput) SetPhoneNumbers(v []*SMSSandboxPhoneNumber) *ListSMSSandboxPhoneNumbersOutput
- func (s ListSMSSandboxPhoneNumbersOutput) String() string
- type ListSubscriptionsByTopicInput
- func (s ListSubscriptionsByTopicInput) GoString() string
- func (s *ListSubscriptionsByTopicInput) SetNextToken(v string) *ListSubscriptionsByTopicInput
- func (s *ListSubscriptionsByTopicInput) SetTopicArn(v string) *ListSubscriptionsByTopicInput
- func (s ListSubscriptionsByTopicInput) String() string
- func (s *ListSubscriptionsByTopicInput) Validate() error
- type ListSubscriptionsByTopicOutput
- func (s ListSubscriptionsByTopicOutput) GoString() string
- func (s *ListSubscriptionsByTopicOutput) SetNextToken(v string) *ListSubscriptionsByTopicOutput
- func (s *ListSubscriptionsByTopicOutput) SetSubscriptions(v []*Subscription) *ListSubscriptionsByTopicOutput
- func (s ListSubscriptionsByTopicOutput) String() string
- type ListSubscriptionsInput
- type ListSubscriptionsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTopicsInput
- type ListTopicsOutput
- type MessageAttributeValue
- func (s MessageAttributeValue) GoString() string
- func (s *MessageAttributeValue) SetBinaryValue(v []byte) *MessageAttributeValue
- func (s *MessageAttributeValue) SetDataType(v string) *MessageAttributeValue
- func (s *MessageAttributeValue) SetStringValue(v string) *MessageAttributeValue
- func (s MessageAttributeValue) String() string
- func (s *MessageAttributeValue) Validate() error
- type OptInPhoneNumberInput
- type OptInPhoneNumberOutput
- type PhoneNumberInformation
- func (s PhoneNumberInformation) GoString() string
- func (s *PhoneNumberInformation) SetCreatedAt(v time.Time) *PhoneNumberInformation
- func (s *PhoneNumberInformation) SetIso2CountryCode(v string) *PhoneNumberInformation
- func (s *PhoneNumberInformation) SetNumberCapabilities(v []*string) *PhoneNumberInformation
- func (s *PhoneNumberInformation) SetPhoneNumber(v string) *PhoneNumberInformation
- func (s *PhoneNumberInformation) SetRouteType(v string) *PhoneNumberInformation
- func (s *PhoneNumberInformation) SetStatus(v string) *PhoneNumberInformation
- func (s PhoneNumberInformation) String() string
- type PlatformApplication
- type PublishBatchInput
- func (s PublishBatchInput) GoString() string
- func (s *PublishBatchInput) SetPublishBatchRequestEntries(v []*PublishBatchRequestEntry) *PublishBatchInput
- func (s *PublishBatchInput) SetTopicArn(v string) *PublishBatchInput
- func (s PublishBatchInput) String() string
- func (s *PublishBatchInput) Validate() error
- type PublishBatchOutput
- type PublishBatchRequestEntry
- func (s PublishBatchRequestEntry) GoString() string
- func (s *PublishBatchRequestEntry) SetId(v string) *PublishBatchRequestEntry
- func (s *PublishBatchRequestEntry) SetMessage(v string) *PublishBatchRequestEntry
- func (s *PublishBatchRequestEntry) SetMessageAttributes(v map[string]*MessageAttributeValue) *PublishBatchRequestEntry
- func (s *PublishBatchRequestEntry) SetMessageDeduplicationId(v string) *PublishBatchRequestEntry
- func (s *PublishBatchRequestEntry) SetMessageGroupId(v string) *PublishBatchRequestEntry
- func (s *PublishBatchRequestEntry) SetMessageStructure(v string) *PublishBatchRequestEntry
- func (s *PublishBatchRequestEntry) SetSubject(v string) *PublishBatchRequestEntry
- func (s PublishBatchRequestEntry) String() string
- func (s *PublishBatchRequestEntry) Validate() error
- type PublishBatchResultEntry
- func (s PublishBatchResultEntry) GoString() string
- func (s *PublishBatchResultEntry) SetId(v string) *PublishBatchResultEntry
- func (s *PublishBatchResultEntry) SetMessageId(v string) *PublishBatchResultEntry
- func (s *PublishBatchResultEntry) SetSequenceNumber(v string) *PublishBatchResultEntry
- func (s PublishBatchResultEntry) String() string
- type PublishInput
- func (s PublishInput) GoString() string
- func (s *PublishInput) SetMessage(v string) *PublishInput
- func (s *PublishInput) SetMessageAttributes(v map[string]*MessageAttributeValue) *PublishInput
- func (s *PublishInput) SetMessageDeduplicationId(v string) *PublishInput
- func (s *PublishInput) SetMessageGroupId(v string) *PublishInput
- func (s *PublishInput) SetMessageStructure(v string) *PublishInput
- func (s *PublishInput) SetPhoneNumber(v string) *PublishInput
- func (s *PublishInput) SetSubject(v string) *PublishInput
- func (s *PublishInput) SetTargetArn(v string) *PublishInput
- func (s *PublishInput) SetTopicArn(v string) *PublishInput
- func (s PublishInput) String() string
- func (s *PublishInput) Validate() error
- type PublishOutput
- type PutDataProtectionPolicyInput
- func (s PutDataProtectionPolicyInput) GoString() string
- func (s *PutDataProtectionPolicyInput) SetDataProtectionPolicy(v string) *PutDataProtectionPolicyInput
- func (s *PutDataProtectionPolicyInput) SetResourceArn(v string) *PutDataProtectionPolicyInput
- func (s PutDataProtectionPolicyInput) String() string
- func (s *PutDataProtectionPolicyInput) Validate() error
- type PutDataProtectionPolicyOutput
- type RemovePermissionInput
- type RemovePermissionOutput
- type SMSSandboxPhoneNumber
- type SNS
- func (c *SNS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error)
- func (c *SNS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)
- func (c *SNS) AddPermissionWithContext(ctx aws.Context, input *AddPermissionInput, opts ...request.Option) (*AddPermissionOutput, error)
- func (c *SNS) CheckIfPhoneNumberIsOptedOut(input *CheckIfPhoneNumberIsOptedOutInput) (*CheckIfPhoneNumberIsOptedOutOutput, error)
- func (c *SNS) CheckIfPhoneNumberIsOptedOutRequest(input *CheckIfPhoneNumberIsOptedOutInput) (req *request.Request, output *CheckIfPhoneNumberIsOptedOutOutput)
- func (c *SNS) CheckIfPhoneNumberIsOptedOutWithContext(ctx aws.Context, input *CheckIfPhoneNumberIsOptedOutInput, ...) (*CheckIfPhoneNumberIsOptedOutOutput, error)
- func (c *SNS) ConfirmSubscription(input *ConfirmSubscriptionInput) (*ConfirmSubscriptionOutput, error)
- func (c *SNS) ConfirmSubscriptionRequest(input *ConfirmSubscriptionInput) (req *request.Request, output *ConfirmSubscriptionOutput)
- func (c *SNS) ConfirmSubscriptionWithContext(ctx aws.Context, input *ConfirmSubscriptionInput, opts ...request.Option) (*ConfirmSubscriptionOutput, error)
- func (c *SNS) CreatePlatformApplication(input *CreatePlatformApplicationInput) (*CreatePlatformApplicationOutput, error)
- func (c *SNS) CreatePlatformApplicationRequest(input *CreatePlatformApplicationInput) (req *request.Request, output *CreatePlatformApplicationOutput)
- func (c *SNS) CreatePlatformApplicationWithContext(ctx aws.Context, input *CreatePlatformApplicationInput, opts ...request.Option) (*CreatePlatformApplicationOutput, error)
- func (c *SNS) CreatePlatformEndpoint(input *CreatePlatformEndpointInput) (*CreatePlatformEndpointOutput, error)
- func (c *SNS) CreatePlatformEndpointRequest(input *CreatePlatformEndpointInput) (req *request.Request, output *CreatePlatformEndpointOutput)
- func (c *SNS) CreatePlatformEndpointWithContext(ctx aws.Context, input *CreatePlatformEndpointInput, opts ...request.Option) (*CreatePlatformEndpointOutput, error)
- func (c *SNS) CreateSMSSandboxPhoneNumber(input *CreateSMSSandboxPhoneNumberInput) (*CreateSMSSandboxPhoneNumberOutput, error)
- func (c *SNS) CreateSMSSandboxPhoneNumberRequest(input *CreateSMSSandboxPhoneNumberInput) (req *request.Request, output *CreateSMSSandboxPhoneNumberOutput)
- func (c *SNS) CreateSMSSandboxPhoneNumberWithContext(ctx aws.Context, input *CreateSMSSandboxPhoneNumberInput, ...) (*CreateSMSSandboxPhoneNumberOutput, error)
- func (c *SNS) CreateTopic(input *CreateTopicInput) (*CreateTopicOutput, error)
- func (c *SNS) CreateTopicRequest(input *CreateTopicInput) (req *request.Request, output *CreateTopicOutput)
- func (c *SNS) CreateTopicWithContext(ctx aws.Context, input *CreateTopicInput, opts ...request.Option) (*CreateTopicOutput, error)
- func (c *SNS) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
- func (c *SNS) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
- func (c *SNS) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)
- func (c *SNS) DeletePlatformApplication(input *DeletePlatformApplicationInput) (*DeletePlatformApplicationOutput, error)
- func (c *SNS) DeletePlatformApplicationRequest(input *DeletePlatformApplicationInput) (req *request.Request, output *DeletePlatformApplicationOutput)
- func (c *SNS) DeletePlatformApplicationWithContext(ctx aws.Context, input *DeletePlatformApplicationInput, opts ...request.Option) (*DeletePlatformApplicationOutput, error)
- func (c *SNS) DeleteSMSSandboxPhoneNumber(input *DeleteSMSSandboxPhoneNumberInput) (*DeleteSMSSandboxPhoneNumberOutput, error)
- func (c *SNS) DeleteSMSSandboxPhoneNumberRequest(input *DeleteSMSSandboxPhoneNumberInput) (req *request.Request, output *DeleteSMSSandboxPhoneNumberOutput)
- func (c *SNS) DeleteSMSSandboxPhoneNumberWithContext(ctx aws.Context, input *DeleteSMSSandboxPhoneNumberInput, ...) (*DeleteSMSSandboxPhoneNumberOutput, error)
- func (c *SNS) DeleteTopic(input *DeleteTopicInput) (*DeleteTopicOutput, error)
- func (c *SNS) DeleteTopicRequest(input *DeleteTopicInput) (req *request.Request, output *DeleteTopicOutput)
- func (c *SNS) DeleteTopicWithContext(ctx aws.Context, input *DeleteTopicInput, opts ...request.Option) (*DeleteTopicOutput, error)
- func (c *SNS) GetDataProtectionPolicy(input *GetDataProtectionPolicyInput) (*GetDataProtectionPolicyOutput, error)
- func (c *SNS) GetDataProtectionPolicyRequest(input *GetDataProtectionPolicyInput) (req *request.Request, output *GetDataProtectionPolicyOutput)
- func (c *SNS) GetDataProtectionPolicyWithContext(ctx aws.Context, input *GetDataProtectionPolicyInput, opts ...request.Option) (*GetDataProtectionPolicyOutput, error)
- func (c *SNS) GetEndpointAttributes(input *GetEndpointAttributesInput) (*GetEndpointAttributesOutput, error)
- func (c *SNS) GetEndpointAttributesRequest(input *GetEndpointAttributesInput) (req *request.Request, output *GetEndpointAttributesOutput)
- func (c *SNS) GetEndpointAttributesWithContext(ctx aws.Context, input *GetEndpointAttributesInput, opts ...request.Option) (*GetEndpointAttributesOutput, error)
- func (c *SNS) GetPlatformApplicationAttributes(input *GetPlatformApplicationAttributesInput) (*GetPlatformApplicationAttributesOutput, error)
- func (c *SNS) GetPlatformApplicationAttributesRequest(input *GetPlatformApplicationAttributesInput) (req *request.Request, output *GetPlatformApplicationAttributesOutput)
- func (c *SNS) GetPlatformApplicationAttributesWithContext(ctx aws.Context, input *GetPlatformApplicationAttributesInput, ...) (*GetPlatformApplicationAttributesOutput, error)
- func (c *SNS) GetSMSAttributes(input *GetSMSAttributesInput) (*GetSMSAttributesOutput, error)
- func (c *SNS) GetSMSAttributesRequest(input *GetSMSAttributesInput) (req *request.Request, output *GetSMSAttributesOutput)
- func (c *SNS) GetSMSAttributesWithContext(ctx aws.Context, input *GetSMSAttributesInput, opts ...request.Option) (*GetSMSAttributesOutput, error)
- func (c *SNS) GetSMSSandboxAccountStatus(input *GetSMSSandboxAccountStatusInput) (*GetSMSSandboxAccountStatusOutput, error)
- func (c *SNS) GetSMSSandboxAccountStatusRequest(input *GetSMSSandboxAccountStatusInput) (req *request.Request, output *GetSMSSandboxAccountStatusOutput)
- func (c *SNS) GetSMSSandboxAccountStatusWithContext(ctx aws.Context, input *GetSMSSandboxAccountStatusInput, ...) (*GetSMSSandboxAccountStatusOutput, error)
- func (c *SNS) GetSubscriptionAttributes(input *GetSubscriptionAttributesInput) (*GetSubscriptionAttributesOutput, error)
- func (c *SNS) GetSubscriptionAttributesRequest(input *GetSubscriptionAttributesInput) (req *request.Request, output *GetSubscriptionAttributesOutput)
- func (c *SNS) GetSubscriptionAttributesWithContext(ctx aws.Context, input *GetSubscriptionAttributesInput, opts ...request.Option) (*GetSubscriptionAttributesOutput, error)
- func (c *SNS) GetTopicAttributes(input *GetTopicAttributesInput) (*GetTopicAttributesOutput, error)
- func (c *SNS) GetTopicAttributesRequest(input *GetTopicAttributesInput) (req *request.Request, output *GetTopicAttributesOutput)
- func (c *SNS) GetTopicAttributesWithContext(ctx aws.Context, input *GetTopicAttributesInput, opts ...request.Option) (*GetTopicAttributesOutput, error)
- func (c *SNS) ListEndpointsByPlatformApplication(input *ListEndpointsByPlatformApplicationInput) (*ListEndpointsByPlatformApplicationOutput, error)
- func (c *SNS) ListEndpointsByPlatformApplicationPages(input *ListEndpointsByPlatformApplicationInput, ...) error
- func (c *SNS) ListEndpointsByPlatformApplicationPagesWithContext(ctx aws.Context, input *ListEndpointsByPlatformApplicationInput, ...) error
- func (c *SNS) ListEndpointsByPlatformApplicationRequest(input *ListEndpointsByPlatformApplicationInput) (req *request.Request, output *ListEndpointsByPlatformApplicationOutput)
- func (c *SNS) ListEndpointsByPlatformApplicationWithContext(ctx aws.Context, input *ListEndpointsByPlatformApplicationInput, ...) (*ListEndpointsByPlatformApplicationOutput, error)
- func (c *SNS) ListOriginationNumbers(input *ListOriginationNumbersInput) (*ListOriginationNumbersOutput, error)
- func (c *SNS) ListOriginationNumbersPages(input *ListOriginationNumbersInput, ...) error
- func (c *SNS) ListOriginationNumbersPagesWithContext(ctx aws.Context, input *ListOriginationNumbersInput, ...) error
- func (c *SNS) ListOriginationNumbersRequest(input *ListOriginationNumbersInput) (req *request.Request, output *ListOriginationNumbersOutput)
- func (c *SNS) ListOriginationNumbersWithContext(ctx aws.Context, input *ListOriginationNumbersInput, opts ...request.Option) (*ListOriginationNumbersOutput, error)
- func (c *SNS) ListPhoneNumbersOptedOut(input *ListPhoneNumbersOptedOutInput) (*ListPhoneNumbersOptedOutOutput, error)
- func (c *SNS) ListPhoneNumbersOptedOutPages(input *ListPhoneNumbersOptedOutInput, ...) error
- func (c *SNS) ListPhoneNumbersOptedOutPagesWithContext(ctx aws.Context, input *ListPhoneNumbersOptedOutInput, ...) error
- func (c *SNS) ListPhoneNumbersOptedOutRequest(input *ListPhoneNumbersOptedOutInput) (req *request.Request, output *ListPhoneNumbersOptedOutOutput)
- func (c *SNS) ListPhoneNumbersOptedOutWithContext(ctx aws.Context, input *ListPhoneNumbersOptedOutInput, opts ...request.Option) (*ListPhoneNumbersOptedOutOutput, error)
- func (c *SNS) ListPlatformApplications(input *ListPlatformApplicationsInput) (*ListPlatformApplicationsOutput, error)
- func (c *SNS) ListPlatformApplicationsPages(input *ListPlatformApplicationsInput, ...) error
- func (c *SNS) ListPlatformApplicationsPagesWithContext(ctx aws.Context, input *ListPlatformApplicationsInput, ...) error
- func (c *SNS) ListPlatformApplicationsRequest(input *ListPlatformApplicationsInput) (req *request.Request, output *ListPlatformApplicationsOutput)
- func (c *SNS) ListPlatformApplicationsWithContext(ctx aws.Context, input *ListPlatformApplicationsInput, opts ...request.Option) (*ListPlatformApplicationsOutput, error)
- func (c *SNS) ListSMSSandboxPhoneNumbers(input *ListSMSSandboxPhoneNumbersInput) (*ListSMSSandboxPhoneNumbersOutput, error)
- func (c *SNS) ListSMSSandboxPhoneNumbersPages(input *ListSMSSandboxPhoneNumbersInput, ...) error
- func (c *SNS) ListSMSSandboxPhoneNumbersPagesWithContext(ctx aws.Context, input *ListSMSSandboxPhoneNumbersInput, ...) error
- func (c *SNS) ListSMSSandboxPhoneNumbersRequest(input *ListSMSSandboxPhoneNumbersInput) (req *request.Request, output *ListSMSSandboxPhoneNumbersOutput)
- func (c *SNS) ListSMSSandboxPhoneNumbersWithContext(ctx aws.Context, input *ListSMSSandboxPhoneNumbersInput, ...) (*ListSMSSandboxPhoneNumbersOutput, error)
- func (c *SNS) ListSubscriptions(input *ListSubscriptionsInput) (*ListSubscriptionsOutput, error)
- func (c *SNS) ListSubscriptionsByTopic(input *ListSubscriptionsByTopicInput) (*ListSubscriptionsByTopicOutput, error)
- func (c *SNS) ListSubscriptionsByTopicPages(input *ListSubscriptionsByTopicInput, ...) error
- func (c *SNS) ListSubscriptionsByTopicPagesWithContext(ctx aws.Context, input *ListSubscriptionsByTopicInput, ...) error
- func (c *SNS) ListSubscriptionsByTopicRequest(input *ListSubscriptionsByTopicInput) (req *request.Request, output *ListSubscriptionsByTopicOutput)
- func (c *SNS) ListSubscriptionsByTopicWithContext(ctx aws.Context, input *ListSubscriptionsByTopicInput, opts ...request.Option) (*ListSubscriptionsByTopicOutput, error)
- func (c *SNS) ListSubscriptionsPages(input *ListSubscriptionsInput, fn func(*ListSubscriptionsOutput, bool) bool) error
- func (c *SNS) ListSubscriptionsPagesWithContext(ctx aws.Context, input *ListSubscriptionsInput, ...) error
- func (c *SNS) ListSubscriptionsRequest(input *ListSubscriptionsInput) (req *request.Request, output *ListSubscriptionsOutput)
- func (c *SNS) ListSubscriptionsWithContext(ctx aws.Context, input *ListSubscriptionsInput, opts ...request.Option) (*ListSubscriptionsOutput, error)
- func (c *SNS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *SNS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *SNS) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
- func (c *SNS) ListTopics(input *ListTopicsInput) (*ListTopicsOutput, error)
- func (c *SNS) ListTopicsPages(input *ListTopicsInput, fn func(*ListTopicsOutput, bool) bool) error
- func (c *SNS) ListTopicsPagesWithContext(ctx aws.Context, input *ListTopicsInput, fn func(*ListTopicsOutput, bool) bool, ...) error
- func (c *SNS) ListTopicsRequest(input *ListTopicsInput) (req *request.Request, output *ListTopicsOutput)
- func (c *SNS) ListTopicsWithContext(ctx aws.Context, input *ListTopicsInput, opts ...request.Option) (*ListTopicsOutput, error)
- func (c *SNS) OptInPhoneNumber(input *OptInPhoneNumberInput) (*OptInPhoneNumberOutput, error)
- func (c *SNS) OptInPhoneNumberRequest(input *OptInPhoneNumberInput) (req *request.Request, output *OptInPhoneNumberOutput)
- func (c *SNS) OptInPhoneNumberWithContext(ctx aws.Context, input *OptInPhoneNumberInput, opts ...request.Option) (*OptInPhoneNumberOutput, error)
- func (c *SNS) Publish(input *PublishInput) (*PublishOutput, error)
- func (c *SNS) PublishBatch(input *PublishBatchInput) (*PublishBatchOutput, error)
- func (c *SNS) PublishBatchRequest(input *PublishBatchInput) (req *request.Request, output *PublishBatchOutput)
- func (c *SNS) PublishBatchWithContext(ctx aws.Context, input *PublishBatchInput, opts ...request.Option) (*PublishBatchOutput, error)
- func (c *SNS) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput)
- func (c *SNS) PublishWithContext(ctx aws.Context, input *PublishInput, opts ...request.Option) (*PublishOutput, error)
- func (c *SNS) PutDataProtectionPolicy(input *PutDataProtectionPolicyInput) (*PutDataProtectionPolicyOutput, error)
- func (c *SNS) PutDataProtectionPolicyRequest(input *PutDataProtectionPolicyInput) (req *request.Request, output *PutDataProtectionPolicyOutput)
- func (c *SNS) PutDataProtectionPolicyWithContext(ctx aws.Context, input *PutDataProtectionPolicyInput, opts ...request.Option) (*PutDataProtectionPolicyOutput, error)
- func (c *SNS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)
- func (c *SNS) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)
- func (c *SNS) RemovePermissionWithContext(ctx aws.Context, input *RemovePermissionInput, opts ...request.Option) (*RemovePermissionOutput, error)
- func (c *SNS) SetEndpointAttributes(input *SetEndpointAttributesInput) (*SetEndpointAttributesOutput, error)
- func (c *SNS) SetEndpointAttributesRequest(input *SetEndpointAttributesInput) (req *request.Request, output *SetEndpointAttributesOutput)
- func (c *SNS) SetEndpointAttributesWithContext(ctx aws.Context, input *SetEndpointAttributesInput, opts ...request.Option) (*SetEndpointAttributesOutput, error)
- func (c *SNS) SetPlatformApplicationAttributes(input *SetPlatformApplicationAttributesInput) (*SetPlatformApplicationAttributesOutput, error)
- func (c *SNS) SetPlatformApplicationAttributesRequest(input *SetPlatformApplicationAttributesInput) (req *request.Request, output *SetPlatformApplicationAttributesOutput)
- func (c *SNS) SetPlatformApplicationAttributesWithContext(ctx aws.Context, input *SetPlatformApplicationAttributesInput, ...) (*SetPlatformApplicationAttributesOutput, error)
- func (c *SNS) SetSMSAttributes(input *SetSMSAttributesInput) (*SetSMSAttributesOutput, error)
- func (c *SNS) SetSMSAttributesRequest(input *SetSMSAttributesInput) (req *request.Request, output *SetSMSAttributesOutput)
- func (c *SNS) SetSMSAttributesWithContext(ctx aws.Context, input *SetSMSAttributesInput, opts ...request.Option) (*SetSMSAttributesOutput, error)
- func (c *SNS) SetSubscriptionAttributes(input *SetSubscriptionAttributesInput) (*SetSubscriptionAttributesOutput, error)
- func (c *SNS) SetSubscriptionAttributesRequest(input *SetSubscriptionAttributesInput) (req *request.Request, output *SetSubscriptionAttributesOutput)
- func (c *SNS) SetSubscriptionAttributesWithContext(ctx aws.Context, input *SetSubscriptionAttributesInput, opts ...request.Option) (*SetSubscriptionAttributesOutput, error)
- func (c *SNS) SetTopicAttributes(input *SetTopicAttributesInput) (*SetTopicAttributesOutput, error)
- func (c *SNS) SetTopicAttributesRequest(input *SetTopicAttributesInput) (req *request.Request, output *SetTopicAttributesOutput)
- func (c *SNS) SetTopicAttributesWithContext(ctx aws.Context, input *SetTopicAttributesInput, opts ...request.Option) (*SetTopicAttributesOutput, error)
- func (c *SNS) Subscribe(input *SubscribeInput) (*SubscribeOutput, error)
- func (c *SNS) SubscribeRequest(input *SubscribeInput) (req *request.Request, output *SubscribeOutput)
- func (c *SNS) SubscribeWithContext(ctx aws.Context, input *SubscribeInput, opts ...request.Option) (*SubscribeOutput, error)
- func (c *SNS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *SNS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *SNS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *SNS) Unsubscribe(input *UnsubscribeInput) (*UnsubscribeOutput, error)
- func (c *SNS) UnsubscribeRequest(input *UnsubscribeInput) (req *request.Request, output *UnsubscribeOutput)
- func (c *SNS) UnsubscribeWithContext(ctx aws.Context, input *UnsubscribeInput, opts ...request.Option) (*UnsubscribeOutput, error)
- func (c *SNS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *SNS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *SNS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- func (c *SNS) VerifySMSSandboxPhoneNumber(input *VerifySMSSandboxPhoneNumberInput) (*VerifySMSSandboxPhoneNumberOutput, error)
- func (c *SNS) VerifySMSSandboxPhoneNumberRequest(input *VerifySMSSandboxPhoneNumberInput) (req *request.Request, output *VerifySMSSandboxPhoneNumberOutput)
- func (c *SNS) VerifySMSSandboxPhoneNumberWithContext(ctx aws.Context, input *VerifySMSSandboxPhoneNumberInput, ...) (*VerifySMSSandboxPhoneNumberOutput, error)
- type SetEndpointAttributesInput
- func (s SetEndpointAttributesInput) GoString() string
- func (s *SetEndpointAttributesInput) SetAttributes(v map[string]*string) *SetEndpointAttributesInput
- func (s *SetEndpointAttributesInput) SetEndpointArn(v string) *SetEndpointAttributesInput
- func (s SetEndpointAttributesInput) String() string
- func (s *SetEndpointAttributesInput) Validate() error
- type SetEndpointAttributesOutput
- type SetPlatformApplicationAttributesInput
- func (s SetPlatformApplicationAttributesInput) GoString() string
- func (s *SetPlatformApplicationAttributesInput) SetAttributes(v map[string]*string) *SetPlatformApplicationAttributesInput
- func (s *SetPlatformApplicationAttributesInput) SetPlatformApplicationArn(v string) *SetPlatformApplicationAttributesInput
- func (s SetPlatformApplicationAttributesInput) String() string
- func (s *SetPlatformApplicationAttributesInput) Validate() error
- type SetPlatformApplicationAttributesOutput
- type SetSMSAttributesInput
- type SetSMSAttributesOutput
- type SetSubscriptionAttributesInput
- func (s SetSubscriptionAttributesInput) GoString() string
- func (s *SetSubscriptionAttributesInput) SetAttributeName(v string) *SetSubscriptionAttributesInput
- func (s *SetSubscriptionAttributesInput) SetAttributeValue(v string) *SetSubscriptionAttributesInput
- func (s *SetSubscriptionAttributesInput) SetSubscriptionArn(v string) *SetSubscriptionAttributesInput
- func (s SetSubscriptionAttributesInput) String() string
- func (s *SetSubscriptionAttributesInput) Validate() error
- type SetSubscriptionAttributesOutput
- type SetTopicAttributesInput
- func (s SetTopicAttributesInput) GoString() string
- func (s *SetTopicAttributesInput) SetAttributeName(v string) *SetTopicAttributesInput
- func (s *SetTopicAttributesInput) SetAttributeValue(v string) *SetTopicAttributesInput
- func (s *SetTopicAttributesInput) SetTopicArn(v string) *SetTopicAttributesInput
- func (s SetTopicAttributesInput) String() string
- func (s *SetTopicAttributesInput) Validate() error
- type SetTopicAttributesOutput
- type SubscribeInput
- func (s SubscribeInput) GoString() string
- func (s *SubscribeInput) SetAttributes(v map[string]*string) *SubscribeInput
- func (s *SubscribeInput) SetEndpoint(v string) *SubscribeInput
- func (s *SubscribeInput) SetProtocol(v string) *SubscribeInput
- func (s *SubscribeInput) SetReturnSubscriptionArn(v bool) *SubscribeInput
- func (s *SubscribeInput) SetTopicArn(v string) *SubscribeInput
- func (s SubscribeInput) String() string
- func (s *SubscribeInput) Validate() error
- type SubscribeOutput
- type Subscription
- func (s Subscription) GoString() string
- func (s *Subscription) SetEndpoint(v string) *Subscription
- func (s *Subscription) SetOwner(v string) *Subscription
- func (s *Subscription) SetProtocol(v string) *Subscription
- func (s *Subscription) SetSubscriptionArn(v string) *Subscription
- func (s *Subscription) SetTopicArn(v string) *Subscription
- func (s Subscription) String() string
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type Topic
- type UnsubscribeInput
- type UnsubscribeOutput
- type UntagResourceInput
- type UntagResourceOutput
- type VerifySMSSandboxPhoneNumberInput
- func (s VerifySMSSandboxPhoneNumberInput) GoString() string
- func (s *VerifySMSSandboxPhoneNumberInput) SetOneTimePassword(v string) *VerifySMSSandboxPhoneNumberInput
- func (s *VerifySMSSandboxPhoneNumberInput) SetPhoneNumber(v string) *VerifySMSSandboxPhoneNumberInput
- func (s VerifySMSSandboxPhoneNumberInput) String() string
- func (s *VerifySMSSandboxPhoneNumberInput) Validate() error
- type VerifySMSSandboxPhoneNumberOutput
Constants ¶
const ( // LanguageCodeStringEnUs is a LanguageCodeString enum value LanguageCodeStringEnUs = "en-US" // LanguageCodeStringEnGb is a LanguageCodeString enum value LanguageCodeStringEnGb = "en-GB" // LanguageCodeStringEs419 is a LanguageCodeString enum value LanguageCodeStringEs419 = "es-419" // LanguageCodeStringEsEs is a LanguageCodeString enum value LanguageCodeStringEsEs = "es-ES" // LanguageCodeStringDeDe is a LanguageCodeString enum value LanguageCodeStringDeDe = "de-DE" // LanguageCodeStringFrCa is a LanguageCodeString enum value LanguageCodeStringFrCa = "fr-CA" // LanguageCodeStringFrFr is a LanguageCodeString enum value LanguageCodeStringFrFr = "fr-FR" // LanguageCodeStringItIt is a LanguageCodeString enum value LanguageCodeStringItIt = "it-IT" // LanguageCodeStringJaJp is a LanguageCodeString enum value LanguageCodeStringJaJp = "ja-JP" // LanguageCodeStringPtBr is a LanguageCodeString enum value LanguageCodeStringPtBr = "pt-BR" // LanguageCodeStringKrKr is a LanguageCodeString enum value LanguageCodeStringKrKr = "kr-KR" // LanguageCodeStringZhCn is a LanguageCodeString enum value LanguageCodeStringZhCn = "zh-CN" // LanguageCodeStringZhTw is a LanguageCodeString enum value LanguageCodeStringZhTw = "zh-TW" )
Supported language code for sending OTP message
const ( // NumberCapabilitySms is a NumberCapability enum value NumberCapabilitySms = "SMS" // NumberCapabilityMms is a NumberCapability enum value NumberCapabilityMms = "MMS" // NumberCapabilityVoice is a NumberCapability enum value NumberCapabilityVoice = "VOICE" )
Enum listing out all supported number capabilities.
const ( // RouteTypeTransactional is a RouteType enum value RouteTypeTransactional = "Transactional" // RouteTypePromotional is a RouteType enum value RouteTypePromotional = "Promotional" // RouteTypePremium is a RouteType enum value RouteTypePremium = "Premium" )
Enum listing out all supported route types. The following enum values are supported. 1. Transactional : Non-marketing traffic 2. Promotional : Marketing 3. Premium : Premium routes for OTP delivery to the carriers
const ( // SMSSandboxPhoneNumberVerificationStatusPending is a SMSSandboxPhoneNumberVerificationStatus enum value SMSSandboxPhoneNumberVerificationStatusPending = "Pending" // SMSSandboxPhoneNumberVerificationStatusVerified is a SMSSandboxPhoneNumberVerificationStatus enum value SMSSandboxPhoneNumberVerificationStatusVerified = "Verified" )
Enum listing out all supported destination phone number verification statuses. The following enum values are supported. 1. PENDING : The destination phone number is pending verification. 2. VERIFIED : The destination phone number is verified.
const ( // ErrCodeAuthorizationErrorException for service response error code // "AuthorizationError". // // Indicates that the user has been denied access to the requested resource. ErrCodeAuthorizationErrorException = "AuthorizationError" // ErrCodeBatchEntryIdsNotDistinctException for service response error code // "BatchEntryIdsNotDistinct". // // Two or more batch entries in the request have the same Id. ErrCodeBatchEntryIdsNotDistinctException = "BatchEntryIdsNotDistinct" // ErrCodeBatchRequestTooLongException for service response error code // "BatchRequestTooLong". // // The length of all the batch messages put together is more than the limit. ErrCodeBatchRequestTooLongException = "BatchRequestTooLong" // ErrCodeConcurrentAccessException for service response error code // "ConcurrentAccess". // // Can't perform multiple operations on a tag simultaneously. Perform the operations // sequentially. ErrCodeConcurrentAccessException = "ConcurrentAccess" // ErrCodeEmptyBatchRequestException for service response error code // "EmptyBatchRequest". // // The batch request doesn't contain any entries. ErrCodeEmptyBatchRequestException = "EmptyBatchRequest" // ErrCodeEndpointDisabledException for service response error code // "EndpointDisabled". // // Exception error indicating endpoint disabled. ErrCodeEndpointDisabledException = "EndpointDisabled" // ErrCodeFilterPolicyLimitExceededException for service response error code // "FilterPolicyLimitExceeded". // // Indicates that the number of filter polices in your Amazon Web Services account // exceeds the limit. To add more filter polices, submit an Amazon SNS Limit // Increase case in the Amazon Web Services Support Center. ErrCodeFilterPolicyLimitExceededException = "FilterPolicyLimitExceeded" // ErrCodeInternalErrorException for service response error code // "InternalError". // // Indicates an internal service error. ErrCodeInternalErrorException = "InternalError" // ErrCodeInvalidBatchEntryIdException for service response error code // "InvalidBatchEntryId". // // The Id of a batch entry in a batch request doesn't abide by the specification. ErrCodeInvalidBatchEntryIdException = "InvalidBatchEntryId" // ErrCodeInvalidParameterException for service response error code // "InvalidParameter". // // Indicates that a request parameter does not comply with the associated constraints. ErrCodeInvalidParameterException = "InvalidParameter" // ErrCodeInvalidParameterValueException for service response error code // "ParameterValueInvalid". // // Indicates that a request parameter does not comply with the associated constraints. ErrCodeInvalidParameterValueException = "ParameterValueInvalid" // ErrCodeInvalidSecurityException for service response error code // "InvalidSecurity". // // The credential signature isn't valid. You must use an HTTPS endpoint and // sign your request using Signature Version 4. ErrCodeInvalidSecurityException = "InvalidSecurity" // ErrCodeInvalidStateException for service response error code // "InvalidState". // // Indicates that the specified state is not a valid state for an event source. ErrCodeInvalidStateException = "InvalidState" // ErrCodeKMSAccessDeniedException for service response error code // "KMSAccessDenied". // // The ciphertext references a key that doesn't exist or that you don't have // access to. ErrCodeKMSAccessDeniedException = "KMSAccessDenied" // ErrCodeKMSDisabledException for service response error code // "KMSDisabled". // // The request was rejected because the specified Amazon Web Services KMS key // isn't enabled. ErrCodeKMSDisabledException = "KMSDisabled" // ErrCodeKMSInvalidStateException for service response error code // "KMSInvalidState". // // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see Key states of Amazon Web // Services KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the Key Management Service Developer Guide. ErrCodeKMSInvalidStateException = "KMSInvalidState" // ErrCodeKMSNotFoundException for service response error code // "KMSNotFound". // // The request was rejected because the specified entity or resource can't be // found. ErrCodeKMSNotFoundException = "KMSNotFound" // ErrCodeKMSOptInRequired for service response error code // "KMSOptInRequired". // // The Amazon Web Services access key ID needs a subscription for the service. ErrCodeKMSOptInRequired = "KMSOptInRequired" // ErrCodeKMSThrottlingException for service response error code // "KMSThrottling". // // The request was denied due to request throttling. For more information about // throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the Key Management Service Developer Guide. ErrCodeKMSThrottlingException = "KMSThrottling" // ErrCodeNotFoundException for service response error code // "NotFound". // // Indicates that the requested resource does not exist. ErrCodeNotFoundException = "NotFound" // ErrCodeOptedOutException for service response error code // "OptedOut". // // Indicates that the specified phone number opted out of receiving SMS messages // from your Amazon Web Services account. You can't send SMS messages to phone // numbers that opt out. ErrCodeOptedOutException = "OptedOut" // ErrCodePlatformApplicationDisabledException for service response error code // "PlatformApplicationDisabled". // // Exception error indicating platform application disabled. ErrCodePlatformApplicationDisabledException = "PlatformApplicationDisabled" // ErrCodeReplayLimitExceededException for service response error code // "ReplayLimitExceeded". // // Indicates that the request parameter has exceeded the maximum number of concurrent // message replays. ErrCodeReplayLimitExceededException = "ReplayLimitExceeded" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFound". // // Can’t perform the action on the specified resource. Make sure that the // resource exists. ErrCodeResourceNotFoundException = "ResourceNotFound" // ErrCodeStaleTagException for service response error code // "StaleTag". // // A tag has been added to a resource with the same ARN as a deleted resource. // Wait a short while and then retry the operation. ErrCodeStaleTagException = "StaleTag" // ErrCodeSubscriptionLimitExceededException for service response error code // "SubscriptionLimitExceeded". // // Indicates that the customer already owns the maximum allowed number of subscriptions. ErrCodeSubscriptionLimitExceededException = "SubscriptionLimitExceeded" // ErrCodeTagLimitExceededException for service response error code // "TagLimitExceeded". // // Can't add more than 50 tags to a topic. ErrCodeTagLimitExceededException = "TagLimitExceeded" // ErrCodeTagPolicyException for service response error code // "TagPolicy". // // The request doesn't comply with the IAM tag policy. Correct your request // and then retry it. ErrCodeTagPolicyException = "TagPolicy" // ErrCodeThrottledException for service response error code // "Throttled". // // Indicates that the rate at which requests have been submitted for this action // exceeds the limit for your Amazon Web Services account. ErrCodeThrottledException = "Throttled" // ErrCodeTooManyEntriesInBatchRequestException for service response error code // "TooManyEntriesInBatchRequest". // // The batch request contains more entries than permissible. ErrCodeTooManyEntriesInBatchRequestException = "TooManyEntriesInBatchRequest" // ErrCodeTopicLimitExceededException for service response error code // "TopicLimitExceeded". // // Indicates that the customer already owns the maximum allowed number of topics. ErrCodeTopicLimitExceededException = "TopicLimitExceeded" // ErrCodeUserErrorException for service response error code // "UserError". // // Indicates that a request parameter does not comply with the associated constraints. ErrCodeUserErrorException = "UserError" // ErrCodeValidationException for service response error code // "ValidationException". // // Indicates that a parameter in the request is invalid. ErrCodeValidationException = "ValidationException" // ErrCodeVerificationException for service response error code // "VerificationException". // // Indicates that the one-time password (OTP) used for verification is invalid. ErrCodeVerificationException = "VerificationException" )
const ( ServiceName = "sns" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "SNS" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
func LanguageCodeString_Values ¶ added in v1.38.52
func LanguageCodeString_Values() []string
LanguageCodeString_Values returns all elements of the LanguageCodeString enum
func NumberCapability_Values ¶ added in v1.38.52
func NumberCapability_Values() []string
NumberCapability_Values returns all elements of the NumberCapability enum
func RouteType_Values ¶ added in v1.38.52
func RouteType_Values() []string
RouteType_Values returns all elements of the RouteType enum
func SMSSandboxPhoneNumberVerificationStatus_Values ¶ added in v1.38.52
func SMSSandboxPhoneNumberVerificationStatus_Values() []string
SMSSandboxPhoneNumberVerificationStatus_Values returns all elements of the SMSSandboxPhoneNumberVerificationStatus enum
Types ¶
type AddPermissionInput ¶
type AddPermissionInput struct { // The Amazon Web Services account IDs of the users (principals) who will be // given access to the specified actions. The users must have Amazon Web Services // account, but do not need to be signed up for this service. // // AWSAccountId is a required field AWSAccountId []*string `type:"list" required:"true"` // The action you want to allow for the specified principal(s). // // Valid values: Any Amazon SNS action name, for example Publish. // // ActionName is a required field ActionName []*string `type:"list" required:"true"` // A unique identifier for the new policy statement. // // Label is a required field Label *string `type:"string" required:"true"` // The ARN of the topic whose access control policy you wish to modify. // // TopicArn is a required field TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (AddPermissionInput) GoString ¶ added in v0.6.5
func (s AddPermissionInput) 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 (*AddPermissionInput) SetAWSAccountId ¶ added in v1.5.0
func (s *AddPermissionInput) SetAWSAccountId(v []*string) *AddPermissionInput
SetAWSAccountId sets the AWSAccountId field's value.
func (*AddPermissionInput) SetActionName ¶ added in v1.5.0
func (s *AddPermissionInput) SetActionName(v []*string) *AddPermissionInput
SetActionName sets the ActionName field's value.
func (*AddPermissionInput) SetLabel ¶ added in v1.5.0
func (s *AddPermissionInput) SetLabel(v string) *AddPermissionInput
SetLabel sets the Label field's value.
func (*AddPermissionInput) SetTopicArn ¶ added in v1.5.0
func (s *AddPermissionInput) SetTopicArn(v string) *AddPermissionInput
SetTopicArn sets the TopicArn field's value.
func (AddPermissionInput) String ¶ added in v0.6.5
func (s AddPermissionInput) 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 (*AddPermissionInput) Validate ¶ added in v1.1.21
func (s *AddPermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddPermissionOutput ¶
type AddPermissionOutput struct {
// contains filtered or unexported fields
}
func (AddPermissionOutput) GoString ¶ added in v0.6.5
func (s AddPermissionOutput) 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 (AddPermissionOutput) String ¶ added in v0.6.5
func (s AddPermissionOutput) 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 BatchResultErrorEntry ¶ added in v1.42.7
type BatchResultErrorEntry struct { // An error code representing why the action failed on this entry. // // Code is a required field Code *string `type:"string" required:"true"` // The Id of an entry in a batch request // // Id is a required field Id *string `type:"string" required:"true"` // A message explaining why the action failed on this entry. Message *string `type:"string"` // Specifies whether the error happened due to the caller of the batch API action. // // SenderFault is a required field SenderFault *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
Gives a detailed description of failed messages in the batch.
func (BatchResultErrorEntry) GoString ¶ added in v1.42.7
func (s BatchResultErrorEntry) 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 (*BatchResultErrorEntry) SetCode ¶ added in v1.42.7
func (s *BatchResultErrorEntry) SetCode(v string) *BatchResultErrorEntry
SetCode sets the Code field's value.
func (*BatchResultErrorEntry) SetId ¶ added in v1.42.7
func (s *BatchResultErrorEntry) SetId(v string) *BatchResultErrorEntry
SetId sets the Id field's value.
func (*BatchResultErrorEntry) SetMessage ¶ added in v1.42.7
func (s *BatchResultErrorEntry) SetMessage(v string) *BatchResultErrorEntry
SetMessage sets the Message field's value.
func (*BatchResultErrorEntry) SetSenderFault ¶ added in v1.42.7
func (s *BatchResultErrorEntry) SetSenderFault(v bool) *BatchResultErrorEntry
SetSenderFault sets the SenderFault field's value.
func (BatchResultErrorEntry) String ¶ added in v1.42.7
func (s BatchResultErrorEntry) 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 CheckIfPhoneNumberIsOptedOutInput ¶ added in v1.2.1
type CheckIfPhoneNumberIsOptedOutInput struct { // The phone number for which you want to check the opt out status. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CheckIfPhoneNumberIsOptedOutInput's // String and GoString methods. // // PhoneNumber is a required field PhoneNumber *string `locationName:"phoneNumber" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
The input for the CheckIfPhoneNumberIsOptedOut action.
func (CheckIfPhoneNumberIsOptedOutInput) GoString ¶ added in v1.2.1
func (s CheckIfPhoneNumberIsOptedOutInput) 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 (*CheckIfPhoneNumberIsOptedOutInput) SetPhoneNumber ¶ added in v1.5.0
func (s *CheckIfPhoneNumberIsOptedOutInput) SetPhoneNumber(v string) *CheckIfPhoneNumberIsOptedOutInput
SetPhoneNumber sets the PhoneNumber field's value.
func (CheckIfPhoneNumberIsOptedOutInput) String ¶ added in v1.2.1
func (s CheckIfPhoneNumberIsOptedOutInput) 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 (*CheckIfPhoneNumberIsOptedOutInput) Validate ¶ added in v1.2.1
func (s *CheckIfPhoneNumberIsOptedOutInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CheckIfPhoneNumberIsOptedOutOutput ¶ added in v1.2.1
type CheckIfPhoneNumberIsOptedOutOutput struct { // Indicates whether the phone number is opted out: // // * true – The phone number is opted out, meaning you cannot publish SMS // messages to it. // // * false – The phone number is opted in, meaning you can publish SMS // messages to it. IsOptedOut *bool `locationName:"isOptedOut" type:"boolean"` // contains filtered or unexported fields }
The response from the CheckIfPhoneNumberIsOptedOut action.
func (CheckIfPhoneNumberIsOptedOutOutput) GoString ¶ added in v1.2.1
func (s CheckIfPhoneNumberIsOptedOutOutput) 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 (*CheckIfPhoneNumberIsOptedOutOutput) SetIsOptedOut ¶ added in v1.5.0
func (s *CheckIfPhoneNumberIsOptedOutOutput) SetIsOptedOut(v bool) *CheckIfPhoneNumberIsOptedOutOutput
SetIsOptedOut sets the IsOptedOut field's value.
func (CheckIfPhoneNumberIsOptedOutOutput) String ¶ added in v1.2.1
func (s CheckIfPhoneNumberIsOptedOutOutput) 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 ConfirmSubscriptionInput ¶
type ConfirmSubscriptionInput struct { // Disallows unauthenticated unsubscribes of the subscription. If the value // of this parameter is true and the request has an Amazon Web Services signature, // then only the topic owner and the subscription owner can unsubscribe the // endpoint. The unsubscribe action requires Amazon Web Services authentication. AuthenticateOnUnsubscribe *string `type:"string"` // Short-lived token sent to an endpoint during the Subscribe action. // // Token is a required field Token *string `type:"string" required:"true"` // The ARN of the topic for which you wish to confirm a subscription. // // TopicArn is a required field TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for ConfirmSubscription action.
func (ConfirmSubscriptionInput) GoString ¶ added in v0.6.5
func (s ConfirmSubscriptionInput) 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 (*ConfirmSubscriptionInput) SetAuthenticateOnUnsubscribe ¶ added in v1.5.0
func (s *ConfirmSubscriptionInput) SetAuthenticateOnUnsubscribe(v string) *ConfirmSubscriptionInput
SetAuthenticateOnUnsubscribe sets the AuthenticateOnUnsubscribe field's value.
func (*ConfirmSubscriptionInput) SetToken ¶ added in v1.5.0
func (s *ConfirmSubscriptionInput) SetToken(v string) *ConfirmSubscriptionInput
SetToken sets the Token field's value.
func (*ConfirmSubscriptionInput) SetTopicArn ¶ added in v1.5.0
func (s *ConfirmSubscriptionInput) SetTopicArn(v string) *ConfirmSubscriptionInput
SetTopicArn sets the TopicArn field's value.
func (ConfirmSubscriptionInput) String ¶ added in v0.6.5
func (s ConfirmSubscriptionInput) 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 (*ConfirmSubscriptionInput) Validate ¶ added in v1.1.21
func (s *ConfirmSubscriptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConfirmSubscriptionOutput ¶
type ConfirmSubscriptionOutput struct { // The ARN of the created subscription. SubscriptionArn *string `type:"string"` // contains filtered or unexported fields }
Response for ConfirmSubscriptions action.
func (ConfirmSubscriptionOutput) GoString ¶ added in v0.6.5
func (s ConfirmSubscriptionOutput) 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 (*ConfirmSubscriptionOutput) SetSubscriptionArn ¶ added in v1.5.0
func (s *ConfirmSubscriptionOutput) SetSubscriptionArn(v string) *ConfirmSubscriptionOutput
SetSubscriptionArn sets the SubscriptionArn field's value.
func (ConfirmSubscriptionOutput) String ¶ added in v0.6.5
func (s ConfirmSubscriptionOutput) 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 CreatePlatformApplicationInput ¶
type CreatePlatformApplicationInput struct { // For a list of attributes, see SetPlatformApplicationAttributes (https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html). // // Attributes is a required field Attributes map[string]*string `type:"map" required:"true"` // Application names must be made up of only uppercase and lowercase ASCII letters, // numbers, underscores, hyphens, and periods, and must be between 1 and 256 // characters long. // // Name is a required field Name *string `type:"string" required:"true"` // The following platforms are supported: ADM (Amazon Device Messaging), APNS // (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud // Messaging). // // Platform is a required field Platform *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for CreatePlatformApplication action.
func (CreatePlatformApplicationInput) GoString ¶ added in v0.6.5
func (s CreatePlatformApplicationInput) 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 (*CreatePlatformApplicationInput) SetAttributes ¶ added in v1.5.0
func (s *CreatePlatformApplicationInput) SetAttributes(v map[string]*string) *CreatePlatformApplicationInput
SetAttributes sets the Attributes field's value.
func (*CreatePlatformApplicationInput) SetName ¶ added in v1.5.0
func (s *CreatePlatformApplicationInput) SetName(v string) *CreatePlatformApplicationInput
SetName sets the Name field's value.
func (*CreatePlatformApplicationInput) SetPlatform ¶ added in v1.5.0
func (s *CreatePlatformApplicationInput) SetPlatform(v string) *CreatePlatformApplicationInput
SetPlatform sets the Platform field's value.
func (CreatePlatformApplicationInput) String ¶ added in v0.6.5
func (s CreatePlatformApplicationInput) 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 (*CreatePlatformApplicationInput) Validate ¶ added in v1.1.21
func (s *CreatePlatformApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePlatformApplicationOutput ¶
type CreatePlatformApplicationOutput struct { // PlatformApplicationArn is returned. PlatformApplicationArn *string `type:"string"` // contains filtered or unexported fields }
Response from CreatePlatformApplication action.
func (CreatePlatformApplicationOutput) GoString ¶ added in v0.6.5
func (s CreatePlatformApplicationOutput) 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 (*CreatePlatformApplicationOutput) SetPlatformApplicationArn ¶ added in v1.5.0
func (s *CreatePlatformApplicationOutput) SetPlatformApplicationArn(v string) *CreatePlatformApplicationOutput
SetPlatformApplicationArn sets the PlatformApplicationArn field's value.
func (CreatePlatformApplicationOutput) String ¶ added in v0.6.5
func (s CreatePlatformApplicationOutput) 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 CreatePlatformEndpointInput ¶
type CreatePlatformEndpointInput struct { // For a list of attributes, see SetEndpointAttributes (https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html). Attributes map[string]*string `type:"map"` // Arbitrary user data to associate with the endpoint. Amazon SNS does not use // this data. The data must be in UTF-8 format and less than 2KB. CustomUserData *string `type:"string"` // PlatformApplicationArn returned from CreatePlatformApplication is used to // create a an endpoint. // // PlatformApplicationArn is a required field PlatformApplicationArn *string `type:"string" required:"true"` // Unique identifier created by the notification service for an app on a device. // The specific name for Token will vary, depending on which notification service // is being used. For example, when using APNS as the notification service, // you need the device token. Alternatively, when using GCM (Firebase Cloud // Messaging) or ADM, the device token equivalent is called the registration // ID. // // Token is a required field Token *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for CreatePlatformEndpoint action.
func (CreatePlatformEndpointInput) GoString ¶ added in v0.6.5
func (s CreatePlatformEndpointInput) 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 (*CreatePlatformEndpointInput) SetAttributes ¶ added in v1.5.0
func (s *CreatePlatformEndpointInput) SetAttributes(v map[string]*string) *CreatePlatformEndpointInput
SetAttributes sets the Attributes field's value.
func (*CreatePlatformEndpointInput) SetCustomUserData ¶ added in v1.5.0
func (s *CreatePlatformEndpointInput) SetCustomUserData(v string) *CreatePlatformEndpointInput
SetCustomUserData sets the CustomUserData field's value.
func (*CreatePlatformEndpointInput) SetPlatformApplicationArn ¶ added in v1.5.0
func (s *CreatePlatformEndpointInput) SetPlatformApplicationArn(v string) *CreatePlatformEndpointInput
SetPlatformApplicationArn sets the PlatformApplicationArn field's value.
func (*CreatePlatformEndpointInput) SetToken ¶ added in v1.5.0
func (s *CreatePlatformEndpointInput) SetToken(v string) *CreatePlatformEndpointInput
SetToken sets the Token field's value.
func (CreatePlatformEndpointInput) String ¶ added in v0.6.5
func (s CreatePlatformEndpointInput) 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 (*CreatePlatformEndpointInput) Validate ¶ added in v1.1.21
func (s *CreatePlatformEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePlatformEndpointOutput ¶
type CreatePlatformEndpointOutput struct { // EndpointArn returned from CreateEndpoint action. EndpointArn *string `type:"string"` // contains filtered or unexported fields }
Response from CreateEndpoint action.
func (CreatePlatformEndpointOutput) GoString ¶ added in v0.6.5
func (s CreatePlatformEndpointOutput) 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 (*CreatePlatformEndpointOutput) SetEndpointArn ¶ added in v1.5.0
func (s *CreatePlatformEndpointOutput) SetEndpointArn(v string) *CreatePlatformEndpointOutput
SetEndpointArn sets the EndpointArn field's value.
func (CreatePlatformEndpointOutput) String ¶ added in v0.6.5
func (s CreatePlatformEndpointOutput) 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 CreateSMSSandboxPhoneNumberInput ¶ added in v1.38.52
type CreateSMSSandboxPhoneNumberInput struct { // The language to use for sending the OTP. The default value is en-US. LanguageCode *string `type:"string" enum:"LanguageCodeString"` // The destination phone number to verify. On verification, Amazon SNS adds // this phone number to the list of verified phone numbers that you can send // SMS messages to. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateSMSSandboxPhoneNumberInput's // String and GoString methods. // // PhoneNumber is a required field PhoneNumber *string `type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (CreateSMSSandboxPhoneNumberInput) GoString ¶ added in v1.38.52
func (s CreateSMSSandboxPhoneNumberInput) 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 (*CreateSMSSandboxPhoneNumberInput) SetLanguageCode ¶ added in v1.38.52
func (s *CreateSMSSandboxPhoneNumberInput) SetLanguageCode(v string) *CreateSMSSandboxPhoneNumberInput
SetLanguageCode sets the LanguageCode field's value.
func (*CreateSMSSandboxPhoneNumberInput) SetPhoneNumber ¶ added in v1.38.52
func (s *CreateSMSSandboxPhoneNumberInput) SetPhoneNumber(v string) *CreateSMSSandboxPhoneNumberInput
SetPhoneNumber sets the PhoneNumber field's value.
func (CreateSMSSandboxPhoneNumberInput) String ¶ added in v1.38.52
func (s CreateSMSSandboxPhoneNumberInput) 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 (*CreateSMSSandboxPhoneNumberInput) Validate ¶ added in v1.38.52
func (s *CreateSMSSandboxPhoneNumberInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateSMSSandboxPhoneNumberOutput ¶ added in v1.38.52
type CreateSMSSandboxPhoneNumberOutput struct {
// contains filtered or unexported fields
}
func (CreateSMSSandboxPhoneNumberOutput) GoString ¶ added in v1.38.52
func (s CreateSMSSandboxPhoneNumberOutput) 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 (CreateSMSSandboxPhoneNumberOutput) String ¶ added in v1.38.52
func (s CreateSMSSandboxPhoneNumberOutput) 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 CreateTopicInput ¶
type CreateTopicInput struct { // A map of attributes with their corresponding values. // // The following lists names, descriptions, and values of the special request // parameters that the CreateTopic action uses: // // * DeliveryPolicy – The policy that defines how Amazon SNS retries failed // deliveries to HTTP/S endpoints. // // * DisplayName – The display name to use for a topic with SMS subscriptions. // // * FifoTopic – Set to true to create a FIFO topic. // // * Policy – The policy that defines who can access your topic. By default, // only the topic owner can publish or subscribe to the topic. // // * SignatureVersion – The signature version corresponds to the hashing // algorithm used while creating the signature of the notifications, subscription // confirmations, or unsubscribe confirmation messages sent by Amazon SNS. // By default, SignatureVersion is set to 1. // // * TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig // is set to PassThrough, and the topic passes through the tracing header // it receives from an Amazon SNS publisher to its subscriptions. If set // to Active, Amazon SNS will vend X-Ray segment data to topic owner account // if the sampled flag in the tracing header is true. This is only supported // on standard topics. // // The following attribute applies only to server-side encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): // // * KmsMasterKeyId – The ID of an Amazon Web Services managed customer // master key (CMK) for Amazon SNS or a custom CMK. For more information, // see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). // For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) // in the Key Management Service API Reference. // // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): // // * ArchivePolicy – Adds or updates an inline policy document to archive // messages stored in the specified Amazon SNS topic. // // * BeginningArchiveTime – The earliest starting point at which a message // in the topic’s archive can be replayed from. This point in time is based // on the configured message retention period set by the topic’s message // archiving policy. // // * ContentBasedDeduplication – Enables content-based deduplication for // FIFO topics. By default, ContentBasedDeduplication is set to false. If // you create a FIFO topic and this attribute is false, you must specify // a value for the MessageDeduplicationId parameter for the Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) // action. When you set ContentBasedDeduplication to true, Amazon SNS uses // a SHA-256 hash to generate the MessageDeduplicationId using the body of // the message (but not the attributes of the message). (Optional) To override // the generated value, you can specify a value for the MessageDeduplicationId // parameter for the Publish action. Attributes map[string]*string `type:"map"` // The body of the policy document you want to use for this topic. // // You can only add one policy per topic. // // The policy must be in JSON string format. // // Length Constraints: Maximum length of 30,720. DataProtectionPolicy *string `type:"string"` // The name of the topic you want to create. // // Constraints: Topic names must be made up of only uppercase and lowercase // ASCII letters, numbers, underscores, and hyphens, and must be between 1 and // 256 characters long. // // For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. // // Name is a required field Name *string `type:"string" required:"true"` // The list of tags to add to a new topic. // // To be able to tag a topic on creation, you must have the sns:CreateTopic // and sns:TagResource permissions. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
Input for CreateTopic action.
func (CreateTopicInput) GoString ¶ added in v0.6.5
func (s CreateTopicInput) 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 (*CreateTopicInput) SetAttributes ¶ added in v1.15.76
func (s *CreateTopicInput) SetAttributes(v map[string]*string) *CreateTopicInput
SetAttributes sets the Attributes field's value.
func (*CreateTopicInput) SetDataProtectionPolicy ¶ added in v1.44.93
func (s *CreateTopicInput) SetDataProtectionPolicy(v string) *CreateTopicInput
SetDataProtectionPolicy sets the DataProtectionPolicy field's value.
func (*CreateTopicInput) SetName ¶ added in v1.5.0
func (s *CreateTopicInput) SetName(v string) *CreateTopicInput
SetName sets the Name field's value.
func (*CreateTopicInput) SetTags ¶ added in v1.19.19
func (s *CreateTopicInput) SetTags(v []*Tag) *CreateTopicInput
SetTags sets the Tags field's value.
func (CreateTopicInput) String ¶ added in v0.6.5
func (s CreateTopicInput) 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 (*CreateTopicInput) Validate ¶ added in v1.1.21
func (s *CreateTopicInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTopicOutput ¶
type CreateTopicOutput struct { // The Amazon Resource Name (ARN) assigned to the created topic. TopicArn *string `type:"string"` // contains filtered or unexported fields }
Response from CreateTopic action.
func (CreateTopicOutput) GoString ¶ added in v0.6.5
func (s CreateTopicOutput) 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 (*CreateTopicOutput) SetTopicArn ¶ added in v1.5.0
func (s *CreateTopicOutput) SetTopicArn(v string) *CreateTopicOutput
SetTopicArn sets the TopicArn field's value.
func (CreateTopicOutput) String ¶ added in v0.6.5
func (s CreateTopicOutput) 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 DeleteEndpointInput ¶
type DeleteEndpointInput struct { // EndpointArn of endpoint to delete. // // EndpointArn is a required field EndpointArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for DeleteEndpoint action.
func (DeleteEndpointInput) GoString ¶ added in v0.6.5
func (s DeleteEndpointInput) 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 (*DeleteEndpointInput) SetEndpointArn ¶ added in v1.5.0
func (s *DeleteEndpointInput) SetEndpointArn(v string) *DeleteEndpointInput
SetEndpointArn sets the EndpointArn field's value.
func (DeleteEndpointInput) String ¶ added in v0.6.5
func (s DeleteEndpointInput) 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 (*DeleteEndpointInput) Validate ¶ added in v1.1.21
func (s *DeleteEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEndpointOutput ¶
type DeleteEndpointOutput struct {
// contains filtered or unexported fields
}
func (DeleteEndpointOutput) GoString ¶ added in v0.6.5
func (s DeleteEndpointOutput) 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 (DeleteEndpointOutput) String ¶ added in v0.6.5
func (s DeleteEndpointOutput) 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 DeletePlatformApplicationInput ¶
type DeletePlatformApplicationInput struct { // PlatformApplicationArn of platform application object to delete. // // PlatformApplicationArn is a required field PlatformApplicationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for DeletePlatformApplication action.
func (DeletePlatformApplicationInput) GoString ¶ added in v0.6.5
func (s DeletePlatformApplicationInput) 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 (*DeletePlatformApplicationInput) SetPlatformApplicationArn ¶ added in v1.5.0
func (s *DeletePlatformApplicationInput) SetPlatformApplicationArn(v string) *DeletePlatformApplicationInput
SetPlatformApplicationArn sets the PlatformApplicationArn field's value.
func (DeletePlatformApplicationInput) String ¶ added in v0.6.5
func (s DeletePlatformApplicationInput) 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 (*DeletePlatformApplicationInput) Validate ¶ added in v1.1.21
func (s *DeletePlatformApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePlatformApplicationOutput ¶
type DeletePlatformApplicationOutput struct {
// contains filtered or unexported fields
}
func (DeletePlatformApplicationOutput) GoString ¶ added in v0.6.5
func (s DeletePlatformApplicationOutput) 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 (DeletePlatformApplicationOutput) String ¶ added in v0.6.5
func (s DeletePlatformApplicationOutput) 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 DeleteSMSSandboxPhoneNumberInput ¶ added in v1.38.52
type DeleteSMSSandboxPhoneNumberInput struct { // The destination phone number to delete. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DeleteSMSSandboxPhoneNumberInput's // String and GoString methods. // // PhoneNumber is a required field PhoneNumber *string `type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (DeleteSMSSandboxPhoneNumberInput) GoString ¶ added in v1.38.52
func (s DeleteSMSSandboxPhoneNumberInput) 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 (*DeleteSMSSandboxPhoneNumberInput) SetPhoneNumber ¶ added in v1.38.52
func (s *DeleteSMSSandboxPhoneNumberInput) SetPhoneNumber(v string) *DeleteSMSSandboxPhoneNumberInput
SetPhoneNumber sets the PhoneNumber field's value.
func (DeleteSMSSandboxPhoneNumberInput) String ¶ added in v1.38.52
func (s DeleteSMSSandboxPhoneNumberInput) 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 (*DeleteSMSSandboxPhoneNumberInput) Validate ¶ added in v1.38.52
func (s *DeleteSMSSandboxPhoneNumberInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteSMSSandboxPhoneNumberOutput ¶ added in v1.38.52
type DeleteSMSSandboxPhoneNumberOutput struct {
// contains filtered or unexported fields
}
func (DeleteSMSSandboxPhoneNumberOutput) GoString ¶ added in v1.38.52
func (s DeleteSMSSandboxPhoneNumberOutput) 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 (DeleteSMSSandboxPhoneNumberOutput) String ¶ added in v1.38.52
func (s DeleteSMSSandboxPhoneNumberOutput) 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 DeleteTopicInput ¶
type DeleteTopicInput struct { // The ARN of the topic you want to delete. // // TopicArn is a required field TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteTopicInput) GoString ¶ added in v0.6.5
func (s DeleteTopicInput) 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 (*DeleteTopicInput) SetTopicArn ¶ added in v1.5.0
func (s *DeleteTopicInput) SetTopicArn(v string) *DeleteTopicInput
SetTopicArn sets the TopicArn field's value.
func (DeleteTopicInput) String ¶ added in v0.6.5
func (s DeleteTopicInput) 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 (*DeleteTopicInput) Validate ¶ added in v1.1.21
func (s *DeleteTopicInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTopicOutput ¶
type DeleteTopicOutput struct {
// contains filtered or unexported fields
}
func (DeleteTopicOutput) GoString ¶ added in v0.6.5
func (s DeleteTopicOutput) 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 (DeleteTopicOutput) String ¶ added in v0.6.5
func (s DeleteTopicOutput) 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 Endpoint ¶
type Endpoint struct { // Attributes for endpoint. Attributes map[string]*string `type:"map"` // The EndpointArn for mobile app and device. EndpointArn *string `type:"string"` // contains filtered or unexported fields }
The endpoint for mobile app and device.
func (Endpoint) GoString ¶ added in v0.6.5
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 (*Endpoint) SetAttributes ¶ added in v1.5.0
SetAttributes sets the Attributes field's value.
func (*Endpoint) SetEndpointArn ¶ added in v1.5.0
SetEndpointArn sets the EndpointArn field's value.
type GetDataProtectionPolicyInput ¶ added in v1.44.93
type GetDataProtectionPolicyInput struct { // The ARN of the topic whose DataProtectionPolicy you want to get. // // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // in the Amazon Web Services General Reference. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (GetDataProtectionPolicyInput) GoString ¶ added in v1.44.93
func (s GetDataProtectionPolicyInput) 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 (*GetDataProtectionPolicyInput) SetResourceArn ¶ added in v1.44.93
func (s *GetDataProtectionPolicyInput) SetResourceArn(v string) *GetDataProtectionPolicyInput
SetResourceArn sets the ResourceArn field's value.
func (GetDataProtectionPolicyInput) String ¶ added in v1.44.93
func (s GetDataProtectionPolicyInput) 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 (*GetDataProtectionPolicyInput) Validate ¶ added in v1.44.93
func (s *GetDataProtectionPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDataProtectionPolicyOutput ¶ added in v1.44.93
type GetDataProtectionPolicyOutput struct { // Retrieves the DataProtectionPolicy in JSON string format. DataProtectionPolicy *string `type:"string"` // contains filtered or unexported fields }
func (GetDataProtectionPolicyOutput) GoString ¶ added in v1.44.93
func (s GetDataProtectionPolicyOutput) 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 (*GetDataProtectionPolicyOutput) SetDataProtectionPolicy ¶ added in v1.44.93
func (s *GetDataProtectionPolicyOutput) SetDataProtectionPolicy(v string) *GetDataProtectionPolicyOutput
SetDataProtectionPolicy sets the DataProtectionPolicy field's value.
func (GetDataProtectionPolicyOutput) String ¶ added in v1.44.93
func (s GetDataProtectionPolicyOutput) 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 GetEndpointAttributesInput ¶
type GetEndpointAttributesInput struct { // EndpointArn for GetEndpointAttributes input. // // EndpointArn is a required field EndpointArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetEndpointAttributes action.
func (GetEndpointAttributesInput) GoString ¶ added in v0.6.5
func (s GetEndpointAttributesInput) 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 (*GetEndpointAttributesInput) SetEndpointArn ¶ added in v1.5.0
func (s *GetEndpointAttributesInput) SetEndpointArn(v string) *GetEndpointAttributesInput
SetEndpointArn sets the EndpointArn field's value.
func (GetEndpointAttributesInput) String ¶ added in v0.6.5
func (s GetEndpointAttributesInput) 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 (*GetEndpointAttributesInput) Validate ¶ added in v1.1.21
func (s *GetEndpointAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEndpointAttributesOutput ¶
type GetEndpointAttributesOutput struct { // Attributes include the following: // // * CustomUserData – arbitrary user data to associate with the endpoint. // Amazon SNS does not use this data. The data must be in UTF-8 format and // less than 2KB. // // * Enabled – flag that enables/disables delivery to the endpoint. Amazon // SNS will set this to false when a notification service indicates to Amazon // SNS that the endpoint is invalid. Users can set it back to true, typically // after updating Token. // // * Token – device token, also referred to as a registration id, for an // app and mobile device. This is returned from the notification service // when an app and mobile device are registered with the notification service. // The device token for the iOS platform is returned in lowercase. Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response from GetEndpointAttributes of the EndpointArn.
func (GetEndpointAttributesOutput) GoString ¶ added in v0.6.5
func (s GetEndpointAttributesOutput) 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 (*GetEndpointAttributesOutput) SetAttributes ¶ added in v1.5.0
func (s *GetEndpointAttributesOutput) SetAttributes(v map[string]*string) *GetEndpointAttributesOutput
SetAttributes sets the Attributes field's value.
func (GetEndpointAttributesOutput) String ¶ added in v0.6.5
func (s GetEndpointAttributesOutput) 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 GetPlatformApplicationAttributesInput ¶
type GetPlatformApplicationAttributesInput struct { // PlatformApplicationArn for GetPlatformApplicationAttributesInput. // // PlatformApplicationArn is a required field PlatformApplicationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetPlatformApplicationAttributes action.
func (GetPlatformApplicationAttributesInput) GoString ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesInput) 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 (*GetPlatformApplicationAttributesInput) SetPlatformApplicationArn ¶ added in v1.5.0
func (s *GetPlatformApplicationAttributesInput) SetPlatformApplicationArn(v string) *GetPlatformApplicationAttributesInput
SetPlatformApplicationArn sets the PlatformApplicationArn field's value.
func (GetPlatformApplicationAttributesInput) String ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesInput) 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 (*GetPlatformApplicationAttributesInput) Validate ¶ added in v1.1.21
func (s *GetPlatformApplicationAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPlatformApplicationAttributesOutput ¶
type GetPlatformApplicationAttributesOutput struct { // Attributes include the following: // // * AppleCertificateExpiryDate – The expiry date of the SSL certificate // used to configure certificate-based authentication. // // * ApplePlatformTeamID – The Apple developer account ID used to configure // token-based authentication. // // * ApplePlatformBundleID – The app identifier used to configure token-based // authentication. // // * AuthenticationMethod – Returns the credential type used when sending // push notifications from application to APNS/APNS_Sandbox, or application // to GCM. APNS – Returns the token or certificate. GCM – Returns the // token or key. // // * EventEndpointCreated – Topic ARN to which EndpointCreated event notifications // should be sent. // // * EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications // should be sent. // // * EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications // should be sent. // // * EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications // should be sent upon Direct Publish delivery failure (permanent) to one // of the application's endpoints. Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response for GetPlatformApplicationAttributes action.
func (GetPlatformApplicationAttributesOutput) GoString ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesOutput) 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 (*GetPlatformApplicationAttributesOutput) SetAttributes ¶ added in v1.5.0
func (s *GetPlatformApplicationAttributesOutput) SetAttributes(v map[string]*string) *GetPlatformApplicationAttributesOutput
SetAttributes sets the Attributes field's value.
func (GetPlatformApplicationAttributesOutput) String ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesOutput) 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 GetSMSAttributesInput ¶ added in v1.2.1
type GetSMSAttributesInput struct { // A list of the individual attribute names, such as MonthlySpendLimit, for // which you want values. // // For all attribute names, see SetSMSAttributes (https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html). // // If you don't use this parameter, Amazon SNS returns all SMS attributes. Attributes []*string `locationName:"attributes" type:"list"` // contains filtered or unexported fields }
The input for the GetSMSAttributes request.
func (GetSMSAttributesInput) GoString ¶ added in v1.2.1
func (s GetSMSAttributesInput) 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 (*GetSMSAttributesInput) SetAttributes ¶ added in v1.5.0
func (s *GetSMSAttributesInput) SetAttributes(v []*string) *GetSMSAttributesInput
SetAttributes sets the Attributes field's value.
func (GetSMSAttributesInput) String ¶ added in v1.2.1
func (s GetSMSAttributesInput) 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 GetSMSAttributesOutput ¶ added in v1.2.1
type GetSMSAttributesOutput struct { // The SMS attribute names and their values. Attributes map[string]*string `locationName:"attributes" type:"map"` // contains filtered or unexported fields }
The response from the GetSMSAttributes request.
func (GetSMSAttributesOutput) GoString ¶ added in v1.2.1
func (s GetSMSAttributesOutput) 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 (*GetSMSAttributesOutput) SetAttributes ¶ added in v1.5.0
func (s *GetSMSAttributesOutput) SetAttributes(v map[string]*string) *GetSMSAttributesOutput
SetAttributes sets the Attributes field's value.
func (GetSMSAttributesOutput) String ¶ added in v1.2.1
func (s GetSMSAttributesOutput) 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 GetSMSSandboxAccountStatusInput ¶ added in v1.38.52
type GetSMSSandboxAccountStatusInput struct {
// contains filtered or unexported fields
}
func (GetSMSSandboxAccountStatusInput) GoString ¶ added in v1.38.52
func (s GetSMSSandboxAccountStatusInput) 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 (GetSMSSandboxAccountStatusInput) String ¶ added in v1.38.52
func (s GetSMSSandboxAccountStatusInput) 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 GetSMSSandboxAccountStatusOutput ¶ added in v1.38.52
type GetSMSSandboxAccountStatusOutput struct { // Indicates whether the calling Amazon Web Services account is in the SMS sandbox. // // IsInSandbox is a required field IsInSandbox *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
func (GetSMSSandboxAccountStatusOutput) GoString ¶ added in v1.38.52
func (s GetSMSSandboxAccountStatusOutput) 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 (*GetSMSSandboxAccountStatusOutput) SetIsInSandbox ¶ added in v1.38.52
func (s *GetSMSSandboxAccountStatusOutput) SetIsInSandbox(v bool) *GetSMSSandboxAccountStatusOutput
SetIsInSandbox sets the IsInSandbox field's value.
func (GetSMSSandboxAccountStatusOutput) String ¶ added in v1.38.52
func (s GetSMSSandboxAccountStatusOutput) 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 GetSubscriptionAttributesInput ¶
type GetSubscriptionAttributesInput struct { // The ARN of the subscription whose properties you want to get. // // SubscriptionArn is a required field SubscriptionArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetSubscriptionAttributes.
func (GetSubscriptionAttributesInput) GoString ¶ added in v0.6.5
func (s GetSubscriptionAttributesInput) 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 (*GetSubscriptionAttributesInput) SetSubscriptionArn ¶ added in v1.5.0
func (s *GetSubscriptionAttributesInput) SetSubscriptionArn(v string) *GetSubscriptionAttributesInput
SetSubscriptionArn sets the SubscriptionArn field's value.
func (GetSubscriptionAttributesInput) String ¶ added in v0.6.5
func (s GetSubscriptionAttributesInput) 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 (*GetSubscriptionAttributesInput) Validate ¶ added in v1.1.21
func (s *GetSubscriptionAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSubscriptionAttributesOutput ¶
type GetSubscriptionAttributesOutput struct { // A map of the subscription's attributes. Attributes in this map include the // following: // // * ConfirmationWasAuthenticated – true if the subscription confirmation // request was authenticated. // // * DeliveryPolicy – The JSON serialization of the subscription's delivery // policy. // // * EffectiveDeliveryPolicy – The JSON serialization of the effective // delivery policy that takes into account the topic delivery policy and // account system defaults. // // * FilterPolicy – The filter policy JSON that is assigned to the subscription. // For more information, see Amazon SNS Message Filtering (https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) // in the Amazon SNS Developer Guide. // // * FilterPolicyScope – This attribute lets you choose the filtering scope // by using one of the following string value types: MessageAttributes (default) // – The filter is applied on the message attributes. MessageBody – The // filter is applied on the message body. // // * Owner – The Amazon Web Services account ID of the subscription's owner. // // * PendingConfirmation – true if the subscription hasn't been confirmed. // To confirm a pending subscription, call the ConfirmSubscription action // with a confirmation token. // // * RawMessageDelivery – true if raw message delivery is enabled for the // subscription. Raw messages are free of JSON formatting and can be sent // to HTTP/S and Amazon SQS endpoints. // // * RedrivePolicy – When specified, sends undeliverable messages to the // specified Amazon SQS dead-letter queue. Messages that can't be delivered // due to client errors (for example, when the subscribed endpoint is unreachable) // or server errors (for example, when the service that powers the subscribed // endpoint becomes unavailable) are held in the dead-letter queue for further // analysis or reprocessing. // // * SubscriptionArn – The subscription's ARN. // // * TopicArn – The topic ARN that the subscription is associated with. // // The following attribute applies only to Amazon Data Firehose delivery stream // subscriptions: // // * SubscriptionRoleArn – The ARN of the IAM role that has the following: // Permission to write to the Firehose delivery stream Amazon SNS listed // as a trusted entity Specifying a valid ARN for this attribute is required // for Firehose delivery stream subscriptions. For more information, see // Fanout to Firehose delivery streams (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) // in the Amazon SNS Developer Guide. Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response for GetSubscriptionAttributes action.
func (GetSubscriptionAttributesOutput) GoString ¶ added in v0.6.5
func (s GetSubscriptionAttributesOutput) 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 (*GetSubscriptionAttributesOutput) SetAttributes ¶ added in v1.5.0
func (s *GetSubscriptionAttributesOutput) SetAttributes(v map[string]*string) *GetSubscriptionAttributesOutput
SetAttributes sets the Attributes field's value.
func (GetSubscriptionAttributesOutput) String ¶ added in v0.6.5
func (s GetSubscriptionAttributesOutput) 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 GetTopicAttributesInput ¶
type GetTopicAttributesInput struct { // The ARN of the topic whose properties you want to get. // // TopicArn is a required field TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetTopicAttributes action.
func (GetTopicAttributesInput) GoString ¶ added in v0.6.5
func (s GetTopicAttributesInput) 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 (*GetTopicAttributesInput) SetTopicArn ¶ added in v1.5.0
func (s *GetTopicAttributesInput) SetTopicArn(v string) *GetTopicAttributesInput
SetTopicArn sets the TopicArn field's value.
func (GetTopicAttributesInput) String ¶ added in v0.6.5
func (s GetTopicAttributesInput) 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 (*GetTopicAttributesInput) Validate ¶ added in v1.1.21
func (s *GetTopicAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTopicAttributesOutput ¶
type GetTopicAttributesOutput struct { // A map of the topic's attributes. Attributes in this map include the following: // // * DeliveryPolicy – The JSON serialization of the topic's delivery policy. // // * DisplayName – The human-readable name used in the From field for notifications // to email and email-json endpoints. // // * EffectiveDeliveryPolicy – The JSON serialization of the effective // delivery policy, taking system defaults into account. // // * Owner – The Amazon Web Services account ID of the topic's owner. // // * Policy – The JSON serialization of the topic's access control policy. // // * SignatureVersion – The signature version corresponds to the hashing // algorithm used while creating the signature of the notifications, subscription // confirmations, or unsubscribe confirmation messages sent by Amazon SNS. // By default, SignatureVersion is set to 1. The signature is a Base64-encoded // SHA1withRSA signature. When you set SignatureVersion to 2. Amazon SNS // uses a Base64-encoded SHA256withRSA signature. If the API response does // not include the SignatureVersion attribute, it means that the SignatureVersion // for the topic has value 1. // // * SubscriptionsConfirmed – The number of confirmed subscriptions for // the topic. // // * SubscriptionsDeleted – The number of deleted subscriptions for the // topic. // // * SubscriptionsPending – The number of subscriptions pending confirmation // for the topic. // // * TopicArn – The topic's ARN. // // * TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig // is set to PassThrough, and the topic passes through the tracing header // it receives from an Amazon SNS publisher to its subscriptions. If set // to Active, Amazon SNS will vend X-Ray segment data to topic owner account // if the sampled flag in the tracing header is true. This is only supported // on standard topics. // // The following attribute applies only to server-side-encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): // // * KmsMasterKeyId - The ID of an Amazon Web Services managed customer master // key (CMK) for Amazon SNS or a custom CMK. For more information, see Key // Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). // For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) // in the Key Management Service API Reference. // // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): // // * FifoTopic – When this is set to true, a FIFO topic is created. // // * ContentBasedDeduplication – Enables content-based deduplication for // FIFO topics. By default, ContentBasedDeduplication is set to false. If // you create a FIFO topic and this attribute is false, you must specify // a value for the MessageDeduplicationId parameter for the Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) // action. When you set ContentBasedDeduplication to true, Amazon SNS uses // a SHA-256 hash to generate the MessageDeduplicationId using the body of // the message (but not the attributes of the message). (Optional) To override // the generated value, you can specify a value for the MessageDeduplicationId // parameter for the Publish action. Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response for GetTopicAttributes action.
func (GetTopicAttributesOutput) GoString ¶ added in v0.6.5
func (s GetTopicAttributesOutput) 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 (*GetTopicAttributesOutput) SetAttributes ¶ added in v1.5.0
func (s *GetTopicAttributesOutput) SetAttributes(v map[string]*string) *GetTopicAttributesOutput
SetAttributes sets the Attributes field's value.
func (GetTopicAttributesOutput) String ¶ added in v0.6.5
func (s GetTopicAttributesOutput) 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 ListEndpointsByPlatformApplicationInput ¶
type ListEndpointsByPlatformApplicationInput struct { // NextToken string is used when calling ListEndpointsByPlatformApplication // action to retrieve additional records that are available after the first // page results. NextToken *string `type:"string"` // PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. // // PlatformApplicationArn is a required field PlatformApplicationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for ListEndpointsByPlatformApplication action.
func (ListEndpointsByPlatformApplicationInput) GoString ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationInput) 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 (*ListEndpointsByPlatformApplicationInput) SetNextToken ¶ added in v1.5.0
func (s *ListEndpointsByPlatformApplicationInput) SetNextToken(v string) *ListEndpointsByPlatformApplicationInput
SetNextToken sets the NextToken field's value.
func (*ListEndpointsByPlatformApplicationInput) SetPlatformApplicationArn ¶ added in v1.5.0
func (s *ListEndpointsByPlatformApplicationInput) SetPlatformApplicationArn(v string) *ListEndpointsByPlatformApplicationInput
SetPlatformApplicationArn sets the PlatformApplicationArn field's value.
func (ListEndpointsByPlatformApplicationInput) String ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationInput) 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 (*ListEndpointsByPlatformApplicationInput) Validate ¶ added in v1.1.21
func (s *ListEndpointsByPlatformApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListEndpointsByPlatformApplicationOutput ¶
type ListEndpointsByPlatformApplicationOutput struct { // Endpoints returned for ListEndpointsByPlatformApplication action. Endpoints []*Endpoint `type:"list"` // NextToken string is returned when calling ListEndpointsByPlatformApplication // action if additional records are available after the first page results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Response for ListEndpointsByPlatformApplication action.
func (ListEndpointsByPlatformApplicationOutput) GoString ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationOutput) 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 (*ListEndpointsByPlatformApplicationOutput) SetEndpoints ¶ added in v1.5.0
func (s *ListEndpointsByPlatformApplicationOutput) SetEndpoints(v []*Endpoint) *ListEndpointsByPlatformApplicationOutput
SetEndpoints sets the Endpoints field's value.
func (*ListEndpointsByPlatformApplicationOutput) SetNextToken ¶ added in v1.5.0
func (s *ListEndpointsByPlatformApplicationOutput) SetNextToken(v string) *ListEndpointsByPlatformApplicationOutput
SetNextToken sets the NextToken field's value.
func (ListEndpointsByPlatformApplicationOutput) String ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationOutput) 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 ListOriginationNumbersInput ¶ added in v1.38.52
type ListOriginationNumbersInput struct { // The maximum number of origination numbers to return. MaxResults *int64 `min:"1" type:"integer"` // Token that the previous ListOriginationNumbers request returns. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListOriginationNumbersInput) GoString ¶ added in v1.38.52
func (s ListOriginationNumbersInput) 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 (*ListOriginationNumbersInput) SetMaxResults ¶ added in v1.38.52
func (s *ListOriginationNumbersInput) SetMaxResults(v int64) *ListOriginationNumbersInput
SetMaxResults sets the MaxResults field's value.
func (*ListOriginationNumbersInput) SetNextToken ¶ added in v1.38.52
func (s *ListOriginationNumbersInput) SetNextToken(v string) *ListOriginationNumbersInput
SetNextToken sets the NextToken field's value.
func (ListOriginationNumbersInput) String ¶ added in v1.38.52
func (s ListOriginationNumbersInput) 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 (*ListOriginationNumbersInput) Validate ¶ added in v1.38.52
func (s *ListOriginationNumbersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListOriginationNumbersOutput ¶ added in v1.38.52
type ListOriginationNumbersOutput struct { // A NextToken string is returned when you call the ListOriginationNumbers operation // if additional pages of records are available. NextToken *string `type:"string"` // A list of the calling account's verified and pending origination numbers. PhoneNumbers []*PhoneNumberInformation `type:"list"` // contains filtered or unexported fields }
func (ListOriginationNumbersOutput) GoString ¶ added in v1.38.52
func (s ListOriginationNumbersOutput) 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 (*ListOriginationNumbersOutput) SetNextToken ¶ added in v1.38.52
func (s *ListOriginationNumbersOutput) SetNextToken(v string) *ListOriginationNumbersOutput
SetNextToken sets the NextToken field's value.
func (*ListOriginationNumbersOutput) SetPhoneNumbers ¶ added in v1.38.52
func (s *ListOriginationNumbersOutput) SetPhoneNumbers(v []*PhoneNumberInformation) *ListOriginationNumbersOutput
SetPhoneNumbers sets the PhoneNumbers field's value.
func (ListOriginationNumbersOutput) String ¶ added in v1.38.52
func (s ListOriginationNumbersOutput) 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 ListPhoneNumbersOptedOutInput ¶ added in v1.2.1
type ListPhoneNumbersOptedOutInput struct { // A NextToken string is used when you call the ListPhoneNumbersOptedOut action // to retrieve additional records that are available after the first page of // results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
The input for the ListPhoneNumbersOptedOut action.
func (ListPhoneNumbersOptedOutInput) GoString ¶ added in v1.2.1
func (s ListPhoneNumbersOptedOutInput) 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 (*ListPhoneNumbersOptedOutInput) SetNextToken ¶ added in v1.5.0
func (s *ListPhoneNumbersOptedOutInput) SetNextToken(v string) *ListPhoneNumbersOptedOutInput
SetNextToken sets the NextToken field's value.
func (ListPhoneNumbersOptedOutInput) String ¶ added in v1.2.1
func (s ListPhoneNumbersOptedOutInput) 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 ListPhoneNumbersOptedOutOutput ¶ added in v1.2.1
type ListPhoneNumbersOptedOutOutput struct { // A NextToken string is returned when you call the ListPhoneNumbersOptedOut // action if additional records are available after the first page of results. NextToken *string `locationName:"nextToken" type:"string"` // A list of phone numbers that are opted out of receiving SMS messages. The // list is paginated, and each page can contain up to 100 phone numbers. PhoneNumbers []*string `locationName:"phoneNumbers" type:"list" sensitive:"true"` // contains filtered or unexported fields }
The response from the ListPhoneNumbersOptedOut action.
func (ListPhoneNumbersOptedOutOutput) GoString ¶ added in v1.2.1
func (s ListPhoneNumbersOptedOutOutput) 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 (*ListPhoneNumbersOptedOutOutput) SetNextToken ¶ added in v1.5.0
func (s *ListPhoneNumbersOptedOutOutput) SetNextToken(v string) *ListPhoneNumbersOptedOutOutput
SetNextToken sets the NextToken field's value.
func (*ListPhoneNumbersOptedOutOutput) SetPhoneNumbers ¶ added in v1.5.0
func (s *ListPhoneNumbersOptedOutOutput) SetPhoneNumbers(v []*string) *ListPhoneNumbersOptedOutOutput
SetPhoneNumbers sets the PhoneNumbers field's value.
func (ListPhoneNumbersOptedOutOutput) String ¶ added in v1.2.1
func (s ListPhoneNumbersOptedOutOutput) 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 ListPlatformApplicationsInput ¶
type ListPlatformApplicationsInput struct { // NextToken string is used when calling ListPlatformApplications action to // retrieve additional records that are available after the first page results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Input for ListPlatformApplications action.
func (ListPlatformApplicationsInput) GoString ¶ added in v0.6.5
func (s ListPlatformApplicationsInput) 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 (*ListPlatformApplicationsInput) SetNextToken ¶ added in v1.5.0
func (s *ListPlatformApplicationsInput) SetNextToken(v string) *ListPlatformApplicationsInput
SetNextToken sets the NextToken field's value.
func (ListPlatformApplicationsInput) String ¶ added in v0.6.5
func (s ListPlatformApplicationsInput) 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 ListPlatformApplicationsOutput ¶
type ListPlatformApplicationsOutput struct { // NextToken string is returned when calling ListPlatformApplications action // if additional records are available after the first page results. NextToken *string `type:"string"` // Platform applications returned when calling ListPlatformApplications action. PlatformApplications []*PlatformApplication `type:"list"` // contains filtered or unexported fields }
Response for ListPlatformApplications action.
func (ListPlatformApplicationsOutput) GoString ¶ added in v0.6.5
func (s ListPlatformApplicationsOutput) 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 (*ListPlatformApplicationsOutput) SetNextToken ¶ added in v1.5.0
func (s *ListPlatformApplicationsOutput) SetNextToken(v string) *ListPlatformApplicationsOutput
SetNextToken sets the NextToken field's value.
func (*ListPlatformApplicationsOutput) SetPlatformApplications ¶ added in v1.5.0
func (s *ListPlatformApplicationsOutput) SetPlatformApplications(v []*PlatformApplication) *ListPlatformApplicationsOutput
SetPlatformApplications sets the PlatformApplications field's value.
func (ListPlatformApplicationsOutput) String ¶ added in v0.6.5
func (s ListPlatformApplicationsOutput) 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 ListSMSSandboxPhoneNumbersInput ¶ added in v1.38.52
type ListSMSSandboxPhoneNumbersInput struct { // The maximum number of phone numbers to return. MaxResults *int64 `min:"1" type:"integer"` // Token that the previous ListSMSSandboxPhoneNumbersInput request returns. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListSMSSandboxPhoneNumbersInput) GoString ¶ added in v1.38.52
func (s ListSMSSandboxPhoneNumbersInput) 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 (*ListSMSSandboxPhoneNumbersInput) SetMaxResults ¶ added in v1.38.52
func (s *ListSMSSandboxPhoneNumbersInput) SetMaxResults(v int64) *ListSMSSandboxPhoneNumbersInput
SetMaxResults sets the MaxResults field's value.
func (*ListSMSSandboxPhoneNumbersInput) SetNextToken ¶ added in v1.38.52
func (s *ListSMSSandboxPhoneNumbersInput) SetNextToken(v string) *ListSMSSandboxPhoneNumbersInput
SetNextToken sets the NextToken field's value.
func (ListSMSSandboxPhoneNumbersInput) String ¶ added in v1.38.52
func (s ListSMSSandboxPhoneNumbersInput) 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 (*ListSMSSandboxPhoneNumbersInput) Validate ¶ added in v1.38.52
func (s *ListSMSSandboxPhoneNumbersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListSMSSandboxPhoneNumbersOutput ¶ added in v1.38.52
type ListSMSSandboxPhoneNumbersOutput struct { // A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput // operation if additional pages of records are available. NextToken *string `type:"string"` // A list of the calling account's pending and verified phone numbers. // // PhoneNumbers is a required field PhoneNumbers []*SMSSandboxPhoneNumber `type:"list" required:"true"` // contains filtered or unexported fields }
func (ListSMSSandboxPhoneNumbersOutput) GoString ¶ added in v1.38.52
func (s ListSMSSandboxPhoneNumbersOutput) 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 (*ListSMSSandboxPhoneNumbersOutput) SetNextToken ¶ added in v1.38.52
func (s *ListSMSSandboxPhoneNumbersOutput) SetNextToken(v string) *ListSMSSandboxPhoneNumbersOutput
SetNextToken sets the NextToken field's value.
func (*ListSMSSandboxPhoneNumbersOutput) SetPhoneNumbers ¶ added in v1.38.52
func (s *ListSMSSandboxPhoneNumbersOutput) SetPhoneNumbers(v []*SMSSandboxPhoneNumber) *ListSMSSandboxPhoneNumbersOutput
SetPhoneNumbers sets the PhoneNumbers field's value.
func (ListSMSSandboxPhoneNumbersOutput) String ¶ added in v1.38.52
func (s ListSMSSandboxPhoneNumbersOutput) 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 ListSubscriptionsByTopicInput ¶
type ListSubscriptionsByTopicInput struct { // Token returned by the previous ListSubscriptionsByTopic request. NextToken *string `type:"string"` // The ARN of the topic for which you wish to find subscriptions. // // TopicArn is a required field TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for ListSubscriptionsByTopic action.
func (ListSubscriptionsByTopicInput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsByTopicInput) 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 (*ListSubscriptionsByTopicInput) SetNextToken ¶ added in v1.5.0
func (s *ListSubscriptionsByTopicInput) SetNextToken(v string) *ListSubscriptionsByTopicInput
SetNextToken sets the NextToken field's value.
func (*ListSubscriptionsByTopicInput) SetTopicArn ¶ added in v1.5.0
func (s *ListSubscriptionsByTopicInput) SetTopicArn(v string) *ListSubscriptionsByTopicInput
SetTopicArn sets the TopicArn field's value.
func (ListSubscriptionsByTopicInput) String ¶ added in v0.6.5
func (s ListSubscriptionsByTopicInput) 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 (*ListSubscriptionsByTopicInput) Validate ¶ added in v1.1.21
func (s *ListSubscriptionsByTopicInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListSubscriptionsByTopicOutput ¶
type ListSubscriptionsByTopicOutput struct { // Token to pass along to the next ListSubscriptionsByTopic request. This element // is returned if there are more subscriptions to retrieve. NextToken *string `type:"string"` // A list of subscriptions. Subscriptions []*Subscription `type:"list"` // contains filtered or unexported fields }
Response for ListSubscriptionsByTopic action.
func (ListSubscriptionsByTopicOutput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsByTopicOutput) 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 (*ListSubscriptionsByTopicOutput) SetNextToken ¶ added in v1.5.0
func (s *ListSubscriptionsByTopicOutput) SetNextToken(v string) *ListSubscriptionsByTopicOutput
SetNextToken sets the NextToken field's value.
func (*ListSubscriptionsByTopicOutput) SetSubscriptions ¶ added in v1.5.0
func (s *ListSubscriptionsByTopicOutput) SetSubscriptions(v []*Subscription) *ListSubscriptionsByTopicOutput
SetSubscriptions sets the Subscriptions field's value.
func (ListSubscriptionsByTopicOutput) String ¶ added in v0.6.5
func (s ListSubscriptionsByTopicOutput) 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 ListSubscriptionsInput ¶
type ListSubscriptionsInput struct { // Token returned by the previous ListSubscriptions request. NextToken *string `type:"string"` // contains filtered or unexported fields }
Input for ListSubscriptions action.
func (ListSubscriptionsInput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsInput) 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 (*ListSubscriptionsInput) SetNextToken ¶ added in v1.5.0
func (s *ListSubscriptionsInput) SetNextToken(v string) *ListSubscriptionsInput
SetNextToken sets the NextToken field's value.
func (ListSubscriptionsInput) String ¶ added in v0.6.5
func (s ListSubscriptionsInput) 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 ListSubscriptionsOutput ¶
type ListSubscriptionsOutput struct { // Token to pass along to the next ListSubscriptions request. This element is // returned if there are more subscriptions to retrieve. NextToken *string `type:"string"` // A list of subscriptions. Subscriptions []*Subscription `type:"list"` // contains filtered or unexported fields }
Response for ListSubscriptions action
func (ListSubscriptionsOutput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsOutput) 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 (*ListSubscriptionsOutput) SetNextToken ¶ added in v1.5.0
func (s *ListSubscriptionsOutput) SetNextToken(v string) *ListSubscriptionsOutput
SetNextToken sets the NextToken field's value.
func (*ListSubscriptionsOutput) SetSubscriptions ¶ added in v1.5.0
func (s *ListSubscriptionsOutput) SetSubscriptions(v []*Subscription) *ListSubscriptionsOutput
SetSubscriptions sets the Subscriptions field's value.
func (ListSubscriptionsOutput) String ¶ added in v0.6.5
func (s ListSubscriptionsOutput) 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 ¶ added in v1.19.19
type ListTagsForResourceInput struct { // The ARN of the topic for which to list tags. // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) GoString ¶ added in v1.19.19
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 ¶ added in v1.19.19
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (ListTagsForResourceInput) String ¶ added in v1.19.19
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 ¶ added in v1.19.19
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v1.19.19
type ListTagsForResourceOutput struct { // The tags associated with the specified topic. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) GoString ¶ added in v1.19.19
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 ¶ added in v1.19.19
func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (ListTagsForResourceOutput) String ¶ added in v1.19.19
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 ListTopicsInput ¶
type ListTopicsInput struct { // Token returned by the previous ListTopics request. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListTopicsInput) GoString ¶ added in v0.6.5
func (s ListTopicsInput) 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 (*ListTopicsInput) SetNextToken ¶ added in v1.5.0
func (s *ListTopicsInput) SetNextToken(v string) *ListTopicsInput
SetNextToken sets the NextToken field's value.
func (ListTopicsInput) String ¶ added in v0.6.5
func (s ListTopicsInput) 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 ListTopicsOutput ¶
type ListTopicsOutput struct { // Token to pass along to the next ListTopics request. This element is returned // if there are additional topics to retrieve. NextToken *string `type:"string"` // A list of topic ARNs. Topics []*Topic `type:"list"` // contains filtered or unexported fields }
Response for ListTopics action.
func (ListTopicsOutput) GoString ¶ added in v0.6.5
func (s ListTopicsOutput) 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 (*ListTopicsOutput) SetNextToken ¶ added in v1.5.0
func (s *ListTopicsOutput) SetNextToken(v string) *ListTopicsOutput
SetNextToken sets the NextToken field's value.
func (*ListTopicsOutput) SetTopics ¶ added in v1.5.0
func (s *ListTopicsOutput) SetTopics(v []*Topic) *ListTopicsOutput
SetTopics sets the Topics field's value.
func (ListTopicsOutput) String ¶ added in v0.6.5
func (s ListTopicsOutput) 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 MessageAttributeValue ¶
type MessageAttributeValue struct { // Binary type attributes can store any binary data, for example, compressed // data, encrypted data, or images. // BinaryValue is automatically base64 encoded/decoded by the SDK. BinaryValue []byte `type:"blob"` // Amazon SNS supports the following logical data types: String, String.Array, // Number, and Binary. For more information, see Message Attribute Data Types // (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes). // // DataType is a required field DataType *string `type:"string" required:"true"` // Strings are Unicode with UTF8 binary encoding. For a list of code values, // see ASCII Printable Characters (https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). StringValue *string `type:"string"` // contains filtered or unexported fields }
The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html).
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html) and Publishing to a mobile phone (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) in the Amazon SNS Developer Guide.
func (MessageAttributeValue) GoString ¶ added in v0.6.5
func (s MessageAttributeValue) 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 (*MessageAttributeValue) SetBinaryValue ¶ added in v1.5.0
func (s *MessageAttributeValue) SetBinaryValue(v []byte) *MessageAttributeValue
SetBinaryValue sets the BinaryValue field's value.
func (*MessageAttributeValue) SetDataType ¶ added in v1.5.0
func (s *MessageAttributeValue) SetDataType(v string) *MessageAttributeValue
SetDataType sets the DataType field's value.
func (*MessageAttributeValue) SetStringValue ¶ added in v1.5.0
func (s *MessageAttributeValue) SetStringValue(v string) *MessageAttributeValue
SetStringValue sets the StringValue field's value.
func (MessageAttributeValue) String ¶ added in v0.6.5
func (s MessageAttributeValue) 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 (*MessageAttributeValue) Validate ¶ added in v1.1.21
func (s *MessageAttributeValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type OptInPhoneNumberInput ¶ added in v1.2.1
type OptInPhoneNumberInput struct { // The phone number to opt in. Use E.164 format. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by OptInPhoneNumberInput's // String and GoString methods. // // PhoneNumber is a required field PhoneNumber *string `locationName:"phoneNumber" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
Input for the OptInPhoneNumber action.
func (OptInPhoneNumberInput) GoString ¶ added in v1.2.1
func (s OptInPhoneNumberInput) 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 (*OptInPhoneNumberInput) SetPhoneNumber ¶ added in v1.5.0
func (s *OptInPhoneNumberInput) SetPhoneNumber(v string) *OptInPhoneNumberInput
SetPhoneNumber sets the PhoneNumber field's value.
func (OptInPhoneNumberInput) String ¶ added in v1.2.1
func (s OptInPhoneNumberInput) 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 (*OptInPhoneNumberInput) Validate ¶ added in v1.2.1
func (s *OptInPhoneNumberInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type OptInPhoneNumberOutput ¶ added in v1.2.1
type OptInPhoneNumberOutput struct {
// contains filtered or unexported fields
}
The response for the OptInPhoneNumber action.
func (OptInPhoneNumberOutput) GoString ¶ added in v1.2.1
func (s OptInPhoneNumberOutput) 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 (OptInPhoneNumberOutput) String ¶ added in v1.2.1
func (s OptInPhoneNumberOutput) 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 PhoneNumberInformation ¶ added in v1.38.52
type PhoneNumberInformation struct { // The date and time when the phone number was created. CreatedAt *time.Time `type:"timestamp"` // The two-character code for the country or region, in ISO 3166-1 alpha-2 format. Iso2CountryCode *string `type:"string"` // The capabilities of each phone number. NumberCapabilities []*string `type:"list" enum:"NumberCapability"` // The phone number. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PhoneNumberInformation's // String and GoString methods. PhoneNumber *string `type:"string" sensitive:"true"` // The list of supported routes. RouteType *string `type:"string" enum:"RouteType"` // The status of the phone number. Status *string `type:"string"` // contains filtered or unexported fields }
A list of phone numbers and their metadata.
func (PhoneNumberInformation) GoString ¶ added in v1.38.52
func (s PhoneNumberInformation) 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 (*PhoneNumberInformation) SetCreatedAt ¶ added in v1.38.52
func (s *PhoneNumberInformation) SetCreatedAt(v time.Time) *PhoneNumberInformation
SetCreatedAt sets the CreatedAt field's value.
func (*PhoneNumberInformation) SetIso2CountryCode ¶ added in v1.38.52
func (s *PhoneNumberInformation) SetIso2CountryCode(v string) *PhoneNumberInformation
SetIso2CountryCode sets the Iso2CountryCode field's value.
func (*PhoneNumberInformation) SetNumberCapabilities ¶ added in v1.38.52
func (s *PhoneNumberInformation) SetNumberCapabilities(v []*string) *PhoneNumberInformation
SetNumberCapabilities sets the NumberCapabilities field's value.
func (*PhoneNumberInformation) SetPhoneNumber ¶ added in v1.38.52
func (s *PhoneNumberInformation) SetPhoneNumber(v string) *PhoneNumberInformation
SetPhoneNumber sets the PhoneNumber field's value.
func (*PhoneNumberInformation) SetRouteType ¶ added in v1.38.52
func (s *PhoneNumberInformation) SetRouteType(v string) *PhoneNumberInformation
SetRouteType sets the RouteType field's value.
func (*PhoneNumberInformation) SetStatus ¶ added in v1.38.52
func (s *PhoneNumberInformation) SetStatus(v string) *PhoneNumberInformation
SetStatus sets the Status field's value.
func (PhoneNumberInformation) String ¶ added in v1.38.52
func (s PhoneNumberInformation) 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 PlatformApplication ¶
type PlatformApplication struct { // Attributes for platform application object. Attributes map[string]*string `type:"map"` // PlatformApplicationArn for platform application object. PlatformApplicationArn *string `type:"string"` // contains filtered or unexported fields }
Platform application object.
func (PlatformApplication) GoString ¶ added in v0.6.5
func (s PlatformApplication) 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 (*PlatformApplication) SetAttributes ¶ added in v1.5.0
func (s *PlatformApplication) SetAttributes(v map[string]*string) *PlatformApplication
SetAttributes sets the Attributes field's value.
func (*PlatformApplication) SetPlatformApplicationArn ¶ added in v1.5.0
func (s *PlatformApplication) SetPlatformApplicationArn(v string) *PlatformApplication
SetPlatformApplicationArn sets the PlatformApplicationArn field's value.
func (PlatformApplication) String ¶ added in v0.6.5
func (s PlatformApplication) 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 PublishBatchInput ¶ added in v1.42.7
type PublishBatchInput struct { // A list of PublishBatch request entries to be sent to the SNS topic. // // PublishBatchRequestEntries is a required field PublishBatchRequestEntries []*PublishBatchRequestEntry `type:"list" required:"true"` // The Amazon resource name (ARN) of the topic you want to batch publish to. // // TopicArn is a required field TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (PublishBatchInput) GoString ¶ added in v1.42.7
func (s PublishBatchInput) 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 (*PublishBatchInput) SetPublishBatchRequestEntries ¶ added in v1.42.7
func (s *PublishBatchInput) SetPublishBatchRequestEntries(v []*PublishBatchRequestEntry) *PublishBatchInput
SetPublishBatchRequestEntries sets the PublishBatchRequestEntries field's value.
func (*PublishBatchInput) SetTopicArn ¶ added in v1.42.7
func (s *PublishBatchInput) SetTopicArn(v string) *PublishBatchInput
SetTopicArn sets the TopicArn field's value.
func (PublishBatchInput) String ¶ added in v1.42.7
func (s PublishBatchInput) 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 (*PublishBatchInput) Validate ¶ added in v1.42.7
func (s *PublishBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PublishBatchOutput ¶ added in v1.42.7
type PublishBatchOutput struct { // A list of failed PublishBatch responses. Failed []*BatchResultErrorEntry `type:"list"` // A list of successful PublishBatch responses. Successful []*PublishBatchResultEntry `type:"list"` // contains filtered or unexported fields }
func (PublishBatchOutput) GoString ¶ added in v1.42.7
func (s PublishBatchOutput) 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 (*PublishBatchOutput) SetFailed ¶ added in v1.42.7
func (s *PublishBatchOutput) SetFailed(v []*BatchResultErrorEntry) *PublishBatchOutput
SetFailed sets the Failed field's value.
func (*PublishBatchOutput) SetSuccessful ¶ added in v1.42.7
func (s *PublishBatchOutput) SetSuccessful(v []*PublishBatchResultEntry) *PublishBatchOutput
SetSuccessful sets the Successful field's value.
func (PublishBatchOutput) String ¶ added in v1.42.7
func (s PublishBatchOutput) 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 PublishBatchRequestEntry ¶ added in v1.42.7
type PublishBatchRequestEntry struct { // An identifier for the message in this batch. // // The Ids of a batch request must be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` // The body of the message. // // Message is a required field Message *string `type:"string" required:"true"` // Each message attribute consists of a Name, Type, and Value. For more information, // see Amazon SNS message attributes (https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html) // in the Amazon SNS Developer Guide. MessageAttributes map[string]*MessageAttributeValue `locationNameKey:"Name" locationNameValue:"Value" type:"map"` // This parameter applies only to FIFO (first-in-first-out) topics. // // The token used for deduplication of messages within a 5-minute minimum deduplication // interval. If a message with a particular MessageDeduplicationId is sent successfully, // subsequent messages with the same MessageDeduplicationId are accepted successfully // but aren't delivered. // // * Every message must have a unique MessageDeduplicationId. You may provide // a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId // and you enable ContentBasedDeduplication for your topic, Amazon SNS uses // a SHA-256 hash to generate the MessageDeduplicationId using the body of // the message (but not the attributes of the message). If you don't provide // a MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication // set, the action fails with an error. If the topic has a ContentBasedDeduplication // set, your MessageDeduplicationId overrides the generated one. // // * When ContentBasedDeduplication is in effect, messages with identical // content sent within the deduplication interval are treated as duplicates // and only one copy of the message is delivered. // // * If you send one message with ContentBasedDeduplication enabled, and // then another message with a MessageDeduplicationId that is the same as // the one generated for the first MessageDeduplicationId, the two messages // are treated as duplicates and only one copy of the message is delivered. // // The MessageDeduplicationId is available to the consumer of the message (this // can be useful for troubleshooting delivery issues). // // If a message is sent successfully but the acknowledgement is lost and the // message is resent with the same MessageDeduplicationId after the deduplication // interval, Amazon SNS can't detect duplicate messages. // // Amazon SNS continues to keep track of the message deduplication ID even after // the message is received and deleted. // // The length of MessageDeduplicationId is 128 characters. // // MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) // and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). MessageDeduplicationId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) topics. // // The tag that specifies that a message belongs to a specific message group. // Messages that belong to the same message group are processed in a FIFO manner // (however, messages in different message groups might be processed out of // order). To interleave multiple ordered streams within a single topic, use // MessageGroupId values (for example, session data for multiple users). In // this scenario, multiple consumers can process the topic, but the session // data of each user is processed in a FIFO fashion. // // You must associate a non-empty MessageGroupId with a message. If you don't // provide a MessageGroupId, the action fails. // // The length of MessageGroupId is 128 characters. // // MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // MessageGroupId is required for FIFO topics. You can't use it for standard // topics. MessageGroupId *string `type:"string"` // Set MessageStructure to json if you want to send a different message for // each protocol. For example, using one publish action, you can send a short // message to your SMS subscribers and a longer message to your email subscribers. // If you set MessageStructure to json, the value of the Message parameter must: // // * be a syntactically valid JSON object; and // // * contain at least a top-level JSON key of "default" with a value that // is a string. // // You can define other top-level keys that define the message you want to send // to a specific transport protocol (e.g. http). MessageStructure *string `type:"string"` // The subject of the batch message. Subject *string `type:"string"` // contains filtered or unexported fields }
Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.
func (PublishBatchRequestEntry) GoString ¶ added in v1.42.7
func (s PublishBatchRequestEntry) 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 (*PublishBatchRequestEntry) SetId ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) SetId(v string) *PublishBatchRequestEntry
SetId sets the Id field's value.
func (*PublishBatchRequestEntry) SetMessage ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) SetMessage(v string) *PublishBatchRequestEntry
SetMessage sets the Message field's value.
func (*PublishBatchRequestEntry) SetMessageAttributes ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) SetMessageAttributes(v map[string]*MessageAttributeValue) *PublishBatchRequestEntry
SetMessageAttributes sets the MessageAttributes field's value.
func (*PublishBatchRequestEntry) SetMessageDeduplicationId ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) SetMessageDeduplicationId(v string) *PublishBatchRequestEntry
SetMessageDeduplicationId sets the MessageDeduplicationId field's value.
func (*PublishBatchRequestEntry) SetMessageGroupId ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) SetMessageGroupId(v string) *PublishBatchRequestEntry
SetMessageGroupId sets the MessageGroupId field's value.
func (*PublishBatchRequestEntry) SetMessageStructure ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) SetMessageStructure(v string) *PublishBatchRequestEntry
SetMessageStructure sets the MessageStructure field's value.
func (*PublishBatchRequestEntry) SetSubject ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) SetSubject(v string) *PublishBatchRequestEntry
SetSubject sets the Subject field's value.
func (PublishBatchRequestEntry) String ¶ added in v1.42.7
func (s PublishBatchRequestEntry) 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 (*PublishBatchRequestEntry) Validate ¶ added in v1.42.7
func (s *PublishBatchRequestEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PublishBatchResultEntry ¶ added in v1.42.7
type PublishBatchResultEntry struct { // The Id of an entry in a batch request. Id *string `type:"string"` // An identifier for the message. MessageId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) topics. // // The large, non-consecutive number that Amazon SNS assigns to each message. // // The length of SequenceNumber is 128 bits. SequenceNumber continues to increase // for a particular MessageGroupId. SequenceNumber *string `type:"string"` // contains filtered or unexported fields }
Encloses data related to a successful message in a batch request for topic.
func (PublishBatchResultEntry) GoString ¶ added in v1.42.7
func (s PublishBatchResultEntry) 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 (*PublishBatchResultEntry) SetId ¶ added in v1.42.7
func (s *PublishBatchResultEntry) SetId(v string) *PublishBatchResultEntry
SetId sets the Id field's value.
func (*PublishBatchResultEntry) SetMessageId ¶ added in v1.42.7
func (s *PublishBatchResultEntry) SetMessageId(v string) *PublishBatchResultEntry
SetMessageId sets the MessageId field's value.
func (*PublishBatchResultEntry) SetSequenceNumber ¶ added in v1.42.7
func (s *PublishBatchResultEntry) SetSequenceNumber(v string) *PublishBatchResultEntry
SetSequenceNumber sets the SequenceNumber field's value.
func (PublishBatchResultEntry) String ¶ added in v1.42.7
func (s PublishBatchResultEntry) 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 PublishInput ¶
type PublishInput struct { // The message you want to send. // // If you are publishing to a topic and you want to send the same message to // all transport protocols, include the text of the message as a String value. // If you want to send different messages for each transport protocol, set the // value of the MessageStructure parameter to json and use a JSON object for // the Message parameter. // // Constraints: // // * With the exception of SMS, messages must be UTF-8 encoded strings and // at most 256 KB in size (262,144 bytes, not 262,144 characters). // // * For SMS, each message can contain up to 140 characters. This character // limit depends on the encoding schema. For example, an SMS message can // contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. // If you publish a message that exceeds this size limit, Amazon SNS sends // the message as multiple messages, each fitting within the size limit. // Messages aren't truncated mid-word but are cut off at whole-word boundaries. // The total size limit for a single SMS Publish action is 1,600 characters. // // JSON-specific constraints: // // * Keys in the JSON object that correspond to supported transport protocols // must have simple JSON string values. // // * The values will be parsed (unescaped) before they are used in outgoing // messages. // // * Outbound notifications are JSON encoded (meaning that the characters // will be reescaped for sending). // // * Values have a minimum length of 0 (the empty string, "", is allowed). // // * Values have a maximum length bounded by the overall message size (so, // including multiple protocols may limit message sizes). // // * Non-string values will cause the key to be ignored. // // * Keys that do not correspond to supported transport protocols are ignored. // // * Duplicate keys are not allowed. // // * Failure to parse or validate any key or value in the message will cause // the Publish call to return an error (no partial delivery). // // Message is a required field Message *string `type:"string" required:"true"` // Message attributes for Publish action. MessageAttributes map[string]*MessageAttributeValue `locationNameKey:"Name" locationNameValue:"Value" type:"map"` // This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId // can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // Every message must have a unique MessageDeduplicationId, which is a token // used for deduplication of sent messages. If a message with a particular MessageDeduplicationId // is sent successfully, any message sent with the same MessageDeduplicationId // during the 5-minute deduplication interval is treated as a duplicate. // // If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId // based on the contents of the message. Your MessageDeduplicationId overrides // the generated one. MessageDeduplicationId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId // can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // The MessageGroupId is a tag that specifies that a message belongs to a specific // message group. Messages that belong to the same message group are processed // in a FIFO manner (however, messages in different message groups might be // processed out of order). Every message must include a MessageGroupId. MessageGroupId *string `type:"string"` // Set MessageStructure to json if you want to send a different message for // each protocol. For example, using one publish action, you can send a short // message to your SMS subscribers and a longer message to your email subscribers. // If you set MessageStructure to json, the value of the Message parameter must: // // * be a syntactically valid JSON object; and // // * contain at least a top-level JSON key of "default" with a value that // is a string. // // You can define other top-level keys that define the message you want to send // to a specific transport protocol (e.g., "http"). // // Valid value: json MessageStructure *string `type:"string"` // The phone number to which you want to deliver an SMS message. Use E.164 format. // // If you don't specify a value for the PhoneNumber parameter, you must specify // a value for the TargetArn or TopicArn parameters. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PublishInput's // String and GoString methods. PhoneNumber *string `type:"string" sensitive:"true"` // Optional parameter to be used as the "Subject" line when the message is delivered // to email endpoints. This field will also be included, if present, in the // standard JSON messages delivered to other endpoints. // // Constraints: Subjects must be UTF-8 text with no line breaks or control characters, // and less than 100 characters long. Subject *string `type:"string"` // If you don't specify a value for the TargetArn parameter, you must specify // a value for the PhoneNumber or TopicArn parameters. TargetArn *string `type:"string"` // The topic you want to publish to. // // If you don't specify a value for the TopicArn parameter, you must specify // a value for the PhoneNumber or TargetArn parameters. TopicArn *string `type:"string"` // contains filtered or unexported fields }
Input for Publish action.
func (PublishInput) GoString ¶ added in v0.6.5
func (s PublishInput) 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 (*PublishInput) SetMessage ¶ added in v1.5.0
func (s *PublishInput) SetMessage(v string) *PublishInput
SetMessage sets the Message field's value.
func (*PublishInput) SetMessageAttributes ¶ added in v1.5.0
func (s *PublishInput) SetMessageAttributes(v map[string]*MessageAttributeValue) *PublishInput
SetMessageAttributes sets the MessageAttributes field's value.
func (*PublishInput) SetMessageDeduplicationId ¶ added in v1.35.13
func (s *PublishInput) SetMessageDeduplicationId(v string) *PublishInput
SetMessageDeduplicationId sets the MessageDeduplicationId field's value.
func (*PublishInput) SetMessageGroupId ¶ added in v1.35.13
func (s *PublishInput) SetMessageGroupId(v string) *PublishInput
SetMessageGroupId sets the MessageGroupId field's value.
func (*PublishInput) SetMessageStructure ¶ added in v1.5.0
func (s *PublishInput) SetMessageStructure(v string) *PublishInput
SetMessageStructure sets the MessageStructure field's value.
func (*PublishInput) SetPhoneNumber ¶ added in v1.5.0
func (s *PublishInput) SetPhoneNumber(v string) *PublishInput
SetPhoneNumber sets the PhoneNumber field's value.
func (*PublishInput) SetSubject ¶ added in v1.5.0
func (s *PublishInput) SetSubject(v string) *PublishInput
SetSubject sets the Subject field's value.
func (*PublishInput) SetTargetArn ¶ added in v1.5.0
func (s *PublishInput) SetTargetArn(v string) *PublishInput
SetTargetArn sets the TargetArn field's value.
func (*PublishInput) SetTopicArn ¶ added in v1.5.0
func (s *PublishInput) SetTopicArn(v string) *PublishInput
SetTopicArn sets the TopicArn field's value.
func (PublishInput) String ¶ added in v0.6.5
func (s PublishInput) 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 (*PublishInput) Validate ¶ added in v1.1.21
func (s *PublishInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PublishOutput ¶
type PublishOutput struct { // Unique identifier assigned to the published message. // // Length Constraint: Maximum 100 characters MessageId *string `type:"string"` // This response element applies only to FIFO (first-in-first-out) topics. // // The sequence number is a large, non-consecutive number that Amazon SNS assigns // to each message. The length of SequenceNumber is 128 bits. SequenceNumber // continues to increase for each MessageGroupId. SequenceNumber *string `type:"string"` // contains filtered or unexported fields }
Response for Publish action.
func (PublishOutput) GoString ¶ added in v0.6.5
func (s PublishOutput) 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 (*PublishOutput) SetMessageId ¶ added in v1.5.0
func (s *PublishOutput) SetMessageId(v string) *PublishOutput
SetMessageId sets the MessageId field's value.
func (*PublishOutput) SetSequenceNumber ¶ added in v1.35.13
func (s *PublishOutput) SetSequenceNumber(v string) *PublishOutput
SetSequenceNumber sets the SequenceNumber field's value.
func (PublishOutput) String ¶ added in v0.6.5
func (s PublishOutput) 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 PutDataProtectionPolicyInput ¶ added in v1.44.93
type PutDataProtectionPolicyInput struct { // The JSON serialization of the topic's DataProtectionPolicy. // // The DataProtectionPolicy must be in JSON string format. // // Length Constraints: Maximum length of 30,720. // // DataProtectionPolicy is a required field DataProtectionPolicy *string `type:"string" required:"true"` // The ARN of the topic whose DataProtectionPolicy you want to add or update. // // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // in the Amazon Web Services General Reference. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (PutDataProtectionPolicyInput) GoString ¶ added in v1.44.93
func (s PutDataProtectionPolicyInput) 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 (*PutDataProtectionPolicyInput) SetDataProtectionPolicy ¶ added in v1.44.93
func (s *PutDataProtectionPolicyInput) SetDataProtectionPolicy(v string) *PutDataProtectionPolicyInput
SetDataProtectionPolicy sets the DataProtectionPolicy field's value.
func (*PutDataProtectionPolicyInput) SetResourceArn ¶ added in v1.44.93
func (s *PutDataProtectionPolicyInput) SetResourceArn(v string) *PutDataProtectionPolicyInput
SetResourceArn sets the ResourceArn field's value.
func (PutDataProtectionPolicyInput) String ¶ added in v1.44.93
func (s PutDataProtectionPolicyInput) 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 (*PutDataProtectionPolicyInput) Validate ¶ added in v1.44.93
func (s *PutDataProtectionPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutDataProtectionPolicyOutput ¶ added in v1.44.93
type PutDataProtectionPolicyOutput struct {
// contains filtered or unexported fields
}
func (PutDataProtectionPolicyOutput) GoString ¶ added in v1.44.93
func (s PutDataProtectionPolicyOutput) 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 (PutDataProtectionPolicyOutput) String ¶ added in v1.44.93
func (s PutDataProtectionPolicyOutput) 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 RemovePermissionInput ¶
type RemovePermissionInput struct { // The unique label of the statement you want to remove. // // Label is a required field Label *string `type:"string" required:"true"` // The ARN of the topic whose access control policy you wish to modify. // // TopicArn is a required field TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for RemovePermission action.
func (RemovePermissionInput) GoString ¶ added in v0.6.5
func (s RemovePermissionInput) 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 (*RemovePermissionInput) SetLabel ¶ added in v1.5.0
func (s *RemovePermissionInput) SetLabel(v string) *RemovePermissionInput
SetLabel sets the Label field's value.
func (*RemovePermissionInput) SetTopicArn ¶ added in v1.5.0
func (s *RemovePermissionInput) SetTopicArn(v string) *RemovePermissionInput
SetTopicArn sets the TopicArn field's value.
func (RemovePermissionInput) String ¶ added in v0.6.5
func (s RemovePermissionInput) 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 (*RemovePermissionInput) Validate ¶ added in v1.1.21
func (s *RemovePermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemovePermissionOutput ¶
type RemovePermissionOutput struct {
// contains filtered or unexported fields
}
func (RemovePermissionOutput) GoString ¶ added in v0.6.5
func (s RemovePermissionOutput) 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 (RemovePermissionOutput) String ¶ added in v0.6.5
func (s RemovePermissionOutput) 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 SMSSandboxPhoneNumber ¶ added in v1.38.52
type SMSSandboxPhoneNumber struct { // The destination phone number. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SMSSandboxPhoneNumber's // String and GoString methods. PhoneNumber *string `type:"string" sensitive:"true"` // The destination phone number's verification status. Status *string `type:"string" enum:"SMSSandboxPhoneNumberVerificationStatus"` // contains filtered or unexported fields }
A verified or pending destination phone number in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon SNS Developer Guide.
func (SMSSandboxPhoneNumber) GoString ¶ added in v1.38.52
func (s SMSSandboxPhoneNumber) 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 (*SMSSandboxPhoneNumber) SetPhoneNumber ¶ added in v1.38.52
func (s *SMSSandboxPhoneNumber) SetPhoneNumber(v string) *SMSSandboxPhoneNumber
SetPhoneNumber sets the PhoneNumber field's value.
func (*SMSSandboxPhoneNumber) SetStatus ¶ added in v1.38.52
func (s *SMSSandboxPhoneNumber) SetStatus(v string) *SMSSandboxPhoneNumber
SetStatus sets the Status field's value.
func (SMSSandboxPhoneNumber) String ¶ added in v1.38.52
func (s SMSSandboxPhoneNumber) 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 SNS ¶
SNS provides the API operation methods for making requests to Amazon Simple Notification Service. See this package's package overview docs for details on the service.
SNS 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) *SNS
New creates a new instance of the SNS 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 SNS client from just a session. svc := sns.New(mySession) // Create a SNS client with additional configuration svc := sns.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*SNS) AddPermission ¶
func (c *SNS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error)
AddPermission API operation for Amazon Simple Notification Service.
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.
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 Amazon Simple Notification Service's API operation AddPermission for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermission
func (*SNS) AddPermissionRequest ¶
func (c *SNS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)
AddPermissionRequest generates a "aws/request.Request" representing the client's request for the AddPermission 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 AddPermission for more information on using the AddPermission 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 AddPermissionRequest method. req, resp := client.AddPermissionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermission
func (*SNS) AddPermissionWithContext ¶ added in v1.8.0
func (c *SNS) AddPermissionWithContext(ctx aws.Context, input *AddPermissionInput, opts ...request.Option) (*AddPermissionOutput, error)
AddPermissionWithContext is the same as AddPermission with the addition of the ability to pass a context and additional request options.
See AddPermission 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 (*SNS) CheckIfPhoneNumberIsOptedOut ¶ added in v1.2.1
func (c *SNS) CheckIfPhoneNumberIsOptedOut(input *CheckIfPhoneNumberIsOptedOutInput) (*CheckIfPhoneNumberIsOptedOutOutput, error)
CheckIfPhoneNumberIsOptedOut API operation for Amazon Simple Notification Service.
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
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 Amazon Simple Notification Service's API operation CheckIfPhoneNumberIsOptedOut for usage and error information.
Returned Error Codes:
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOut
func (*SNS) CheckIfPhoneNumberIsOptedOutRequest ¶ added in v1.2.1
func (c *SNS) CheckIfPhoneNumberIsOptedOutRequest(input *CheckIfPhoneNumberIsOptedOutInput) (req *request.Request, output *CheckIfPhoneNumberIsOptedOutOutput)
CheckIfPhoneNumberIsOptedOutRequest generates a "aws/request.Request" representing the client's request for the CheckIfPhoneNumberIsOptedOut 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 CheckIfPhoneNumberIsOptedOut for more information on using the CheckIfPhoneNumberIsOptedOut 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 CheckIfPhoneNumberIsOptedOutRequest method. req, resp := client.CheckIfPhoneNumberIsOptedOutRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOut
func (*SNS) CheckIfPhoneNumberIsOptedOutWithContext ¶ added in v1.8.0
func (c *SNS) CheckIfPhoneNumberIsOptedOutWithContext(ctx aws.Context, input *CheckIfPhoneNumberIsOptedOutInput, opts ...request.Option) (*CheckIfPhoneNumberIsOptedOutOutput, error)
CheckIfPhoneNumberIsOptedOutWithContext is the same as CheckIfPhoneNumberIsOptedOut with the addition of the ability to pass a context and additional request options.
See CheckIfPhoneNumberIsOptedOut 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 (*SNS) ConfirmSubscription ¶
func (c *SNS) ConfirmSubscription(input *ConfirmSubscriptionInput) (*ConfirmSubscriptionOutput, error)
ConfirmSubscription API operation for Amazon Simple Notification Service.
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".
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 Amazon Simple Notification Service's API operation ConfirmSubscription for usage and error information.
Returned Error Codes:
ErrCodeSubscriptionLimitExceededException "SubscriptionLimitExceeded" Indicates that the customer already owns the maximum allowed number of subscriptions.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeFilterPolicyLimitExceededException "FilterPolicyLimitExceeded" Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
ErrCodeReplayLimitExceededException "ReplayLimitExceeded" Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscription
func (*SNS) ConfirmSubscriptionRequest ¶
func (c *SNS) ConfirmSubscriptionRequest(input *ConfirmSubscriptionInput) (req *request.Request, output *ConfirmSubscriptionOutput)
ConfirmSubscriptionRequest generates a "aws/request.Request" representing the client's request for the ConfirmSubscription 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 ConfirmSubscription for more information on using the ConfirmSubscription 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 ConfirmSubscriptionRequest method. req, resp := client.ConfirmSubscriptionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscription
func (*SNS) ConfirmSubscriptionWithContext ¶ added in v1.8.0
func (c *SNS) ConfirmSubscriptionWithContext(ctx aws.Context, input *ConfirmSubscriptionInput, opts ...request.Option) (*ConfirmSubscriptionOutput, error)
ConfirmSubscriptionWithContext is the same as ConfirmSubscription with the addition of the ability to pass a context and additional request options.
See ConfirmSubscription 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 (*SNS) CreatePlatformApplication ¶
func (c *SNS) CreatePlatformApplication(input *CreatePlatformApplicationInput) (*CreatePlatformApplicationOutput, error)
CreatePlatformApplication API operation for Amazon Simple Notification Service.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.
PlatformPrincipal and PlatformCredential are received from the notification service.
For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.
For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.
For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.
For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.
You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.
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 Amazon Simple Notification Service's API operation CreatePlatformApplication for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplication
func (*SNS) CreatePlatformApplicationRequest ¶
func (c *SNS) CreatePlatformApplicationRequest(input *CreatePlatformApplicationInput) (req *request.Request, output *CreatePlatformApplicationOutput)
CreatePlatformApplicationRequest generates a "aws/request.Request" representing the client's request for the CreatePlatformApplication 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 CreatePlatformApplication for more information on using the CreatePlatformApplication 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 CreatePlatformApplicationRequest method. req, resp := client.CreatePlatformApplicationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplication
func (*SNS) CreatePlatformApplicationWithContext ¶ added in v1.8.0
func (c *SNS) CreatePlatformApplicationWithContext(ctx aws.Context, input *CreatePlatformApplicationInput, opts ...request.Option) (*CreatePlatformApplicationOutput, error)
CreatePlatformApplicationWithContext is the same as CreatePlatformApplication with the addition of the ability to pass a context and additional request options.
See CreatePlatformApplication 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 (*SNS) CreatePlatformEndpoint ¶
func (c *SNS) CreatePlatformEndpoint(input *CreatePlatformEndpointInput) (*CreatePlatformEndpointOutput, error)
CreatePlatformEndpoint API operation for Amazon Simple Notification Service.
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html).
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 Amazon Simple Notification Service's API operation CreatePlatformEndpoint for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformEndpoint
func (*SNS) CreatePlatformEndpointRequest ¶
func (c *SNS) CreatePlatformEndpointRequest(input *CreatePlatformEndpointInput) (req *request.Request, output *CreatePlatformEndpointOutput)
CreatePlatformEndpointRequest generates a "aws/request.Request" representing the client's request for the CreatePlatformEndpoint 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 CreatePlatformEndpoint for more information on using the CreatePlatformEndpoint 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 CreatePlatformEndpointRequest method. req, resp := client.CreatePlatformEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformEndpoint
func (*SNS) CreatePlatformEndpointWithContext ¶ added in v1.8.0
func (c *SNS) CreatePlatformEndpointWithContext(ctx aws.Context, input *CreatePlatformEndpointInput, opts ...request.Option) (*CreatePlatformEndpointOutput, error)
CreatePlatformEndpointWithContext is the same as CreatePlatformEndpoint with the addition of the ability to pass a context and additional request options.
See CreatePlatformEndpoint 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 (*SNS) CreateSMSSandboxPhoneNumber ¶ added in v1.38.52
func (c *SNS) CreateSMSSandboxPhoneNumber(input *CreateSMSSandboxPhoneNumberInput) (*CreateSMSSandboxPhoneNumberOutput, error)
CreateSMSSandboxPhoneNumber API operation for Amazon Simple Notification Service.
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon SNS Developer Guide.
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 Amazon Simple Notification Service's API operation CreateSMSSandboxPhoneNumber for usage and error information.
Returned Error Codes:
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeOptedOutException "OptedOut" Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.
ErrCodeUserErrorException "UserError" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateSMSSandboxPhoneNumber
func (*SNS) CreateSMSSandboxPhoneNumberRequest ¶ added in v1.38.52
func (c *SNS) CreateSMSSandboxPhoneNumberRequest(input *CreateSMSSandboxPhoneNumberInput) (req *request.Request, output *CreateSMSSandboxPhoneNumberOutput)
CreateSMSSandboxPhoneNumberRequest generates a "aws/request.Request" representing the client's request for the CreateSMSSandboxPhoneNumber 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 CreateSMSSandboxPhoneNumber for more information on using the CreateSMSSandboxPhoneNumber 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 CreateSMSSandboxPhoneNumberRequest method. req, resp := client.CreateSMSSandboxPhoneNumberRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateSMSSandboxPhoneNumber
func (*SNS) CreateSMSSandboxPhoneNumberWithContext ¶ added in v1.38.52
func (c *SNS) CreateSMSSandboxPhoneNumberWithContext(ctx aws.Context, input *CreateSMSSandboxPhoneNumberInput, opts ...request.Option) (*CreateSMSSandboxPhoneNumberOutput, error)
CreateSMSSandboxPhoneNumberWithContext is the same as CreateSMSSandboxPhoneNumber with the addition of the ability to pass a context and additional request options.
See CreateSMSSandboxPhoneNumber 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 (*SNS) CreateTopic ¶
func (c *SNS) CreateTopic(input *CreateTopicInput) (*CreateTopicOutput, error)
CreateTopic API operation for Amazon Simple Notification Service.
Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic (https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
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 Amazon Simple Notification Service's API operation CreateTopic for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeTopicLimitExceededException "TopicLimitExceeded" Indicates that the customer already owns the maximum allowed number of topics.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInvalidSecurityException "InvalidSecurity" The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
ErrCodeTagLimitExceededException "TagLimitExceeded" Can't add more than 50 tags to a topic.
ErrCodeStaleTagException "StaleTag" A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
ErrCodeTagPolicyException "TagPolicy" The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
ErrCodeConcurrentAccessException "ConcurrentAccess" Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopic
func (*SNS) CreateTopicRequest ¶
func (c *SNS) CreateTopicRequest(input *CreateTopicInput) (req *request.Request, output *CreateTopicOutput)
CreateTopicRequest generates a "aws/request.Request" representing the client's request for the CreateTopic 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 CreateTopic for more information on using the CreateTopic 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 CreateTopicRequest method. req, resp := client.CreateTopicRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopic
func (*SNS) CreateTopicWithContext ¶ added in v1.8.0
func (c *SNS) CreateTopicWithContext(ctx aws.Context, input *CreateTopicInput, opts ...request.Option) (*CreateTopicOutput, error)
CreateTopicWithContext is the same as CreateTopic with the addition of the ability to pass a context and additional request options.
See CreateTopic 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 (*SNS) DeleteEndpoint ¶
func (c *SNS) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
DeleteEndpoint API operation for Amazon Simple Notification Service.
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
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 Amazon Simple Notification Service's API operation DeleteEndpoint for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpoint
func (*SNS) DeleteEndpointRequest ¶
func (c *SNS) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
DeleteEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteEndpoint 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 DeleteEndpoint for more information on using the DeleteEndpoint 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 DeleteEndpointRequest method. req, resp := client.DeleteEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpoint
func (*SNS) DeleteEndpointWithContext ¶ added in v1.8.0
func (c *SNS) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)
DeleteEndpointWithContext is the same as DeleteEndpoint with the addition of the ability to pass a context and additional request options.
See DeleteEndpoint 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 (*SNS) DeletePlatformApplication ¶
func (c *SNS) DeletePlatformApplication(input *DeletePlatformApplicationInput) (*DeletePlatformApplicationOutput, error)
DeletePlatformApplication API operation for Amazon Simple Notification Service.
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
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 Amazon Simple Notification Service's API operation DeletePlatformApplication for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplication
func (*SNS) DeletePlatformApplicationRequest ¶
func (c *SNS) DeletePlatformApplicationRequest(input *DeletePlatformApplicationInput) (req *request.Request, output *DeletePlatformApplicationOutput)
DeletePlatformApplicationRequest generates a "aws/request.Request" representing the client's request for the DeletePlatformApplication 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 DeletePlatformApplication for more information on using the DeletePlatformApplication 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 DeletePlatformApplicationRequest method. req, resp := client.DeletePlatformApplicationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplication
func (*SNS) DeletePlatformApplicationWithContext ¶ added in v1.8.0
func (c *SNS) DeletePlatformApplicationWithContext(ctx aws.Context, input *DeletePlatformApplicationInput, opts ...request.Option) (*DeletePlatformApplicationOutput, error)
DeletePlatformApplicationWithContext is the same as DeletePlatformApplication with the addition of the ability to pass a context and additional request options.
See DeletePlatformApplication 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 (*SNS) DeleteSMSSandboxPhoneNumber ¶ added in v1.38.52
func (c *SNS) DeleteSMSSandboxPhoneNumber(input *DeleteSMSSandboxPhoneNumberInput) (*DeleteSMSSandboxPhoneNumberOutput, error)
DeleteSMSSandboxPhoneNumber API operation for Amazon Simple Notification Service.
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon SNS Developer Guide.
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 Amazon Simple Notification Service's API operation DeleteSMSSandboxPhoneNumber for usage and error information.
Returned Error Codes:
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeResourceNotFoundException "ResourceNotFound" Can’t perform the action on the specified resource. Make sure that the resource exists.
ErrCodeUserErrorException "UserError" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteSMSSandboxPhoneNumber
func (*SNS) DeleteSMSSandboxPhoneNumberRequest ¶ added in v1.38.52
func (c *SNS) DeleteSMSSandboxPhoneNumberRequest(input *DeleteSMSSandboxPhoneNumberInput) (req *request.Request, output *DeleteSMSSandboxPhoneNumberOutput)
DeleteSMSSandboxPhoneNumberRequest generates a "aws/request.Request" representing the client's request for the DeleteSMSSandboxPhoneNumber 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 DeleteSMSSandboxPhoneNumber for more information on using the DeleteSMSSandboxPhoneNumber 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 DeleteSMSSandboxPhoneNumberRequest method. req, resp := client.DeleteSMSSandboxPhoneNumberRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteSMSSandboxPhoneNumber
func (*SNS) DeleteSMSSandboxPhoneNumberWithContext ¶ added in v1.38.52
func (c *SNS) DeleteSMSSandboxPhoneNumberWithContext(ctx aws.Context, input *DeleteSMSSandboxPhoneNumberInput, opts ...request.Option) (*DeleteSMSSandboxPhoneNumberOutput, error)
DeleteSMSSandboxPhoneNumberWithContext is the same as DeleteSMSSandboxPhoneNumber with the addition of the ability to pass a context and additional request options.
See DeleteSMSSandboxPhoneNumber 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 (*SNS) DeleteTopic ¶
func (c *SNS) DeleteTopic(input *DeleteTopicInput) (*DeleteTopicOutput, error)
DeleteTopic API operation for Amazon Simple Notification Service.
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
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 Amazon Simple Notification Service's API operation DeleteTopic for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInvalidStateException "InvalidState" Indicates that the specified state is not a valid state for an event source.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeStaleTagException "StaleTag" A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
ErrCodeTagPolicyException "TagPolicy" The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
ErrCodeConcurrentAccessException "ConcurrentAccess" Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteTopic
func (*SNS) DeleteTopicRequest ¶
func (c *SNS) DeleteTopicRequest(input *DeleteTopicInput) (req *request.Request, output *DeleteTopicOutput)
DeleteTopicRequest generates a "aws/request.Request" representing the client's request for the DeleteTopic 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 DeleteTopic for more information on using the DeleteTopic 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 DeleteTopicRequest method. req, resp := client.DeleteTopicRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteTopic
func (*SNS) DeleteTopicWithContext ¶ added in v1.8.0
func (c *SNS) DeleteTopicWithContext(ctx aws.Context, input *DeleteTopicInput, opts ...request.Option) (*DeleteTopicOutput, error)
DeleteTopicWithContext is the same as DeleteTopic with the addition of the ability to pass a context and additional request options.
See DeleteTopic 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 (*SNS) GetDataProtectionPolicy ¶ added in v1.44.93
func (c *SNS) GetDataProtectionPolicy(input *GetDataProtectionPolicyInput) (*GetDataProtectionPolicyOutput, error)
GetDataProtectionPolicy API operation for Amazon Simple Notification Service.
Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.
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 Amazon Simple Notification Service's API operation GetDataProtectionPolicy for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInvalidSecurityException "InvalidSecurity" The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetDataProtectionPolicy
func (*SNS) GetDataProtectionPolicyRequest ¶ added in v1.44.93
func (c *SNS) GetDataProtectionPolicyRequest(input *GetDataProtectionPolicyInput) (req *request.Request, output *GetDataProtectionPolicyOutput)
GetDataProtectionPolicyRequest generates a "aws/request.Request" representing the client's request for the GetDataProtectionPolicy 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 GetDataProtectionPolicy for more information on using the GetDataProtectionPolicy 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 GetDataProtectionPolicyRequest method. req, resp := client.GetDataProtectionPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetDataProtectionPolicy
func (*SNS) GetDataProtectionPolicyWithContext ¶ added in v1.44.93
func (c *SNS) GetDataProtectionPolicyWithContext(ctx aws.Context, input *GetDataProtectionPolicyInput, opts ...request.Option) (*GetDataProtectionPolicyOutput, error)
GetDataProtectionPolicyWithContext is the same as GetDataProtectionPolicy with the addition of the ability to pass a context and additional request options.
See GetDataProtectionPolicy 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 (*SNS) GetEndpointAttributes ¶
func (c *SNS) GetEndpointAttributes(input *GetEndpointAttributesInput) (*GetEndpointAttributesOutput, error)
GetEndpointAttributes API operation for Amazon Simple Notification Service.
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
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 Amazon Simple Notification Service's API operation GetEndpointAttributes for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributes
func (*SNS) GetEndpointAttributesRequest ¶
func (c *SNS) GetEndpointAttributesRequest(input *GetEndpointAttributesInput) (req *request.Request, output *GetEndpointAttributesOutput)
GetEndpointAttributesRequest generates a "aws/request.Request" representing the client's request for the GetEndpointAttributes 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 GetEndpointAttributes for more information on using the GetEndpointAttributes 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 GetEndpointAttributesRequest method. req, resp := client.GetEndpointAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributes
func (*SNS) GetEndpointAttributesWithContext ¶ added in v1.8.0
func (c *SNS) GetEndpointAttributesWithContext(ctx aws.Context, input *GetEndpointAttributesInput, opts ...request.Option) (*GetEndpointAttributesOutput, error)
GetEndpointAttributesWithContext is the same as GetEndpointAttributes with the addition of the ability to pass a context and additional request options.
See GetEndpointAttributes 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 (*SNS) GetPlatformApplicationAttributes ¶
func (c *SNS) GetPlatformApplicationAttributes(input *GetPlatformApplicationAttributesInput) (*GetPlatformApplicationAttributesOutput, error)
GetPlatformApplicationAttributes API operation for Amazon Simple Notification Service.
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
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 Amazon Simple Notification Service's API operation GetPlatformApplicationAttributes for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributes
func (*SNS) GetPlatformApplicationAttributesRequest ¶
func (c *SNS) GetPlatformApplicationAttributesRequest(input *GetPlatformApplicationAttributesInput) (req *request.Request, output *GetPlatformApplicationAttributesOutput)
GetPlatformApplicationAttributesRequest generates a "aws/request.Request" representing the client's request for the GetPlatformApplicationAttributes 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 GetPlatformApplicationAttributes for more information on using the GetPlatformApplicationAttributes 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 GetPlatformApplicationAttributesRequest method. req, resp := client.GetPlatformApplicationAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributes
func (*SNS) GetPlatformApplicationAttributesWithContext ¶ added in v1.8.0
func (c *SNS) GetPlatformApplicationAttributesWithContext(ctx aws.Context, input *GetPlatformApplicationAttributesInput, opts ...request.Option) (*GetPlatformApplicationAttributesOutput, error)
GetPlatformApplicationAttributesWithContext is the same as GetPlatformApplicationAttributes with the addition of the ability to pass a context and additional request options.
See GetPlatformApplicationAttributes 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 (*SNS) GetSMSAttributes ¶ added in v1.2.1
func (c *SNS) GetSMSAttributes(input *GetSMSAttributesInput) (*GetSMSAttributesOutput, error)
GetSMSAttributes API operation for Amazon Simple Notification Service.
Returns the settings for sending SMS messages from your Amazon Web Services account.
These settings are set with the SetSMSAttributes action.
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 Amazon Simple Notification Service's API operation GetSMSAttributes for usage and error information.
Returned Error Codes:
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributes
func (*SNS) GetSMSAttributesRequest ¶ added in v1.2.1
func (c *SNS) GetSMSAttributesRequest(input *GetSMSAttributesInput) (req *request.Request, output *GetSMSAttributesOutput)
GetSMSAttributesRequest generates a "aws/request.Request" representing the client's request for the GetSMSAttributes 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 GetSMSAttributes for more information on using the GetSMSAttributes 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 GetSMSAttributesRequest method. req, resp := client.GetSMSAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributes
func (*SNS) GetSMSAttributesWithContext ¶ added in v1.8.0
func (c *SNS) GetSMSAttributesWithContext(ctx aws.Context, input *GetSMSAttributesInput, opts ...request.Option) (*GetSMSAttributesOutput, error)
GetSMSAttributesWithContext is the same as GetSMSAttributes with the addition of the ability to pass a context and additional request options.
See GetSMSAttributes 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 (*SNS) GetSMSSandboxAccountStatus ¶ added in v1.38.52
func (c *SNS) GetSMSSandboxAccountStatus(input *GetSMSSandboxAccountStatusInput) (*GetSMSSandboxAccountStatusOutput, error)
GetSMSSandboxAccountStatus API operation for Amazon Simple Notification Service.
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon SNS Developer Guide.
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 Amazon Simple Notification Service's API operation GetSMSSandboxAccountStatus for usage and error information.
Returned Error Codes:
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSSandboxAccountStatus
func (*SNS) GetSMSSandboxAccountStatusRequest ¶ added in v1.38.52
func (c *SNS) GetSMSSandboxAccountStatusRequest(input *GetSMSSandboxAccountStatusInput) (req *request.Request, output *GetSMSSandboxAccountStatusOutput)
GetSMSSandboxAccountStatusRequest generates a "aws/request.Request" representing the client's request for the GetSMSSandboxAccountStatus 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 GetSMSSandboxAccountStatus for more information on using the GetSMSSandboxAccountStatus 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 GetSMSSandboxAccountStatusRequest method. req, resp := client.GetSMSSandboxAccountStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSSandboxAccountStatus
func (*SNS) GetSMSSandboxAccountStatusWithContext ¶ added in v1.38.52
func (c *SNS) GetSMSSandboxAccountStatusWithContext(ctx aws.Context, input *GetSMSSandboxAccountStatusInput, opts ...request.Option) (*GetSMSSandboxAccountStatusOutput, error)
GetSMSSandboxAccountStatusWithContext is the same as GetSMSSandboxAccountStatus with the addition of the ability to pass a context and additional request options.
See GetSMSSandboxAccountStatus 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 (*SNS) GetSubscriptionAttributes ¶
func (c *SNS) GetSubscriptionAttributes(input *GetSubscriptionAttributesInput) (*GetSubscriptionAttributesOutput, error)
GetSubscriptionAttributes API operation for Amazon Simple Notification Service.
Returns all of the properties of a subscription.
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 Amazon Simple Notification Service's API operation GetSubscriptionAttributes for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributes
func (*SNS) GetSubscriptionAttributesRequest ¶
func (c *SNS) GetSubscriptionAttributesRequest(input *GetSubscriptionAttributesInput) (req *request.Request, output *GetSubscriptionAttributesOutput)
GetSubscriptionAttributesRequest generates a "aws/request.Request" representing the client's request for the GetSubscriptionAttributes 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 GetSubscriptionAttributes for more information on using the GetSubscriptionAttributes 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 GetSubscriptionAttributesRequest method. req, resp := client.GetSubscriptionAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributes
func (*SNS) GetSubscriptionAttributesWithContext ¶ added in v1.8.0
func (c *SNS) GetSubscriptionAttributesWithContext(ctx aws.Context, input *GetSubscriptionAttributesInput, opts ...request.Option) (*GetSubscriptionAttributesOutput, error)
GetSubscriptionAttributesWithContext is the same as GetSubscriptionAttributes with the addition of the ability to pass a context and additional request options.
See GetSubscriptionAttributes 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 (*SNS) GetTopicAttributes ¶
func (c *SNS) GetTopicAttributes(input *GetTopicAttributesInput) (*GetTopicAttributesOutput, error)
GetTopicAttributes API operation for Amazon Simple Notification Service.
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
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 Amazon Simple Notification Service's API operation GetTopicAttributes for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInvalidSecurityException "InvalidSecurity" The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributes
func (*SNS) GetTopicAttributesRequest ¶
func (c *SNS) GetTopicAttributesRequest(input *GetTopicAttributesInput) (req *request.Request, output *GetTopicAttributesOutput)
GetTopicAttributesRequest generates a "aws/request.Request" representing the client's request for the GetTopicAttributes 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 GetTopicAttributes for more information on using the GetTopicAttributes 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 GetTopicAttributesRequest method. req, resp := client.GetTopicAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributes
func (*SNS) GetTopicAttributesWithContext ¶ added in v1.8.0
func (c *SNS) GetTopicAttributesWithContext(ctx aws.Context, input *GetTopicAttributesInput, opts ...request.Option) (*GetTopicAttributesOutput, error)
GetTopicAttributesWithContext is the same as GetTopicAttributes with the addition of the ability to pass a context and additional request options.
See GetTopicAttributes 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 (*SNS) ListEndpointsByPlatformApplication ¶
func (c *SNS) ListEndpointsByPlatformApplication(input *ListEndpointsByPlatformApplicationInput) (*ListEndpointsByPlatformApplicationOutput, error)
ListEndpointsByPlatformApplication API operation for Amazon Simple Notification Service.
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
This action is throttled at 30 transactions per second (TPS).
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 Amazon Simple Notification Service's API operation ListEndpointsByPlatformApplication for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplication
func (*SNS) ListEndpointsByPlatformApplicationPages ¶
func (c *SNS) ListEndpointsByPlatformApplicationPages(input *ListEndpointsByPlatformApplicationInput, fn func(*ListEndpointsByPlatformApplicationOutput, bool) bool) error
ListEndpointsByPlatformApplicationPages iterates over the pages of a ListEndpointsByPlatformApplication operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListEndpointsByPlatformApplication 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 ListEndpointsByPlatformApplication operation. pageNum := 0 err := client.ListEndpointsByPlatformApplicationPages(params, func(page *sns.ListEndpointsByPlatformApplicationOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListEndpointsByPlatformApplicationPagesWithContext ¶ added in v1.8.0
func (c *SNS) ListEndpointsByPlatformApplicationPagesWithContext(ctx aws.Context, input *ListEndpointsByPlatformApplicationInput, fn func(*ListEndpointsByPlatformApplicationOutput, bool) bool, opts ...request.Option) error
ListEndpointsByPlatformApplicationPagesWithContext same as ListEndpointsByPlatformApplicationPages 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 (*SNS) ListEndpointsByPlatformApplicationRequest ¶
func (c *SNS) ListEndpointsByPlatformApplicationRequest(input *ListEndpointsByPlatformApplicationInput) (req *request.Request, output *ListEndpointsByPlatformApplicationOutput)
ListEndpointsByPlatformApplicationRequest generates a "aws/request.Request" representing the client's request for the ListEndpointsByPlatformApplication 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 ListEndpointsByPlatformApplication for more information on using the ListEndpointsByPlatformApplication 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 ListEndpointsByPlatformApplicationRequest method. req, resp := client.ListEndpointsByPlatformApplicationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplication
func (*SNS) ListEndpointsByPlatformApplicationWithContext ¶ added in v1.8.0
func (c *SNS) ListEndpointsByPlatformApplicationWithContext(ctx aws.Context, input *ListEndpointsByPlatformApplicationInput, opts ...request.Option) (*ListEndpointsByPlatformApplicationOutput, error)
ListEndpointsByPlatformApplicationWithContext is the same as ListEndpointsByPlatformApplication with the addition of the ability to pass a context and additional request options.
See ListEndpointsByPlatformApplication 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 (*SNS) ListOriginationNumbers ¶ added in v1.38.52
func (c *SNS) ListOriginationNumbers(input *ListOriginationNumbersInput) (*ListOriginationNumbersOutput, error)
ListOriginationNumbers API operation for Amazon Simple Notification Service.
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers (https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html) in the Amazon SNS Developer Guide.
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 Amazon Simple Notification Service's API operation ListOriginationNumbers for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeValidationException "ValidationException" Indicates that a parameter in the request is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListOriginationNumbers
func (*SNS) ListOriginationNumbersPages ¶ added in v1.38.52
func (c *SNS) ListOriginationNumbersPages(input *ListOriginationNumbersInput, fn func(*ListOriginationNumbersOutput, bool) bool) error
ListOriginationNumbersPages iterates over the pages of a ListOriginationNumbers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListOriginationNumbers 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 ListOriginationNumbers operation. pageNum := 0 err := client.ListOriginationNumbersPages(params, func(page *sns.ListOriginationNumbersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListOriginationNumbersPagesWithContext ¶ added in v1.38.52
func (c *SNS) ListOriginationNumbersPagesWithContext(ctx aws.Context, input *ListOriginationNumbersInput, fn func(*ListOriginationNumbersOutput, bool) bool, opts ...request.Option) error
ListOriginationNumbersPagesWithContext same as ListOriginationNumbersPages 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 (*SNS) ListOriginationNumbersRequest ¶ added in v1.38.52
func (c *SNS) ListOriginationNumbersRequest(input *ListOriginationNumbersInput) (req *request.Request, output *ListOriginationNumbersOutput)
ListOriginationNumbersRequest generates a "aws/request.Request" representing the client's request for the ListOriginationNumbers 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 ListOriginationNumbers for more information on using the ListOriginationNumbers 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 ListOriginationNumbersRequest method. req, resp := client.ListOriginationNumbersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListOriginationNumbers
func (*SNS) ListOriginationNumbersWithContext ¶ added in v1.38.52
func (c *SNS) ListOriginationNumbersWithContext(ctx aws.Context, input *ListOriginationNumbersInput, opts ...request.Option) (*ListOriginationNumbersOutput, error)
ListOriginationNumbersWithContext is the same as ListOriginationNumbers with the addition of the ability to pass a context and additional request options.
See ListOriginationNumbers 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 (*SNS) ListPhoneNumbersOptedOut ¶ added in v1.2.1
func (c *SNS) ListPhoneNumbersOptedOut(input *ListPhoneNumbersOptedOutInput) (*ListPhoneNumbersOptedOutOutput, error)
ListPhoneNumbersOptedOut API operation for Amazon Simple Notification Service.
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.
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 Amazon Simple Notification Service's API operation ListPhoneNumbersOptedOut for usage and error information.
Returned Error Codes:
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOut
func (*SNS) ListPhoneNumbersOptedOutPages ¶ added in v1.39.1
func (c *SNS) ListPhoneNumbersOptedOutPages(input *ListPhoneNumbersOptedOutInput, fn func(*ListPhoneNumbersOptedOutOutput, bool) bool) error
ListPhoneNumbersOptedOutPages iterates over the pages of a ListPhoneNumbersOptedOut operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPhoneNumbersOptedOut 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 ListPhoneNumbersOptedOut operation. pageNum := 0 err := client.ListPhoneNumbersOptedOutPages(params, func(page *sns.ListPhoneNumbersOptedOutOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListPhoneNumbersOptedOutPagesWithContext ¶ added in v1.39.1
func (c *SNS) ListPhoneNumbersOptedOutPagesWithContext(ctx aws.Context, input *ListPhoneNumbersOptedOutInput, fn func(*ListPhoneNumbersOptedOutOutput, bool) bool, opts ...request.Option) error
ListPhoneNumbersOptedOutPagesWithContext same as ListPhoneNumbersOptedOutPages 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 (*SNS) ListPhoneNumbersOptedOutRequest ¶ added in v1.2.1
func (c *SNS) ListPhoneNumbersOptedOutRequest(input *ListPhoneNumbersOptedOutInput) (req *request.Request, output *ListPhoneNumbersOptedOutOutput)
ListPhoneNumbersOptedOutRequest generates a "aws/request.Request" representing the client's request for the ListPhoneNumbersOptedOut 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 ListPhoneNumbersOptedOut for more information on using the ListPhoneNumbersOptedOut 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 ListPhoneNumbersOptedOutRequest method. req, resp := client.ListPhoneNumbersOptedOutRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOut
func (*SNS) ListPhoneNumbersOptedOutWithContext ¶ added in v1.8.0
func (c *SNS) ListPhoneNumbersOptedOutWithContext(ctx aws.Context, input *ListPhoneNumbersOptedOutInput, opts ...request.Option) (*ListPhoneNumbersOptedOutOutput, error)
ListPhoneNumbersOptedOutWithContext is the same as ListPhoneNumbersOptedOut with the addition of the ability to pass a context and additional request options.
See ListPhoneNumbersOptedOut 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 (*SNS) ListPlatformApplications ¶
func (c *SNS) ListPlatformApplications(input *ListPlatformApplicationsInput) (*ListPlatformApplicationsOutput, error)
ListPlatformApplications API operation for Amazon Simple Notification Service.
Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
This action is throttled at 15 transactions per second (TPS).
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 Amazon Simple Notification Service's API operation ListPlatformApplications for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplications
func (*SNS) ListPlatformApplicationsPages ¶
func (c *SNS) ListPlatformApplicationsPages(input *ListPlatformApplicationsInput, fn func(*ListPlatformApplicationsOutput, bool) bool) error
ListPlatformApplicationsPages iterates over the pages of a ListPlatformApplications operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPlatformApplications 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 ListPlatformApplications operation. pageNum := 0 err := client.ListPlatformApplicationsPages(params, func(page *sns.ListPlatformApplicationsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListPlatformApplicationsPagesWithContext ¶ added in v1.8.0
func (c *SNS) ListPlatformApplicationsPagesWithContext(ctx aws.Context, input *ListPlatformApplicationsInput, fn func(*ListPlatformApplicationsOutput, bool) bool, opts ...request.Option) error
ListPlatformApplicationsPagesWithContext same as ListPlatformApplicationsPages 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 (*SNS) ListPlatformApplicationsRequest ¶
func (c *SNS) ListPlatformApplicationsRequest(input *ListPlatformApplicationsInput) (req *request.Request, output *ListPlatformApplicationsOutput)
ListPlatformApplicationsRequest generates a "aws/request.Request" representing the client's request for the ListPlatformApplications 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 ListPlatformApplications for more information on using the ListPlatformApplications 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 ListPlatformApplicationsRequest method. req, resp := client.ListPlatformApplicationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplications
func (*SNS) ListPlatformApplicationsWithContext ¶ added in v1.8.0
func (c *SNS) ListPlatformApplicationsWithContext(ctx aws.Context, input *ListPlatformApplicationsInput, opts ...request.Option) (*ListPlatformApplicationsOutput, error)
ListPlatformApplicationsWithContext is the same as ListPlatformApplications with the addition of the ability to pass a context and additional request options.
See ListPlatformApplications 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 (*SNS) ListSMSSandboxPhoneNumbers ¶ added in v1.38.52
func (c *SNS) ListSMSSandboxPhoneNumbers(input *ListSMSSandboxPhoneNumbersInput) (*ListSMSSandboxPhoneNumbersOutput, error)
ListSMSSandboxPhoneNumbers API operation for Amazon Simple Notification Service.
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon SNS Developer Guide.
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 Amazon Simple Notification Service's API operation ListSMSSandboxPhoneNumbers for usage and error information.
Returned Error Codes:
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeResourceNotFoundException "ResourceNotFound" Can’t perform the action on the specified resource. Make sure that the resource exists.
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSMSSandboxPhoneNumbers
func (*SNS) ListSMSSandboxPhoneNumbersPages ¶ added in v1.38.52
func (c *SNS) ListSMSSandboxPhoneNumbersPages(input *ListSMSSandboxPhoneNumbersInput, fn func(*ListSMSSandboxPhoneNumbersOutput, bool) bool) error
ListSMSSandboxPhoneNumbersPages iterates over the pages of a ListSMSSandboxPhoneNumbers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListSMSSandboxPhoneNumbers 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 ListSMSSandboxPhoneNumbers operation. pageNum := 0 err := client.ListSMSSandboxPhoneNumbersPages(params, func(page *sns.ListSMSSandboxPhoneNumbersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListSMSSandboxPhoneNumbersPagesWithContext ¶ added in v1.38.52
func (c *SNS) ListSMSSandboxPhoneNumbersPagesWithContext(ctx aws.Context, input *ListSMSSandboxPhoneNumbersInput, fn func(*ListSMSSandboxPhoneNumbersOutput, bool) bool, opts ...request.Option) error
ListSMSSandboxPhoneNumbersPagesWithContext same as ListSMSSandboxPhoneNumbersPages 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 (*SNS) ListSMSSandboxPhoneNumbersRequest ¶ added in v1.38.52
func (c *SNS) ListSMSSandboxPhoneNumbersRequest(input *ListSMSSandboxPhoneNumbersInput) (req *request.Request, output *ListSMSSandboxPhoneNumbersOutput)
ListSMSSandboxPhoneNumbersRequest generates a "aws/request.Request" representing the client's request for the ListSMSSandboxPhoneNumbers 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 ListSMSSandboxPhoneNumbers for more information on using the ListSMSSandboxPhoneNumbers 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 ListSMSSandboxPhoneNumbersRequest method. req, resp := client.ListSMSSandboxPhoneNumbersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSMSSandboxPhoneNumbers
func (*SNS) ListSMSSandboxPhoneNumbersWithContext ¶ added in v1.38.52
func (c *SNS) ListSMSSandboxPhoneNumbersWithContext(ctx aws.Context, input *ListSMSSandboxPhoneNumbersInput, opts ...request.Option) (*ListSMSSandboxPhoneNumbersOutput, error)
ListSMSSandboxPhoneNumbersWithContext is the same as ListSMSSandboxPhoneNumbers with the addition of the ability to pass a context and additional request options.
See ListSMSSandboxPhoneNumbers 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 (*SNS) ListSubscriptions ¶
func (c *SNS) ListSubscriptions(input *ListSubscriptionsInput) (*ListSubscriptionsOutput, error)
ListSubscriptions API operation for Amazon Simple Notification Service.
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Amazon Simple Notification Service's API operation ListSubscriptions for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptions
func (*SNS) ListSubscriptionsByTopic ¶
func (c *SNS) ListSubscriptionsByTopic(input *ListSubscriptionsByTopicInput) (*ListSubscriptionsByTopicOutput, error)
ListSubscriptionsByTopic API operation for Amazon Simple Notification Service.
Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Amazon Simple Notification Service's API operation ListSubscriptionsByTopic for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopic
func (*SNS) ListSubscriptionsByTopicPages ¶
func (c *SNS) ListSubscriptionsByTopicPages(input *ListSubscriptionsByTopicInput, fn func(*ListSubscriptionsByTopicOutput, bool) bool) error
ListSubscriptionsByTopicPages iterates over the pages of a ListSubscriptionsByTopic operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListSubscriptionsByTopic 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 ListSubscriptionsByTopic operation. pageNum := 0 err := client.ListSubscriptionsByTopicPages(params, func(page *sns.ListSubscriptionsByTopicOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListSubscriptionsByTopicPagesWithContext ¶ added in v1.8.0
func (c *SNS) ListSubscriptionsByTopicPagesWithContext(ctx aws.Context, input *ListSubscriptionsByTopicInput, fn func(*ListSubscriptionsByTopicOutput, bool) bool, opts ...request.Option) error
ListSubscriptionsByTopicPagesWithContext same as ListSubscriptionsByTopicPages 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 (*SNS) ListSubscriptionsByTopicRequest ¶
func (c *SNS) ListSubscriptionsByTopicRequest(input *ListSubscriptionsByTopicInput) (req *request.Request, output *ListSubscriptionsByTopicOutput)
ListSubscriptionsByTopicRequest generates a "aws/request.Request" representing the client's request for the ListSubscriptionsByTopic 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 ListSubscriptionsByTopic for more information on using the ListSubscriptionsByTopic 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 ListSubscriptionsByTopicRequest method. req, resp := client.ListSubscriptionsByTopicRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopic
func (*SNS) ListSubscriptionsByTopicWithContext ¶ added in v1.8.0
func (c *SNS) ListSubscriptionsByTopicWithContext(ctx aws.Context, input *ListSubscriptionsByTopicInput, opts ...request.Option) (*ListSubscriptionsByTopicOutput, error)
ListSubscriptionsByTopicWithContext is the same as ListSubscriptionsByTopic with the addition of the ability to pass a context and additional request options.
See ListSubscriptionsByTopic 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 (*SNS) ListSubscriptionsPages ¶
func (c *SNS) ListSubscriptionsPages(input *ListSubscriptionsInput, fn func(*ListSubscriptionsOutput, bool) bool) error
ListSubscriptionsPages iterates over the pages of a ListSubscriptions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListSubscriptions 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 ListSubscriptions operation. pageNum := 0 err := client.ListSubscriptionsPages(params, func(page *sns.ListSubscriptionsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListSubscriptionsPagesWithContext ¶ added in v1.8.0
func (c *SNS) ListSubscriptionsPagesWithContext(ctx aws.Context, input *ListSubscriptionsInput, fn func(*ListSubscriptionsOutput, bool) bool, opts ...request.Option) error
ListSubscriptionsPagesWithContext same as ListSubscriptionsPages 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 (*SNS) ListSubscriptionsRequest ¶
func (c *SNS) ListSubscriptionsRequest(input *ListSubscriptionsInput) (req *request.Request, output *ListSubscriptionsOutput)
ListSubscriptionsRequest generates a "aws/request.Request" representing the client's request for the ListSubscriptions 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 ListSubscriptions for more information on using the ListSubscriptions 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 ListSubscriptionsRequest method. req, resp := client.ListSubscriptionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptions
func (*SNS) ListSubscriptionsWithContext ¶ added in v1.8.0
func (c *SNS) ListSubscriptionsWithContext(ctx aws.Context, input *ListSubscriptionsInput, opts ...request.Option) (*ListSubscriptionsOutput, error)
ListSubscriptionsWithContext is the same as ListSubscriptions with the addition of the ability to pass a context and additional request options.
See ListSubscriptions 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 (*SNS) ListTagsForResource ¶ added in v1.19.19
func (c *SNS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for Amazon Simple Notification Service.
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the Amazon Simple Notification Service Developer Guide.
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 Amazon Simple Notification Service's API operation ListTagsForResource for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFound" Can’t perform the action on the specified resource. Make sure that the resource exists.
ErrCodeTagPolicyException "TagPolicy" The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeConcurrentAccessException "ConcurrentAccess" Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTagsForResource
func (*SNS) ListTagsForResourceRequest ¶ added in v1.19.19
func (c *SNS) 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/sns-2010-03-31/ListTagsForResource
func (*SNS) ListTagsForResourceWithContext ¶ added in v1.19.19
func (c *SNS) 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 (*SNS) ListTopics ¶
func (c *SNS) ListTopics(input *ListTopicsInput) (*ListTopicsOutput, error)
ListTopics API operation for Amazon Simple Notification Service.
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Amazon Simple Notification Service's API operation ListTopics for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopics
func (*SNS) ListTopicsPages ¶
func (c *SNS) ListTopicsPages(input *ListTopicsInput, fn func(*ListTopicsOutput, bool) bool) error
ListTopicsPages iterates over the pages of a ListTopics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTopics 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 ListTopics operation. pageNum := 0 err := client.ListTopicsPages(params, func(page *sns.ListTopicsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SNS) ListTopicsPagesWithContext ¶ added in v1.8.0
func (c *SNS) ListTopicsPagesWithContext(ctx aws.Context, input *ListTopicsInput, fn func(*ListTopicsOutput, bool) bool, opts ...request.Option) error
ListTopicsPagesWithContext same as ListTopicsPages 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 (*SNS) ListTopicsRequest ¶
func (c *SNS) ListTopicsRequest(input *ListTopicsInput) (req *request.Request, output *ListTopicsOutput)
ListTopicsRequest generates a "aws/request.Request" representing the client's request for the ListTopics 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 ListTopics for more information on using the ListTopics 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 ListTopicsRequest method. req, resp := client.ListTopicsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopics
func (*SNS) ListTopicsWithContext ¶ added in v1.8.0
func (c *SNS) ListTopicsWithContext(ctx aws.Context, input *ListTopicsInput, opts ...request.Option) (*ListTopicsOutput, error)
ListTopicsWithContext is the same as ListTopics with the addition of the ability to pass a context and additional request options.
See ListTopics 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 (*SNS) OptInPhoneNumber ¶ added in v1.2.1
func (c *SNS) OptInPhoneNumber(input *OptInPhoneNumberInput) (*OptInPhoneNumberOutput, error)
OptInPhoneNumber API operation for Amazon Simple Notification Service.
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
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 Amazon Simple Notification Service's API operation OptInPhoneNumber for usage and error information.
Returned Error Codes:
ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumber
func (*SNS) OptInPhoneNumberRequest ¶ added in v1.2.1
func (c *SNS) OptInPhoneNumberRequest(input *OptInPhoneNumberInput) (req *request.Request, output *OptInPhoneNumberOutput)
OptInPhoneNumberRequest generates a "aws/request.Request" representing the client's request for the OptInPhoneNumber 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 OptInPhoneNumber for more information on using the OptInPhoneNumber 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 OptInPhoneNumberRequest method. req, resp := client.OptInPhoneNumberRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumber
func (*SNS) OptInPhoneNumberWithContext ¶ added in v1.8.0
func (c *SNS) OptInPhoneNumberWithContext(ctx aws.Context, input *OptInPhoneNumberInput, opts ...request.Option) (*OptInPhoneNumberOutput, error)
OptInPhoneNumberWithContext is the same as OptInPhoneNumber with the addition of the ability to pass a context and additional request options.
See OptInPhoneNumber 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 (*SNS) Publish ¶
func (c *SNS) Publish(input *PublishInput) (*PublishOutput, error)
Publish API operation for Amazon Simple Notification Service.
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message is saved and Amazon SNS immediately delivers it to subscribers.
To use the Publish action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices (https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html).
You can publish messages only to topics and endpoints in the same Amazon Web Services Region.
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 Amazon Simple Notification Service's API operation Publish for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInvalidParameterValueException "ParameterValueInvalid" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeEndpointDisabledException "EndpointDisabled" Exception error indicating endpoint disabled.
ErrCodePlatformApplicationDisabledException "PlatformApplicationDisabled" Exception error indicating platform application disabled.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeKMSDisabledException "KMSDisabled" The request was rejected because the specified Amazon Web Services KMS key isn't enabled.
ErrCodeKMSInvalidStateException "KMSInvalidState" The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the Key Management Service Developer Guide.
ErrCodeKMSNotFoundException "KMSNotFound" The request was rejected because the specified entity or resource can't be found.
ErrCodeKMSOptInRequired "KMSOptInRequired" The Amazon Web Services access key ID needs a subscription for the service.
ErrCodeKMSThrottlingException "KMSThrottling" The request was denied due to request throttling. For more information about throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the Key Management Service Developer Guide.
ErrCodeKMSAccessDeniedException "KMSAccessDenied" The ciphertext references a key that doesn't exist or that you don't have access to.
ErrCodeInvalidSecurityException "InvalidSecurity" The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
ErrCodeValidationException "ValidationException" Indicates that a parameter in the request is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Publish
func (*SNS) PublishBatch ¶ added in v1.42.7
func (c *SNS) PublishBatch(input *PublishBatchInput) (*PublishBatchOutput, error)
PublishBatch API operation for Amazon Simple Notification Service.
Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.
The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.
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 Amazon Simple Notification Service's API operation PublishBatch for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInvalidParameterValueException "ParameterValueInvalid" Indicates that a request parameter does not comply with the associated constraints.
ErrCodeInternalErrorException "InternalError" Indicates an internal service error.
ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.
ErrCodeEndpointDisabledException "EndpointDisabled" Exception error indicating endpoint disabled.
ErrCodePlatformApplicationDisabledException "PlatformApplicationDisabled" Exception error indicating platform application disabled.
ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.
ErrCodeBatchEntryIdsNotDistinctException "BatchEntryIdsNotDistinct" Two or more batch entries in the request have the same Id.
ErrCodeBatchRequestTooLongException "BatchRequestTooLong" The length of all the batch messages put together is more than the limit.
ErrCodeEmptyBatchRequestException "EmptyBatchRequest" The batch request doesn't contain any entries.
ErrCodeInvalidBatchEntryIdException "InvalidBatchEntryId" The Id of a batch entry in a batch request doesn't abide by the specification.
ErrCodeTooManyEntriesInBatchRequestException "TooManyEntriesInBatchRequest" The batch request contains more entries than permissible.
ErrCodeKMSDisabledException "KMSDisabled" The request was rejected because the specified Amazon Web Services KMS key isn't enabled.
ErrCodeKMSInvalidStateException "KMSInvalidState" The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the Key Management Service Developer Guide.
ErrCodeKMSNotFoundException "KMSNotFound" The request was rejected because the specified entity or resource can't be found.
ErrCodeKMSOptInRequired "KMSOptInRequired" The Amazon Web Services access key ID needs a subscription for the service.
ErrCodeKMSThrottlingException "KMSThrottling" The request was denied due to request throttling. For more information about throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the Key Management Service Developer Guide.
ErrCodeKMSAccessDeniedException "KMSAccessDenied" The ciphertext references a key that doesn't exist or that you don't have access to.
ErrCodeInvalidSecurityException "InvalidSecurity" The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
ErrCodeValidationException "ValidationException" Indicates that a parameter in the request is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishBatch
func (*SNS) PublishBatchRequest ¶ added in v1.42.7
func (c *SNS) PublishBatchRequest(input *PublishBatchInput) (req *request.Request, output *PublishBatchOutput)
PublishBatchRequest generates a "aws/request.Request" representing the client's request for the PublishBatch 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 PublishBatch for more information on using the PublishBatch 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 PublishBatchRequest method. req, resp := client.PublishBatchRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishBatch
func (*SNS) PublishBatchWithContext ¶ added in v1.42.7
func (c *SNS) PublishBatchWithContext(ctx