set_endpoint_attributes¶
Operation¶
set_endpoint_attributes
¶
set_endpoint_attributes(request: SetEndpointAttributesInput | SetEndpointAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SetEndpointAttributesInputDict]) -> 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 |
|---|---|---|---|
request
|
SetEndpointAttributesInput | SetEndpointAttributesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[SetEndpointAttributesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SetEndpointAttributesOutput
|
An instance of |
set_endpoint_attributes
async
¶
set_endpoint_attributes(request: SetEndpointAttributesInput | SetEndpointAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SetEndpointAttributesInputDict]) -> 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 |
|---|---|---|---|
request
|
SetEndpointAttributesInput | SetEndpointAttributesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[SetEndpointAttributesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SetEndpointAttributesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
SetEndpointAttributesInputDict
¶
Bases: TypedDict
Dictionary form of SetEndpointAttributesInput.
Attributes¶
attributes
instance-attribute
¶
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.
SetEndpointAttributesInput
dataclass
¶
Bases: _SerdeShape
Input for SetEndpointAttributes action.
Attributes¶
attributes
class-attribute
instance-attribute
¶
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.
Output¶
SetEndpointAttributesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SetEndpointAttributesOutput structure.