Menu
AWS IoT
Developer Guide

DescribeEndpoint

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

Request syntax:

GET /endpoint?endpointType=endpointType

URI Request Parameters:

Name

Type

Req?

Description

endpointType

EndpointType

no

The endpoint type.

Response syntax:

Content-type: application/json { "endpointAddress": "string" }

Response Body Parameters:

Name

Type

Req?

Description

endpointAddress

EndpointAddress

no

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

Errors:

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

CLI

Synopsis:

aws iot describe-endpoint \ [--endpoint-type <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "endpointType": "string" }

cli-input-json fields:

Name

Type

Description

endpointType

string

The endpoint type.

Output:

{ "endpointAddress": "string" }

cli output fields:

Name

Type

Description

endpointAddress

string

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

On this page: