{
"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 (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
\nWe 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": "\nThe ARN of the topic whose access control policy you wish to modify.
\n ", "required": true }, "Label": { "shape_name": "label", "type": "string", "documentation": "\nA 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": "\nThe 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": "\nThe action you want to allow for the specified principal(s).
\nValid 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": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nAdds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
\nThe ARN of the topic for which you wish to confirm a subscription.
\n ", "required": true }, "Token": { "shape_name": "token", "type": "string", "documentation": "\nShort-lived token sent to an endpoint during the Subscribe
action.
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.
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": "\nIndicates 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": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nVerifies 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\".
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": "\nThe 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": "\nFor a list of attributes, see SetPlatformApplicationAttributes
\n ", "required": true } }, "documentation": "\nInput for CreatePlatformApplication action.
\n " }, "output": { "shape_name": "CreatePlatformApplicationResponse", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\nPlatformApplicationArn is returned.
\n " } }, "documentation": "\nResponse from CreatePlatformApplication action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\n \nCreates 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
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n ", "required": true }, "Token": { "shape_name": "String", "type": "string", "documentation": "\nUnique 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": "\nArbitrary 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.
\n " }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\nFor a list of attributes, see SetEndpointAttributes.
\n " } }, "documentation": "\nInput for CreatePlatformEndpoint action.
\n " }, "output": { "shape_name": "CreateEndpointResponse", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\nEndpointArn returned from CreateEndpoint action.
\n " } }, "documentation": "\nResponse from CreateEndpoint action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nCreates 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. The CreatePlatformEndpoint
action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, \n that endpoint's ARN is returned without creating a new endpoint. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n
When using CreatePlatformEndpoint
with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. \n For more information, see Creating an Amazon SNS Endpoint for Baidu. \n
The name of the topic you want to create.
\nConstraints: 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": "\nInput for CreateTopic action.
\n " }, "output": { "shape_name": "CreateTopicResponse", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) assigned to the created topic.
\n " } }, "documentation": "\nResponse from CreateTopic action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nCreates a topic to which notifications can be published. Users can create\n at most 3000 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.
\nEndpointArn of endpoint to delete.
\n ", "required": true } }, "documentation": "\nInput for DeleteEndpoint action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nDeletes the endpoint from Amazon SNS. This action is idempotent. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n
\nPlatformApplicationArn of platform application object to delete.
\n ", "required": true } }, "documentation": "\nInput for DeletePlatformApplication action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nDeletes 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
\nThe ARN of the topic you want to delete.
\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nDeletes 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.
\nEndpointArn for GetEndpointAttributes input.
\n ", "required": true } }, "documentation": "\nInput 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": "\nAttributes include the following:
\nCustomUserData
-- 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. \n Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. \n 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. \n This is returned from the notification service when an app and mobile device are registered with the notification service.Response from GetEndpointAttributes of the EndpointArn.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nRetrieves 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
\nPlatformApplicationArn for GetPlatformApplicationAttributesInput.
\n ", "required": true } }, "documentation": "\nInput 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": "\nAttributes include the following:
\nEventEndpointCreated
-- 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.Response for GetPlatformApplicationAttributes action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nRetrieves 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
\nThe ARN of the subscription whose properties you want to get.
\n ", "required": true } }, "documentation": "\nInput 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": "\nA map of the subscription's attributes. Attributes in this map include the following:
\nSubscriptionArn
-- the subscription's ARNTopicArn
-- the topic ARN that the subscription is associated withOwner
-- the AWS account ID of the subscription's ownerConfirmationWasAuthenticated
-- true if the subscription confirmation request was authenticatedDeliveryPolicy
-- the JSON serialization of the subscription's delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of the effective delivery policy that takes \n into account the topic delivery policy and account system defaultsResponse for GetSubscriptionAttributes action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nReturns all of the properties of a subscription.
\nThe ARN of the topic whose properties you want to get.
\n ", "required": true } }, "documentation": "\nInput 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": "\nA map of the topic's attributes. Attributes in this map include the following:
\nTopicArn
-- the topic's ARNOwner
-- the AWS account ID of the topic's ownerPolicy
-- the JSON serialization of the topic's access control policyDisplayName
-- the human-readable name used in the \"From\" field for notifications to email and email-json endpointsSubscriptionsPending
-- the number of subscriptions pending confirmation on this topicSubscriptionsConfirmed
-- the number of confirmed subscriptions on this topicSubscriptionsDeleted
-- the number of deleted subscriptions on this topicDeliveryPolicy
-- the JSON serialization of the topic's delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of the effective delivery policy that takes into account system defaultsResponse for GetTopicAttributes action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nReturns all of the properties of a topic. \n Topic properties returned might differ based on the authorization of the user.
\nPlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
\n ", "required": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nNextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
\n " } }, "documentation": "\nInput 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": "\nEndpointArn 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": "\nAttributes for endpoint.
\n " } }, "documentation": "\nEndpoint for mobile app and device.
\n " }, "documentation": "\nEndpoints returned for ListEndpointsByPlatformApplication action.
\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nNextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
\n " } }, "documentation": "\nResponse for ListEndpointsByPlatformApplication action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nLists 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
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
\n " } }, "documentation": "\nInput 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": "\nPlatformApplicationArn 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": "\nAttributes for platform application object.
\n " } }, "documentation": "\nPlatform application object.
\n " }, "documentation": "\nPlatform applications returned when calling ListPlatformApplications action.
\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nNextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
\n " } }, "documentation": "\nResponse for ListPlatformApplications action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nLists 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
Token returned by the previous ListSubscriptions
request.
The subscription's ARN.
\n " }, "Owner": { "shape_name": "account", "type": "string", "documentation": "\nThe subscription's owner.
\n " }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\nThe subscription's protocol.
\n " }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\nThe subscription's endpoint (format depends on the protocol).
\n " }, "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\nThe ARN of the subscription's topic.
\n " } }, "documentation": "A wrapper type for the attributes of an Amazon SNS subscription.
" }, "documentation": "\nA list of subscriptions.
\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\nToken to pass along to the next ListSubscriptions
request. This element is returned if there are more subscriptions to retrieve.
Response for ListSubscriptions action
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nReturns 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.
The ARN of the topic for which you wish to find subscriptions.
\n ", "required": true }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\nToken returned by the previous ListSubscriptionsByTopic
request.
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": "\nThe subscription's ARN.
\n " }, "Owner": { "shape_name": "account", "type": "string", "documentation": "\nThe subscription's owner.
\n " }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\nThe subscription's protocol.
\n " }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\nThe subscription's endpoint (format depends on the protocol).
\n " }, "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\nThe ARN of the subscription's topic.
\n " } }, "documentation": "A wrapper type for the attributes of an Amazon SNS subscription.
" }, "documentation": "\nA list of subscriptions.
\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\nToken to pass along to the next ListSubscriptionsByTopic
request. This element is returned if there are more subscriptions to retrieve.
Response for ListSubscriptionsByTopic action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nReturns 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.
Token returned by the previous ListTopics
request.
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
.
A list of topic ARNs.
\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\nToken to pass along to the next ListTopics
request. This element is returned if there are additional topics to retrieve.
Response for ListTopics action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nReturns 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.
The topic you want to publish to.
\n " }, "TargetArn": { "shape_name": "String", "type": "string", "documentation": "\nEither TopicArn or EndpointArn, but not both.
\n " }, "Message": { "shape_name": "message", "type": "string", "documentation": "\nThe message you want to send to the topic.
\nIf you want to send the same message to all transport protocols,\n include the text of the message as a String value.
\nIf 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.
Constraints: Messages must be UTF-8 encoded\n strings at most 256 KB in size (262144 bytes, not 262144 characters).
\nJSON-specific constraints:\n
Publish
call to return an error (no partial\n delivery).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.
\nConstraints: 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": "\nSet 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
You can define other top-level keys that define the message you want to send\n to a specific transport protocol (e.g., \"http\").
\nFor 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\nValid value: json
Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n ", "required": true }, "StringValue": { "shape_name": "String", "type": "string", "documentation": "\nStrings are Unicode with UTF8 binary encoding. \n For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n " }, "BinaryValue": { "shape_name": "Binary", "type": "blob", "documentation": "\nBinary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n " } }, "documentation": "\nThe user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. \n For more information, see Publish.
\nName, type, and value must not be empty or null. In addition, the message body should not be empty or null. \n All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).\n For more information, see Using Amazon SNS Message Attributes.
\n ", "xmlname": "Value" }, "documentation": "\nMessage attributes for Publish action.
\n " } }, "documentation": "\nInput for Publish action.
\n " }, "output": { "shape_name": "PublishResponse", "type": "structure", "members": { "MessageId": { "shape_name": "messageId", "type": "string", "documentation": "\nUnique identifier assigned to the published message.
\nLength Constraint: Maximum 100 characters
\n\n " } }, "documentation": "\nResponse for Publish action.
\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that a request parameter does not comply with the associated constraints.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": " \n " } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "EndpointDisabledException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\nMessage for endpoint disabled.
\n " } }, "documentation": "\nException error indicating endpoint disabled.
\n " }, { "shape_name": "PlatformApplicationDisabledException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\nMessage for platform application disabled.
\n " } }, "documentation": "\nException error indicating platform application disabled.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nSends 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.
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
The ARN of the topic whose access control policy you wish to modify.
\n ", "required": true }, "Label": { "shape_name": "label", "type": "string", "documentation": "\nThe unique label of the statement you want to remove.
\n ", "required": true } }, "documentation": "\nInput for RemovePermission action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nRemoves a statement from a topic's access control policy.
\nEndpointArn 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": "\nA map of the endpoint attributes. Attributes in this map include the following:
\nCustomUserData
-- 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. \n Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. \n 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. \n This is returned from the notification service when an app and mobile device are registered with the notification service.Input for SetEndpointAttributes action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nSets 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
\nPlatformApplicationArn 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": "\nA map of the platform application attributes. Attributes in this map include the following:
\nPlatformCredential
-- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". \n For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\".PlatformPrincipal
-- The principal 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\".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.Input for SetPlatformApplicationAttributes action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nSets 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
\nThe ARN of the subscription to modify.
\n ", "required": true }, "AttributeName": { "shape_name": "attributeName", "type": "string", "documentation": "\nThe name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
\nValid values: DeliveryPolicy
| RawMessageDelivery
The new value for the attribute in JSON format.
\n " } }, "documentation": "\nInput for SetSubscriptionAttributes action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nAllows a subscription owner to set an attribute of the topic to a new value.
\nThe ARN of the topic to modify.
\n ", "required": true }, "AttributeName": { "shape_name": "attributeName", "type": "string", "documentation": "\nThe name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
\nValid values: Policy
| DisplayName
| DeliveryPolicy
The new value for the attribute.
\n \n\n " } }, "documentation": "\nInput for SetTopicAttributes action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nAllows a topic owner to set an attribute of the topic to a new value.
\nThe ARN of the topic you want to subscribe to.
\n ", "required": true }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\nThe protocol you want to use. Supported protocols include:
\nhttp
-- delivery of JSON-encoded message via HTTP POSThttps
-- delivery of JSON-encoded message via HTTPS POSTemail
-- delivery of message via SMTPemail-json
-- delivery of JSON-encoded message via SMTPsms
-- delivery of message via SMSsqs
-- delivery of JSON-encoded message to an Amazon SQS queueapplication
-- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.The endpoint that you want to receive notifications. Endpoints vary by protocol:
\nhttp
protocol, the endpoint is an URL beginning with \"http://\"https
protocol, the endpoint is a URL beginning with \"https://\"email
protocol, the endpoint is an email addressemail-json
protocol, the endpoint is an email addresssms
protocol, the endpoint is a phone number of an SMS-enabled devicesqs
protocol, the endpoint is the ARN of an Amazon SQS queueapplication
protocol, the endpoint is the EndpointArn of a mobile app and device.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": "\nIndicates 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": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the requested resource does not exist.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates that the user has been denied access to the requested resource.
\n " } ], "documentation": "\nPrepares 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.
The ARN of the subscription to be deleted.
\n ", "required": true } }, "documentation": "\nInput for Unsubscribe action.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates an internal service error.
\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\nIndicates 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": "\nIndicates that the requested resource does not exist.
\n " } ], "documentation": "\nDeletes 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.