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 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.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 ARNTopicArn
-- the topic ARN that the subscription is
associated withOwner
-- the AWS account ID of the subscription's ownerConfirmationWasAuthenticated
-- true if the subscription
confirmation request was authenticatedDeliveryPolicy
-- the JSON serialization of the
subscription's delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of the
effective delivery policy that takes into account the topic delivery
policy and account system defaultsString 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 ARNOwner
-- the AWS account ID of the topic's ownerPolicy
-- the JSON serialization of the topic's access
control policyDisplayName
-- the human-readable name used in the
"From" field for notifications to email and email-json endpointsSubscriptionsPending
-- the number of subscriptions
pending confirmation on this topicSubscriptionsConfirmed
-- the number of confirmed
subscriptions on this topicSubscriptionsDeleted
-- the number of deleted
subscriptions on this topicDeliveryPolicy
-- the JSON serialization of the topic's
delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of the
effective delivery policy that takes into account system defaultsString 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
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 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.
String targetArn
Either TopicArn or EndpointArn, but not both.
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. See the Examples section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
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:
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.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 POSThttps
-- delivery of JSON-encoded message via HTTPS POST
email
-- delivery of message via SMTPemail-json
-- delivery of JSON-encoded message via SMTPsms
-- delivery of message via SMSsqs
-- delivery of JSON-encoded message to an Amazon SQS
queueapplication
-- delivery of JSON-encoded message to an
EndpointArn for a mobile app and device.String endpoint
The endpoint that you want to receive notifications. Endpoints vary by protocol:
http
protocol, the endpoint is an URL beginning
with "http://"https
protocol, the endpoint is a URL beginning
with "https://"email
protocol, the endpoint is an email address
email-json
protocol, the endpoint is an email
addresssms
protocol, the endpoint is a phone number of
an SMS-enabled devicesqs
protocol, the endpoint is the ARN of an
Amazon SQS queueapplication
protocol, the endpoint is the
EndpointArn of a mobile app and device.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 © 2016. All rights reserved.