Menu
AWS IoT
API Reference

DescribeEndpoint

Returns a unique endpoint specific to the AWS account making the call.

Request Syntax

GET /endpoint?endpointType=endpointType HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

endpointType

The endpoint type.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "endpointAddress": "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.

endpointAddress

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

Type: String

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

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