GetEndpoint - AWS IoT

GetEndpoint

Gets information about an Device Advisor endpoint.

Request Syntax

GET /endpoint?authenticationMethod=authenticationMethod&certificateArn=certificateArn&deviceRoleArn=deviceRoleArn&thingArn=thingArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

authenticationMethod

The authentication method used during the device connection.

Valid Values: X509ClientCertificate | SignatureVersion4

certificateArn

The certificate ARN of the device. This is an optional parameter.

Length Constraints: Minimum length of 20. Maximum length of 2048.

deviceRoleArn

The device role ARN of the device. This is an optional parameter.

Length Constraints: Minimum length of 20. Maximum length of 2048.

thingArn

The thing ARN of the device. This is an optional parameter.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "endpoint": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

endpoint

The response of an Device Advisor endpoint.

Type: String

Length Constraints: Minimum length of 45. Maximum length of 75.

Errors

InternalServerException

Sends an Internal Failure exception.

HTTP Status Code: 500

ResourceNotFoundException

Sends a Resource Not Found exception.

HTTP Status Code: 404

ValidationException

Sends a validation exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: