Skip to content

SNS  >  Operations  >  delete_endpoint

delete_endpoint

Operation

delete_endpoint async 

delete_endpoint(input: DeleteEndpointInput, plugins: list[Plugin] | None = None) -> 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
input DeleteEndpointInput

An instance of DeleteEndpointInput.

 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
DeleteEndpointOutput

An instance of DeleteEndpointOutput.

Input

DeleteEndpointInput dataclass

Input for DeleteEndpoint action.

Attributes

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

EndpointArn of endpoint to delete.

Output

DeleteEndpointOutput dataclass

Dataclass for DeleteEndpointOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.