sns

package module
Version: v1.17.12 Latest Latest
Warning

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

Go to latest
Published: Aug 9, 2022 License: Apache-2.0 Imports: 36 Imported by: 104

Documentation

Overview

Package sns provides the API client, operations, and parameter types for Amazon Simple Notification Service.

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/).

Index

Constants

View Source
const ServiceAPIVersion = "2010-03-31"
View Source
const ServiceID = "SNS"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type 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.
	//
	// This member is required.
	AWSAccountId []string

	// The action you want to allow for the specified principal(s). Valid values: Any
	// Amazon SNS action name, for example Publish.
	//
	// This member is required.
	ActionName []string

	// A unique identifier for the new policy statement.
	//
	// This member is required.
	Label *string

	// The ARN of the topic whose access control policy you wish to modify.
	//
	// This member is required.
	TopicArn *string
	// contains filtered or unexported fields
}

type AddPermissionOutput

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

type CheckIfPhoneNumberIsOptedOutInput

type CheckIfPhoneNumberIsOptedOutInput struct {

	// The phone number for which you want to check the opt out status.
	//
	// This member is required.
	PhoneNumber *string
	// contains filtered or unexported fields
}

The input for the CheckIfPhoneNumberIsOptedOut action.

type CheckIfPhoneNumberIsOptedOutOutput

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

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

The response from the CheckIfPhoneNumberIsOptedOut action.

type Client

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

Client provides the API client to make operations call for Amazon Simple Notification Service.

func New

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

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

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

NewFromConfig returns a new client from the provided config.

func (*Client) AddPermission

func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, optFns ...func(*Options)) (*AddPermissionOutput, error)

Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.

func (*Client) CheckIfPhoneNumberIsOptedOut

func (c *Client) CheckIfPhoneNumberIsOptedOut(ctx context.Context, params *CheckIfPhoneNumberIsOptedOutInput, optFns ...func(*Options)) (*CheckIfPhoneNumberIsOptedOutOutput, error)

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.

func (*Client) ConfirmSubscription

func (c *Client) ConfirmSubscription(ctx context.Context, params *ConfirmSubscriptionInput, optFns ...func(*Options)) (*ConfirmSubscriptionOutput, error)

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

func (*Client) CreatePlatformApplication

func (c *Client) CreatePlatformApplication(ctx context.Context, params *CreatePlatformApplicationInput, optFns ...func(*Options)) (*CreatePlatformApplicationOutput, error)

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 Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

* 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 GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.

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

func (*Client) CreatePlatformEndpoint

func (c *Client) CreatePlatformEndpoint(ctx context.Context, params *CreatePlatformEndpointInput, optFns ...func(*Options)) (*CreatePlatformEndpointOutput, error)

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

func (*Client) CreateSMSSandboxPhoneNumber added in v1.5.0

func (c *Client) CreateSMSSandboxPhoneNumber(ctx context.Context, params *CreateSMSSandboxPhoneNumberInput, optFns ...func(*Options)) (*CreateSMSSandboxPhoneNumberOutput, error)

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.

func (*Client) CreateTopic

func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optFns ...func(*Options)) (*CreateTopicOutput, error)

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.

func (*Client) DeleteEndpoint

func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error)

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.

func (*Client) DeletePlatformApplication

func (c *Client) DeletePlatformApplication(ctx context.Context, params *DeletePlatformApplicationInput, optFns ...func(*Options)) (*DeletePlatformApplicationOutput, error)

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

func (*Client) DeleteSMSSandboxPhoneNumber added in v1.5.0

func (c *Client) DeleteSMSSandboxPhoneNumber(ctx context.Context, params *DeleteSMSSandboxPhoneNumberInput, optFns ...func(*Options)) (*DeleteSMSSandboxPhoneNumberOutput, error)

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.

func (*Client) DeleteTopic

func (c *Client) DeleteTopic(ctx context.Context, params *DeleteTopicInput, optFns ...func(*Options)) (*DeleteTopicOutput, error)

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.

func (*Client) GetEndpointAttributes

func (c *Client) GetEndpointAttributes(ctx context.Context, params *GetEndpointAttributesInput, optFns ...func(*Options)) (*GetEndpointAttributesOutput, error)

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

func (*Client) GetPlatformApplicationAttributes

func (c *Client) GetPlatformApplicationAttributes(ctx context.Context, params *GetPlatformApplicationAttributesInput, optFns ...func(*Options)) (*GetPlatformApplicationAttributesOutput, error)

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

func (*Client) GetSMSAttributes

func (c *Client) GetSMSAttributes(ctx context.Context, params *GetSMSAttributesInput, optFns ...func(*Options)) (*GetSMSAttributesOutput, error)

Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action.

func (*Client) GetSMSSandboxAccountStatus added in v1.5.0

func (c *Client) GetSMSSandboxAccountStatus(ctx context.Context, params *GetSMSSandboxAccountStatusInput, optFns ...func(*Options)) (*GetSMSSandboxAccountStatusOutput, error)

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.

func (*Client) GetSubscriptionAttributes

func (c *Client) GetSubscriptionAttributes(ctx context.Context, params *GetSubscriptionAttributesInput, optFns ...func(*Options)) (*GetSubscriptionAttributesOutput, error)

Returns all of the properties of a subscription.

func (*Client) GetTopicAttributes

func (c *Client) GetTopicAttributes(ctx context.Context, params *GetTopicAttributesInput, optFns ...func(*Options)) (*GetTopicAttributesOutput, error)

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

func (*Client) ListEndpointsByPlatformApplication

func (c *Client) ListEndpointsByPlatformApplication(ctx context.Context, params *ListEndpointsByPlatformApplicationInput, optFns ...func(*Options)) (*ListEndpointsByPlatformApplicationOutput, error)

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

func (*Client) ListOriginationNumbers added in v1.5.0

