get_endpoint_attributes

SNS.Client.get_endpoint_attributes(**kwargs)

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

See also: AWS API Documentation

Request Syntax

response = client.get_endpoint_attributes(
    EndpointArn='string'
)

Parameters

EndpointArn (string) --

[REQUIRED]

EndpointArn for GetEndpointAttributes input.

Return type

dict

Returns

Response Syntax

{
    'Attributes': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  Response from GetEndpointAttributes of the EndpointArn.

  • Attributes (dict) --

    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.

    Note

    The device token for the iOS platform is returned in lowercase.

    • (string) --
      • (string) --

Exceptions

• SNS.Client.exceptions.InvalidParameterException
• SNS.Client.exceptions.InternalErrorException
• SNS.Client.exceptions.AuthorizationErrorException
• SNS.Client.exceptions.NotFoundException