DescribeEndpoint
Returns a unique endpoint specific to the AWS account making the call.
Requires permission to access the DescribeEndpoint action.
Request Syntax
GET /endpoint?endpointType=endpointType
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- endpointType
-
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 AWS IoT credentials provider API endpoint.
-
iot:Jobs
- Returns an AWS 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. ATS Signed Certificates are more secure and are trusted by most popular browsers.Length Constraints: Maximum length of 128.
Pattern:
[\s\S]*
-
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: 400
- 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: