set_endpoint_attributes

SNS.Client.set_endpoint_attributes(**kwargs)

Sets the attributes for an endpoint 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.set_endpoint_attributes(
    EndpointArn='string',
    Attributes={
        'string': 'string'
    }
)

Parameters

• EndpointArn (string) --

  [REQUIRED]

  EndpointArn used for SetEndpointAttributes action.

• Attributes (dict) --

  [REQUIRED]

  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) --
    • (string) --

Returns

None

Exceptions

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