IoT / Client / describe_endpoint

describe_endpoint#

IoT.Client.describe_endpoint(**kwargs)#

Returns a unique endpoint specific to the Amazon Web Services account making the call.

Requires permission to access the DescribeEndpoint action.

See also: AWS API Documentation

Request Syntax

response = client.describe_endpoint(
    endpointType='string'
)
Parameters:

endpointType (string) –

The endpoint type. Valid endpoint types include:

  • iot:Data - Returns a VeriSign signed data endpoint.

  • iot:Data-ATS - Returns an ATS signed data endpoint.

  • iot:CredentialProvider - Returns an IoT credentials provider API endpoint.

  • iot:Jobs - Returns an IoT device management Jobs API endpoint.

We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

Return type:

dict

Returns:

Response Syntax

{
    'endpointAddress': 'string'
}

Response Structure

  • (dict) –

    The output from the DescribeEndpoint operation.

    • endpointAddress (string) –

      The endpoint. The format of the endpoint is as follows: identifier.iot.*region*.amazonaws.com.

Exceptions

  • IoT.Client.exceptions.InternalFailureException

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.UnauthorizedException

  • IoT.Client.exceptions.ThrottlingException