Skip to content

delete_endpoint

Operation

delete_endpoint

delete_endpoint(request: DeleteEndpointInput | DeleteEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteEndpointInputDict]) -> DeleteEndpointOutput

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

Parameters:

Name Type Description Default
request DeleteEndpointInput | DeleteEndpointInputDict | 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[DeleteEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteEndpointOutput

An instance of DeleteEndpointOutput.

delete_endpoint async

delete_endpoint(request: DeleteEndpointInput | DeleteEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteEndpointInputDict]) -> DeleteEndpointOutput

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

Parameters:

Name Type Description Default
request DeleteEndpointInput | DeleteEndpointInputDict | 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[DeleteEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteEndpointOutput

An instance of DeleteEndpointOutput.

Input

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

DeleteEndpointInputDict

Bases: TypedDict

Dictionary form of DeleteEndpointInput.

Attributes

endpoint_arn instance-attribute
endpoint_arn: Required[str]

EndpointArn of endpoint to delete.

DeleteEndpointInput dataclass

Bases: _SerdeShape

Input for DeleteEndpoint action.

Attributes

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

EndpointArn of endpoint to delete.

Output

DeleteEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteEndpointOutput structure.

Attributes

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.