URI HTTP methods Schemas Properties See also

Endpoints

URI

/2017-08-29/endpoints

HTTP methods

POST

Operation ID: DescribeEndpoints

Send a request with an empty body to the regional API endpoint to get your account API endpoint. Note that DescribeEndpoints is no longer required. We recommend that you send your requests directly to the regional endpoint instead.

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


{
  "nextToken": "string",
  "maxResults": integer,
  "mode": enum
}

Response bodies


{
  "endpoints": [
    {
      "url": "string"
    }
  ],
  "nextToken": "string"
}


{
  "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

Property Type Required Description

Property	Type	Required	Description
`maxResults`	integer Format: int32	False	Optional. Max number of endpoints, up to twenty, that will be returned at one time.
`mode`	DescribeEndpointsMode	False	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.
`nextToken`	string	False	Use this string, provided with the response to a previous request, to request the next batch of endpoints.

maxResults

integer

Format: int32

False

Optional. Max number of endpoints, up to twenty, that will be returned at one time.

mode

DescribeEndpointsMode

False

nextToken

string

False

Use this string, provided with the response to a previous request, to request the next batch of endpoints.

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.

Property	Type	Required	Description
`url`	string	False	URL of endpoint

ExceptionBody

Property	Type	Required	Description
`message`	string	False