String topicArn
The ARN of the topic whose access control policy you wish to modify.
String label
A unique identifier for the new policy statement.
com.amazonaws.internal.SdkInternalList<T> aWSAccountIds
The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
com.amazonaws.internal.SdkInternalList<T> actionNames
The action you want to allow for the specified principal(s).
Valid values: any Amazon SNS action name.
String phoneNumber
The phone number for which you want to check the opt out status.
Boolean 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.
String topicArn
The ARN of the topic for which you wish to confirm a subscription.
String token
Short-lived token sent to an endpoint during the Subscribe
action.
String 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.
String subscriptionArn
The ARN of the created subscription.
String name
Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
String platform
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
com.amazonaws.internal.SdkInternalMap<K,V> attributes
For a list of attributes, see SetPlatformApplicationAttributes
String platformApplicationArn
PlatformApplicationArn is returned.
String platformApplicationArn
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
String 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.
String 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.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
For a list of attributes, see SetEndpointAttributes.
String endpointArn
EndpointArn returned from CreateEndpoint action.
String name
The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
String topicArn
The Amazon Resource Name (ARN) assigned to the created topic.
String endpointArn
EndpointArn of endpoint to delete.
String platformApplicationArn
PlatformApplicationArn of platform application object to delete.
String topicArn
The ARN of the topic you want to delete.
String endpointArn
EndpointArn for mobile app and device.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes for endpoint.
String endpointArn
EndpointArn for GetEndpointAttributes input.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes include the following:
CustomUserData
-- arbitrary user data to associate with the endpoint. Amazon SNS does not use this
data. The data must be in UTF-8 format and less than 2KB.
Enabled
-- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false
when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true,
typically after updating Token.
Token
-- device token, also referred to as a registration id, for an app and mobile device. This is
returned from the notification service when an app and mobile device are registered with the notification
service.
String platformApplicationArn
PlatformApplicationArn for GetPlatformApplicationAttributesInput.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes include the following:
EventEndpointCreated
-- Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted
-- Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated
-- Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure
-- Topic ARN to which DeliveryFailure event notifications should be sent upon
Direct Publish delivery failure (permanent) to one of the application's endpoints.
com.amazonaws.internal.SdkInternalList<T> attributes
A list of the individual attribute names, such as MonthlySpendLimit
, for which you want values.
For all attribute names, see SetSMSAttributes.
If you don't use this parameter, Amazon SNS returns all SMS attributes.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
The SMS attribute names and their values.
String subscriptionArn
The ARN of the subscription whose properties you want to get.
com.amazonaws.internal.SdkInternalMap<K,V> 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
String topicArn
The ARN of the topic whose properties you want to get.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of the topic's attributes. Attributes in this map include the following:
TopicArn
-- the topic's ARN
Owner
-- the AWS account ID of the topic's owner
Policy
-- the JSON serialization of the topic's access control policy
DisplayName
-- the human-readable name used in the "From" field for notifications to email and
email-json endpoints
SubscriptionsPending
-- the number of subscriptions pending confirmation on this topic
SubscriptionsConfirmed
-- the number of confirmed subscriptions on this topic
SubscriptionsDeleted
-- the number of deleted subscriptions on this topic
DeliveryPolicy
-- the JSON serialization of the topic's delivery policy
EffectiveDeliveryPolicy
-- the JSON serialization of the effective delivery policy that takes into
account system defaults
String platformApplicationArn
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
String nextToken
NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
com.amazonaws.internal.SdkInternalList<T> endpoints
Endpoints returned for ListEndpointsByPlatformApplication action.
String nextToken
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
String nextToken
A NextToken
string is used when you call the ListPhoneNumbersOptedOut
action to
retrieve additional records that are available after the first page of results.
com.amazonaws.internal.SdkInternalList<T> phoneNumbers
A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.
String nextToken
A NextToken
string is returned when you call the ListPhoneNumbersOptedOut
action if
additional records are available after the first page of results.
String nextToken
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
com.amazonaws.internal.SdkInternalList<T> platformApplications
Platform applications returned when calling ListPlatformApplications action.
String nextToken
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
com.amazonaws.internal.SdkInternalList<T> subscriptions
A list of subscriptions.
String nextToken
Token to pass along to the next ListSubscriptionsByTopic
request. This element is returned if there
are more subscriptions to retrieve.
String nextToken
Token returned by the previous ListSubscriptions
request.
com.amazonaws.internal.SdkInternalList<T> subscriptions
A list of subscriptions.
String nextToken
Token to pass along to the next ListSubscriptions
request. This element is returned if there are
more subscriptions to retrieve.
String nextToken
Token returned by the previous ListTopics
request.
com.amazonaws.internal.SdkInternalList<T> topics
A list of topic ARNs.
String nextToken
Token to pass along to the next ListTopics
request. This element is returned if there are additional
topics to retrieve.
String dataType
Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
String stringValue
Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
ByteBuffer binaryValue
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
String phoneNumber
The phone number to opt in.
String platformApplicationArn
PlatformApplicationArn for platform application object.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes for platform application object.
String topicArn
The topic you want to publish to.
If you don't specify a value for the TopicArn
parameter, you must specify a value for the
PhoneNumber
or TargetArn
parameters.
String targetArn
Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter, you must specify a value for the
PhoneNumber
or TopicArn
parameters.
String phoneNumber
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber
parameter, you must specify a value for the
TargetArn
or TopicArn
parameters.
String message
The message you want to send to the topic.
If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send different messages for each transport protocol, set the value of the
MessageStructure
parameter to json
and use a JSON object for the Message
parameter.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish
call to return
an error (no partial delivery).
String subject
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
String messageStructure
Set MessageStructure
to json
if you want to send a different message for each protocol.
For example, using one publish action, you can send a short message to your SMS subscribers and a longer message
to your email subscribers. If you set MessageStructure
to json
, the value of the
Message
parameter must:
be a syntactically valid JSON object; and
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value: json
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Message attributes for Publish action.
String messageId
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
String endpointArn
EndpointArn used for SetEndpointAttributes action.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData
-- arbitrary user data to associate with the endpoint. Amazon SNS does not use this
data. The data must be in UTF-8 format and less than 2KB.
Enabled
-- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false
when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true,
typically after updating Token.
Token
-- device token, also referred to as a registration id, for an app and mobile device. This is
returned from the notification service when an app and mobile device are registered with the notification
service.
String platformApplicationArn
PlatformApplicationArn for SetPlatformApplicationAttributes action.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential
-- The credential received from the notification service. For APNS/APNS_SANDBOX,
PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret".
PlatformPrincipal
-- The principal received from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is
"client id".
EventEndpointCreated
-- Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted
-- Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated
-- Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure
-- Topic ARN to which DeliveryFailure event notifications should be sent upon
Direct Publish delivery failure (permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn
-- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs
on your behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs
on your behalf.
SuccessFeedbackSampleRate
-- Sample rate percentage (0-100) of successfully delivered messages.
com.amazonaws.internal.SdkInternalMap<K,V> 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.
By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to exceed the maximum, contact AWS Support or your AWS sales representative for a service limit increase.
DeliveryStatusIAMRole
– The ARN of the IAM role that allows Amazon SNS to write logs about SMS
deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the
message price, the success or failure status, the reason for failure (if the message failed), the message dwell
time, and other information.
DeliveryStatusSuccessSamplingRate
– The percentage of successful SMS deliveries for which Amazon SNS
will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for
failed deliveries, set this value to 0
. To write logs for 10% of your successful deliveries, set it
to 10
.
DefaultSenderID
– A string, such as your business brand, that is displayed as the sender on the
receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters,
and it must contain at least one letter.
DefaultSMSType
– The type of SMS message that you will send by default. You can assign the following
values:
Promotional
– (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the
message delivery to incur the lowest cost.
Transactional
– Critical messages that support customer transactions, such as one-time passcodes for
multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket
– The name of the Amazon S3 bucket to receive daily SMS usage reports from
Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the
following information for each SMS message that was successfully delivered by your 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 Monitoring SMS Activity in the Amazon SNS Developer Guide.
String subscriptionArn
The ARN of the subscription to modify.
String attributeName
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy
| RawMessageDelivery
String attributeValue
The new value for the attribute in JSON format.
String topicArn
The ARN of the topic to modify.
String 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
String attributeValue
The new value for the attribute.
String topicArn
The ARN of the topic you want to subscribe to.
String 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.
String 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.
String subscriptionArn
The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
String subscriptionArn
The subscription's ARN.
String owner
The subscription's owner.
String protocol
The subscription's protocol.
String endpoint
The subscription's endpoint (format depends on the protocol).
String topicArn
The ARN of the subscription's topic.
String topicArn
The topic's ARN.
String subscriptionArn
The ARN of the subscription to be deleted.
Copyright © 2017. All rights reserved.