Skip to content

get_endpoint_attributes

get_endpoint_attributes(
    endpoint_arn: String, *, config_overrides: Optional[SNSClientConfig] = None
) -> GetEndpointAttributesResponse

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:

  • endpoint_arn (String) –

    EndpointArn for GetEndpointAttributes input.

Raises:

Source code in docs_src/capo_sns/_services/sns.py
def get_endpoint_attributes(
    self,
    endpoint_arn: "capo_sns.types.string.String",
    *,
    config_overrides: Optional[SNSClientConfig] = None,
) -> (
    "capo_sns.types.get_endpoint_attributes_response.GetEndpointAttributesResponse"
):
    """<p>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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>

    Args:
        endpoint_arn: <p> <code>EndpointArn</code> for <code>GetEndpointAttributes</code> input.</p>

    Raises:
        capo_sns.errors.authorization_error_exception.AuthorizationErrorException: <p>Indicates that the user has been denied access to the requested resource.</p>
        capo_sns.errors.internal_error_exception.InternalErrorException: <p>Indicates an internal service error.</p>
        capo_sns.errors.invalid_parameter_exception.InvalidParameterException: <p>Indicates that a request parameter does not comply with the associated constraints.</p>
        capo_sns.errors.not_found_exception.NotFoundException: <p>Indicates that the requested resource does not exist.</p>
        capo_sns.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sns.types.get_endpoint_attributes_input.GetEndpointAttributesInput]",
    ) -> OperationResponse[
        "capo_sns.types.get_endpoint_attributes_response.GetEndpointAttributesResponse"
    ]:
        import capo_sns._operations.amazon_simple_notification_service.get_endpoint_attributes

        output, http_response = (
            capo_sns._operations.amazon_simple_notification_service.get_endpoint_attributes.get_endpoint_attributes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEndpointAttributes")
    )
    input_: capo_sns.types.get_endpoint_attributes_input.GetEndpointAttributesInput = {
        "endpoint_arn": endpoint_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output