{ "api_version": "2010-03-31", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon Simple Notification Service", "service_abbreviation": "Amazon SNS", "endpoint_prefix": "sns", "xmlnamespace": "http://sns.amazonaws.com/doc/2010-03-31/", "documentation": "\n Amazon Simple Notification Service\n \n\t

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. \n \tApplications can use Amazon SNS to easily push real-time notification messages \n \tto interested subscribers over multiple delivery protocols. For more information about this product\n\t\tsee http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls,\n\t\tsee the Amazon SNS Developer Guide.\n\t

\n

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. \n The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, \n retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services. \n

\n\n ", "operations": { "AddPermission": { "name": "AddPermission", "input": { "shape_name": "AddPermissionInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic whose access control policy you wish to modify.

\n ", "required": true }, "Label": { "shape_name": "label", "type": "string", "documentation": "\n

A unique identifier for the new policy statement.

\n ", "required": true }, "AWSAccountId": { "shape_name": "DelegatesList", "type": "list", "members": { "shape_name": "delegate", "type": "string", "documentation": null }, "documentation": "\n

The AWS account IDs of the users (principals) who will be given access to the specified\n actions. The users must have AWS accounts, but do not need to be signed up \n for this service.

\n ", "required": true }, "ActionName": { "shape_name": "ActionsList", "type": "list", "members": { "shape_name": "action", "type": "string", "documentation": null }, "documentation": "\n

The action you want to allow for the specified principal(s).

\n

Valid values: any Amazon SNS action name.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The AddPermission action adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &ActionName.member.1=Publish\n &ActionName.member.2=GetTopicAttributes\n &Label=NewPermission\n &AWSAccountId.member.1=987654321000\n &AWSAccountId.member.2=876543210000\n &Action=AddPermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=k%2FAU%2FKp13pjndwJ7rr1sZszy6MZMlOhRBCHx1ZaZFiw%3D\n\n \n \n \n\n \n 6a213e4e-33a8-11df-9540-99d0768312d3\n \n\n \n \n\n " }, "ConfirmSubscription": { "name": "ConfirmSubscription", "input": { "shape_name": "ConfirmSubscriptionInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic for which you wish to confirm a subscription.

\n ", "required": true }, "Token": { "shape_name": "token", "type": "string", "documentation": "\n

Short-lived token sent to an endpoint during the Subscribe action.

\n ", "required": true }, "AuthenticateOnUnsubscribe": { "shape_name": "authenticateOnUnsubscribe", "type": "string", "documentation": "\n

Disallows unauthenticated unsubscribes of the subscription. \n If the value of this parameter is true and the request has an AWS signature, then only the topic owner\n and the subscription owner can unsubscribe the endpoint. The unsubscribe\n action requires AWS authentication.

\n " } }, "documentation": "\n Input for ConfirmSubscription action.\n " }, "output": { "shape_name": "ConfirmSubscriptionResponse", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the created subscription.

\n " } }, "documentation": "\n Response for ConfirmSubscriptions action.\n " }, "errors": [ { "shape_name": "SubscriptionLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the customer already owns the maximum allowed number of subscriptions.

\n " }, { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating\n the token sent to the endpoint by an earlier Subscribe action. If the\n token is valid, the action creates a new subscription and returns its\n Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".

\n\n \n\n https://sns.us-east-1.amazonaws.com/\n ?Action=ConfirmSubscription\n &TopicArn=arn:aws:sns:us-east-1:123456789012:My-Topic\n &Token=51b2ff3edb475b7d91550e0ab6edf0c1de2a34e6ebaf6\n c2262a001bcb7e051c43aa00022ceecce70bd2a67b2042da8d8\n eb47fef7a4e4e942d23e7fa56146b9ee35da040b4b8af564cc4\n 184a7391c834cb75d75c22981f776ad1ce8805e9bab29da2329\n 985337bb8095627907b46c8577c8440556b6f86582a95475802\n 6f41fc62041c4b3f67b0f5921232b5dae5aaca1\n\n \n \n \n\n \n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n \n \n 7a50221f-3774-11df-a9b7-05d48da6f042\n \n\n \n \n\n\n\n " }, "CreatePlatformApplication": { "name": "CreatePlatformApplication", "input": { "shape_name": "CreatePlatformApplicationInput", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

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.

\n ", "required": true }, "Platform": { "shape_name": "String", "type": "string", "documentation": "\n

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

\n ", "required": true }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

For a list of attributes, see SetPlatformApplicationAttributes

\n ", "required": true } }, "documentation": "\n

Input for CreatePlatformApplication action.

\n " }, "output": { "shape_name": "CreatePlatformApplicationResponse", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn is returned.

\n " } }, "documentation": "\n

Response from CreatePlatformApplication action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n \n

The CreatePlatformApplication action creates a platform application object for one of the supported push notification services, \n such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using \n the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". \n For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. \n For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". \n The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action.\n For more information, see Using Amazon SNS Mobile Push Notifications. \n

\n \n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.2.key=PlatformPrincipal\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=AIzaSyClE2lcV2zEKTLYYo645zfk2jhQPFeyxDo\n&Attributes.entry.2.value=There+is+no+principal+for+GCM\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Signature=82sHzg1Wfbgisw3i%2BHA2OgBmRktsqUKFinknkq3u%2FQ4%3D\n&Timestamp=2013-07-01T15%3A49%3A50.354Z\n&Name=gcmpushapp\n&Attributes.entry.1.key=PlatformCredential\n&Action=CreatePlatformApplication\n&Version=2010-03-31\n&SignatureVersion=2\n&Platform=GCM\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp\n \n \n b6f0e78b-e9d4-5a0e-b973-adc04e8a4ff9\n \n\n\n \n \n " }, "CreatePlatformEndpoint": { "name": "CreatePlatformEndpoint", "input": { "shape_name": "CreatePlatformEndpointInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

\n ", "required": true }, "Token": { "shape_name": "String", "type": "string", "documentation": "\n

Unique identifier created by the notification service for an app on a device. \n The specific name for Token will vary, depending on which notification service is being used. \n For example, when using APNS as the notification service, you need the device token. \n Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

\n ", "required": true }, "CustomUserData": { "shape_name": "String", "type": "string", "documentation": "\n

Arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

\n " }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

For a list of attributes, see SetEndpointAttributes.

\n " } }, "documentation": "\n

Input for CreatePlatformEndpoint action.

\n " }, "output": { "shape_name": "CreateEndpointResponse", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn returned from CreateEndpoint action.

\n " } }, "documentation": "\n

Response from CreateEndpoint action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The CreatePlatformEndpoint creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. \n CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is\n returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe \n action for subscription to a topic. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=CreatePlatformEndpoint\n&SignatureMethod=HmacSHA256\n&CustomUserData=UserId%3D27576823\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Token=APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Rg5vXBS6OfgPtWkt1u32p1w14uiGh%2BKOicvXNWTEz2w%3D\n&Timestamp=2013-07-01T15%3A49%3A50.598Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n \n \n 6613341d-3e15-53f7-bf3c-7e56994ba278\n \n\n\n \n \n " }, "CreateTopic": { "name": "CreateTopic", "input": { "shape_name": "CreateTopicInput", "type": "structure", "members": { "Name": { "shape_name": "topicName", "type": "string", "documentation": "\n

The name of the topic you want to create.

\n

Constraints: Topic names must be made up of \n only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be \n between 1 and 256 characters long.

\n ", "required": true } }, "documentation": "\n

Input for CreateTopic action.

\n " }, "output": { "shape_name": "CreateTopicResponse", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) assigned to the created topic.

\n " } }, "documentation": "\n

Response from CreateTopic action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "TopicLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the customer already owns the maximum allowed number of topics.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The CreateTopic action creates a topic to which notifications can be published. Users can create\n at most 100 topics. For more information, see http://aws.amazon.com/sns. \n This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is \n returned without creating a new topic.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?Name=My-Topic\n &Action=CreateTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=gfzIF53exFVdpSNb8AiwN3Lv%2FNYXh6S%2Br3yySK70oX4%3D\n\n \n \n \n \n \n arn:aws:sns:us-east-1:123456789012:My-Topic\n \n \n a8dec8b3-33a4-11df-8963-01868b7c937a\n \n \n \n \n\n " }, "DeleteEndpoint": { "name": "DeleteEndpoint", "input": { "shape_name": "DeleteEndpointInput", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn of endpoint to delete.

\n ", "required": true } }, "documentation": "\n

Input for DeleteEndpoint action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The DeleteEndpoint action, which is idempotent, deletes the endpoint from SNS. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=DeleteEndpoint\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=LIc6GI3JbNhmHBEDmSxzZp648XPe5CMeFny%2BTQFtomQ%3D\n&Timestamp=2013-07-01T23%3A00%3A12.456Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n c1d2b191-353c-5a5f-8969-fbdd3900afa8\n \n\n\n \n \n " }, "DeletePlatformApplication": { "name": "DeletePlatformApplication", "input": { "shape_name": "DeletePlatformApplicationInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn of platform application object to delete.

\n ", "required": true } }, "documentation": "\n

Input for DeletePlatformApplication action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The DeletePlatformApplication action deletes a platform application object for one of the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=DeletePlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Mh7X%2BQo%2BGpcm5B1IpkovBaRiJCJOqvFlIOYzL62SGrg%3D\n&Timestamp=2013-07-01T23%3A02%3A03.872Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n 097dac18-7a77-5823-a8dd-e65476dcb037\n \n\n\n \n \n " }, "DeleteTopic": { "name": "DeleteTopic", "input": { "shape_name": "DeleteTopicInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic you want to delete.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D\n\n \n \n \n\n \n fba800b9-3765-11df-8cf3-c58c53254dfb\n \n\n \n \n\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might\n prevent some messages previously sent to the topic from being delivered to\n subscribers. This action is idempotent, so deleting a topic that does not\n exist does not result in an error.

\n\n\n\n http://sns.us-east-1.amazonaws.com/\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n\n\n\n\n\n \n f3aa9ac9-3c3d-11df-8235-9dab105e9c32\n \n\n\n\n\n " }, "GetEndpointAttributes": { "name": "GetEndpointAttributes", "input": { "shape_name": "GetEndpointAttributesInput", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn for GetEndpointAttributes input.

\n ", "required": true } }, "documentation": "\n

Input for GetEndpointAttributes action.

\n " }, "output": { "shape_name": "GetEndpointAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes include the following:

\n \n " } }, "documentation": "\n

Response from GetEndpointAttributes of the EndpointArn.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The GetEndpointAttributes retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=GetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=%2B2egbEoT4npw3p5H3wiIdzZBoTn4KI3UWmMFyBsHH9c%3D\n&Timestamp=2013-07-01T22%3A44%3A56.515Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n Enabled\n true\n \n \n CustomUserData\n UserId=01234567\n \n \n Token\n APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n \n \n \n \n 6c725a19-a142-5b77-94f9-1055a9ea04e7\n \n\n\n \n \n " }, "GetPlatformApplicationAttributes": { "name": "GetPlatformApplicationAttributes", "input": { "shape_name": "GetPlatformApplicationAttributesInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

\n ", "required": true } }, "documentation": "\n

Input for GetPlatformApplicationAttributes action.

\n " }, "output": { "shape_name": "GetPlatformApplicationAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes include the following:

\n \n " } }, "documentation": "\n

Response for GetPlatformApplicationAttributes action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The GetPlatformApplicationAttributes action retrieves the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=GetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=UGMaCq8CCJGSYXO9Ehr2VuHIBYSe6WbxkqgMKRslTK4%3D\n&Timestamp=2013-07-01T22%3A40%3A50.643Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n AllowEndpointPolicies\n false\n \n \n \n \n 74848df2-87f6-55ed-890c-c7be80442462\n \n\n\n \n \n " }, "GetSubscriptionAttributes": { "name": "GetSubscriptionAttributes", "input": { "shape_name": "GetSubscriptionAttributesInput", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription whose properties you want to get.

\n ", "required": true } }, "documentation": "\n

Input for GetSubscriptionAttributes.

\n " }, "output": { "shape_name": "GetSubscriptionAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "SubscriptionAttributesMap", "type": "map", "keys": { "shape_name": "attributeName", "type": "string", "documentation": null }, "members": { "shape_name": "attributeValue", "type": "string", "documentation": null }, "documentation": "\n

A map of the subscription's attributes. Attributes in this map include the following:

\n \n " } }, "documentation": "\n

Response for GetSubscriptionAttributes action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The GetSubscriptionAttribtues action returns all of the properties of a subscription.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=GetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n \n \n \n\n \n \n \n Owner\n 123456789012\n \n \n DeliveryPolicy\n {"healthyRetryPolicy":{"numRetries":10}}\n \n \n SubscriptionArn\n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n \n \n \n \n 057f074c-33a7-11df-9540-99d0768312d3\n \n\n \n \n\n " }, "GetTopicAttributes": { "name": "GetTopicAttributes", "input": { "shape_name": "GetTopicAttributesInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic whose properties you want to get.

\n ", "required": true } }, "documentation": "\n

Input for GetTopicAttributes action.

\n " }, "output": { "shape_name": "GetTopicAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "TopicAttributesMap", "type": "map", "keys": { "shape_name": "attributeName", "type": "string", "documentation": null }, "members": { "shape_name": "attributeValue", "type": "string", "documentation": null }, "documentation": "\n

A map of the topic's attributes. Attributes in this map include the following:

\n \n " } }, "documentation": "\n

Response for GetTopicAttributes action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The GetTopicAttributes action returns all of the properties of a topic. \n Topic properties returned might differ based on the authorization of the user.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=GetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n \n \n \n\n \n \n \n Owner\n 123456789012\n \n \n Policy\n {\n"Version":"2008-10-17","Id":"us-east-1/698519295917/test__default_policy_ID","Statement" : [{"Effect":"Allow","Sid":"us-east-1/698519295917/test__default_statement_ID","Principal" : {"AWS": "*"},"Action":["SNS:GetTopicAttributes","SNS:SetTopicAttributes","SNS:AddPermission","SNS:RemovePermission","SNS:DeleteTopic","SNS:Subscribe","SNS:ListSubscriptionsByTopic","SNS:Publish","SNS:Receive"],"Resource":"arn:aws:sns:us-east-1:698519295917:test","Condition" : {"StringLike" : {"AWS:SourceArn": "arn:aws:*:*:698519295917:*"}}}]}\n \n \n TopicArn\n arn:aws:sns:us-east-1:123456789012:My-Topic\n \n \n \n \n 057f074c-33a7-11df-9540-99d0768312d3\n \n\n \n \n\n " }, "ListEndpointsByPlatformApplication": { "name": "ListEndpointsByPlatformApplication", "input": { "shape_name": "ListEndpointsByPlatformApplicationInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

\n ", "required": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

\n " } }, "documentation": "\n

Input for ListEndpointsByPlatformApplication action.

\n " }, "output": { "shape_name": "ListEndpointsByPlatformApplicationResponse", "type": "structure", "members": { "Endpoints": { "shape_name": "ListOfEndpoints", "type": "list", "members": { "shape_name": "Endpoint", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn for mobile app and device.

\n " }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes for endpoint.

\n " } }, "documentation": "\n

Endpoint for mobile app and device.

\n " }, "documentation": "\n

Endpoints returned for ListEndpointsByPlatformApplication action.

\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

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

\n " } }, "documentation": "\n

Response for ListEndpointsByPlatformApplication action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The ListEndpointsByPlatformApplication action lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. \n The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=ListEndpointsByPlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=e6H4sJSCRBBlh%2BaigB%2FtYgp4%2Bjl7dikAQ6WKf%2BMTwNM%3D\n&Timestamp=2013-07-01T23%3A00%3A52.515Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n \n \n Enabled\n true\n \n \n CustomUserData\n UserId=27576823\n \n \n Token\n APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n \n \n \n \n \n \n 9a48768c-dac8-5a60-aec0-3cc27ea08d96\n \n\n\n \n \n \n " }, "ListPlatformApplications": { "name": "ListPlatformApplications", "input": { "shape_name": "ListPlatformApplicationsInput", "type": "structure", "members": { "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

\n " } }, "documentation": "\n

Input for ListPlatformApplications action.

\n " }, "output": { "shape_name": "ListPlatformApplicationsResponse", "type": "structure", "members": { "PlatformApplications": { "shape_name": "ListOfPlatformApplications", "type": "list", "members": { "shape_name": "PlatformApplication", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for platform application object.

\n " }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes for platform application object.

\n " } }, "documentation": "\n

Platform application object.

\n " }, "documentation": "\n

Platform applications returned when calling ListPlatformApplications action.

\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

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

\n " } }, "documentation": "\n

Response for ListPlatformApplications action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListPlatformApplications action lists the platform application objects for the supported push notification services, \n such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=ListPlatformApplications\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=drVbTuyR5N9e88WJMNPzBOjNFNvawkCaMfZI0xa9kIQ%3D\n&Timestamp=2013-07-01T22%3A33%3A55.618Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n arn:aws:sns:us-west-2:123456789012:app/APNS_SANDBOX/apnspushapp\n \n \n AllowEndpointPolicies\n false\n \n \n \n \n arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp\n \n \n AllowEndpointPolicies\n false\n \n \n \n \n \n \n 315a335e-85d8-52df-9349-791283cbb529\n \n\n\n \n \n " }, "ListSubscriptions": { "name": "ListSubscriptions", "input": { "shape_name": "ListSubscriptionsInput", "type": "structure", "members": { "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token returned by the previous ListSubscriptions request.

\n " } }, "documentation": "\n Input for ListSubscriptions action.\n " }, "output": { "shape_name": "ListSubscriptionsResponse", "type": "structure", "members": { "Subscriptions": { "shape_name": "SubscriptionsList", "type": "list", "members": { "shape_name": "Subscription", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The subscription's ARN.

\n " }, "Owner": { "shape_name": "account", "type": "string", "documentation": "\n

The subscription's owner.

\n " }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\n

The subscription's protocol.

\n " }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\n

The subscription's endpoint (format depends on the protocol).

\n " }, "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the subscription's topic.

\n " } }, "documentation": "

A wrapper type for the attributes of an SNS subscription.

" }, "documentation": "\n

A list of subscriptions.

\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list\n of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a \n new ListSubscriptions call to get further results.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n &Action=ListSubscriptions\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n \n \n \n\n \n \n \n arn:aws:sns:us-east-1:698519295917:My-Topic\n email\n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n 123456789012\n example@amazon.com\n \n \n \n \n 384ac68d-3775-11df-8963-01868b7c937a\n \n\n \n \n\n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" } }, "ListSubscriptionsByTopic": { "name": "ListSubscriptionsByTopic", "input": { "shape_name": "ListSubscriptionsByTopicInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic for which you wish to find subscriptions.

\n ", "required": true }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token returned by the previous ListSubscriptionsByTopic request.

\n " } }, "documentation": "\n

Input for ListSubscriptionsByTopic action.

\n " }, "output": { "shape_name": "ListSubscriptionsByTopicResponse", "type": "structure", "members": { "Subscriptions": { "shape_name": "SubscriptionsList", "type": "list", "members": { "shape_name": "Subscription", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The subscription's ARN.

\n " }, "Owner": { "shape_name": "account", "type": "string", "documentation": "\n

The subscription's owner.

\n " }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\n

The subscription's protocol.

\n " }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\n

The subscription's endpoint (format depends on the protocol).

\n " }, "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the subscription's topic.

\n " } }, "documentation": "

A wrapper type for the attributes of an SNS subscription.

" }, "documentation": "\n

A list of subscriptions.

\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

\n " } }, "documentation": "\n

Response for ListSubscriptionsByTopic action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListSubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns \n a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken \n parameter in a new ListSubscriptionsByTopic call to get further results.

\n \n \n \n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=ListSubscriptionsByTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n \n \n \n\n \n \n \n arn:aws:sns:us-east-1:123456789012:My-Topic\n email\n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n 123456789012\n example@amazon.com\n \n \n \n \n b9275252-3774-11df-9540-99d0768312d3\n \n\n \n \n \n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" } }, "ListTopics": { "name": "ListTopics", "input": { "shape_name": "ListTopicsInput", "type": "structure", "members": { "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token returned by the previous ListTopics request.

\n " } }, "documentation": null }, "output": { "shape_name": "ListTopicsResponse", "type": "structure", "members": { "Topics": { "shape_name": "TopicsList", "type": "list", "members": { "shape_name": "Topic", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The topic's ARN.

\n " } }, "documentation": "

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.

" }, "documentation": "\n

A list of topic ARNs.

\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

\n " } }, "documentation": "\n

Response for ListTopics action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If\n there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get \n further results.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?Action=ListTopics\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=tPg1qKNTNVPydnL3Yx5Fqm2O9GxCr9vh3EF5r9%2F5%2BJs%3D\n\n \n \n \n\n \n \n \n arn:aws:sns:us-east-1:123456789012:My-Topic\n \n \n \n \n 3f1478c7-33a9-11df-9540-99d0768312d3\n \n\n \n \n\n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Topics", "py_input_token": "next_token" } }, "Publish": { "name": "Publish", "input": { "shape_name": "PublishInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The topic you want to publish to.

\n " }, "TargetArn": { "shape_name": "String", "type": "string", "documentation": "\n

Either TopicArn or EndpointArn, but not both.

\n " }, "Message": { "shape_name": "message", "type": "string", "documentation": "\n

The message you want to send to the topic.

\n

If you want to send the same message to all transport protocols,\n include the text of the message as a String value.

\n

If you want to send different messages for each transport protocol,\n set the value of the MessageStructure parameter to json\n and use a JSON object for the Message parameter.\n See the Examples section for the format of the JSON object.

\n

Constraints: Messages must be UTF-8 encoded\n strings at most 256 KB in size (262144 bytes, not 262144 characters).

\n

JSON-specific constraints:\n

\n

\n ", "required": true }, "Subject": { "shape_name": "subject", "type": "string", "documentation": "\n

Optional parameter to be used as the \"Subject\" line when the message is\n delivered to email endpoints. This field will also be included, if present, \n in the standard JSON messages delivered to other endpoints.

\n

Constraints: Subjects must be ASCII text that begins with a letter, number, \n or punctuation mark; must not include line breaks or control characters; and \n must be less than 100 characters long.

\n " }, "MessageStructure": { "shape_name": "messageStructure", "type": "string", "documentation": "\n

Set MessageStructure to json if you want to send\n a different message for each protocol. For example, using one publish action,\n you can send a short message to your SMS subscribers and a longer message to\n your email subscribers.\n If you set MessageStructure to json, the value of \n the Message parameter must:\n

\n \n

You can define other top-level keys that define the message you want to send\n to a specific transport protocol (e.g., \"http\").

\n

For information about sending different messages for each protocol using\n the AWS Management Console, go to Create \n Different Messages for Each Protocol in the Amazon Simple Notification Service\n Getting Started Guide.\n

\n\n

Valid value: json

\n " } }, "documentation": "\n

Input for Publish action.

\n " }, "output": { "shape_name": "PublishResponse", "type": "structure", "members": { "MessageId": { "shape_name": "messageId", "type": "string", "documentation": "\n

Unique identifier assigned to the published message.

\n

Length Constraint: Maximum 100 characters

\n\n " } }, "documentation": "\n

Response for Publish action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "EndpointDisabledException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

Message for endpoint disabled.

\n " } }, "documentation": "\n

Exception error indicating endpoint disabled.

\n " }, { "shape_name": "PlatformApplicationDisabledException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

Message for platform application disabled.

\n " } }, "documentation": "\n

Exception error indicating platform application disabled.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The Publish action sends a message to all of a topic's subscribed endpoints. When a\n messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it \n to the topic's subscribers shortly. The format of the outgoing message to each\n subscribed endpoint depends on the notification protocol selected.

\n

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, \n you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. \n The second example below shows a request and response for publishing to a mobile endpoint.\n

\n \n \n \n The following example publishes the same message to all protocols:\n \n http://sns.us-east-1.amazonaws.com/\n ?Subject=My%20first%20message\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A698519295917%3AMy-Topic\n &Message=Hello%20world%21\n &Action=Publish\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n &Signature=9GZysQ4Jpnz%2BHklqM7VFTvEcjR2LIUtn6jW47054xxE%3D\n \n Use the following JSON object format for the Message parameter to send different messages to each protocol (linebreaks added for readability):\n {\n \"default\" : \"some message\",\n \"email\" : \"some email message\",\n \"email-json\" : \"some email-json message\",\n \"http\" : \"some http message\",\n \"https\" : \"some https message\",\n \"sqs\" : \"some sqs message\"\n }\n \n\n \n \n \n\n \n 94f20ce6-13c5-43a0-9a9e-ca52d816e90b\n \n \n f187a3c1-376f-11df-8963-01868b7c937a\n \n\n \n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=Publish\n&Message=%7B%22default%22%3A%22This+is+the+default+Message%22%2C%22APNS_SANDBOX%22%3A%22%7B+%5C%22aps%5C%22+%3A+%7B+%5C%22alert%5C%22+%3A+%5C%22You+have+got+email.%5C%22%2C+%5C%22badge%5C%22+%3A+9%2C%5C%22sound%5C%22+%3A%5C%22default%5C%22%7D%7D%22%7D\n&TargetArn=arn%3Aaws%3Asns%3Aus-west-2%3A803981987763%3Aendpoint%2FAPNS_SANDBOX%2Fpushapp%2F98e9ced9-f136-3893-9d60-776547eafebb\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=vmqc4XRupKAxsDAdN4j4Ayw5LQljXMps3kss4bkDfCk%3D\n&Timestamp=2013-07-18T22%3A44%3A09.452Z\n&MessageStructure=json\n \n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n 567910cd-659e-55d4-8ccb-5aaf14679dc0\n \n \n d74b8436-ae13-5ab4-a9ff-ce54dfea72a0\n \n\n \n \n \n " }, "RemovePermission": { "name": "RemovePermission", "input": { "shape_name": "RemovePermissionInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic whose access control policy you wish to modify.

\n ", "required": true }, "Label": { "shape_name": "label", "type": "string", "documentation": "\n

The unique label of the statement you want to remove.

\n ", "required": true } }, "documentation": "\n

Input for RemovePermission action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The RemovePermission action removes a statement from a topic's access control policy.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &Label=NewPermission\n &Action=RemovePermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=N1abwRY9i7zaSQmbAlm71pPf9EEFOqNbQL1alzw2yCg%3D\n\n \n \n \n\n \n d170b150-33a8-11df-995a-2d6fbe836cc1\n \n\n \n \n\n " }, "SetEndpointAttributes": { "name": "SetEndpointAttributes", "input": { "shape_name": "SetEndpointAttributesInput", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn used for SetEndpointAttributes action.

\n ", "required": true }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A map of the endpoint attributes. Attributes in this map include the following:

\n \n ", "required": true } }, "documentation": "\n

Input for SetEndpointAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The SetEndpointAttributes action sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=CustomUserData\n&Action=SetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=My+custom+userdata\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=CFTGfGOS5vgSU3%2FZgv2h%2FJdWgr2JQdDJSrUU9k38wSM%3D\n&Timestamp=2013-07-01T22%3A56%3A45.582Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n 2fe0bfc7-3e85-5ee5-a9e2-f58b35e85f6a\n \n\n\n \n \n " }, "SetPlatformApplicationAttributes": { "name": "SetPlatformApplicationAttributes", "input": { "shape_name": "SetPlatformApplicationAttributesInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for SetPlatformApplicationAttributes action.

\n ", "required": true }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A map of the platform application attributes. Attributes in this map include the following:

\n \n ", "required": true } }, "documentation": "\n

Input for SetPlatformApplicationAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The SetPlatformApplicationAttributes action sets the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=EventEndpointCreated&PlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=SetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Atopicarn\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=06L2TsW3jiH%2FGKDYuT8w4NojSrTf4Ig2GKqGeJPhPT4%3D\n&Timestamp=2013-07-01T22%3A53%3A17.800Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n cf577bcc-b3dc-5463-88f1-3180b9412395\n \n\n\n \n \n " }, "SetSubscriptionAttributes": { "name": "SetSubscriptionAttributes", "input": { "shape_name": "SetSubscriptionAttributesInput", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription to modify.

\n ", "required": true }, "AttributeName": { "shape_name": "attributeName", "type": "string", "documentation": "\n

The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

\n

Valid values: DeliveryPolicy

\n ", "required": true }, "AttributeValue": { "shape_name": "attributeValue", "type": "string", "documentation": "\n

The new value for the attribute in JSON format.

\n " } }, "documentation": "\n

Input for SetSubscriptionAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The SetSubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value.

\n\n \n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"healthyRetryPolicy\":{\"numRetries\":5}}\n &SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &AttributeName=DeliveryPolicy\n &Action=SetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"healthyRetryPolicy\": \n {\n \"minDelayTarget\": ,\n \"maxDelayTarget\": ,\n \"numRetries\": ,\n \"numMaxDelayRetries\": ,\n \"backoffFunction\": \"\"\n },\n \"throttlePolicy\":\n {\n \"maxReceivesPerSecond\": \n }\n}\n \n \n \n\n \n a8763b99-33a7-11df-a9b7-05d48da6f042\n \n\n \n \n\n\n\n " }, "SetTopicAttributes": { "name": "SetTopicAttributes", "input": { "shape_name": "SetTopicAttributesInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic to modify.

\n ", "required": true }, "AttributeName": { "shape_name": "attributeName", "type": "string", "documentation": "\n

The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

\n

Valid values: Policy | DisplayName | DeliveryPolicy

\n ", "required": true }, "AttributeValue": { "shape_name": "attributeValue", "type": "string", "documentation": "\n

The new value for the attribute.

\n \n\n " } }, "documentation": "\n

Input for SetTopicAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The SetTopicAttributes action allows a topic owner to set an attribute of the topic to a new value.

\n\n \nThe following example sets the DisplayName attribute to MyTopicName\n\n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue=MyTopicName\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DisplayName\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"http\":{\"defaultHealthyRetryPolicy\":{\"numRetries\":5}}}\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DeliveryPolicy\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D \n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"http\": {\n \"defaultHealthyRetryPolicy\": \n {\n \"minDelayTarget\": <int>,\n \"maxDelayTarget\": <int>,\n \"numRetries\": <int>,\n \"numMaxDelayRetries\": <int>,\n \"backoffFunction\": \"<linear|arithmetic|geometric|exponential>\"\n },\n \"disableSubscriptionOverrides\": <boolean>,\n \"defaultThrottlePolicy\": \n {\n \"maxReceivesPerSecond\": <int>\n }\n }\n \n \n \n\n \n a8763b99-33a7-11df-a9b7-05d48da6f042\n \n\n \n \n\n\n\n " }, "Subscribe": { "name": "Subscribe", "input": { "shape_name": "SubscribeInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic you want to subscribe to.

\n ", "required": true }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\n

The protocol you want to use. Supported protocols include:

\n \n ", "required": true }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\n

The endpoint that you want to receive notifications. Endpoints vary by protocol:

\n \n ", "py_name": "notification_endpoint", "cli_name": "notification-endpoint", "no_paramfile": true } }, "documentation": "\n Input for Subscribe action.\n " }, "output": { "shape_name": "SubscribeResponse", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription, if the service was able to create a \n subscription immediately (without requiring endpoint owner confirmation).

\n " } }, "documentation": "\n Response for Subscribe action.\n " }, "errors": [ { "shape_name": "SubscriptionLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the customer already owns the maximum allowed number of subscriptions.

\n " }, { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a\n subscription, the endpoint owner must call the ConfirmSubscription\n action with the token from the confirmation message. Confirmation tokens are\n valid for three days.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Endpoint=example%40amazon.com\n &Protocol=email\n &Action=Subscribe\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=1%2FeGaDphxXq%2Fa89x6HvKh%2Fc1yLGXzuhS7vS2MslToDM%3D\n\n \n \n \n\n \n pending confirmation\n \n \n a169c740-3766-11df-8963-01868b7c937a\n \n\n \n \n\n " }, "Unsubscribe": { "name": "Unsubscribe", "input": { "shape_name": "UnsubscribeInput", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription to be deleted.

\n ", "required": true } }, "documentation": "\n

Input for Unsubscribe action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The Unsubscribe action deletes a subscription. If the subscription requires authentication for \n deletion, only the owner of the subscription or the topic's owner \n can unsubscribe, and an AWS signature is required. If the \n Unsubscribe call does not require authentication and the requester is not \n the subscription owner, a final cancellation message is delivered to the \n endpoint, so that the endpoint owner can easily resubscribe to the topic if \n the Unsubscribe request was unintended.

\n \n \n \n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=Unsubscribe\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=e8IwhPzuWeMvPDVrN7jUVxasd3Wv2LuO8x6rE23VCv8%3D\n\n \n \n \n\n \n 18e0ac39-3776-11df-84c0-b93cc1666b84\n \n\n \n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://sns.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https", "http" ] }, "pagination": { "ListSubscriptions": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" }, "ListSubscriptionsByTopic": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" }, "ListTopics": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Topics", "py_input_token": "next_token" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }