aws apigatewayv2 import-api

Imports an API. AWS CLI reference

1 example 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To import an HTTP API

The following import-api example creates an HTTP API from an OpenAPI 3.0 definition file named api-definition.yaml.

aws apigatewayv2 import-api --body file://api-definition.yamlIdentify

--bodyThe OpenAPI definition.

Contents of api-definition.yaml:

openapi: 3.0.1
info:
    title: My Lambda API
    version: v1.0
paths:
    /hello:
        x-amazon-apigateway-any-method:
            x-amazon-apigateway-integration:
                payloadFormatVersion: 2.0
                type: aws_proxy
                httpMethod: POST
                uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:hello/invocations
                connectionType: INTERNET

Its output

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CreatedDate": "2020-04-08T17:19:38+00:00",
    "Name": "My Lambda API",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {},
    "Version": "v1.0"
}

For more information, see Working with OpenAPI definitions for HTTP APIs in the Amazon API Gateway Developer Guide.

Options

3 in the AWS CLI reference

--basepathSpecifies how to interpret the base path of the API during import.

--bodyThe OpenAPI definition.

--fail-on-warningsSpecifies whether to rollback the API creation when a warning is encountered.