Menu
Amazon Simple Notification Service
API Reference (API Version 2010-03-31)

GetEndpointAttributes

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

EndpointArn

EndpointArn for GetEndpointAttributes input.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

Attributes
Attributes.entry.N.key (key)
Attributesentry.N.value (value)

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.

Type: String to string map

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationError

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

HTTP Status Code: 403

InternalError

Indicates an internal service error.

HTTP Status Code: 500

InvalidParameter

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

HTTP Status Code: 400

NotFound

Indicates that the requested resource does not exist.

HTTP Status Code: 404

Example

Example

Sample Request

POST http://sns.us-west-2.amazonaws.com/ HTTP/1.1 ... Action=GetEndpointAttributes &SignatureMethod=HmacSHA256 &AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE &EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3 &SignatureVersion=2 &Version=2010-03-31 &Signature=%2B2egbEoT4npw3p5H3wiIdzZBoTn4KI3UWmMFyBsHH9c%3D &Timestamp=2013-07-01T22%3A44%3A56.515Z

Sample Response

HTTP/1.1 200 OK ... <GetEndpointAttributesResponse xmlns="http://sns.amazonaws.com/doc/2010-03-31/"> <GetEndpointAttributesResult> <Attributes> <entry> <key>Enabled</key> <value>true</value> </entry> <entry> <key>CustomUserData</key> <value>UserId=01234567</value> </entry> <entry> <key>Token</key> <value>APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE</value> </entry> </Attributes> </GetEndpointAttributesResult> <ResponseMetadata> <RequestId>6c725a19-a142-5b77-94f9-1055a9ea04e7</RequestId> </ResponseMetadata> </GetEndpointAttributesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: