set_endpoint_attributes¶
Operation¶
async
¶
set_endpoint_attributes(input: SetEndpointAttributesInput, plugins: list[Plugin] | None = None) -> SetEndpointAttributesOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SetEndpointAttributesInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
SetEndpointAttributesOutput
|
An instance of |
Input¶
dataclass
¶
Input for SetEndpointAttributes action.
Attributes¶
class-attribute
instance-attribute
¶
attributes: dict[str, str] | None = None
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.
class-attribute
instance-attribute
¶
endpoint_arn: str | None = None
EndpointArn used for SetEndpointAttributes action.
Output¶
dataclass
¶
Dataclass for SetEndpointAttributesOutput structure.