Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
Endpoints
URI
/2017-08-29/endpoints
HTTP Methods
POST
Operation ID: DescribeEndpoints
Send an request with an empty body to the regional API endpoint to get your account API endpoint.
Responses
| Status Code | Response Model | Description |
|---|---|---|
200 |
DescribeEndpointsResponse |
200 response |
400 |
ExceptionBody |
The service can't process your request because of a problem in the request. Please check your request form and syntax. |
403 |
ExceptionBody |
You don't have permissions for this action with the credentials you sent. |
404 |
ExceptionBody |
The resource you requested does not exist. |
409 |
ExceptionBody |
The service could not complete your request because there is a conflict with the current state of the resource. |
429 |
ExceptionBody |
Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. |
500 |
ExceptionBody |
The service encountered an unexpected condition and cannot fulfill your request. |
OPTIONS
Supports CORS preflight requests.
Responses
| Status Code | Response Model | Description |
|---|---|---|
200 |
None |
The request completed successfully. |
Schemas
Request Bodies
Example POST
{ "nextToken": "string", "maxResults": integer, "mode": enum }
Response Bodies
Example DescribeEndpointsResponse
{ "endpoints": [ { "url": "string" } ], "nextToken": "string" }
Example ExceptionBody
{ "message": "string" }
Properties
DescribeEndpointsMode
Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.
-
DEFAULT
-
GET_ONLY
DescribeEndpointsRequest
Send an request with an empty body to the regional API endpoint to get your account API endpoint.
DescribeEndpointsResponse
Successful describe endpoints requests will return your account API endpoint.
| Property | Type | Required | Description |
|---|---|---|---|
endpoints |
Array of type Endpoint |
False |
List of endpoints |
nextToken |
string |
False |
Use this string to request the next batch of endpoints. |
Endpoint
Describes an account-specific API endpoint.
ExceptionBody
See Also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:


