IoTDeviceAdvisor / Client / get_endpoint

get_endpoint#

IoTDeviceAdvisor.Client.get_endpoint(**kwargs)#

Gets information about an Device Advisor endpoint.

See also: AWS API Documentation

Request Syntax

response = client.get_endpoint(
    thingArn='string',
    certificateArn='string',
    deviceRoleArn='string',
    authenticationMethod='X509ClientCertificate'|'SignatureVersion4'
)
Parameters:

  • thingArn (string) – The thing ARN of the device. This is an optional parameter.

  • certificateArn (string) – The certificate ARN of the device. This is an optional parameter.

  • deviceRoleArn (string) – The device role ARN of the device. This is an optional parameter.

  • authenticationMethod (string) – The authentication method used during the device connection.

Return type:

dict

Returns:

Response Syntax

{
    'endpoint': 'string'
}

Response Structure

  • (dict) –

    • endpoint (string) –

      The response of an Device Advisor endpoint.

Exceptions

  • IoTDeviceAdvisor.Client.exceptions.ValidationException

  • IoTDeviceAdvisor.Client.exceptions.InternalServerException

  • IoTDeviceAdvisor.Client.exceptions.ResourceNotFoundException