Amazon API Gateway
API Reference

The AWS Documentation website is getting a new look!
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.

ApiMappings

Represents a collection of API mappings.

URI

/v2/domainnames/domainName/apimappings

HTTP Methods

GET

Operation ID: GetApiMappings

Gets API mappings.

Path Parameters

Name Type Required Description
domainName String True

The domain name.

Query Parameters

Name Type Required Description
nextToken String False

The next page of elements from this collection. Not valid for the last element of the collection.

maxResults String False

The maximum number of elements to be returned for this resource.

Responses

Status Code Response Model Description
200 ApiMappings

Success

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

POST

Operation ID: CreateApiMapping

Creates an API mapping.

Path Parameters

Name Type Required Description
domainName String True

The domain name.

Responses

Status Code Response Model Description
201 ApiMapping

The request has succeeded and has resulted in the creation of a resource.

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

409 ConflictException

The resource already exists.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Request Bodies

Example POST

{ "apiMappingKey": "string", "apiId": "string", "stage": "string" }

Response Bodies

Example ApiMappings

{ "items": [ { "apiMappingId": "string", "apiMappingKey": "string", "apiId": "string", "stage": "string" } ], "nextToken": "string" }

Example ApiMapping

{ "apiMappingId": "string", "apiMappingKey": "string", "apiId": "string", "stage": "string" }

Example BadRequestException

{ "message": "string" }

Example NotFoundException

{ "message": "string", "resourceType": "string" }

Example ConflictException

{ "message": "string" }

Example LimitExceededException

{ "message": "string", "limitType": "string" }

Properties

ApiMapping

Represents an API mapping.

Property Type Required Description
apiMappingId

string

False

The API mapping identifier.

apiMappingKey

string

False

The API mapping key.

apiId

string

True

The API identifier.

stage

string

True

The API stage.

ApiMappings

Represents a collection of ApiMappings resources.

Property Type Required Description
items

Array of type ApiMapping

False

The elements from this collection.

nextToken

string

False

The next page of elements from this collection. Not valid for the last element of the collection.

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

CreateApiMappingInput

Represents the input parameters for a CreateApiMapping request.

Property Type Required Description
apiMappingKey

string

False

The API mapping key.

apiId

string

True

The API identifier.

stage

string

True

The API stage.

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property Type Required Description
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

See Also

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

GetApiMappings

CreateApiMapping