Skip to content

get_endpoint_attributes

Operation

get_endpoint_attributes

get_endpoint_attributes(request: GetEndpointAttributesInput | GetEndpointAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEndpointAttributesInputDict]) -> GetEndpointAttributesOutput

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.

Parameters:

Name Type Description Default
request GetEndpointAttributesInput | GetEndpointAttributesInputDict | 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[GetEndpointAttributesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetEndpointAttributesOutput

An instance of GetEndpointAttributesOutput.

get_endpoint_attributes async

get_endpoint_attributes(request: GetEndpointAttributesInput | GetEndpointAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEndpointAttributesInputDict]) -> GetEndpointAttributesOutput

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.

Parameters:

Name Type Description Default
request GetEndpointAttributesInput | GetEndpointAttributesInputDict | 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[GetEndpointAttributesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetEndpointAttributesOutput

An instance of GetEndpointAttributesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetEndpointAttributesInputDict

Bases: TypedDict

Dictionary form of GetEndpointAttributesInput.

Attributes

endpoint_arn instance-attribute
endpoint_arn: Required[str]

EndpointArn for GetEndpointAttributes input.

GetEndpointAttributesInput dataclass

Bases: _SerdeShape

Input for GetEndpointAttributes action.

Attributes

endpoint_arn class-attribute instance-attribute
endpoint_arn: str | None = ...

EndpointArn for GetEndpointAttributes input.

Output

GetEndpointAttributesOutput dataclass

Bases: _SerdeShape

Response from GetEndpointAttributes of the EndpointArn.

Attributes

attributes class-attribute instance-attribute
attributes: dict[str, str] | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.