func (c *Client) ListOriginationNumbers(ctx context.Context, params *ListOriginationNumbersInput, optFns ...func(*Options)) (*ListOriginationNumbersOutput, error)

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.

func (*Client) ListPhoneNumbersOptedOut

func (c *Client) ListPhoneNumbersOptedOut(ctx context.Context, params *ListPhoneNumbersOptedOutInput, optFns ...func(*Options)) (*ListPhoneNumbersOptedOutOutput, error)

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.

func (*Client) ListPlatformApplications

func (c *Client) ListPlatformApplications(ctx context.Context, params *ListPlatformApplicationsInput, optFns ...func(*Options)) (*ListPlatformApplicationsOutput, error)

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

func (*Client) ListSMSSandboxPhoneNumbers added in v1.5.0

func (c *Client) ListSMSSandboxPhoneNumbers(ctx context.Context, params *ListSMSSandboxPhoneNumbersInput, optFns ...func(*Options)) (*ListSMSSandboxPhoneNumbersOutput, error)

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.

func (*Client) ListSubscriptions

func (c *Client) ListSubscriptions(ctx context.Context, params *ListSubscriptionsInput, optFns ...func(*Options)) (*ListSubscriptionsOutput, error)

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

func (*Client) ListSubscriptionsByTopic

func (c *Client) ListSubscriptionsByTopic(ctx context.Context, params *ListSubscriptionsByTopicInput, optFns ...func(*Options)) (*ListSubscriptionsByTopicOutput, error)

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

func (*Client) ListTagsForResource

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

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.

func (*Client) ListTopics

func (c *Client) ListTopics(ctx context.Context, params *ListTopicsInput, optFns ...func(*Options)) (*ListTopicsOutput, error)

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

func (*Client) OptInPhoneNumber

func (c *Client) OptInPhoneNumber(ctx context.Context, params *OptInPhoneNumberInput, optFns ...func(*Options)) (*OptInPhoneNumberOutput, error)

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.

func (*Client) Publish

func (c *Client) Publish(ctx context.Context, params *PublishInput, optFns ...func(*Options)) (*PublishOutput, error)

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.

func (*Client) PublishBatch added in v1.12.0

func (c *Client) PublishBatch(ctx context.Context, params *PublishBatchInput, optFns ...func(*Options)) (*PublishBatchOutput, error)

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.

func (*Client) RemovePermission

func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error)

Removes a statement from a topic's access control policy.

func (*Client) SetEndpointAttributes

func (c *Client) SetEndpointAttributes(ctx context.Context, params *SetEndpointAttributesInput, optFns ...func(*Options)) (*SetEndpointAttributesOutput, error)

Sets the attributes for an endpoint 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).

func (*Client) SetPlatformApplicationAttributes

func (c *Client) SetPlatformApplicationAttributes(ctx context.Context, params *SetPlatformApplicationAttributesInput, optFns ...func(*Options)) (*SetPlatformApplicationAttributesOutput, error)

Sets 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). For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status (https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html).

func (*Client) SetSMSAttributes

func (c *Client) SetSMSAttributes(ctx context.Context, params *SetSMSAttributesInput, optFns ...func(*Options)) (*SetSMSAttributesOutput, error)

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports. You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) in the Amazon SNS Developer Guide. To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

func (*Client) SetSubscriptionAttributes

func (c *Client) SetSubscriptionAttributes(ctx context.Context, params *SetSubscriptionAttributesInput, optFns ...func(*Options)) (*SetSubscriptionAttributesOutput, error)

Allows a subscription owner to set an attribute of the subscription to a new value.

func (*Client) SetTopicAttributes

func (c *Client) SetTopicAttributes(ctx context.Context, params *SetTopicAttributesInput, optFns ...func(*Options)) (*SetTopicAttributesOutput, error)

Allows a topic owner to set an attribute of the topic to a new value.

func (*Client) Subscribe

func (c *Client) Subscribe(ctx context.Context, params *SubscribeInput, optFns ...func(*Options)) (*SubscribeOutput, error)

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription. You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days. This action is throttled at 100 transactions per second (TPS).

func (*Client) TagResource

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

Add tags 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 SNS Developer Guide. When you use topic tags, keep the following guidelines in mind:

* Adding more than 50 tags to a topic isn't recommended.

* Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.

* Tags are case-sensitive.

* A new tag with a key identical to that of an existing tag overwrites the existing tag.

* Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request (https://console.aws.amazon.com/support/home#/case/create?issueType=technical).

func (*Client) Unsubscribe

func (c *Client) Unsubscribe(ctx context.Context, params *UnsubscribeInput, optFns ...func(*Options)) (*UnsubscribeOutput, error)

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended. This action is throttled at 100 transactions per second (TPS).

func (*Client) UntagResource

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

Remove tags from 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 SNS Developer Guide.

func (*Client) VerifySMSSandboxPhoneNumber added in v1.5.0

func (c *Client) VerifySMSSandboxPhoneNumber(ctx context.Context, params *VerifySMSSandboxPhoneNumberInput, optFns ...func(*Options)) (*VerifySMSSandboxPhoneNumberOutput, error)

Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account. 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.

type ConfirmSubscriptionInput

type ConfirmSubscriptionInput struct {

	// Short-lived token sent to an endpoint during the Subscribe action.
	//
	// This member is required.
	Token *string

	// The ARN of the topic for which you wish to confirm a subscription.
	//
	// This member is required.
	TopicArn *string

	// 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
	// contains filtered or unexported fields
}

Input for ConfirmSubscription action.

type ConfirmSubscriptionOutput

type ConfirmSubscriptionOutput struct {

	// The ARN of the created subscription.
	SubscriptionArn *string

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

Response for ConfirmSubscriptions action.

type CreatePlatformApplicationInput

type CreatePlatformApplicationInput struct {

	// For a list of attributes, see SetPlatformApplicationAttributes
	// (https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html).
	//
	// This member is required.
	Attributes map[string]string

	// 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.
	//
	// This member is required.
	Name *string

	// The following platforms are supported: ADM (Amazon Device Messaging), APNS
	// (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud
	// Messaging).
	//
	// This member is required.
	Platform *string
	// contains filtered or unexported fields
}

Input for CreatePlatformApplication action.

type CreatePlatformApplicationOutput

type CreatePlatformApplicationOutput struct {

	// PlatformApplicationArn is returned.
	PlatformApplicationArn *string

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

Response from CreatePlatformApplication action.

type CreatePlatformEndpointInput

type CreatePlatformEndpointInput struct {

	// PlatformApplicationArn returned from CreatePlatformApplication is used to create
	// a an endpoint.
	//
	// This member is required.
	PlatformApplicationArn *string

	// 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.
	//
	// This member is required.
	Token *string

	// For a list of attributes, see SetEndpointAttributes
	// (https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html).
	Attributes map[string]string

	// 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
	// contains filtered or unexported fields
}

Input for CreatePlatformEndpoint action.

type CreatePlatformEndpointOutput

type CreatePlatformEndpointOutput struct {

	// EndpointArn returned from CreateEndpoint action.
	EndpointArn *string

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

Response from CreateEndpoint action.

type CreateSMSSandboxPhoneNumberInput added in v1.5.0

type CreateSMSSandboxPhoneNumberInput struct {

	// 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.
	//
	// This member is required.
	PhoneNumber *string

	// The language to use for sending the OTP. The default value is en-US.
	LanguageCode types.LanguageCodeString
	// contains filtered or unexported fields
}

type CreateSMSSandboxPhoneNumberOutput added in v1.5.0

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

type CreateTopicInput

type CreateTopicInput struct {

	// 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.
	//
	// This member is required.
	Name *string

	// A map of attributes with their corresponding values. The following lists the
	// 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.
	//
	// 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

	// 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 []types.Tag
	// contains filtered or unexported fields
}

Input for CreateTopic action.

type CreateTopicOutput

type CreateTopicOutput struct {

	// The Amazon Resource Name (ARN) assigned to the created topic.
	TopicArn *string

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

Response from CreateTopic action.

type DeleteEndpointInput

type DeleteEndpointInput struct {

	// EndpointArn of endpoint to delete.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

Input for DeleteEndpoint action.

type DeleteEndpointOutput

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

type DeletePlatformApplicationInput

type DeletePlatformApplicationInput struct {

	// PlatformApplicationArn of platform application object to delete.
	//
	// This member is required.
	PlatformApplicationArn *string
	// contains filtered or unexported fields
}

Input for DeletePlatformApplication action.

type DeletePlatformApplicationOutput

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

type DeleteSMSSandboxPhoneNumberInput added in v1.5.0

type DeleteSMSSandboxPhoneNumberInput struct {

	// The destination phone number to delete.
	//
	// This member is required.
	PhoneNumber *string
	// contains filtered or unexported fields
}

type DeleteSMSSandboxPhoneNumberOutput added in v1.5.0

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

type DeleteTopicInput

type DeleteTopicInput struct {

	// The ARN of the topic you want to delete.
	//
	// This member is required.
	TopicArn *string
	// contains filtered or unexported fields
}

type DeleteTopicOutput

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

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetEndpointAttributesInput

type GetEndpointAttributesInput struct {

	// EndpointArn for GetEndpointAttributes input.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

Input for GetEndpointAttributes action.

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

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

Response from GetEndpointAttributes of the EndpointArn.

type GetPlatformApplicationAttributesInput

type GetPlatformApplicationAttributesInput struct {

	// PlatformApplicationArn for GetPlatformApplicationAttributesInput.
	//
	// This member is required.
	PlatformApplicationArn *string
	// contains filtered or unexported fields
}

Input for GetPlatformApplicationAttributes action.

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.
	//
	// * 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

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

Response for GetPlatformApplicationAttributes action.

type GetSMSAttributesInput

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
	// contains filtered or unexported fields
}

The input for the GetSMSAttributes request.

type GetSMSAttributesOutput

type GetSMSAttributesOutput struct {

	// The SMS attribute names and their values.
	Attributes map[string]string

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

The response from the GetSMSAttributes request.

type GetSMSSandboxAccountStatusInput added in v1.5.0

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

type GetSMSSandboxAccountStatusOutput added in v1.5.0

type GetSMSSandboxAccountStatusOutput struct {

	// Indicates whether the calling Amazon Web Services account is in the SMS sandbox.
	//
	// This member is required.
	IsInSandbox bool

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

type GetSubscriptionAttributesInput

type GetSubscriptionAttributesInput struct {

	// The ARN of the subscription whose properties you want to get.
	//
	// This member is required.
	SubscriptionArn *string
	// contains filtered or unexported fields
}

Input for GetSubscriptionAttributes.

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.
	//
	// * 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 Kinesis Data Firehose delivery stream subscriptions:
	//
	// *
	// SubscriptionRoleArn – The ARN of the IAM role that has the following:
	//
	// *
	// Permission to write to the Kinesis Data Firehose delivery stream
	//
	// * Amazon SNS
	// listed as a trusted entity
	//
	// Specifying a valid ARN for this attribute is
	// required for Kinesis Data Firehose delivery stream subscriptions. For more
	// information, see Fanout to Kinesis Data 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

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

Response for GetSubscriptionAttributes action.

type GetTopicAttributesInput

type GetTopicAttributesInput struct {

	// The ARN of the topic whose properties you want to get.
	//
	// This member is required.
	TopicArn *string
	// contains filtered or unexported fields
}

Input for GetTopicAttributes action.

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.
	//
	// * Owner – The Amazon Web
	// Services account ID of the topic's owner.
	//
	// * Policy – The JSON serialization of
	// the topic's access control policy.
	//
	// * 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.
	//
	// * EffectiveDeliveryPolicy – The JSON serialization of the effective
	// delivery policy, taking system defaults into account.
	//
	// 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

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

Response for GetTopicAttributes action.

type HTTPClient

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

type HTTPSignerV4

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

type ListEndpointsByPlatformApplicationAPIClient added in v0.30.0

type ListEndpointsByPlatformApplicationAPIClient interface {
	ListEndpointsByPlatformApplication(context.Context, *ListEndpointsByPlatformApplicationInput, ...func(*Options)) (*ListEndpointsByPlatformApplicationOutput, error)
}

ListEndpointsByPlatformApplicationAPIClient is a client that implements the ListEndpointsByPlatformApplication operation.

type ListEndpointsByPlatformApplicationInput

type ListEndpointsByPlatformApplicationInput struct {

	// PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
	//
	// This member is required.
	PlatformApplicationArn *string

	// NextToken string is used when calling ListEndpointsByPlatformApplication action
	// to retrieve additional records that are available after the first page results.
	NextToken *string
	// contains filtered or unexported fields
}

Input for ListEndpointsByPlatformApplication action.

type ListEndpointsByPlatformApplicationOutput

type ListEndpointsByPlatformApplicationOutput struct {

	// Endpoints returned for ListEndpointsByPlatformApplication action.
	Endpoints []types.Endpoint

	// NextToken string is returned when calling ListEndpointsByPlatformApplication
	// action if additional records are available after the first page results.
	NextToken *string

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

Response for ListEndpointsByPlatformApplication action.

type ListEndpointsByPlatformApplicationPaginator added in v0.30.0

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

ListEndpointsByPlatformApplicationPaginator is a paginator for ListEndpointsByPlatformApplication

func NewListEndpointsByPlatformApplicationPaginator added in v0.30.0

NewListEndpointsByPlatformApplicationPaginator returns a new ListEndpointsByPlatformApplicationPaginator

func (*ListEndpointsByPlatformApplicationPaginator) HasMorePages added in v0.30.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEndpointsByPlatformApplicationPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListEndpointsByPlatformApplication page.

type ListEndpointsByPlatformApplicationPaginatorOptions added in v0.30.0

type ListEndpointsByPlatformApplicationPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEndpointsByPlatformApplicationPaginatorOptions is the paginator options for ListEndpointsByPlatformApplication

type ListOriginationNumbersAPIClient added in v1.5.0

type ListOriginationNumbersAPIClient interface {
	ListOriginationNumbers(context.Context, *ListOriginationNumbersInput, ...func(*Options)) (*ListOriginationNumbersOutput, error)
}

ListOriginationNumbersAPIClient is a client that implements the ListOriginationNumbers operation.

type ListOriginationNumbersInput added in v1.5.0

type ListOriginationNumbersInput struct {

	// The maximum number of origination numbers to return.
	MaxResults *int32

	// Token that the previous ListOriginationNumbers request returns.
	NextToken *string
	// contains filtered or unexported fields
}

type ListOriginationNumbersOutput added in v1.5.0

type ListOriginationNumbersOutput struct {

	// A NextToken string is returned when you call the ListOriginationNumbers
	// operation if additional pages of records are available.
	NextToken *string

	// A list of the calling account's verified and pending origination numbers.
	PhoneNumbers []types.PhoneNumberInformation

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

type ListOriginationNumbersPaginator added in v1.5.0

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

ListOriginationNumbersPaginator is a paginator for ListOriginationNumbers

func NewListOriginationNumbersPaginator added in v1.5.0

NewListOriginationNumbersPaginator returns a new ListOriginationNumbersPaginator

func (*ListOriginationNumbersPaginator) HasMorePages added in v1.5.0

func (p *ListOriginationNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOriginationNumbersPaginator) NextPage added in v1.5.0

NextPage retrieves the next ListOriginationNumbers page.

type ListOriginationNumbersPaginatorOptions added in v1.5.0

type ListOriginationNumbersPaginatorOptions struct {
	// The maximum number of origination numbers to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListOriginationNumbersPaginatorOptions is the paginator options for ListOriginationNumbers

type ListPhoneNumbersOptedOutAPIClient added in v1.7.0

type ListPhoneNumbersOptedOutAPIClient interface {
	ListPhoneNumbersOptedOut(context.Context, *ListPhoneNumbersOptedOutInput, ...func(*Options)) (*ListPhoneNumbersOptedOutOutput, error)
}

ListPhoneNumbersOptedOutAPIClient is a client that implements the ListPhoneNumbersOptedOut operation.

type ListPhoneNumbersOptedOutInput

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
	// contains filtered or unexported fields
}

The input for the ListPhoneNumbersOptedOut action.

type ListPhoneNumbersOptedOutOutput

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

	// 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

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

The response from the ListPhoneNumbersOptedOut action.

type ListPhoneNumbersOptedOutPaginator added in v1.7.0

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

ListPhoneNumbersOptedOutPaginator is a paginator for ListPhoneNumbersOptedOut

func NewListPhoneNumbersOptedOutPaginator added in v1.7.0

NewListPhoneNumbersOptedOutPaginator returns a new ListPhoneNumbersOptedOutPaginator

func (*ListPhoneNumbersOptedOutPaginator) HasMorePages added in v1.7.0

func (p *ListPhoneNumbersOptedOutPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPhoneNumbersOptedOutPaginator) NextPage added in v1.7.0

NextPage retrieves the next ListPhoneNumbersOptedOut page.

type ListPhoneNumbersOptedOutPaginatorOptions added in v1.7.0

type ListPhoneNumbersOptedOutPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPhoneNumbersOptedOutPaginatorOptions is the paginator options for ListPhoneNumbersOptedOut

type ListPlatformApplicationsAPIClient added in v0.30.0

type ListPlatformApplicationsAPIClient interface {
	ListPlatformApplications(context.Context, *ListPlatformApplicationsInput, ...func(*Options)) (*ListPlatformApplicationsOutput, error)
}

ListPlatformApplicationsAPIClient is a client that implements the ListPlatformApplications operation.

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
	// contains filtered or unexported fields
}

Input for ListPlatformApplications action.

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

	// Platform applications returned when calling ListPlatformApplications action.
	PlatformApplications []types.PlatformApplication

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

Response for ListPlatformApplications action.

type ListPlatformApplicationsPaginator added in v0.30.0

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

ListPlatformApplicationsPaginator is a paginator for ListPlatformApplications

func NewListPlatformApplicationsPaginator added in v0.30.0

NewListPlatformApplicationsPaginator returns a new ListPlatformApplicationsPaginator

func (*ListPlatformApplicationsPaginator) HasMorePages added in v0.30.0

func (p *ListPlatformApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPlatformApplicationsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListPlatformApplications page.

type ListPlatformApplicationsPaginatorOptions added in v0.30.0

type ListPlatformApplicationsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPlatformApplicationsPaginatorOptions is the paginator options for ListPlatformApplications

type ListSMSSandboxPhoneNumbersAPIClient added in v1.5.0

type ListSMSSandboxPhoneNumbersAPIClient interface {
	ListSMSSandboxPhoneNumbers(context.Context, *ListSMSSandboxPhoneNumbersInput, ...func(*Options)) (*ListSMSSandboxPhoneNumbersOutput, error)
}

ListSMSSandboxPhoneNumbersAPIClient is a client that implements the ListSMSSandboxPhoneNumbers operation.

type ListSMSSandboxPhoneNumbersInput added in v1.5.0

type ListSMSSandboxPhoneNumbersInput struct {

	// The maximum number of phone numbers to return.
	MaxResults *int32

	// Token that the previous ListSMSSandboxPhoneNumbersInput request returns.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSMSSandboxPhoneNumbersOutput added in v1.5.0

type ListSMSSandboxPhoneNumbersOutput struct {

	// A list of the calling account's pending and verified phone numbers.
	//
	// This member is required.
	PhoneNumbers []types.SMSSandboxPhoneNumber

	// A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput
	// operation if additional pages of records are available.
	NextToken *string

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

type ListSMSSandboxPhoneNumbersPaginator added in v1.5.0

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

ListSMSSandboxPhoneNumbersPaginator is a paginator for ListSMSSandboxPhoneNumbers

func NewListSMSSandboxPhoneNumbersPaginator added in v1.5.0

NewListSMSSandboxPhoneNumbersPaginator returns a new ListSMSSandboxPhoneNumbersPaginator

func (*ListSMSSandboxPhoneNumbersPaginator) HasMorePages added in v1.5.0

func (p *ListSMSSandboxPhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSMSSandboxPhoneNumbersPaginator) NextPage added in v1.5.0

NextPage retrieves the next ListSMSSandboxPhoneNumbers page.

type ListSMSSandboxPhoneNumbersPaginatorOptions added in v1.5.0

type ListSMSSandboxPhoneNumbersPaginatorOptions struct {
	// The maximum number of phone numbers to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSMSSandboxPhoneNumbersPaginatorOptions is the paginator options for ListSMSSandboxPhoneNumbers

type ListSubscriptionsAPIClient added in v0.30.0

type ListSubscriptionsAPIClient interface {
	ListSubscriptions(context.Context, *ListSubscriptionsInput, ...func(*Options)) (*ListSubscriptionsOutput, error)
}

ListSubscriptionsAPIClient is a client that implements the ListSubscriptions operation.

type ListSubscriptionsByTopicAPIClient added in v0.30.0

type ListSubscriptionsByTopicAPIClient interface {
	ListSubscriptionsByTopic(context.Context, *ListSubscriptionsByTopicInput, ...func(*Options)) (*ListSubscriptionsByTopicOutput, error)
}

ListSubscriptionsByTopicAPIClient is a client that implements the ListSubscriptionsByTopic operation.

type ListSubscriptionsByTopicInput

type ListSubscriptionsByTopicInput struct {

	// The ARN of the topic for which you wish to find subscriptions.
	//
	// This member is required.
	TopicArn *string

	// Token returned by the previous ListSubscriptionsByTopic request.
	NextToken *string
	// contains filtered or unexported fields
}

Input for ListSubscriptionsByTopic action.

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

	// A list of subscriptions.
	Subscriptions []types.Subscription

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

Response for ListSubscriptionsByTopic action.

type ListSubscriptionsByTopicPaginator added in v0.30.0

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

ListSubscriptionsByTopicPaginator is a paginator for ListSubscriptionsByTopic

func NewListSubscriptionsByTopicPaginator added in v0.30.0

NewListSubscriptionsByTopicPaginator returns a new ListSubscriptionsByTopicPaginator

func (*ListSubscriptionsByTopicPaginator) HasMorePages added in v0.30.0

func (p *ListSubscriptionsByTopicPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSubscriptionsByTopicPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListSubscriptionsByTopic page.

type ListSubscriptionsByTopicPaginatorOptions added in v0.30.0

type ListSubscriptionsByTopicPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSubscriptionsByTopicPaginatorOptions is the paginator options for ListSubscriptionsByTopic

type ListSubscriptionsInput

type ListSubscriptionsInput struct {

	// Token returned by the previous ListSubscriptions request.
	NextToken *string
	// contains filtered or unexported fields
}

Input for ListSubscriptions action.

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

	// A list of subscriptions.
	Subscriptions []types.Subscription

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

Response for ListSubscriptions action

type ListSubscriptionsPaginator added in v0.30.0

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

ListSubscriptionsPaginator is a paginator for ListSubscriptions

func NewListSubscriptionsPaginator added in v0.30.0

func NewListSubscriptionsPaginator(client ListSubscriptionsAPIClient, params *ListSubscriptionsInput, optFns ...func(*ListSubscriptionsPaginatorOptions)) *ListSubscriptionsPaginator

NewListSubscriptionsPaginator returns a new ListSubscriptionsPaginator

func (*ListSubscriptionsPaginator) HasMorePages added in v0.30.0

func (p *ListSubscriptionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSubscriptionsPaginator) NextPage added in v0.30.0

func (p *ListSubscriptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSubscriptionsOutput, error)

NextPage retrieves the next ListSubscriptions page.

type ListSubscriptionsPaginatorOptions added in v0.30.0

type ListSubscriptionsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSubscriptionsPaginatorOptions is the paginator options for ListSubscriptions

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The ARN of the topic for which to list tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags associated with the specified topic.
	Tags []types.Tag

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

type ListTopicsAPIClient added in v0.30.0

type ListTopicsAPIClient interface {
	ListTopics(context.Context, *ListTopicsInput, ...func(*Options)) (*ListTopicsOutput, error)
}

ListTopicsAPIClient is a client that implements the ListTopics operation.

type ListTopicsInput

type ListTopicsInput struct {

	// Token returned by the previous ListTopics request.
	NextToken *string
	// contains filtered or unexported fields
}

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

	// A list of topic ARNs.
	Topics []types.Topic

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

Response for ListTopics action.

type ListTopicsPaginator added in v0.30.0

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

ListTopicsPaginator is a paginator for ListTopics

func NewListTopicsPaginator added in v0.30.0

func NewListTopicsPaginator(client ListTopicsAPIClient, params *ListTopicsInput, optFns ...func(*ListTopicsPaginatorOptions)) *ListTopicsPaginator

NewListTopicsPaginator returns a new ListTopicsPaginator

func (*ListTopicsPaginator) HasMorePages added in v0.30.0

func (p *ListTopicsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTopicsPaginator) NextPage added in v0.30.0

func (p *ListTopicsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicsOutput, error)

NextPage retrieves the next ListTopics page.

type ListTopicsPaginatorOptions added in v0.30.0

type ListTopicsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTopicsPaginatorOptions is the paginator options for ListTopics

type OptInPhoneNumberInput

type OptInPhoneNumberInput struct {

	// The phone number to opt in. Use E.164 format.
	//
	// This member is required.
	PhoneNumber *string
	// contains filtered or unexported fields
}

Input for the OptInPhoneNumber action.

type OptInPhoneNumberOutput

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

The response for the OptInPhoneNumber action.

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

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

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

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

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

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

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

type PublishBatchInput added in v1.12.0

type PublishBatchInput struct {

	// A list of PublishBatch request entries to be sent to the SNS topic.
	//
	// This member is required.
	PublishBatchRequestEntries []types.PublishBatchRequestEntry

	// The Amazon resource name (ARN) of the topic you want to batch publish to.
	//
	// This member is required.
	TopicArn *string
	// contains filtered or unexported fields
}

type PublishBatchOutput added in v1.12.0

type PublishBatchOutput struct {

	// A list of failed PublishBatch responses.
	Failed []types.BatchResultErrorEntry

	// A list of successful PublishBatch responses.
	Successful []types.PublishBatchResultEntry

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

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).
	//
	// This member is required.
	Message *string

	// Message attributes for Publish action.
	MessageAttributes map[string]types.MessageAttributeValue

	// 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

	// 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

	// 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

	// 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 *string

	// 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 ASCII text that begins with a letter, number, or punctuation mark; must
	// not include line breaks or control characters; and must be less than 100
	// characters long.
	Subject *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

	// 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
	// contains filtered or unexported fields
}

Input for Publish action.

type PublishOutput

type PublishOutput struct {

	// Unique identifier assigned to the published message. Length Constraint: Maximum
	// 100 characters
	MessageId *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

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

Response for Publish action.

type RemovePermissionInput

type RemovePermissionInput struct {

	// The unique label of the statement you want to remove.
	//
	// This member is required.
	Label *string

	// The ARN of the topic whose access control policy you wish to modify.
	//
	// This member is required.
	TopicArn *string
	// contains filtered or unexported fields
}

Input for RemovePermission action.

type RemovePermissionOutput

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type SetEndpointAttributesInput

type SetEndpointAttributesInput struct {

	// A map of the endpoint attributes. Attributes in this map 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.
	//
	// This member is required.
	Attributes map[string]string

	// EndpointArn used for SetEndpointAttributes action.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

Input for SetEndpointAttributes action.

type SetEndpointAttributesOutput

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

type SetPlatformApplicationAttributesInput

type SetPlatformApplicationAttributesInput struct {

	// A map of the platform application attributes. Attributes in this map include the
	// following:
	//
	// * PlatformCredential – The credential received from the notification
	// service.
	//
	// * For ADM, PlatformCredentialis client secret.
	//
	// * For Apple Services
	// using certificate credentials, PlatformCredential is private key.
	//
	// * For Apple
	// Services using token credentials, PlatformCredential is signing key.
	//
	// * For GCM
	// (Firebase Cloud Messaging), PlatformCredential is API key.
	//
	// * PlatformPrincipal
	// – The principal received from the notification service.
	//
	// * For ADM,
	// PlatformPrincipalis client id.
	//
	// * For Apple Services using certificate
	// credentials, PlatformPrincipal is SSL certificate.
	//
	// * For Apple Services using
	// token credentials, PlatformPrincipal is signing key ID.
	//
	// * For GCM (Firebase
	// Cloud Messaging), there is no PlatformPrincipal.
	//
	// * EventEndpointCreated – Topic
	// ARN to which EndpointCreated event notifications are sent.
	//
	// *
	// EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications
	// are sent.
	//
	// * EventEndpointUpdated – Topic ARN to which EndpointUpdate event
	// notifications are sent.
	//
	// * EventDeliveryFailure – Topic ARN to which
	// DeliveryFailure event notifications are sent upon Direct Publish delivery
	// failure (permanent) to one of the application's endpoints.
	//
	// *
	// SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to
	// use CloudWatch Logs on your behalf.
	//
	// * FailureFeedbackRoleArn – IAM role ARN
	// used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
	//
	// *
	// SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully
	// delivered messages.
	//
	// The following attributes only apply to APNs token-based
	// authentication:
	//
	// * ApplePlatformTeamID – The identifier that's assigned to your
	// Apple developer account team.
	//
	// * ApplePlatformBundleID – The bundle identifier
	// that's assigned to your iOS app.
	//
	// This member is required.
	Attributes map[string]string

	// PlatformApplicationArn for SetPlatformApplicationAttributes action.
	//
	// This member is required.
	PlatformApplicationArn *string
	// contains filtered or unexported fields
}

Input for SetPlatformApplicationAttributes action.

type SetPlatformApplicationAttributesOutput

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

type SetSMSAttributesInput

type SetSMSAttributesInput struct {

	// The default settings for sending SMS messages from your Amazon Web Services
	// account. You can set values for the following attribute names: MonthlySpendLimit
	// – The maximum amount in USD that you are willing to spend each month to send SMS
	// messages. When Amazon SNS determines that sending an SMS message would incur a
	// cost that exceeds this limit, it stops sending SMS messages within minutes.
	// Amazon SNS stops sending SMS messages within minutes of the limit being crossed.
	// During that interval, if you continue to send SMS messages, you will incur costs
	// that exceed your limit. By default, the spend limit is set to the maximum
	// allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit
	// Increase case
	// (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns).
	// For New limit value, enter your desired monthly spend limit. In the Use Case
	// Description field, explain that you are requesting an SMS monthly spend limit
	// increase. DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS
	// to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that
	// you send, Amazon SNS writes a log that includes the message price, the success
	// or failure status, the reason for failure (if the message failed), the message
	// dwell time, and other information. DeliveryStatusSuccessSamplingRate – The
	// percentage of successful SMS deliveries for which Amazon SNS will write logs in
	// CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write
	// logs only for failed deliveries, set this value to 0. To write logs for 10% of
	// your successful deliveries, set it to 10. DefaultSenderID – A string, such as
	// your business brand, that is displayed as the sender on the receiving device.
	// Support for sender IDs varies by country. The sender ID can be 1 - 11
	// alphanumeric characters, and it must contain at least one letter. DefaultSMSType
	// – The type of SMS message that you will send by default. You can assign the
	// following values:
	//
	// * Promotional – (Default) Noncritical messages, such as
	// marketing messages. Amazon SNS optimizes the message delivery to incur the
	// lowest cost.
	//
	// * Transactional – Critical messages that support customer
	// transactions, such as one-time passcodes for multi-factor authentication. Amazon
	// SNS optimizes the message delivery to achieve the highest
	// reliability.
	//
	// UsageReportS3Bucket – The name of the Amazon S3 bucket to receive
	// daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a
	// usage report as a CSV file to the bucket. The report includes the following
	// information for each SMS message that was successfully delivered by your Amazon
	// Web Services account:
	//
	// * Time that the message was published (in UTC)
	//
	// * Message
	// ID
	//
	// * Destination phone number
	//
	// * Message type
	//
	// * Delivery status
	//
	// * Message
	// price (in USD)
	//
	// * Part number (a message is split into multiple parts if it is
	// too long for a single message)
	//
	// * Total number of parts
	//
	// To receive the report,
	// the bucket must have a policy that allows the Amazon SNS service principal to
	// perform the s3:PutObject and s3:GetBucketLocation actions. For an example bucket
	// policy and usage report, see Monitoring SMS Activity
	// (https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html) in the Amazon SNS
	// Developer Guide.
	//
	// This member is required.
	Attributes map[string]string
	// contains filtered or unexported fields
}

The input for the SetSMSAttributes action.

type SetSMSAttributesOutput

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

The response for the SetSMSAttributes action.

type SetSubscriptionAttributesInput

type SetSubscriptionAttributesInput struct {

	// A map of attributes with their corresponding values. The following lists the
	// names, descriptions, and values of the special request parameters that this
	// action uses:
	//
	// * DeliveryPolicy – The policy that defines how Amazon SNS retries
	// failed deliveries to HTTP/S endpoints.
	//
	// * FilterPolicy – The simple JSON object
	// that lets your subscriber receive only a subset of messages, rather than
	// receiving every message published to the topic.
	//
	// * RawMessageDelivery – When set
	// to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This
	// eliminates the need for the endpoints to process JSON formatting, which is
	// otherwise created for Amazon SNS metadata.
	//
	// * 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.
	//
	// The following attribute
	// applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
	//
	// *
	// SubscriptionRoleArn – The ARN of the IAM role that has the following:
	//
	// *
	// Permission to write to the Kinesis Data Firehose delivery stream
	//
	// * Amazon SNS
	// listed as a trusted entity
	//
	// Specifying a valid ARN for this attribute is
	// required for Kinesis Data Firehose delivery stream subscriptions. For more
	// information, see Fanout to Kinesis Data Firehose delivery streams
	// (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in
	// the Amazon SNS Developer Guide.
	//
	// This member is required.
	AttributeName *string

	// The ARN of the subscription to modify.
	//
	// This member is required.
	SubscriptionArn *string

	// The new value for the attribute in JSON format.
	AttributeValue *string
	// contains filtered or unexported fields
}

Input for SetSubscriptionAttributes action.

type SetSubscriptionAttributesOutput

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

type SetTopicAttributesInput

type SetTopicAttributesInput struct {

	// A map of attributes with their corresponding values. The following lists the
	// names, descriptions, and values of the special request parameters that the
	// SetTopicAttributes 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.
	//
	// * Policy – The policy
	// that defines who can access your topic. By default, only the topic owner can
	// publish or subscribe to the topic.
	//
	// 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 attribute applies
	// only to FIFO topics
	// (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html):
	//
	// *
	// 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.
	//
	// This member is required.
	AttributeName *string

	// The ARN of the topic to modify.
	//
	// This member is required.
	TopicArn *string

	// The new value for the attribute.
	AttributeValue *string
	// contains filtered or unexported fields
}

Input for SetTopicAttributes action.

type SetTopicAttributesOutput

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

type SubscribeInput

type SubscribeInput struct {

	// The protocol that you want to use. Supported protocols include:
	//
	// * http –
	// delivery of JSON-encoded message via HTTP POST
	//
	// * https – delivery of
	// JSON-encoded message via HTTPS POST
	//
	// * email – delivery of message via SMTP
	//
	// *
	// email-json – delivery of JSON-encoded message via SMTP
	//
	// * sms – delivery of
	// message via SMS
	//
	// * sqs – delivery of JSON-encoded message to an Amazon SQS
	// queue
	//
	// * application – delivery of JSON-encoded message to an EndpointArn for a
	// mobile app and device
	//
	// * lambda – delivery of JSON-encoded message to an Lambda
	// function
	//
	// * firehose – delivery of JSON-encoded message to an Amazon Kinesis
	// Data Firehose delivery stream.
	//
	// This member is required.
	Protocol *string

	// The ARN of the topic you want to subscribe to.
	//
	// This member is required.
	TopicArn *string

	// A map of attributes with their corresponding values. The following lists the
	// names, descriptions, and values of the special request parameters that the
	// Subscribe action uses:
	//
	// * DeliveryPolicy – The policy that defines how Amazon
	// SNS retries failed deliveries to HTTP/S endpoints.
	//
	// * FilterPolicy – The simple
	// JSON object that lets your subscriber receive only a subset of messages, rather
	// than receiving every message published to the topic.
	//
	// * RawMessageDelivery –
	// When set to true, enables raw message delivery to Amazon SQS or HTTP/S
	// endpoints. This eliminates the need for the endpoints to process JSON
	// formatting, which is otherwise created for Amazon SNS metadata.
	//
	// * 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.
	//
	// The following attribute applies only to Amazon Kinesis Data
	// Firehose delivery stream subscriptions:
	//
	// * SubscriptionRoleArn – The ARN of the
	// IAM role that has the following:
	//
	// * Permission to write to the Kinesis Data
	// Firehose delivery stream
	//
	// * Amazon SNS listed as a trusted entity
	//
	// Specifying a
	// valid ARN for this attribute is required for Kinesis Data Firehose delivery
	// stream subscriptions. For more information, see Fanout to Kinesis Data 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

	// The endpoint that you want to receive notifications. Endpoints vary by
	// protocol:
	//
	// * For the http protocol, the (public) endpoint is a URL beginning
	// with http://.
	//
	// * For the https protocol, the (public) endpoint is a URL
	// beginning with https://.
	//
	// * For the email protocol, the endpoint is an email
	// address.
	//
	// * For the email-json protocol, the endpoint is an email address.
	//
	// *
	// For the sms protocol, the endpoint is a phone number of an SMS-enabled
	// device.
	//
	// * For the sqs protocol, the endpoint is the ARN of an Amazon SQS
	// queue.
	//
	// * For the application protocol, the endpoint is the EndpointArn of a
	// mobile app and device.
	//
	// * For the lambda protocol, the endpoint is the ARN of an
	// Lambda function.
	//
	// * For the firehose protocol, the endpoint is the ARN of an
	// Amazon Kinesis Data Firehose delivery stream.
	Endpoint *string

	// Sets whether the response from the Subscribe request includes the subscription
	// ARN, even if the subscription is not yet confirmed. If you set this parameter to
	// true, the response includes the ARN in all cases, even if the subscription is
	// not yet confirmed. In addition to the ARN for confirmed subscriptions, the
	// response also includes the pending subscription ARN value for subscriptions that
	// aren't yet confirmed. A subscription becomes confirmed when the subscriber calls
	// the ConfirmSubscription action with a confirmation token. The default value is
	// false.
	ReturnSubscriptionArn bool
	// contains filtered or unexported fields
}

Input for Subscribe action.

type SubscribeOutput

type SubscribeOutput struct {

	// The ARN of the subscription if it is confirmed, or the string "pending
	// confirmation" if the subscription requires confirmation. However, if the API
	// request parameter ReturnSubscriptionArn is true, then the value is always the
	// subscription ARN, even if the subscription requires confirmation.
	SubscriptionArn *string

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

Response for Subscribe action.

type TagResourceInput

type TagResourceInput struct {

	// The ARN of the topic to which to add tags.
	//
	// This member is required.
	ResourceArn *string

	// The tags to be added to the specified topic. A tag consists of a required key
	// and an optional value.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput

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

type UnsubscribeInput

type UnsubscribeInput struct {

	// The ARN of the subscription to be deleted.
	//
	// This member is required.
	SubscriptionArn *string
	// contains filtered or unexported fields
}

Input for Unsubscribe action.

type UnsubscribeOutput

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

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the topic from which to remove tags.
	//
	// This member is required.
	ResourceArn *string

	// The list of tag keys to remove from the specified topic.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

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

type VerifySMSSandboxPhoneNumberInput added in v1.5.0

type VerifySMSSandboxPhoneNumberInput struct {

	// The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber
	// call.
	//
	// This member is required.
	OneTimePassword *string

	// The destination phone number to verify.
	//
	// This member is required.
	PhoneNumber *string
	// contains filtered or unexported fields
}

type VerifySMSSandboxPhoneNumberOutput added in v1.5.0

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

The destination phone number's verification status.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL