models.sns-2010-03-31-intermediate.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
{
"metadata" : {
"apiVersion" : "2010-03-31",
"protocol" : "query",
"checksumFormat" : null,
"documentation" : "Amazon Simple Notification Service Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
",
"defaultEndpoint" : "https://sns.us-east-1.amazonaws.com",
"defaultEndpointWithoutHttpProtocol" : "sns.us-east-1.amazonaws.com",
"syncInterface" : "AmazonSNS",
"syncClient" : "AmazonSNSClient",
"asyncInterface" : "AmazonSNSAsync",
"asyncClient" : "AmazonSNSAsyncClient",
"packageName" : "com.amazonaws.services.sns",
"packagePath" : "com/amazonaws/services/sns",
"serviceAbbreviation" : "Amazon SNS",
"serviceFullName" : "Amazon Simple Notification Service",
"hasApiWithStreamInput" : false,
"contentType" : null,
"jsonVersion" : null,
"endpointPrefix" : "sns",
"signingName" : "sns",
"protocolDefaultExceptionUmarshallerImpl" : "StandardErrorUnmarshaller",
"jsonProtocol" : false,
"xmlProtocol" : true,
"cborProtocol" : false,
"unmarshallerContextClassName" : "StaxUnmarshallerContext",
"unmarshallerClassSuffix" : "StaxUnmarshaller",
"syncClientBuilderClassName" : "AmazonSNSClientBuilder",
"asyncClientBuilderClassName" : "AmazonSNSAsyncClientBuilder",
"cucumberModuleInjectorClassName" : "AmazonSNSModuleInjector",
"smokeTestsPackageName" : "com.amazonaws.services.sns.smoketests",
"serviceName" : "Amazon SNS"
},
"operations" : {
"AddPermission" : {
"documentation" : "Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
",
"operationName" : "AddPermission",
"deprecated" : false,
"input" : {
"variableName" : "addPermissionRequest",
"variableType" : "AddPermissionRequest",
"variableDeclarationType" : "AddPermissionRequest",
"documentation" : "",
"simpleType" : "AddPermissionRequest",
"variableSetterType" : "AddPermissionRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "AddPermissionResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "addPermission",
"authenticated" : true,
"syncReturnType" : "AddPermissionResult",
"asyncReturnType" : "AddPermissionResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"CheckIfPhoneNumberIsOptedOut" : {
"documentation" : "Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
",
"operationName" : "CheckIfPhoneNumberIsOptedOut",
"deprecated" : false,
"input" : {
"variableName" : "checkIfPhoneNumberIsOptedOutRequest",
"variableType" : "CheckIfPhoneNumberIsOptedOutRequest",
"variableDeclarationType" : "CheckIfPhoneNumberIsOptedOutRequest",
"documentation" : "The input for the CheckIfPhoneNumberIsOptedOut action.
",
"simpleType" : "CheckIfPhoneNumberIsOptedOutRequest",
"variableSetterType" : "CheckIfPhoneNumberIsOptedOutRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "CheckIfPhoneNumberIsOptedOutResult",
"documentation" : "The response from the CheckIfPhoneNumberIsOptedOut action.
"
},
"exceptions" : [ {
"exceptionName" : "ThrottledException",
"documentation" : "Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "checkIfPhoneNumberIsOptedOut",
"authenticated" : true,
"syncReturnType" : "CheckIfPhoneNumberIsOptedOutResult",
"asyncReturnType" : "CheckIfPhoneNumberIsOptedOutResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"ConfirmSubscription" : {
"documentation" : "Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".
",
"operationName" : "ConfirmSubscription",
"deprecated" : false,
"input" : {
"variableName" : "confirmSubscriptionRequest",
"variableType" : "ConfirmSubscriptionRequest",
"variableDeclarationType" : "ConfirmSubscriptionRequest",
"documentation" : "Input for ConfirmSubscription action.
",
"simpleType" : "ConfirmSubscriptionRequest",
"variableSetterType" : "ConfirmSubscriptionRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ConfirmSubscriptionResult",
"documentation" : "Response for ConfirmSubscriptions action.
"
},
"exceptions" : [ {
"exceptionName" : "SubscriptionLimitExceededException",
"documentation" : "Indicates that the customer already owns the maximum allowed number of subscriptions.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "confirmSubscription",
"authenticated" : true,
"syncReturnType" : "ConfirmSubscriptionResult",
"asyncReturnType" : "ConfirmSubscriptionResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"CreatePlatformApplication" : {
"documentation" : "Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is \"Package Security Identifier\". For MPNS, PlatformPrincipal is \"TLS certificate\". For Baidu, PlatformPrincipal is \"API key\".
For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". For WNS, PlatformCredential is \"secret key\". For MPNS, PlatformCredential is \"private key\". For Baidu, PlatformCredential is \"secret key\". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
",
"operationName" : "CreatePlatformApplication",
"deprecated" : false,
"input" : {
"variableName" : "createPlatformApplicationRequest",
"variableType" : "CreatePlatformApplicationRequest",
"variableDeclarationType" : "CreatePlatformApplicationRequest",
"documentation" : "Input for CreatePlatformApplication action.
",
"simpleType" : "CreatePlatformApplicationRequest",
"variableSetterType" : "CreatePlatformApplicationRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "CreatePlatformApplicationResult",
"documentation" : "Response from CreatePlatformApplication action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "createPlatformApplication",
"authenticated" : true,
"syncReturnType" : "CreatePlatformApplicationResult",
"asyncReturnType" : "CreatePlatformApplicationResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"CreatePlatformEndpoint" : {
"documentation" : "Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
",
"operationName" : "CreatePlatformEndpoint",
"deprecated" : false,
"input" : {
"variableName" : "createPlatformEndpointRequest",
"variableType" : "CreatePlatformEndpointRequest",
"variableDeclarationType" : "CreatePlatformEndpointRequest",
"documentation" : "Input for CreatePlatformEndpoint action.
",
"simpleType" : "CreatePlatformEndpointRequest",
"variableSetterType" : "CreatePlatformEndpointRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "CreatePlatformEndpointResult",
"documentation" : "Response from CreateEndpoint action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "createPlatformEndpoint",
"authenticated" : true,
"syncReturnType" : "CreatePlatformEndpointResult",
"asyncReturnType" : "CreatePlatformEndpointResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"CreateTopic" : {
"documentation" : "Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
",
"operationName" : "CreateTopic",
"deprecated" : false,
"input" : {
"variableName" : "createTopicRequest",
"variableType" : "CreateTopicRequest",
"variableDeclarationType" : "CreateTopicRequest",
"documentation" : "Input for CreateTopic action.
",
"simpleType" : "CreateTopicRequest",
"variableSetterType" : "CreateTopicRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "CreateTopicResult",
"documentation" : "Response from CreateTopic action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "TopicLimitExceededException",
"documentation" : "Indicates that the customer already owns the maximum allowed number of topics.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "createTopic",
"authenticated" : true,
"syncReturnType" : "CreateTopicResult",
"asyncReturnType" : "CreateTopicResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"DeleteEndpoint" : {
"documentation" : "Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
",
"operationName" : "DeleteEndpoint",
"deprecated" : false,
"input" : {
"variableName" : "deleteEndpointRequest",
"variableType" : "DeleteEndpointRequest",
"variableDeclarationType" : "DeleteEndpointRequest",
"documentation" : "Input for DeleteEndpoint action.
",
"simpleType" : "DeleteEndpointRequest",
"variableSetterType" : "DeleteEndpointRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "DeleteEndpointResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "deleteEndpoint",
"authenticated" : true,
"syncReturnType" : "DeleteEndpointResult",
"asyncReturnType" : "DeleteEndpointResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"DeletePlatformApplication" : {
"documentation" : "Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
",
"operationName" : "DeletePlatformApplication",
"deprecated" : false,
"input" : {
"variableName" : "deletePlatformApplicationRequest",
"variableType" : "DeletePlatformApplicationRequest",
"variableDeclarationType" : "DeletePlatformApplicationRequest",
"documentation" : "Input for DeletePlatformApplication action.
",
"simpleType" : "DeletePlatformApplicationRequest",
"variableSetterType" : "DeletePlatformApplicationRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "DeletePlatformApplicationResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "deletePlatformApplication",
"authenticated" : true,
"syncReturnType" : "DeletePlatformApplicationResult",
"asyncReturnType" : "DeletePlatformApplicationResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"DeleteTopic" : {
"documentation" : "Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
",
"operationName" : "DeleteTopic",
"deprecated" : false,
"input" : {
"variableName" : "deleteTopicRequest",
"variableType" : "DeleteTopicRequest",
"variableDeclarationType" : "DeleteTopicRequest",
"documentation" : "",
"simpleType" : "DeleteTopicRequest",
"variableSetterType" : "DeleteTopicRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "DeleteTopicResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "deleteTopic",
"authenticated" : true,
"syncReturnType" : "DeleteTopicResult",
"asyncReturnType" : "DeleteTopicResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"GetEndpointAttributes" : {
"documentation" : "Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
",
"operationName" : "GetEndpointAttributes",
"deprecated" : false,
"input" : {
"variableName" : "getEndpointAttributesRequest",
"variableType" : "GetEndpointAttributesRequest",
"variableDeclarationType" : "GetEndpointAttributesRequest",
"documentation" : "Input for GetEndpointAttributes action.
",
"simpleType" : "GetEndpointAttributesRequest",
"variableSetterType" : "GetEndpointAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "GetEndpointAttributesResult",
"documentation" : "Response from GetEndpointAttributes of the EndpointArn.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "getEndpointAttributes",
"authenticated" : true,
"syncReturnType" : "GetEndpointAttributesResult",
"asyncReturnType" : "GetEndpointAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"GetPlatformApplicationAttributes" : {
"documentation" : "Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
",
"operationName" : "GetPlatformApplicationAttributes",
"deprecated" : false,
"input" : {
"variableName" : "getPlatformApplicationAttributesRequest",
"variableType" : "GetPlatformApplicationAttributesRequest",
"variableDeclarationType" : "GetPlatformApplicationAttributesRequest",
"documentation" : "Input for GetPlatformApplicationAttributes action.
",
"simpleType" : "GetPlatformApplicationAttributesRequest",
"variableSetterType" : "GetPlatformApplicationAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "GetPlatformApplicationAttributesResult",
"documentation" : "Response for GetPlatformApplicationAttributes action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "getPlatformApplicationAttributes",
"authenticated" : true,
"syncReturnType" : "GetPlatformApplicationAttributesResult",
"asyncReturnType" : "GetPlatformApplicationAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"GetSMSAttributes" : {
"documentation" : "Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes action.
",
"operationName" : "GetSMSAttributes",
"deprecated" : false,
"input" : {
"variableName" : "getSMSAttributesRequest",
"variableType" : "GetSMSAttributesRequest",
"variableDeclarationType" : "GetSMSAttributesRequest",
"documentation" : "The input for the GetSMSAttributes request.
",
"simpleType" : "GetSMSAttributesRequest",
"variableSetterType" : "GetSMSAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "GetSMSAttributesResult",
"documentation" : "The response from the GetSMSAttributes request.
"
},
"exceptions" : [ {
"exceptionName" : "ThrottledException",
"documentation" : "Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "getSMSAttributes",
"authenticated" : true,
"syncReturnType" : "GetSMSAttributesResult",
"asyncReturnType" : "GetSMSAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"GetSubscriptionAttributes" : {
"documentation" : "Returns all of the properties of a subscription.
",
"operationName" : "GetSubscriptionAttributes",
"deprecated" : false,
"input" : {
"variableName" : "getSubscriptionAttributesRequest",
"variableType" : "GetSubscriptionAttributesRequest",
"variableDeclarationType" : "GetSubscriptionAttributesRequest",
"documentation" : "Input for GetSubscriptionAttributes.
",
"simpleType" : "GetSubscriptionAttributesRequest",
"variableSetterType" : "GetSubscriptionAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "GetSubscriptionAttributesResult",
"documentation" : "Response for GetSubscriptionAttributes action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "getSubscriptionAttributes",
"authenticated" : true,
"syncReturnType" : "GetSubscriptionAttributesResult",
"asyncReturnType" : "GetSubscriptionAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"GetTopicAttributes" : {
"documentation" : "Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
",
"operationName" : "GetTopicAttributes",
"deprecated" : false,
"input" : {
"variableName" : "getTopicAttributesRequest",
"variableType" : "GetTopicAttributesRequest",
"variableDeclarationType" : "GetTopicAttributesRequest",
"documentation" : "Input for GetTopicAttributes action.
",
"simpleType" : "GetTopicAttributesRequest",
"variableSetterType" : "GetTopicAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "GetTopicAttributesResult",
"documentation" : "Response for GetTopicAttributes action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "getTopicAttributes",
"authenticated" : true,
"syncReturnType" : "GetTopicAttributesResult",
"asyncReturnType" : "GetTopicAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"ListEndpointsByPlatformApplication" : {
"documentation" : "Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
",
"operationName" : "ListEndpointsByPlatformApplication",
"deprecated" : false,
"input" : {
"variableName" : "listEndpointsByPlatformApplicationRequest",
"variableType" : "ListEndpointsByPlatformApplicationRequest",
"variableDeclarationType" : "ListEndpointsByPlatformApplicationRequest",
"documentation" : "Input for ListEndpointsByPlatformApplication action.
",
"simpleType" : "ListEndpointsByPlatformApplicationRequest",
"variableSetterType" : "ListEndpointsByPlatformApplicationRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ListEndpointsByPlatformApplicationResult",
"documentation" : "Response for ListEndpointsByPlatformApplication action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "listEndpointsByPlatformApplication",
"authenticated" : true,
"syncReturnType" : "ListEndpointsByPlatformApplicationResult",
"asyncReturnType" : "ListEndpointsByPlatformApplicationResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"ListPhoneNumbersOptedOut" : {
"documentation" : "Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.
",
"operationName" : "ListPhoneNumbersOptedOut",
"deprecated" : false,
"input" : {
"variableName" : "listPhoneNumbersOptedOutRequest",
"variableType" : "ListPhoneNumbersOptedOutRequest",
"variableDeclarationType" : "ListPhoneNumbersOptedOutRequest",
"documentation" : "The input for the ListPhoneNumbersOptedOut action.
",
"simpleType" : "ListPhoneNumbersOptedOutRequest",
"variableSetterType" : "ListPhoneNumbersOptedOutRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ListPhoneNumbersOptedOutResult",
"documentation" : "The response from the ListPhoneNumbersOptedOut action.
"
},
"exceptions" : [ {
"exceptionName" : "ThrottledException",
"documentation" : "Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "listPhoneNumbersOptedOut",
"authenticated" : true,
"syncReturnType" : "ListPhoneNumbersOptedOutResult",
"asyncReturnType" : "ListPhoneNumbersOptedOutResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"ListPlatformApplications" : {
"documentation" : "Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
",
"operationName" : "ListPlatformApplications",
"deprecated" : false,
"input" : {
"variableName" : "listPlatformApplicationsRequest",
"variableType" : "ListPlatformApplicationsRequest",
"variableDeclarationType" : "ListPlatformApplicationsRequest",
"documentation" : "Input for ListPlatformApplications action.
",
"simpleType" : "ListPlatformApplicationsRequest",
"variableSetterType" : "ListPlatformApplicationsRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ListPlatformApplicationsResult",
"documentation" : "Response for ListPlatformApplications action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "listPlatformApplications",
"authenticated" : true,
"syncReturnType" : "ListPlatformApplicationsResult",
"asyncReturnType" : "ListPlatformApplicationsResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"ListSubscriptions" : {
"documentation" : "Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
",
"operationName" : "ListSubscriptions",
"deprecated" : false,
"input" : {
"variableName" : "listSubscriptionsRequest",
"variableType" : "ListSubscriptionsRequest",
"variableDeclarationType" : "ListSubscriptionsRequest",
"documentation" : "Input for ListSubscriptions action.
",
"simpleType" : "ListSubscriptionsRequest",
"variableSetterType" : "ListSubscriptionsRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ListSubscriptionsResult",
"documentation" : "Response for ListSubscriptions action
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "listSubscriptions",
"authenticated" : true,
"syncReturnType" : "ListSubscriptionsResult",
"asyncReturnType" : "ListSubscriptionsResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"ListSubscriptionsByTopic" : {
"documentation" : "Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
",
"operationName" : "ListSubscriptionsByTopic",
"deprecated" : false,
"input" : {
"variableName" : "listSubscriptionsByTopicRequest",
"variableType" : "ListSubscriptionsByTopicRequest",
"variableDeclarationType" : "ListSubscriptionsByTopicRequest",
"documentation" : "Input for ListSubscriptionsByTopic action.
",
"simpleType" : "ListSubscriptionsByTopicRequest",
"variableSetterType" : "ListSubscriptionsByTopicRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ListSubscriptionsByTopicResult",
"documentation" : "Response for ListSubscriptionsByTopic action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "listSubscriptionsByTopic",
"authenticated" : true,
"syncReturnType" : "ListSubscriptionsByTopicResult",
"asyncReturnType" : "ListSubscriptionsByTopicResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"ListTopics" : {
"documentation" : "Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
",
"operationName" : "ListTopics",
"deprecated" : false,
"input" : {
"variableName" : "listTopicsRequest",
"variableType" : "ListTopicsRequest",
"variableDeclarationType" : "ListTopicsRequest",
"documentation" : "",
"simpleType" : "ListTopicsRequest",
"variableSetterType" : "ListTopicsRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "ListTopicsResult",
"documentation" : "Response for ListTopics action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "listTopics",
"authenticated" : true,
"syncReturnType" : "ListTopicsResult",
"asyncReturnType" : "ListTopicsResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"OptInPhoneNumber" : {
"documentation" : "Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
",
"operationName" : "OptInPhoneNumber",
"deprecated" : false,
"input" : {
"variableName" : "optInPhoneNumberRequest",
"variableType" : "OptInPhoneNumberRequest",
"variableDeclarationType" : "OptInPhoneNumberRequest",
"documentation" : "Input for the OptInPhoneNumber action.
",
"simpleType" : "OptInPhoneNumberRequest",
"variableSetterType" : "OptInPhoneNumberRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "OptInPhoneNumberResult",
"documentation" : "The response for the OptInPhoneNumber action.
"
},
"exceptions" : [ {
"exceptionName" : "ThrottledException",
"documentation" : "Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "optInPhoneNumber",
"authenticated" : true,
"syncReturnType" : "OptInPhoneNumberResult",
"asyncReturnType" : "OptInPhoneNumberResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"Publish" : {
"documentation" : "Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
",
"operationName" : "Publish",
"deprecated" : false,
"input" : {
"variableName" : "publishRequest",
"variableType" : "PublishRequest",
"variableDeclarationType" : "PublishRequest",
"documentation" : "Input for Publish action.
",
"simpleType" : "PublishRequest",
"variableSetterType" : "PublishRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "PublishResult",
"documentation" : "Response for Publish action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InvalidParameterValueException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "EndpointDisabledException",
"documentation" : "Exception error indicating endpoint disabled.
"
}, {
"exceptionName" : "PlatformApplicationDisabledException",
"documentation" : "Exception error indicating platform application disabled.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "publish",
"authenticated" : true,
"syncReturnType" : "PublishResult",
"asyncReturnType" : "PublishResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"RemovePermission" : {
"documentation" : "Removes a statement from a topic's access control policy.
",
"operationName" : "RemovePermission",
"deprecated" : false,
"input" : {
"variableName" : "removePermissionRequest",
"variableType" : "RemovePermissionRequest",
"variableDeclarationType" : "RemovePermissionRequest",
"documentation" : "Input for RemovePermission action.
",
"simpleType" : "RemovePermissionRequest",
"variableSetterType" : "RemovePermissionRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "RemovePermissionResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "removePermission",
"authenticated" : true,
"syncReturnType" : "RemovePermissionResult",
"asyncReturnType" : "RemovePermissionResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"SetEndpointAttributes" : {
"documentation" : "Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
",
"operationName" : "SetEndpointAttributes",
"deprecated" : false,
"input" : {
"variableName" : "setEndpointAttributesRequest",
"variableType" : "SetEndpointAttributesRequest",
"variableDeclarationType" : "SetEndpointAttributesRequest",
"documentation" : "Input for SetEndpointAttributes action.
",
"simpleType" : "SetEndpointAttributesRequest",
"variableSetterType" : "SetEndpointAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "SetEndpointAttributesResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "setEndpointAttributes",
"authenticated" : true,
"syncReturnType" : "SetEndpointAttributesResult",
"asyncReturnType" : "SetEndpointAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"SetPlatformApplicationAttributes" : {
"documentation" : "Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
",
"operationName" : "SetPlatformApplicationAttributes",
"deprecated" : false,
"input" : {
"variableName" : "setPlatformApplicationAttributesRequest",
"variableType" : "SetPlatformApplicationAttributesRequest",
"variableDeclarationType" : "SetPlatformApplicationAttributesRequest",
"documentation" : "Input for SetPlatformApplicationAttributes action.
",
"simpleType" : "SetPlatformApplicationAttributesRequest",
"variableSetterType" : "SetPlatformApplicationAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "SetPlatformApplicationAttributesResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "setPlatformApplicationAttributes",
"authenticated" : true,
"syncReturnType" : "SetPlatformApplicationAttributesResult",
"asyncReturnType" : "SetPlatformApplicationAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"SetSMSAttributes" : {
"documentation" : "Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide.
",
"operationName" : "SetSMSAttributes",
"deprecated" : false,
"input" : {
"variableName" : "setSMSAttributesRequest",
"variableType" : "SetSMSAttributesRequest",
"variableDeclarationType" : "SetSMSAttributesRequest",
"documentation" : "The input for the SetSMSAttributes action.
",
"simpleType" : "SetSMSAttributesRequest",
"variableSetterType" : "SetSMSAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "SetSMSAttributesResult",
"documentation" : "The response for the SetSMSAttributes action.
"
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "ThrottledException",
"documentation" : "Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "setSMSAttributes",
"authenticated" : true,
"syncReturnType" : "SetSMSAttributesResult",
"asyncReturnType" : "SetSMSAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"SetSubscriptionAttributes" : {
"documentation" : "Allows a subscription owner to set an attribute of the topic to a new value.
",
"operationName" : "SetSubscriptionAttributes",
"deprecated" : false,
"input" : {
"variableName" : "setSubscriptionAttributesRequest",
"variableType" : "SetSubscriptionAttributesRequest",
"variableDeclarationType" : "SetSubscriptionAttributesRequest",
"documentation" : "Input for SetSubscriptionAttributes action.
",
"simpleType" : "SetSubscriptionAttributesRequest",
"variableSetterType" : "SetSubscriptionAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "SetSubscriptionAttributesResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "setSubscriptionAttributes",
"authenticated" : true,
"syncReturnType" : "SetSubscriptionAttributesResult",
"asyncReturnType" : "SetSubscriptionAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"SetTopicAttributes" : {
"documentation" : "Allows a topic owner to set an attribute of the topic to a new value.
",
"operationName" : "SetTopicAttributes",
"deprecated" : false,
"input" : {
"variableName" : "setTopicAttributesRequest",
"variableType" : "SetTopicAttributesRequest",
"variableDeclarationType" : "SetTopicAttributesRequest",
"documentation" : "Input for SetTopicAttributes action.
",
"simpleType" : "SetTopicAttributesRequest",
"variableSetterType" : "SetTopicAttributesRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "SetTopicAttributesResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "setTopicAttributes",
"authenticated" : true,
"syncReturnType" : "SetTopicAttributesResult",
"asyncReturnType" : "SetTopicAttributesResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"Subscribe" : {
"documentation" : "Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
",
"operationName" : "Subscribe",
"deprecated" : false,
"input" : {
"variableName" : "subscribeRequest",
"variableType" : "SubscribeRequest",
"variableDeclarationType" : "SubscribeRequest",
"documentation" : "Input for Subscribe action.
",
"simpleType" : "SubscribeRequest",
"variableSetterType" : "SubscribeRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "SubscribeResult",
"documentation" : "Response for Subscribe action.
"
},
"exceptions" : [ {
"exceptionName" : "SubscriptionLimitExceededException",
"documentation" : "Indicates that the customer already owns the maximum allowed number of subscriptions.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "subscribe",
"authenticated" : true,
"syncReturnType" : "SubscribeResult",
"asyncReturnType" : "SubscribeResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
},
"Unsubscribe" : {
"documentation" : "Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
",
"operationName" : "Unsubscribe",
"deprecated" : false,
"input" : {
"variableName" : "unsubscribeRequest",
"variableType" : "UnsubscribeRequest",
"variableDeclarationType" : "UnsubscribeRequest",
"documentation" : "Input for Unsubscribe action.
",
"simpleType" : "UnsubscribeRequest",
"variableSetterType" : "UnsubscribeRequest"
},
"inputStreamPropertyName" : null,
"returnType" : {
"returnType" : "UnsubscribeResult",
"documentation" : null
},
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "Indicates an internal service error.
"
}, {
"exceptionName" : "AuthorizationErrorException",
"documentation" : "Indicates that the user has been denied access to the requested resource.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "Indicates that the requested resource does not exist.
"
} ],
"hasBlobMemberAsPayload" : false,
"methodName" : "unsubscribe",
"authenticated" : true,
"syncReturnType" : "UnsubscribeResult",
"asyncReturnType" : "UnsubscribeResult",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler"
}
},
"shapes" : {
"SubscriptionLimitExceededException" : {
"c2jName" : "SubscriptionLimitExceededException",
"documentation" : "Indicates that the customer already owns the maximum allowed number of subscriptions.
",
"shapeName" : "SubscriptionLimitExceededException",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ ],
"enums" : null,
"variable" : {
"variableName" : "subscriptionLimitExceededException",
"variableType" : "SubscriptionLimitExceededException",
"variableDeclarationType" : "SubscriptionLimitExceededException",
"documentation" : null,
"simpleType" : "SubscriptionLimitExceededException",
"variableSetterType" : "SubscriptionLimitExceededException"
},
"marshaller" : null,
"unmarshaller" : null,
"errorCode" : "SubscriptionLimitExceeded",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : { }
},
"GetSMSAttributesResult" : {
"c2jName" : "GetSMSAttributesResponse",
"documentation" : "The response from the GetSMSAttributes request.
",
"shapeName" : "GetSMSAttributesResult",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The SMS attribute names and their values.
",
"name" : "Attributes",
"c2jName" : "attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "The SMS attribute names and their values.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "attributes",
"marshallLocationName" : "attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**The SMS attribute names and their values.
\n@param attributes The SMS attribute names and their values.*/",
"getterDocumentation" : "/**The SMS attribute names and their values.
\n@return The SMS attribute names and their values.*/",
"fluentSetterDocumentation" : "/**The SMS attribute names and their values.
\n@param attributes The SMS attribute names and their values.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The SMS attribute names and their values.
\n@param attributes The SMS attribute names and their values.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "getSMSAttributesResult",
"variableType" : "GetSMSAttributesResult",
"variableDeclarationType" : "GetSMSAttributesResult",
"documentation" : null,
"simpleType" : "GetSMSAttributesResult",
"variableSetterType" : "GetSMSAttributesResult"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : "GetSMSAttributesResult",
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"Attributes" : {
"documentation" : "The SMS attribute names and their values.
",
"name" : "Attributes",
"c2jName" : "attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "The SMS attribute names and their values.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "attributes",
"marshallLocationName" : "attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**The SMS attribute names and their values.
\n@param attributes The SMS attribute names and their values.*/",
"getterDocumentation" : "/**The SMS attribute names and their values.
\n@return The SMS attribute names and their values.*/",
"fluentSetterDocumentation" : "/**The SMS attribute names and their values.
\n@param attributes The SMS attribute names and their values.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The SMS attribute names and their values.
\n@param attributes The SMS attribute names and their values.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"ListTopicsRequest" : {
"c2jName" : "ListTopicsInput",
"documentation" : "",
"shapeName" : "ListTopicsRequest",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "Token returned by the previous ListTopics request.
",
"name" : "NextToken",
"c2jName" : "NextToken",
"c2jShape" : "nextToken",
"variable" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Token returned by the previous ListTopics request.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NextToken",
"marshallLocationName" : "NextToken",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@param nextToken Token returned by the previous ListTopics request.*/",
"getterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@return Token returned by the previous ListTopics request.*/",
"fluentSetterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@param nextToken Token returned by the previous ListTopics request.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@param nextToken Token returned by the previous ListTopics request.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "listTopicsRequest",
"variableType" : "ListTopicsRequest",
"variableDeclarationType" : "ListTopicsRequest",
"documentation" : null,
"simpleType" : "ListTopicsRequest",
"variableSetterType" : "ListTopicsRequest"
},
"marshaller" : {
"action" : "ListTopics",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"NextToken" : {
"documentation" : "Token returned by the previous ListTopics request.
",
"name" : "NextToken",
"c2jName" : "NextToken",
"c2jShape" : "nextToken",
"variable" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Token returned by the previous ListTopics request.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NextToken",
"marshallLocationName" : "NextToken",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@param nextToken Token returned by the previous ListTopics request.*/",
"getterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@return Token returned by the previous ListTopics request.*/",
"fluentSetterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@param nextToken Token returned by the previous ListTopics request.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Token returned by the previous ListTopics request.
\n@param nextToken Token returned by the previous ListTopics request.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"CreatePlatformEndpointRequest" : {
"c2jName" : "CreatePlatformEndpointInput",
"documentation" : "Input for CreatePlatformEndpoint action.
",
"shapeName" : "CreatePlatformEndpointRequest",
"deprecated" : false,
"required" : [ "PlatformApplicationArn", "Token" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
",
"name" : "PlatformApplicationArn",
"c2jName" : "PlatformApplicationArn",
"c2jShape" : "String",
"variable" : {
"variableName" : "platformApplicationArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "platformApplicationArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "PlatformApplicationArn",
"marshallLocationName" : "PlatformApplicationArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@param platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.*/",
"getterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@return PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.*/",
"fluentSetterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@param platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@param platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
",
"name" : "Token",
"c2jName" : "Token",
"c2jShape" : "String",
"variable" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Token",
"marshallLocationName" : "Token",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@param token Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.*/",
"getterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@return Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.*/",
"fluentSetterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@param token Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@param token Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "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.
",
"name" : "CustomUserData",
"c2jName" : "CustomUserData",
"c2jShape" : "String",
"variable" : {
"variableName" : "customUserData",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "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.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "customUserData",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "CustomUserData",
"marshallLocationName" : "CustomUserData",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**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.
\n@param customUserData Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.*/",
"getterDocumentation" : "/**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.
\n@return 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.*/",
"fluentSetterDocumentation" : "/**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.
\n@param customUserData Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**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.
\n@param customUserData Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "For a list of attributes, see SetEndpointAttributes.
",
"name" : "Attributes",
"c2jName" : "Attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "For a list of attributes, see SetEndpointAttributes.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Attributes",
"marshallLocationName" : "Attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@param attributes For a list of attributes, see SetEndpointAttributes.*/",
"getterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@return For a list of attributes, see SetEndpointAttributes.*/",
"fluentSetterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@param attributes For a list of attributes, see SetEndpointAttributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@param attributes For a list of attributes, see SetEndpointAttributes.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "createPlatformEndpointRequest",
"variableType" : "CreatePlatformEndpointRequest",
"variableDeclarationType" : "CreatePlatformEndpointRequest",
"documentation" : null,
"simpleType" : "CreatePlatformEndpointRequest",
"variableSetterType" : "CreatePlatformEndpointRequest"
},
"marshaller" : {
"action" : "CreatePlatformEndpoint",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"Attributes" : {
"documentation" : "For a list of attributes, see SetEndpointAttributes.
",
"name" : "Attributes",
"c2jName" : "Attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "For a list of attributes, see SetEndpointAttributes.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Attributes",
"marshallLocationName" : "Attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@param attributes For a list of attributes, see SetEndpointAttributes.*/",
"getterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@return For a list of attributes, see SetEndpointAttributes.*/",
"fluentSetterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@param attributes For a list of attributes, see SetEndpointAttributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**For a list of attributes, see SetEndpointAttributes.
\n@param attributes For a list of attributes, see SetEndpointAttributes.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"Token" : {
"documentation" : "Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
",
"name" : "Token",
"c2jName" : "Token",
"c2jShape" : "String",
"variable" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Token",
"marshallLocationName" : "Token",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@param token Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.*/",
"getterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@return Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.*/",
"fluentSetterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@param token Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
\n@param token Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"PlatformApplicationArn" : {
"documentation" : "PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
",
"name" : "PlatformApplicationArn",
"c2jName" : "PlatformApplicationArn",
"c2jShape" : "String",
"variable" : {
"variableName" : "platformApplicationArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "platformApplicationArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "PlatformApplicationArn",
"marshallLocationName" : "PlatformApplicationArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@param platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.*/",
"getterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@return PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.*/",
"fluentSetterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@param platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
\n@param platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"CustomUserData" : {
"documentation" : "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.
",
"name" : "CustomUserData",
"c2jName" : "CustomUserData",
"c2jShape" : "String",
"variable" : {
"variableName" : "customUserData",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "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.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "customUserData",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "CustomUserData",
"marshallLocationName" : "CustomUserData",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**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.
\n@param customUserData Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.*/",
"getterDocumentation" : "/**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.
\n@return 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.*/",
"fluentSetterDocumentation" : "/**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.
\n@param customUserData Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**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.
\n@param customUserData Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"SetSMSAttributesRequest" : {
"c2jName" : "SetSMSAttributesInput",
"documentation" : "The input for the SetSMSAttributes action.
",
"shapeName" : "SetSMSAttributesRequest",
"deprecated" : false,
"required" : [ "attributes" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
",
"name" : "Attributes",
"c2jName" : "attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "attributes",
"marshallLocationName" : "attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@param attributes The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.*/",
"getterDocumentation" : "/**
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@return The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.*/",
"fluentSetterDocumentation" : "/**
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@param attributes The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@param attributes The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "setSMSAttributesRequest",
"variableType" : "SetSMSAttributesRequest",
"variableDeclarationType" : "SetSMSAttributesRequest",
"documentation" : null,
"simpleType" : "SetSMSAttributesRequest",
"variableSetterType" : "SetSMSAttributesRequest"
},
"marshaller" : {
"action" : "SetSMSAttributes",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"Attributes" : {
"documentation" : "
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
",
"name" : "Attributes",
"c2jName" : "attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "attributes",
"marshallLocationName" : "attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@param attributes The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.*/",
"getterDocumentation" : "/**
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@return The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.*/",
"fluentSetterDocumentation" : "/**
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@param attributes The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
\n@param attributes The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
-
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
-
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
-
Time that the message was published (in UTC)
-
Message ID
-
Destination phone number
-
Message type
-
Delivery status
-
Message price (in USD)
-
Part number (a message is split into multiple parts if it is too long for a single message)
-
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"SubscribeResult" : {
"c2jName" : "SubscribeResponse",
"documentation" : "
Response for Subscribe action.
",
"shapeName" : "SubscribeResult",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
",
"name" : "SubscriptionArn",
"c2jName" : "SubscriptionArn",
"c2jShape" : "subscriptionARN",
"variable" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SubscriptionArn",
"marshallLocationName" : "SubscriptionArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@param subscriptionArn The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).*/",
"getterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@return The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).*/",
"fluentSetterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@param subscriptionArn The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@param subscriptionArn The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "subscribeResult",
"variableType" : "SubscribeResult",
"variableDeclarationType" : "SubscribeResult",
"documentation" : null,
"simpleType" : "SubscribeResult",
"variableSetterType" : "SubscribeResult"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : "SubscribeResult",
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"SubscriptionArn" : {
"documentation" : "The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
",
"name" : "SubscriptionArn",
"c2jName" : "SubscriptionArn",
"c2jShape" : "subscriptionARN",
"variable" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SubscriptionArn",
"marshallLocationName" : "SubscriptionArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@param subscriptionArn The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).*/",
"getterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@return The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).*/",
"fluentSetterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@param subscriptionArn The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
\n@param subscriptionArn The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"InvalidParameterException" : {
"c2jName" : "InvalidParameterException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
",
"shapeName" : "InvalidParameterException",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ ],
"enums" : null,
"variable" : {
"variableName" : "invalidParameterException",
"variableType" : "InvalidParameterException",
"variableDeclarationType" : "InvalidParameterException",
"documentation" : null,
"simpleType" : "InvalidParameterException",
"variableSetterType" : "InvalidParameterException"
},
"marshaller" : null,
"unmarshaller" : null,
"errorCode" : "InvalidParameter",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : { }
},
"ConfirmSubscriptionRequest" : {
"c2jName" : "ConfirmSubscriptionInput",
"documentation" : "Input for ConfirmSubscription action.
",
"shapeName" : "ConfirmSubscriptionRequest",
"deprecated" : false,
"required" : [ "TopicArn", "Token" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The ARN of the topic for which you wish to confirm a subscription.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic for which you wish to confirm a subscription.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@param topicArn The ARN of the topic for which you wish to confirm a subscription.*/",
"getterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@return The ARN of the topic for which you wish to confirm a subscription.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@param topicArn The ARN of the topic for which you wish to confirm a subscription.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@param topicArn The ARN of the topic for which you wish to confirm a subscription.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "Short-lived token sent to an endpoint during the Subscribe action.
",
"name" : "Token",
"c2jName" : "Token",
"c2jShape" : "token",
"variable" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Short-lived token sent to an endpoint during the Subscribe action.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Token",
"marshallLocationName" : "Token",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@param token Short-lived token sent to an endpoint during the Subscribe action.*/",
"getterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@return Short-lived token sent to an endpoint during the Subscribe action.*/",
"fluentSetterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@param token Short-lived token sent to an endpoint during the Subscribe action.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@param token Short-lived token sent to an endpoint during the Subscribe action.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
",
"name" : "AuthenticateOnUnsubscribe",
"c2jName" : "AuthenticateOnUnsubscribe",
"c2jShape" : "authenticateOnUnsubscribe",
"variable" : {
"variableName" : "authenticateOnUnsubscribe",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "authenticateOnUnsubscribe",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AuthenticateOnUnsubscribe",
"marshallLocationName" : "AuthenticateOnUnsubscribe",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@param authenticateOnUnsubscribe Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.*/",
"getterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@return Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.*/",
"fluentSetterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@param authenticateOnUnsubscribe Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@param authenticateOnUnsubscribe Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "confirmSubscriptionRequest",
"variableType" : "ConfirmSubscriptionRequest",
"variableDeclarationType" : "ConfirmSubscriptionRequest",
"documentation" : null,
"simpleType" : "ConfirmSubscriptionRequest",
"variableSetterType" : "ConfirmSubscriptionRequest"
},
"marshaller" : {
"action" : "ConfirmSubscription",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"TopicArn" : {
"documentation" : "The ARN of the topic for which you wish to confirm a subscription.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic for which you wish to confirm a subscription.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@param topicArn The ARN of the topic for which you wish to confirm a subscription.*/",
"getterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@return The ARN of the topic for which you wish to confirm a subscription.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@param topicArn The ARN of the topic for which you wish to confirm a subscription.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic for which you wish to confirm a subscription.
\n@param topicArn The ARN of the topic for which you wish to confirm a subscription.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"AuthenticateOnUnsubscribe" : {
"documentation" : "Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
",
"name" : "AuthenticateOnUnsubscribe",
"c2jName" : "AuthenticateOnUnsubscribe",
"c2jShape" : "authenticateOnUnsubscribe",
"variable" : {
"variableName" : "authenticateOnUnsubscribe",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "authenticateOnUnsubscribe",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AuthenticateOnUnsubscribe",
"marshallLocationName" : "AuthenticateOnUnsubscribe",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@param authenticateOnUnsubscribe Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.*/",
"getterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@return Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.*/",
"fluentSetterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@param authenticateOnUnsubscribe Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
\n@param authenticateOnUnsubscribe Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"Token" : {
"documentation" : "Short-lived token sent to an endpoint during the Subscribe action.
",
"name" : "Token",
"c2jName" : "Token",
"c2jShape" : "token",
"variable" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Short-lived token sent to an endpoint during the Subscribe action.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "token",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Token",
"marshallLocationName" : "Token",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@param token Short-lived token sent to an endpoint during the Subscribe action.*/",
"getterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@return Short-lived token sent to an endpoint during the Subscribe action.*/",
"fluentSetterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@param token Short-lived token sent to an endpoint during the Subscribe action.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Short-lived token sent to an endpoint during the Subscribe action.
\n@param token Short-lived token sent to an endpoint during the Subscribe action.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"CreateTopicResult" : {
"c2jName" : "CreateTopicResponse",
"documentation" : "Response from CreateTopic action.
",
"shapeName" : "CreateTopicResult",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The Amazon Resource Name (ARN) assigned to the created topic.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The Amazon Resource Name (ARN) assigned to the created topic.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@param topicArn The Amazon Resource Name (ARN) assigned to the created topic.*/",
"getterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@return The Amazon Resource Name (ARN) assigned to the created topic.*/",
"fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@param topicArn The Amazon Resource Name (ARN) assigned to the created topic.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@param topicArn The Amazon Resource Name (ARN) assigned to the created topic.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "createTopicResult",
"variableType" : "CreateTopicResult",
"variableDeclarationType" : "CreateTopicResult",
"documentation" : null,
"simpleType" : "CreateTopicResult",
"variableSetterType" : "CreateTopicResult"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : "CreateTopicResult",
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"TopicArn" : {
"documentation" : "The Amazon Resource Name (ARN) assigned to the created topic.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The Amazon Resource Name (ARN) assigned to the created topic.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@param topicArn The Amazon Resource Name (ARN) assigned to the created topic.*/",
"getterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@return The Amazon Resource Name (ARN) assigned to the created topic.*/",
"fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@param topicArn The Amazon Resource Name (ARN) assigned to the created topic.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) assigned to the created topic.
\n@param topicArn The Amazon Resource Name (ARN) assigned to the created topic.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"Endpoint" : {
"c2jName" : "Endpoint",
"documentation" : "Endpoint for mobile app and device.
",
"shapeName" : "Endpoint",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "EndpointArn for mobile app and device.
",
"name" : "EndpointArn",
"c2jName" : "EndpointArn",
"c2jShape" : "String",
"variable" : {
"variableName" : "endpointArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "EndpointArn for mobile app and device.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "endpointArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "EndpointArn",
"marshallLocationName" : "EndpointArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**EndpointArn for mobile app and device.
\n@param endpointArn EndpointArn for mobile app and device.*/",
"getterDocumentation" : "/**EndpointArn for mobile app and device.
\n@return EndpointArn for mobile app and device.*/",
"fluentSetterDocumentation" : "/**EndpointArn for mobile app and device.
\n@param endpointArn EndpointArn for mobile app and device.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**EndpointArn for mobile app and device.
\n@param endpointArn EndpointArn for mobile app and device.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "Attributes for endpoint.
",
"name" : "Attributes",
"c2jName" : "Attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "Attributes for endpoint.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Attributes",
"marshallLocationName" : "Attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**Attributes for endpoint.
\n@param attributes Attributes for endpoint.*/",
"getterDocumentation" : "/**Attributes for endpoint.
\n@return Attributes for endpoint.*/",
"fluentSetterDocumentation" : "/**Attributes for endpoint.
\n@param attributes Attributes for endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Attributes for endpoint.
\n@param attributes Attributes for endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "endpoint",
"variableType" : "Endpoint",
"variableDeclarationType" : "Endpoint",
"documentation" : null,
"simpleType" : "Endpoint",
"variableSetterType" : "Endpoint"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : null,
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"Attributes" : {
"documentation" : "Attributes for endpoint.
",
"name" : "Attributes",
"c2jName" : "Attributes",
"c2jShape" : "MapStringToString",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "Attributes for endpoint.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Attributes",
"marshallLocationName" : "Attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "String",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**Attributes for endpoint.
\n@param attributes Attributes for endpoint.*/",
"getterDocumentation" : "/**Attributes for endpoint.
\n@return Attributes for endpoint.*/",
"fluentSetterDocumentation" : "/**Attributes for endpoint.
\n@param attributes Attributes for endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Attributes for endpoint.
\n@param attributes Attributes for endpoint.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"EndpointArn" : {
"documentation" : "EndpointArn for mobile app and device.
",
"name" : "EndpointArn",
"c2jName" : "EndpointArn",
"c2jShape" : "String",
"variable" : {
"variableName" : "endpointArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "EndpointArn for mobile app and device.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "endpointArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "EndpointArn",
"marshallLocationName" : "EndpointArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**EndpointArn for mobile app and device.
\n@param endpointArn EndpointArn for mobile app and device.*/",
"getterDocumentation" : "/**EndpointArn for mobile app and device.
\n@return EndpointArn for mobile app and device.*/",
"fluentSetterDocumentation" : "/**EndpointArn for mobile app and device.
\n@param endpointArn EndpointArn for mobile app and device.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**EndpointArn for mobile app and device.
\n@param endpointArn EndpointArn for mobile app and device.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"InvalidParameterValueException" : {
"c2jName" : "InvalidParameterValueException",
"documentation" : "Indicates that a request parameter does not comply with the associated constraints.
",
"shapeName" : "InvalidParameterValueException",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ ],
"enums" : null,
"variable" : {
"variableName" : "invalidParameterValueException",
"variableType" : "InvalidParameterValueException",
"variableDeclarationType" : "InvalidParameterValueException",
"documentation" : null,
"simpleType" : "InvalidParameterValueException",
"variableSetterType" : "InvalidParameterValueException"
},
"marshaller" : null,
"unmarshaller" : null,
"errorCode" : "ParameterValueInvalid",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : { }
},
"SubscribeRequest" : {
"c2jName" : "SubscribeInput",
"documentation" : "Input for Subscribe action.
",
"shapeName" : "SubscribeRequest",
"deprecated" : false,
"required" : [ "TopicArn", "Protocol" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The ARN of the topic you want to subscribe to.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic you want to subscribe to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@param topicArn The ARN of the topic you want to subscribe to.*/",
"getterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@return The ARN of the topic you want to subscribe to.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@param topicArn The ARN of the topic you want to subscribe to.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@param topicArn The ARN of the topic you want to subscribe to.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
",
"name" : "Protocol",
"c2jName" : "Protocol",
"c2jShape" : "protocol",
"variable" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Protocol",
"marshallLocationName" : "Protocol",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@param protocol The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
*/",
"getterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@return The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
*/",
"fluentSetterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@param protocol The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@param protocol The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
",
"name" : "Endpoint",
"c2jName" : "Endpoint",
"c2jShape" : "endpoint",
"variable" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Endpoint",
"marshallLocationName" : "Endpoint",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@param endpoint The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
*/",
"getterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@return The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
*/",
"fluentSetterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@param endpoint The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@param endpoint The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "subscribeRequest",
"variableType" : "SubscribeRequest",
"variableDeclarationType" : "SubscribeRequest",
"documentation" : null,
"simpleType" : "SubscribeRequest",
"variableSetterType" : "SubscribeRequest"
},
"marshaller" : {
"action" : "Subscribe",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"TopicArn" : {
"documentation" : "The ARN of the topic you want to subscribe to.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic you want to subscribe to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@param topicArn The ARN of the topic you want to subscribe to.*/",
"getterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@return The ARN of the topic you want to subscribe to.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@param topicArn The ARN of the topic you want to subscribe to.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic you want to subscribe to.
\n@param topicArn The ARN of the topic you want to subscribe to.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"Endpoint" : {
"documentation" : "The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
",
"name" : "Endpoint",
"c2jName" : "Endpoint",
"c2jShape" : "endpoint",
"variable" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Endpoint",
"marshallLocationName" : "Endpoint",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@param endpoint The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
*/",
"getterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@return The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
*/",
"fluentSetterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@param endpoint The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The endpoint that you want to receive notifications. Endpoints vary by protocol:
-
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@param endpoint The endpoint that you want to receive notifications. Endpoints vary by protocol: -
For the http protocol, the endpoint is an URL beginning with \"http://\"
-
For the https protocol, the endpoint is a URL beginning with \"https://\"
-
For the email protocol, the endpoint is an email address
-
For the email-json protocol, the endpoint is an email address
-
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
-
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
-
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
-
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"Protocol" : {
"documentation" : "The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
",
"name" : "Protocol",
"c2jName" : "Protocol",
"c2jShape" : "protocol",
"variable" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Protocol",
"marshallLocationName" : "Protocol",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@param protocol The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
*/",
"getterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@return The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
*/",
"fluentSetterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@param protocol The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The protocol you want to use. Supported protocols include:
-
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@param protocol The protocol you want to use. Supported protocols include: -
http -- delivery of JSON-encoded message via HTTP POST
-
https -- delivery of JSON-encoded message via HTTPS POST
-
email -- delivery of message via SMTP
-
email-json -- delivery of JSON-encoded message via SMTP
-
sms -- delivery of message via SMS
-
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
-
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
-
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"EndpointDisabledException" : {
"c2jName" : "EndpointDisabledException",
"documentation" : "Exception error indicating endpoint disabled.
",
"shapeName" : "EndpointDisabledException",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ ],
"enums" : null,
"variable" : {
"variableName" : "endpointDisabledException",
"variableType" : "EndpointDisabledException",
"variableDeclarationType" : "EndpointDisabledException",
"documentation" : null,
"simpleType" : "EndpointDisabledException",
"variableSetterType" : "EndpointDisabledException"
},
"marshaller" : null,
"unmarshaller" : null,
"errorCode" : "EndpointDisabled",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : { }
},
"SetSubscriptionAttributesRequest" : {
"c2jName" : "SetSubscriptionAttributesInput",
"documentation" : "Input for SetSubscriptionAttributes action.
",
"shapeName" : "SetSubscriptionAttributesRequest",
"deprecated" : false,
"required" : [ "SubscriptionArn", "AttributeName" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The ARN of the subscription to modify.
",
"name" : "SubscriptionArn",
"c2jName" : "SubscriptionArn",
"c2jShape" : "subscriptionARN",
"variable" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the subscription to modify.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SubscriptionArn",
"marshallLocationName" : "SubscriptionArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the subscription to modify.
\n@param subscriptionArn The ARN of the subscription to modify.*/",
"getterDocumentation" : "/**The ARN of the subscription to modify.
\n@return The ARN of the subscription to modify.*/",
"fluentSetterDocumentation" : "/**The ARN of the subscription to modify.
\n@param subscriptionArn The ARN of the subscription to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the subscription to modify.
\n@param subscriptionArn The ARN of the subscription to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
",
"name" : "AttributeName",
"c2jName" : "AttributeName",
"c2jShape" : "attributeName",
"variable" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeName",
"marshallLocationName" : "AttributeName",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@param attributeName The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery*/",
"getterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@return The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery*/",
"fluentSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@param attributeName The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@param attributeName The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "
The new value for the attribute in JSON format.
",
"name" : "AttributeValue",
"c2jName" : "AttributeValue",
"c2jShape" : "attributeValue",
"variable" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The new value for the attribute in JSON format.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeValue",
"marshallLocationName" : "AttributeValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The new value for the attribute in JSON format.
\n@param attributeValue The new value for the attribute in JSON format.*/",
"getterDocumentation" : "/**The new value for the attribute in JSON format.
\n@return The new value for the attribute in JSON format.*/",
"fluentSetterDocumentation" : "/**The new value for the attribute in JSON format.
\n@param attributeValue The new value for the attribute in JSON format.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The new value for the attribute in JSON format.
\n@param attributeValue The new value for the attribute in JSON format.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "setSubscriptionAttributesRequest",
"variableType" : "SetSubscriptionAttributesRequest",
"variableDeclarationType" : "SetSubscriptionAttributesRequest",
"documentation" : null,
"simpleType" : "SetSubscriptionAttributesRequest",
"variableSetterType" : "SetSubscriptionAttributesRequest"
},
"marshaller" : {
"action" : "SetSubscriptionAttributes",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"AttributeValue" : {
"documentation" : "The new value for the attribute in JSON format.
",
"name" : "AttributeValue",
"c2jName" : "AttributeValue",
"c2jShape" : "attributeValue",
"variable" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The new value for the attribute in JSON format.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeValue",
"marshallLocationName" : "AttributeValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The new value for the attribute in JSON format.
\n@param attributeValue The new value for the attribute in JSON format.*/",
"getterDocumentation" : "/**The new value for the attribute in JSON format.
\n@return The new value for the attribute in JSON format.*/",
"fluentSetterDocumentation" : "/**The new value for the attribute in JSON format.
\n@param attributeValue The new value for the attribute in JSON format.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The new value for the attribute in JSON format.
\n@param attributeValue The new value for the attribute in JSON format.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"AttributeName" : {
"documentation" : "The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
",
"name" : "AttributeName",
"c2jName" : "AttributeName",
"c2jShape" : "attributeName",
"variable" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeName",
"marshallLocationName" : "AttributeName",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@param attributeName The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery*/",
"getterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@return The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery*/",
"fluentSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@param attributeName The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
\n@param attributeName The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"SubscriptionArn" : {
"documentation" : "
The ARN of the subscription to modify.
",
"name" : "SubscriptionArn",
"c2jName" : "SubscriptionArn",
"c2jShape" : "subscriptionARN",
"variable" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the subscription to modify.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SubscriptionArn",
"marshallLocationName" : "SubscriptionArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the subscription to modify.
\n@param subscriptionArn The ARN of the subscription to modify.*/",
"getterDocumentation" : "/**The ARN of the subscription to modify.
\n@return The ARN of the subscription to modify.*/",
"fluentSetterDocumentation" : "/**The ARN of the subscription to modify.
\n@param subscriptionArn The ARN of the subscription to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the subscription to modify.
\n@param subscriptionArn The ARN of the subscription to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"CheckIfPhoneNumberIsOptedOutResult" : {
"c2jName" : "CheckIfPhoneNumberIsOptedOutResponse",
"documentation" : "The response from the CheckIfPhoneNumberIsOptedOut action.
",
"shapeName" : "CheckIfPhoneNumberIsOptedOutResult",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
",
"name" : "IsOptedOut",
"c2jName" : "isOptedOut",
"c2jShape" : "boolean",
"variable" : {
"variableName" : "isOptedOut",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"setterModel" : {
"variableName" : "isOptedOut",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "isOptedOut",
"marshallLocationName" : "isOptedOut",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@param isOptedOut Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@return Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@param isOptedOut Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@param isOptedOut Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
",
"name" : "IsOptedOut",
"c2jName" : "isOptedOut",
"c2jShape" : "boolean",
"variable" : {
"variableName" : "isOptedOut",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"setterModel" : {
"variableName" : "isOptedOut",
"variableType" : "Boolean",
"variableDeclarationType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "isOptedOut",
"marshallLocationName" : "isOptedOut",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@param isOptedOut Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@return Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@param isOptedOut Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
\n@param isOptedOut Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
Response for ListTopics action.
",
"shapeName" : "ListTopicsResult",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "A list of topic ARNs.
",
"name" : "Topics",
"c2jName" : "Topics",
"c2jShape" : "TopicsList",
"variable" : {
"variableName" : "topics",
"variableType" : "java.util.List",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"documentation" : "A list of topic ARNs.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "topics",
"variableType" : "java.util.List",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Topics",
"marshallLocationName" : "Topics",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "Topic",
"memberLocationName" : null,
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "Topic",
"variable" : {
"variableName" : "member",
"variableType" : "Topic",
"variableDeclarationType" : "Topic",
"documentation" : "",
"simpleType" : "Topic",
"variableSetterType" : "Topic"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "Topic",
"variableDeclarationType" : "Topic",
"documentation" : "",
"simpleType" : "Topic",
"variableSetterType" : "Topic"
},
"getterModel" : {
"returnType" : "Topic",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"simple" : false,
"map" : false,
"simpleType" : "Topic",
"templateType" : "java.util.List",
"templateImplType" : "com.amazonaws.internal.SdkInternalList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A list of topic ARNs.
\n@param topics A list of topic ARNs.*/",
"getterDocumentation" : "/**A list of topic ARNs.
\n@return A list of topic ARNs.*/",
"fluentSetterDocumentation" : "/**A list of topic ARNs.
\n@param topics A list of topic ARNs.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A list of topic ARNs.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTopics(java.util.Collection)} or {@link #withTopics(java.util.Collection)} if you want to override the existing values.
\n@param topics A list of topic ARNs.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
",
"name" : "NextToken",
"c2jName" : "NextToken",
"c2jShape" : "nextToken",
"variable" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NextToken",
"marshallLocationName" : "NextToken",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@param nextToken Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.*/",
"getterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@return Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.*/",
"fluentSetterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@param nextToken Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@param nextToken Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "listTopicsResult",
"variableType" : "ListTopicsResult",
"variableDeclarationType" : "ListTopicsResult",
"documentation" : null,
"simpleType" : "ListTopicsResult",
"variableSetterType" : "ListTopicsResult"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : "ListTopicsResult",
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"Topics" : {
"documentation" : "A list of topic ARNs.
",
"name" : "Topics",
"c2jName" : "Topics",
"c2jShape" : "TopicsList",
"variable" : {
"variableName" : "topics",
"variableType" : "java.util.List",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"documentation" : "A list of topic ARNs.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"setterModel" : {
"variableName" : "topics",
"variableType" : "java.util.List",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Topics",
"marshallLocationName" : "Topics",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : {
"memberType" : "Topic",
"memberLocationName" : null,
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"documentation" : "",
"name" : "Member",
"c2jName" : "member",
"c2jShape" : "Topic",
"variable" : {
"variableName" : "member",
"variableType" : "Topic",
"variableDeclarationType" : "Topic",
"documentation" : "",
"simpleType" : "Topic",
"variableSetterType" : "Topic"
},
"setterModel" : {
"variableName" : "member",
"variableType" : "Topic",
"variableDeclarationType" : "Topic",
"documentation" : "",
"simpleType" : "Topic",
"variableSetterType" : "Topic"
},
"getterModel" : {
"returnType" : "Topic",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "member",
"marshallLocationName" : "member",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param member */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"simple" : false,
"map" : false,
"simpleType" : "Topic",
"templateType" : "java.util.List",
"templateImplType" : "com.amazonaws.internal.SdkInternalList"
},
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : true,
"map" : false,
"setterDocumentation" : "/**A list of topic ARNs.
\n@param topics A list of topic ARNs.*/",
"getterDocumentation" : "/**A list of topic ARNs.
\n@return A list of topic ARNs.*/",
"fluentSetterDocumentation" : "/**A list of topic ARNs.
\n@param topics A list of topic ARNs.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**A list of topic ARNs.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTopics(java.util.Collection)} or {@link #withTopics(java.util.Collection)} if you want to override the existing values.
\n@param topics A list of topic ARNs.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"NextToken" : {
"documentation" : "Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
",
"name" : "NextToken",
"c2jName" : "NextToken",
"c2jShape" : "nextToken",
"variable" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "nextToken",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "NextToken",
"marshallLocationName" : "NextToken",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@param nextToken Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.*/",
"getterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@return Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.*/",
"fluentSetterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@param nextToken Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
\n@param nextToken Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"DeleteTopicRequest" : {
"c2jName" : "DeleteTopicInput",
"documentation" : "",
"shapeName" : "DeleteTopicRequest",
"deprecated" : false,
"required" : [ "TopicArn" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The ARN of the topic you want to delete.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic you want to delete.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic you want to delete.
\n@param topicArn The ARN of the topic you want to delete.*/",
"getterDocumentation" : "/**The ARN of the topic you want to delete.
\n@return The ARN of the topic you want to delete.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic you want to delete.
\n@param topicArn The ARN of the topic you want to delete.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic you want to delete.
\n@param topicArn The ARN of the topic you want to delete.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "deleteTopicRequest",
"variableType" : "DeleteTopicRequest",
"variableDeclarationType" : "DeleteTopicRequest",
"documentation" : null,
"simpleType" : "DeleteTopicRequest",
"variableSetterType" : "DeleteTopicRequest"
},
"marshaller" : {
"action" : "DeleteTopic",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"TopicArn" : {
"documentation" : "The ARN of the topic you want to delete.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic you want to delete.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic you want to delete.
\n@param topicArn The ARN of the topic you want to delete.*/",
"getterDocumentation" : "/**The ARN of the topic you want to delete.
\n@return The ARN of the topic you want to delete.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic you want to delete.
\n@param topicArn The ARN of the topic you want to delete.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic you want to delete.
\n@param topicArn The ARN of the topic you want to delete.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"SetTopicAttributesRequest" : {
"c2jName" : "SetTopicAttributesInput",
"documentation" : "Input for SetTopicAttributes action.
",
"shapeName" : "SetTopicAttributesRequest",
"deprecated" : false,
"required" : [ "TopicArn", "AttributeName" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The ARN of the topic to modify.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic to modify.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic to modify.
\n@param topicArn The ARN of the topic to modify.*/",
"getterDocumentation" : "/**The ARN of the topic to modify.
\n@return The ARN of the topic to modify.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic to modify.
\n@param topicArn The ARN of the topic to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic to modify.
\n@param topicArn The ARN of the topic to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
",
"name" : "AttributeName",
"c2jName" : "AttributeName",
"c2jShape" : "attributeName",
"variable" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeName",
"marshallLocationName" : "AttributeName",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@param attributeName The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy*/",
"getterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@return The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy*/",
"fluentSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@param attributeName The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@param attributeName The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "
The new value for the attribute.
",
"name" : "AttributeValue",
"c2jName" : "AttributeValue",
"c2jShape" : "attributeValue",
"variable" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The new value for the attribute.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeValue",
"marshallLocationName" : "AttributeValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The new value for the attribute.
\n@param attributeValue The new value for the attribute.*/",
"getterDocumentation" : "/**The new value for the attribute.
\n@return The new value for the attribute.*/",
"fluentSetterDocumentation" : "/**The new value for the attribute.
\n@param attributeValue The new value for the attribute.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The new value for the attribute.
\n@param attributeValue The new value for the attribute.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "setTopicAttributesRequest",
"variableType" : "SetTopicAttributesRequest",
"variableDeclarationType" : "SetTopicAttributesRequest",
"documentation" : null,
"simpleType" : "SetTopicAttributesRequest",
"variableSetterType" : "SetTopicAttributesRequest"
},
"marshaller" : {
"action" : "SetTopicAttributes",
"verb" : "POST",
"target" : null,
"requestUri" : "/",
"locationName" : null,
"xmlNameSpaceUri" : null
},
"unmarshaller" : null,
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"AttributeValue" : {
"documentation" : "The new value for the attribute.
",
"name" : "AttributeValue",
"c2jName" : "AttributeValue",
"c2jShape" : "attributeValue",
"variable" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The new value for the attribute.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeValue",
"marshallLocationName" : "AttributeValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The new value for the attribute.
\n@param attributeValue The new value for the attribute.*/",
"getterDocumentation" : "/**The new value for the attribute.
\n@return The new value for the attribute.*/",
"fluentSetterDocumentation" : "/**The new value for the attribute.
\n@param attributeValue The new value for the attribute.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The new value for the attribute.
\n@param attributeValue The new value for the attribute.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"TopicArn" : {
"documentation" : "The ARN of the topic to modify.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the topic to modify.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the topic to modify.
\n@param topicArn The ARN of the topic to modify.*/",
"getterDocumentation" : "/**The ARN of the topic to modify.
\n@return The ARN of the topic to modify.*/",
"fluentSetterDocumentation" : "/**The ARN of the topic to modify.
\n@param topicArn The ARN of the topic to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the topic to modify.
\n@param topicArn The ARN of the topic to modify.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"AttributeName" : {
"documentation" : "The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
",
"name" : "AttributeName",
"c2jName" : "AttributeName",
"c2jShape" : "attributeName",
"variable" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "attributeName",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "AttributeName",
"marshallLocationName" : "AttributeName",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@param attributeName The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy*/",
"getterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@return The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy*/",
"fluentSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@param attributeName The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
\n@param attributeName The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"DeleteEndpointResult" : {
"c2jName" : "DeleteEndpointResult",
"documentation" : null,
"shapeName" : "DeleteEndpointResult",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : null,
"enums" : null,
"variable" : {
"variableName" : "deleteEndpointResult",
"variableType" : "DeleteEndpointResult",
"variableDeclarationType" : "DeleteEndpointResult",
"documentation" : null,
"simpleType" : "DeleteEndpointResult",
"variableSetterType" : "DeleteEndpointResult"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : null,
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : { }
},
"Subscription" : {
"c2jName" : "Subscription",
"documentation" : "
A wrapper type for the attributes of an Amazon SNS subscription.
",
"shapeName" : "Subscription",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "The subscription's ARN.
",
"name" : "SubscriptionArn",
"c2jName" : "SubscriptionArn",
"c2jShape" : "subscriptionARN",
"variable" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's ARN.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SubscriptionArn",
"marshallLocationName" : "SubscriptionArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's ARN.
\n@param subscriptionArn The subscription's ARN.*/",
"getterDocumentation" : "/**The subscription's ARN.
\n@return The subscription's ARN.*/",
"fluentSetterDocumentation" : "/**The subscription's ARN.
\n@param subscriptionArn The subscription's ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's ARN.
\n@param subscriptionArn The subscription's ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The subscription's owner.
",
"name" : "Owner",
"c2jName" : "Owner",
"c2jShape" : "account",
"variable" : {
"variableName" : "owner",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's owner.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "owner",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Owner",
"marshallLocationName" : "Owner",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's owner.
\n@param owner The subscription's owner.*/",
"getterDocumentation" : "/**The subscription's owner.
\n@return The subscription's owner.*/",
"fluentSetterDocumentation" : "/**The subscription's owner.
\n@param owner The subscription's owner.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's owner.
\n@param owner The subscription's owner.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The subscription's protocol.
",
"name" : "Protocol",
"c2jName" : "Protocol",
"c2jShape" : "protocol",
"variable" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's protocol.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Protocol",
"marshallLocationName" : "Protocol",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's protocol.
\n@param protocol The subscription's protocol.*/",
"getterDocumentation" : "/**The subscription's protocol.
\n@return The subscription's protocol.*/",
"fluentSetterDocumentation" : "/**The subscription's protocol.
\n@param protocol The subscription's protocol.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's protocol.
\n@param protocol The subscription's protocol.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The subscription's endpoint (format depends on the protocol).
",
"name" : "Endpoint",
"c2jName" : "Endpoint",
"c2jShape" : "endpoint",
"variable" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's endpoint (format depends on the protocol).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Endpoint",
"marshallLocationName" : "Endpoint",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@param endpoint The subscription's endpoint (format depends on the protocol).*/",
"getterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@return The subscription's endpoint (format depends on the protocol).*/",
"fluentSetterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@param endpoint The subscription's endpoint (format depends on the protocol).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@param endpoint The subscription's endpoint (format depends on the protocol).\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "The ARN of the subscription's topic.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the subscription's topic.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the subscription's topic.
\n@param topicArn The ARN of the subscription's topic.*/",
"getterDocumentation" : "/**The ARN of the subscription's topic.
\n@return The ARN of the subscription's topic.*/",
"fluentSetterDocumentation" : "/**The ARN of the subscription's topic.
\n@param topicArn The ARN of the subscription's topic.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the subscription's topic.
\n@param topicArn The ARN of the subscription's topic.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "subscription",
"variableType" : "Subscription",
"variableDeclarationType" : "Subscription",
"documentation" : null,
"simpleType" : "Subscription",
"variableSetterType" : "Subscription"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : null,
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"Owner" : {
"documentation" : "The subscription's owner.
",
"name" : "Owner",
"c2jName" : "Owner",
"c2jShape" : "account",
"variable" : {
"variableName" : "owner",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's owner.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "owner",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Owner",
"marshallLocationName" : "Owner",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's owner.
\n@param owner The subscription's owner.*/",
"getterDocumentation" : "/**The subscription's owner.
\n@return The subscription's owner.*/",
"fluentSetterDocumentation" : "/**The subscription's owner.
\n@param owner The subscription's owner.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's owner.
\n@param owner The subscription's owner.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"Endpoint" : {
"documentation" : "The subscription's endpoint (format depends on the protocol).
",
"name" : "Endpoint",
"c2jName" : "Endpoint",
"c2jShape" : "endpoint",
"variable" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's endpoint (format depends on the protocol).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "endpoint",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Endpoint",
"marshallLocationName" : "Endpoint",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@param endpoint The subscription's endpoint (format depends on the protocol).*/",
"getterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@return The subscription's endpoint (format depends on the protocol).*/",
"fluentSetterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@param endpoint The subscription's endpoint (format depends on the protocol).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's endpoint (format depends on the protocol).
\n@param endpoint The subscription's endpoint (format depends on the protocol).\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"TopicArn" : {
"documentation" : "The ARN of the subscription's topic.
",
"name" : "TopicArn",
"c2jName" : "TopicArn",
"c2jShape" : "topicARN",
"variable" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The ARN of the subscription's topic.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "topicArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "TopicArn",
"marshallLocationName" : "TopicArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The ARN of the subscription's topic.
\n@param topicArn The ARN of the subscription's topic.*/",
"getterDocumentation" : "/**The ARN of the subscription's topic.
\n@return The ARN of the subscription's topic.*/",
"fluentSetterDocumentation" : "/**The ARN of the subscription's topic.
\n@param topicArn The ARN of the subscription's topic.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The ARN of the subscription's topic.
\n@param topicArn The ARN of the subscription's topic.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"Protocol" : {
"documentation" : "The subscription's protocol.
",
"name" : "Protocol",
"c2jName" : "Protocol",
"c2jShape" : "protocol",
"variable" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's protocol.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "protocol",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Protocol",
"marshallLocationName" : "Protocol",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's protocol.
\n@param protocol The subscription's protocol.*/",
"getterDocumentation" : "/**The subscription's protocol.
\n@return The subscription's protocol.*/",
"fluentSetterDocumentation" : "/**The subscription's protocol.
\n@param protocol The subscription's protocol.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's protocol.
\n@param protocol The subscription's protocol.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"SubscriptionArn" : {
"documentation" : "The subscription's ARN.
",
"name" : "SubscriptionArn",
"c2jName" : "SubscriptionArn",
"c2jShape" : "subscriptionARN",
"variable" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "The subscription's ARN.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "subscriptionArn",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "SubscriptionArn",
"marshallLocationName" : "SubscriptionArn",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**The subscription's ARN.
\n@param subscriptionArn The subscription's ARN.*/",
"getterDocumentation" : "/**The subscription's ARN.
\n@return The subscription's ARN.*/",
"fluentSetterDocumentation" : "/**The subscription's ARN.
\n@param subscriptionArn The subscription's ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**The subscription's ARN.
\n@param subscriptionArn The subscription's ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"MessageAttributeValue" : {
"c2jName" : "MessageAttributeValue",
"documentation" : "The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes.
",
"shapeName" : "MessageAttributeValue",
"deprecated" : false,
"required" : [ "DataType" ],
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
",
"name" : "DataType",
"c2jName" : "DataType",
"c2jShape" : "String",
"variable" : {
"variableName" : "dataType",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "dataType",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "DataType",
"marshallLocationName" : "DataType",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@param dataType Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.*/",
"getterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@return Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.*/",
"fluentSetterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@param dataType Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@param dataType Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
",
"name" : "StringValue",
"c2jName" : "StringValue",
"c2jShape" : "String",
"variable" : {
"variableName" : "stringValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "stringValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "StringValue",
"marshallLocationName" : "StringValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@param stringValue Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.*/",
"getterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@return Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.*/",
"fluentSetterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@param stringValue Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@param stringValue Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}, {
"documentation" : "Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
",
"name" : "BinaryValue",
"c2jName" : "BinaryValue",
"c2jShape" : "Binary",
"variable" : {
"variableName" : "binaryValue",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"setterModel" : {
"variableName" : "binaryValue",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "BinaryValue",
"marshallLocationName" : "BinaryValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param binaryValue Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.*/",
"getterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.*/",
"fluentSetterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n@param binaryValue Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n@param binaryValue Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.\n@return Returns a reference to this object so that method calls can be chained together.*/"
} ],
"enums" : null,
"variable" : {
"variableName" : "messageAttributeValue",
"variableType" : "MessageAttributeValue",
"variableDeclarationType" : "MessageAttributeValue",
"documentation" : null,
"simpleType" : "MessageAttributeValue",
"variableSetterType" : "MessageAttributeValue"
},
"marshaller" : null,
"unmarshaller" : {
"resultWrapper" : null,
"flattened" : false
},
"errorCode" : null,
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingModelClass" : false,
"skipGeneratingMarshaller" : false,
"skipGeneratingUnmarshaller" : false
},
"membersAsMap" : {
"DataType" : {
"documentation" : "Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
",
"name" : "DataType",
"c2jName" : "DataType",
"c2jShape" : "String",
"variable" : {
"variableName" : "dataType",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "dataType",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "DataType",
"marshallLocationName" : "DataType",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@param dataType Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.*/",
"getterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@return Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.*/",
"fluentSetterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@param dataType Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
\n@param dataType Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"BinaryValue" : {
"documentation" : "Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
",
"name" : "BinaryValue",
"c2jName" : "BinaryValue",
"c2jShape" : "Binary",
"variable" : {
"variableName" : "binaryValue",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"setterModel" : {
"variableName" : "binaryValue",
"variableType" : "java.nio.ByteBuffer",
"variableDeclarationType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "BinaryValue",
"marshallLocationName" : "BinaryValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param binaryValue Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.*/",
"getterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.*/",
"fluentSetterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n@param binaryValue Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
\n@param binaryValue Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.\n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"StringValue" : {
"documentation" : "Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
",
"name" : "StringValue",
"c2jName" : "StringValue",
"c2jShape" : "String",
"variable" : {
"variableName" : "stringValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "stringValue",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "StringValue",
"marshallLocationName" : "StringValue",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@param stringValue Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.*/",
"getterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@return Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.*/",
"fluentSetterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@param stringValue Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
\n@param stringValue Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.\n@return Returns a reference to this object so that method calls can be chained together.*/"
}
}
},
"GetSubscriptionAttributesResult" : {
"c2jName" : "GetSubscriptionAttributesResponse",
"documentation" : "Response for GetSubscriptionAttributes action.
",
"shapeName" : "GetSubscriptionAttributesResult",
"deprecated" : false,
"required" : null,
"hasPayloadMember" : false,
"hasHeaderMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"wrapper" : false,
"members" : [ {
"documentation" : "A map of the subscription's attributes. Attributes in this map include the following:
-
SubscriptionArn -- the subscription's ARN
-
TopicArn -- the topic ARN that the subscription is associated with
-
Owner -- the AWS account ID of the subscription's owner
-
ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated
-
DeliveryPolicy -- the JSON serialization of the subscription's delivery policy
-
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
",
"name" : "Attributes",
"c2jName" : "Attributes",
"c2jShape" : "SubscriptionAttributesMap",
"variable" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "A map of the subscription's attributes. Attributes in this map include the following:
-
SubscriptionArn -- the subscription's ARN
-
TopicArn -- the topic ARN that the subscription is associated with
-
Owner -- the AWS account ID of the subscription's owner
-
ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated
-
DeliveryPolicy -- the JSON serialization of the subscription's delivery policy
-
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"setterModel" : {
"variableName" : "attributes",
"variableType" : "java.util.Map",
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "Attributes",
"marshallLocationName" : "Attributes",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyType" : "String",
"keyLocationName" : "key",
"keyModel" : null,
"valueType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"documentation" : "",
"name" : "Value",
"c2jName" : "value",
"c2jShape" : "attributeValue",
"variable" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"setterModel" : {
"variableName" : "value",
"variableType" : "String",
"variableDeclarationType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"unmarshallLocationName" : "value",
"marshallLocationName" : "value",
"additionalUnmarshallingPath" : null,
"additionalMarshallingPath" : null,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"flattened" : false,
"header" : false,
"uri" : false,
"statusCode" : false,
"queryString" : false
},
"deprecated" : false,
"listModel" : null,
"mapModel" : null,
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : true,
"list" : false,
"map" : false,
"setterDocumentation" : "/**\n@param value */",
"getterDocumentation" : "/**\n@return */",
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/"
},
"templateType" : "java.util.Map",
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"keySimple" : true,
"valueSimple" : true,
"valueList" : false,
"entryType" : "Map.Entry"
},
"enumType" : null,
"xmlNameSpaceUri" : null,
"idempotencyToken" : false,
"simple" : false,
"list" : false,
"map" : true,
"setterDocumentation" : "/**A map of the subscription's attributes. Attributes in this map include the following:
-
SubscriptionArn -- the subscription's ARN
-
TopicArn -- the topic ARN that the subscription is associated with
-
Owner -- the AWS account ID of the subscription's owner
-
ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated
-
DeliveryPolicy -- the JSON serialization of the subscription's delivery policy
-
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
\n@param attributes A map of the subscription's attributes. Attributes in this map include the following: -
SubscriptionArn -- the subscription's ARN
-
TopicArn -- the topic ARN that the subscription is associated with
-
Owner -- the AWS account ID of the subscription's owner
-
ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated
-
DeliveryPolicy -- the JSON serialization of the subscription's delivery policy
-
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
*/",
"getterDocumentation" : "/**A map of the subscription's attributes. Attributes in this map include the following:
-
SubscriptionArn -- the subscription's ARN
-
TopicArn -- the topic ARN that the subscription is associated with
-
Owner -- the AWS account ID of the subscription's owner
-
ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated
-
DeliveryPolicy -- the JSON serialization of the subscription's delivery policy
-
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
\n@return A map of the subscription's attributes. Attributes in this map include the following: -
SubscriptionArn -- the subscription's ARN
-
TopicArn -- the topic ARN that the subscription is associated with
-
Owner -- the AWS account ID of the subscription's owner
-
ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated
-
DeliveryPolicy -- the JSON serialization of the subscription's delivery policy
-
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
*/",
"fluentSetterDocumentation" : "/**A map of the subscription's attributes. Attributes in this map include the following:
-