- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateApiMappingCommand
Creates an API mapping.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ApiGatewayV2Client, CreateApiMappingCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
// const { ApiGatewayV2Client, CreateApiMappingCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
const client = new ApiGatewayV2Client(config);
const input = { // CreateApiMappingRequest
ApiId: "STRING_VALUE", // required
ApiMappingKey: "STRING_VALUE",
DomainName: "STRING_VALUE", // required
Stage: "STRING_VALUE", // required
};
const command = new CreateApiMappingCommand(input);
const response = await client.send(command);
// { // CreateApiMappingResponse
// ApiId: "STRING_VALUE",
// ApiMappingId: "STRING_VALUE",
// ApiMappingKey: "STRING_VALUE",
// Stage: "STRING_VALUE",
// };
CreateApiMappingCommand Input
See CreateApiMappingCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ApiId Required | string | undefined | The API identifier. |
DomainName Required | string | undefined | The domain name. |
Stage Required | string | undefined | The API stage. |
ApiMappingKey | string | undefined | The API mapping key. |
CreateApiMappingCommand Output
See CreateApiMappingCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ApiId | string | undefined | The API identifier. |
ApiMappingId | string | undefined | The API mapping identifier. |
ApiMappingKey | string | undefined | The API mapping key. |
Stage | string | undefined | The API stage. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details. |
ConflictException | client | 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. |
NotFoundException | client | The resource specified in the request was not found. See the message field for more information. |
TooManyRequestsException | client | A limit has been exceeded. See the accompanying error message for details. |
ApiGatewayV2ServiceException | Base exception class for all service exceptions from ApiGatewayV2 service. |