를 사용한 API Gateway HTTP 및 WebSocket API Word예제 AWS CLI

API에 대한 API 매핑을 생성하려면

다음 create-api-mapping 예제에서는 API의 test 단계를 regional.example.com 사용자 지정 도메인 이름의 /myApi 경로에 매핑합니다.

aws apigatewayv2 create-api-mapping \
    --domain-name regional.example.com \
    --api-mapping-key myApi \
    --api-id a1b2c3d4 \
    --stage test

출력:

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "myApi"
    "Stage": "test"
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

HTTP API를 생성하려면

다음 create-api 예제에서는 빠른 생성을 사용하여 HTTP API를 생성합니다. 빠른 생성을 사용하여 AWS Lambda 또는 API 통합, 기본 캐치-올 라우팅, 변경 사항을 자동으로 배포하도록 구성된 기본 단계가 포함된 HTTP를 생성할 수 있습니다. 다음 명령은 빠른 생성을 사용하여 Lambda 함수와 통합되는 HTTP API를 생성합니다.

aws apigatewayv2 create-api \
    --name my-http-api \
    --protocol-type HTTP \
    --target arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function

출력:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CreatedDate": "2020-04-08T19:05:45+00:00",
    "Name": "my-http-api",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path"
}

자세한 내용은 Amazon API HTTP Gateway 개발자 안내서의 API Gateway에서 Word Word 개발을 참조하세요. API

a WebSocket APIWord를 생성하려면

다음 create-api 예제에서는 지정된 이름으로 WebSocket API를 생성합니다.

aws apigatewayv2 create-api \
    --name "myWebSocketApi" \
    --protocol-type WEBSOCKET \
    --route-selection-expression '$request.body.action'

출력:

{
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "Name": "myWebSocketApi",
    "CreatedDate": "2018-11-15T06:23:51Z",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "'$request.body.action'",
    "ApiId": "aabbccddee"
}

자세한 내용은 Amazon Word API Gateway 개발자 안내서의 API Gateway에서 a WebSocket API Word생성을 참조하세요.

JWT Word에 대한 API HTTP 권한 부여자를 생성하려면

다음 create-authorizer 예제에서는 Amazon Cognito를 자격 증명 공급자로 사용하는 JWT 권한 부여자를 생성합니다.

aws apigatewayv2 create-authorizer \
    --name my-jwt-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-type JWT \
    --identity-source '$request.header.Authorization' \
    --jwt-configuration Audience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123

출력:

{
    "AuthorizerId": "a1b2c3",
    "AuthorizerType": "JWT",
    "IdentitySource": [
        "$request.header.Authorization"
    ],
    "JwtConfiguration": {
        "Audience": [
            "123456abc"
        ],
        "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
    },
    "Name": "my-jwt-authorizer"
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP JWT 권한 부여자를 사용하여 Word에 대한 액세스 제어를 참조하세요. API

API에 대한 배포를 생성하려면

다음 create-deployment 예제에서는 API에 대한 배포를 생성하고 해당 배포를 API의 dev 단계와 연결합니다.

aws apigatewayv2 create-deployment \
    --api-id a1b2c3d4 \
    --stage-name dev

출력:

{
    "AutoDeployed": false,
    "CreatedDate": "2020-04-06T23:38:08Z",
    "DeploymentId": "53lz9l",
    "DeploymentStatus": "DEPLOYED"
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word 배포를 참조하세요. API

사용자 지정 도메인 이름을 생성하려면

다음 create-domain-name 예제에서는 API에 대한 리전 사용자 지정 도메인 이름을 생성합니다.

aws apigatewayv2 create-domain-name \
    --domain-name regional.example.com \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

출력:

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "regional.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "123456789111",
            "SecurityPolicy": "TLS_1_2",
            "DomainNameStatus": "AVAILABLE"
        }
    ]
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

a WebSocket API Word통합을 생성하려면

다음 create-integration 예제에서는 a WebSocket APIWord에 대한 모의 통합을 생성합니다.

aws apigatewayv2 create-integration \
    --api-id aabbccddee \
    --passthrough-behavior WHEN_NO_MATCH \
    --timeout-in-millis 29000 \
    --connection-type INTERNET \
    --integration-type MOCK

출력:

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "0abcdef",
    "IntegrationResponseSelectionExpression": "${integration.response.statuscode}",
    "IntegrationType": "MOCK",
    "PassthroughBehavior": "WHEN_NO_MATCH",
    "PayloadFormatVersion": "1.0",
    "TimeoutInMillis": 29000
}

자세한 내용은 Amazon Word API Gateway 개발자 안내서의 API Gateway에서 a WebSocket API Word통합 요청 설정을 참조하세요.

HTTP API 통합을 생성하려면

다음 create-integration 예에서는 HTTP API에 대한 AWS Lambda 통합을 생성합니다.

aws apigatewayv2 create-integration \
    --api-id a1b2c3d4 \
    --integration-type AWS_PROXY \
    --integration-uri arn:aws:lambda:us-west-2:123456789012:function:my-function \
    --payload-format-version 2.0

출력:

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "0abcdef",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 30000
}

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word에 대한 통합 구성을 참조하세요. API

a WebSocket 또는 HTTP API에 대한 $기본 라우팅을 생성하려면

다음 create-route 예제에서는 a WebSocket 또는 HTTP API에 대한 $default 경로를 생성합니다.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key '$default'

출력:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 WebSocket APIsWord 경로 작업을 참조하세요.

HTTP API에 대한 경로를 생성하려면

다음 create-route 예제에서는 POST 요청을 수락signup하는 라는 라우팅을 생성합니다.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key 'POST /signup'

출력:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "POST /signup",
    "RouteId": "1122334"
}

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word 경로 작업을 참조하세요. API

스테이지를 생성하려면

다음 create-stage 예제에서는 dev for a API라는 단계를 생성합니다.

aws apigatewayv2 create-stage \
    --api-id a1b2c3d4 \
    --stage-name dev

출력:

{
    "CreatedDate": "2020-04-06T23:23:46Z",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "LastUpdatedDate": "2020-04-06T23:23:46Z",
    "RouteSettings": {},
    "StageName": "dev",
    "StageVariables": {},
    "Tags": {}
}

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word에 대한 단계 작업을 참조하세요. API

VPC Word에 대한 API HTTP 링크를 생성하려면

다음 create-vpc-link 예제에서는 VPC Word에 대한 APIs HTTP 링크를 생성합니다.

aws apigatewayv2 create-vpc-link \
    --name MyVpcLink \
    --subnet-ids subnet-aaaa subnet-bbbb \
    --security-group-ids sg1234 sg5678

출력:

{
    "CreatedDate": "2020-04-07T00:11:46Z",
    "Name": "MyVpcLink",
    "SecurityGroupIds": [
        "sg1234",
        "sg5678"
    ],
    "SubnetIds": [
        "subnet-aaaa",
        "subnet-bbbb"
    ],
    "Tags": {},
    "VpcLinkId": "abcd123",
    "VpcLinkStatus": "PENDING",
    "VpcLinkStatusMessage": "VPC link is provisioning ENIs",
    "VpcLinkVersion": "V2"
}

자세한 내용은 Amazon VPC Gateway 개발자 안내서의 APIs HTTP용 Word 링크 작업을 참조하세요. API

API에 대한 액세스 로깅을 비활성화하려면

다음 delete-access-log-settings 예제에서는 API $default 단계의 액세스 로그 설정을 삭제합니다. 단계에 대한 액세스 로깅을 비활성화하려면 해당 액세스 로그 설정을 삭제합니다.

aws apigatewayv2 delete-access-log-settings \
    --api-id a1b2c3d4 \
    --stage-name '$default'

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon HTTP Gateway 개발자 안내서의 API에 대한 로깅 구성을 참조하세요. API

API 매핑을 삭제하려면

다음 delete-api-mapping 예제에서는 api.example.com 사용자 지정 도메인 이름에 대한 API 매핑을 삭제합니다.

aws apigatewayv2 delete-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

API를 삭제하려면

다음 delete-api 예제에서는 API를 삭제합니다.

aws apigatewayv2 delete-api \
    --api-id a1b2c3d4

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP 작업 및 WebSocket APIsWord 작업을 참조하세요. API

권한 부여자를 삭제하려면

다음 delete-authorizer 예제에서는 권한 부여자를 삭제합니다.

aws apigatewayv2 delete-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP JWT 권한 부여자를 사용하여 Word에 대한 액세스 제어를 참조하세요. API

CORS Word에 대한 API HTTP 구성을 삭제하려면

다음 delete-cors-configuration 예제에서는 CORS 구성을 삭제하여 API HTTP for a CORS를 비활성화합니다.

aws apigatewayv2 delete-cors-configuration \
    --api-id a1b2c3d4

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon CORS Gateway 개발자 안내서의 API HTTP for a Word 구성을 참조하세요. API

배포를 삭제하려면

다음 delete-deployment 예제에서는 API 배포를 삭제합니다.

aws apigatewayv2 delete-deployment \
    --api-id a1b2c3d4 \
    --deployment-id a1b2c3

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word 배포를 참조하세요. API

사용자 지정 도메인 이름을 삭제하려면

다음 delete-domain-name 예제에서는 사용자 지정 도메인 이름을 삭제합니다.

aws apigatewayv2 delete-domain-name \
    --domain-name api.example.com

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

통합을 삭제하려면

다음 delete-integration 예제에서는 API 통합을 삭제합니다.

aws apigatewayv2 delete-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP용 통합 구성 및 WebSocket API Word통합 설정을 참조하세요. API

라우팅 설정을 삭제하려면

다음 delete-route-settings 예제에서는 지정된 경로에 대한 경로 설정을 삭제합니다.

aws apigatewayv2 delete-route-settings \
    --api-id a1b2c3d4 \
    --stage-name dev \
    --route-key 'GET /pets'

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word 경로 작업을 참조하세요. API

라우팅을 삭제하려면

다음 delete-route 예제에서는 API 라우팅을 삭제합니다.

aws apigatewayv2 delete-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word 경로 작업을 참조하세요. API

스테이지를 삭제하려면

다음 delete-stage 예제에서는 API의 test 단계를 삭제합니다.

aws apigatewayv2 delete-stage \
    --api-id a1b2c3d4 \
    --stage-name test

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word에 대한 단계 작업을 참조하세요. API

VPC Word에 대한 API HTTP 링크를 삭제하려면

다음 delete-vpc-link 예제에서는 VPC 링크를 삭제합니다.

aws apigatewayv2 delete-vpc-link \
    --vpc-link-id abcd123

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon VPC Gateway 개발자 안내서의 APIs HTTP용 Word 링크 작업을 참조하세요. API

HTTPAPI의 OpenAPI 정의를 내보내려면

다음 export-api 예제에서는 이름이 인 API 단계의 OpenAPI 3.0 정의를 이름이 prod인 YAML 파일로 내보냅니다stage-definition.yaml. 내보낸 정의 파일에는 기본적으로 API Gateway 확장이 포함됩니다.

aws apigatewayv2 export-api \
    --api-id a1b2c3d4 \
    --output-type YAML \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon API HTTP Gateway 개발자 안내서의 API Gateway에서 Word Word 내보내기를 참조하세요. API

사용자 지정 도메인 이름의 API 매핑에 대한 정보를 가져오려면

다음 get-api-mapping 예제에서는 api.example.com 사용자 지정 도메인 이름에 대한 API 매핑에 대한 정보를 보여줍니다.

aws apigatewayv2 get-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com

출력:

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "a1b2c3d5",
    "ApiMappingKey": "myTestApi"
    "Stage": "test"
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

사용자 지정 도메인 이름에 대한 API 매핑을 가져오려면

다음 get-api-mappings 예제에서는 api.example.com 사용자 지정 도메인 이름에 대한 모든 API 매핑 목록을 표시합니다.

aws apigatewayv2 get-api-mappings \
    --domain-name api.example.com

출력:

{
    "Items": [
        {
            "ApiId": "a1b2c3d4",
            "ApiMappingId": "a1b2c3d5",
            "ApiMappingKey": "myTestApi"
            "Stage": "test"
        },
        {
            "ApiId": "a5b6c7d8",
            "ApiMappingId": "a1b2c3d6",
            "ApiMappingKey": "myDevApi"
            "Stage": "dev"
        },
    ]
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

API에 대한 정보를 검색하려면

다음 get-api 예제에서는 API에 대한 정보를 보여줍니다.

aws apigatewayv2 get-api \
    --api-id a1b2c3d4

출력:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CreatedDate": "2020-03-28T00:32:37Z",
    "Name": "my-api",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {
        "department": "finance"
    }
}

APIs 목록을 검색하려면

다음 get-apis 예제에서는 현재 사용자의 모든 APIs를 나열합니다.

aws apigatewayv2 get-apis

출력:

{
    "Items": [
        {
            "ApiEndpoint": "wss://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
            "ApiId": "a1b2c3d4",
            "ApiKeySelectionExpression": "$request.header.x-api-key",
            "CreatedDate": "2020-04-07T20:21:59Z",
            "Name": "my-websocket-api",
            "ProtocolType": "WEBSOCKET",
            "RouteSelectionExpression": "$request.body.message",
            "Tags": {}
        },
        {
            "ApiEndpoint": "https://a1b2c3d5.execute-api.us-west-2.amazonaws.com",
            "ApiId": "a1b2c3d5",
            "ApiKeySelectionExpression": "$request.header.x-api-key",
            "CreatedDate": "2020-04-07T20:23:50Z",
            "Name": "my-http-api",
            "ProtocolType": "HTTP",
            "RouteSelectionExpression": "$request.method $request.path",
            "Tags": {}
        }
    ]
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP 작업 및 WebSocket APIsWord 작업을 참조하세요. API

권한 부여자에 대한 정보를 검색하려면

다음 get-authorizer 예제에서는 권한 부여자에 대한 정보를 보여줍니다.

aws apigatewayv2 get-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3

출력:

{
    "AuthorizerId": "a1b2c3",
    "AuthorizerType": "JWT",
    "IdentitySource": [
        "$request.header.Authorization"
    ],
    "JwtConfiguration": {
        "Audience": [
            "123456abc"
        ],
        "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
    },
    "Name": "my-jwt-authorizer"
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP JWT 권한 부여자를 사용하여 Word에 대한 액세스 제어를 참조하세요. API

API에 대한 권한 부여자 목록을 검색하려면

다음 get-authorizers 예제에서는 API의 모든 권한 부여자 목록을 표시합니다.

aws apigatewayv2 get-authorizers \
    --api-id a1b2c3d4

출력:

{
    "Items": [
        {
            "AuthorizerId": "a1b2c3",
            "AuthorizerType": "JWT",
            "IdentitySource": [
                "$request.header.Authorization"
            ],
            "JwtConfiguration": {
                "Audience": [
                    "123456abc"
                ],
                "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
            },
            "Name": "my-jwt-authorizer"
        },
        {
            "AuthorizerId": "a1b2c4",
            "AuthorizerType": "JWT",
            "IdentitySource": [
                "$request.header.Authorization"
            ],
            "JwtConfiguration": {
                "Audience": [
                    "6789abcde"
                ],
                "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc234"
            },
            "Name": "new-jwt-authorizer"
        }
    ]
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP JWT 권한 부여자를 사용하여 Word에 대한 액세스 제어를 참조하세요. API

배포에 대한 정보를 검색하려면

다음 get-deployment 예제에서는 배포에 대한 정보를 보여줍니다.

aws apigatewayv2 get-deployment \
    --api-id a1b2c3d4 \
    --deployment-id abcdef

출력:

{
    "AutoDeployed": true,
    "CreatedDate": "2020-04-07T23:58:40Z",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Automatic deployment triggered by changes to the Api configuration"
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word 배포를 참조하세요. API

배포 목록을 검색하려면

다음 get-deployments 예제에서는 API의 모든 배포 목록을 표시합니다.

aws apigatewayv2 get-deployments \
    --api-id a1b2c3d4

출력:

{
    "Items": [
        {
            "AutoDeployed": true,
            "CreatedDate": "2020-04-07T23:58:40Z",
            "DeploymentId": "abcdef",
            "DeploymentStatus": "DEPLOYED",
            "Description": "Automatic deployment triggered by changes to the Api configuration"
        },
        {
            "AutoDeployed": true,
            "CreatedDate": "2020-04-06T00:33:00Z",
            "DeploymentId": "bcdefg",
            "DeploymentStatus": "DEPLOYED",
            "Description": "Automatic deployment triggered by changes to the Api configuration"
        }
    ]
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word 배포를 참조하세요. API

사용자 지정 도메인 이름에 대한 정보를 검색하려면

다음 get-domain-name 예제에서는 사용자 지정 도메인 이름에 대한 정보를 표시합니다.

aws apigatewayv2 get-domain-name \
    --domain-name api.example.com

출력:

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "api.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "123456789111",
            "SecurityPolicy": "TLS_1_2",
            "DomainNameStatus": "AVAILABLE"
        }
    ],
    "Tags": {}
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

사용자 지정 도메인 이름 목록을 검색하려면

다음 get-domain-names 예제에서는 현재 사용자의 모든 사용자 지정 도메인 이름 목록을 표시합니다.

aws apigatewayv2 get-domain-names

출력:

{
    "Items": [
        {
            "ApiMappingSelectionExpression": "$request.basepath",
            "DomainName": "api.example.com",
            "DomainNameConfigurations": [
                {
                    "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com",
                    "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
                    "EndpointType": "REGIONAL",
                    "HostedZoneId": "123456789111",
                    "SecurityPolicy": "TLS_1_2",
                    "DomainNameStatus": "AVAILABLE"
                }
            ]
        },
        {
            "ApiMappingSelectionExpression": "$request.basepath",
            "DomainName": "newApi.example.com",
            "DomainNameConfigurations": [
                {
                    "ApiGatewayDomainName": "d-5678.execute-api.us-west-2.amazonaws.com",
                    "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
                    "EndpointType": "REGIONAL",
                    "HostedZoneId": "123456789222",
                    "SecurityPolicy": "TLS_1_2",
                    "DomainNameStatus": "AVAILABLE"
                }
            ]
        }
    ]
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

통합에 대한 정보를 검색하려면

다음 get-integration 예제에서는 통합에 대한 정보를 보여줍니다.

aws apigatewayv2 get-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3

출력:

{
    "ApiGatewayManaged": true,
    "ConnectionType": "INTERNET",
    "IntegrationId": "a1b2c3",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:lambda:us-west-2:12356789012:function:hello12",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 30000
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP용 통합 구성 및 WebSocket API Word통합 설정을 참조하세요. API

통합 목록을 검색하려면

다음 get-integrations 예제에서는 API의 모든 통합 목록을 표시합니다.

aws apigatewayv2 get-integrations \
    --api-id a1b2c3d4

출력:

{
    "Items": [
        {
            "ApiGatewayManaged": true,
            "ConnectionType": "INTERNET",
            "IntegrationId": "a1b2c3",
            "IntegrationMethod": "POST",
            "IntegrationType": "AWS_PROXY",
            "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
            "PayloadFormatVersion": "2.0",
            "TimeoutInMillis": 30000
        },
        {
            "ConnectionType": "INTERNET",
            "IntegrationId": "a1b2c4",
            "IntegrationMethod": "ANY",
            "IntegrationType": "HTTP_PROXY",
            "IntegrationUri": "https://www.example.com",
            "PayloadFormatVersion": "1.0",
            "TimeoutInMillis": 30000
        }
    ]
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP용 통합 구성 및 WebSocket API Word통합 설정을 참조하세요. API

경로에 대한 정보를 검색하려면

다음 get-route 예제에서는 라우팅에 대한 정보를 보여줍니다.

aws apigatewayv2 get-route \
    --api-id a1b2c3d4 \
    --route-id 72jz1wk

출력:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "72jz1wk",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c3"
}

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word용 경로 작업을 참조하세요. API

경로 목록을 검색하려면

다음 get-routes 예제에서는 API의 모든 경로 목록을 표시합니다.

aws apigatewayv2 get-routes \
    --api-id a1b2c3d4

출력:

{
    "Items": [
        {
            "ApiKeyRequired": false,
            "AuthorizationType": "NONE",
            "RouteId": "72jz1wk",
            "RouteKey": "ANY /admin",
            "Target": "integrations/a1b2c3"
        },
        {
            "ApiGatewayManaged": true,
            "ApiKeyRequired": false,
            "AuthorizationType": "NONE",
            "RouteId": "go65gqi",
            "RouteKey": "$default",
            "Target": "integrations/a1b2c4"
        }
    ]
}

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word Word 경로 작업을 참조하세요. API

단계에 대한 정보를 검색하려면

다음 get-stage 예제에서는 API의 prod 단계에 대한 정보를 보여줍니다.

aws apigatewayv2 get-stage \
    --api-id a1b2c3d4 \
    --stage-name prod

출력:

{
    "CreatedDate": "2020-04-08T00:36:05Z",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "DeploymentId": "x1zwyv",
    "LastUpdatedDate": "2020-04-08T00:36:13Z",
    "RouteSettings": {},
    "StageName": "prod",
    "StageVariables": {
        "function": "my-prod-function"
    },
    "Tags": {}
}

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word에 대한 단계 작업을 참조하세요. API

스테이지 목록을 검색하려면

다음 get-stages 예제에서는 API의 모든 단계를 나열합니다.

aws apigatewayv2 get-stages \
    --api-id a1b2c3d4

출력:

{
    "Items": [
        {
            "ApiGatewayManaged": true,
            "AutoDeploy": true,
            "CreatedDate": "2020-04-08T00:08:44Z",
            "DefaultRouteSettings": {
                "DetailedMetricsEnabled": false
            },
            "DeploymentId": "dty748",
            "LastDeploymentStatusMessage": "Successfully deployed stage with deployment ID 'dty748'",
            "LastUpdatedDate": "2020-04-08T00:09:49Z",
            "RouteSettings": {},
            "StageName": "$default",
            "StageVariables": {},
            "Tags": {}
        },
        {
            "AutoDeploy": true,
            "CreatedDate": "2020-04-08T00:35:06Z",
            "DefaultRouteSettings": {
                "DetailedMetricsEnabled": false
            },
            "LastUpdatedDate": "2020-04-08T00:35:48Z",
            "RouteSettings": {},
            "StageName": "dev",
            "StageVariables": {
                "function": "my-dev-function"
            },
            "Tags": {}
        },
        {
            "CreatedDate": "2020-04-08T00:36:05Z",
            "DefaultRouteSettings": {
                "DetailedMetricsEnabled": false
            },
            "DeploymentId": "x1zwyv",
            "LastUpdatedDate": "2020-04-08T00:36:13Z",
            "RouteSettings": {},
            "StageName": "prod",
            "StageVariables": {
                "function": "my-prod-function"
            },
            "Tags": {}
        }
    ]
}

자세한 내용은 Amazon APIs HTTP Gateway 개발자 안내서의 Word 단계 작업을 참조하세요. API

리소스의 태그 목록을 검색하려면

다음 get-tags 예제에서는 API의 태그를 모두 나열합니다.

aws apigatewayv2 get-tags \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4

출력:

{
    "Tags": {
        "owner": "dev-team",
        "environment": "prod"
    }
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway 리소스 태그 지정을 참조하세요. API

VPC 링크에 대한 정보를 검색하려면

다음 get-vpc-link 예제에서는 VPC 링크에 대한 정보를 보여줍니다.

aws apigatewayv2 get-vpc-link \
    --vpc-link-id abcd123

출력:

{
    "CreatedDate": "2020-04-07T00:27:47Z",
    "Name": "MyVpcLink",
    "SecurityGroupIds": [
        "sg1234",
        "sg5678"
    ],
    "SubnetIds": [
        "subnet-aaaa",
        "subnet-bbbb"
    ],
    "Tags": {},
    "VpcLinkId": "abcd123",
    "VpcLinkStatus": "AVAILABLE",
    "VpcLinkStatusMessage": "VPC link is ready to route traffic",
    "VpcLinkVersion": "V2"
}

자세한 내용은 Amazon VPC Gateway 개발자 안내서의 APIs HTTP용 Word 링크 작업을 참조하세요. API

VPC 링크 목록을 검색하려면

다음 get-vpc-links 예제에서는 현재 사용자의 모든 VPC 링크 목록을 표시합니다.

aws apigatewayv2 get-vpc-links

출력:

{
    "Items": [
        {
            "CreatedDate": "2020-04-07T00:27:47Z",
            "Name": "MyVpcLink",
            "SecurityGroupIds": [
                "sg1234",
                "sg5678"
            ],
            "SubnetIds": [
                "subnet-aaaa",
                "subnet-bbbb"
            ],
            "Tags": {},
            "VpcLinkId": "abcd123",
            "VpcLinkStatus": "AVAILABLE",
            "VpcLinkStatusMessage": "VPC link is ready to route traffic",
            "VpcLinkVersion": "V2"
        }
        {
            "CreatedDate": "2020-04-07T00:27:47Z",
            "Name": "MyOtherVpcLink",
            "SecurityGroupIds": [
                "sg1234",
                "sg5678"
            ],
            "SubnetIds": [
                "subnet-aaaa",
                "subnet-bbbb"
            ],
            "Tags": {},
            "VpcLinkId": "abcd456",
            "VpcLinkStatus": "AVAILABLE",
            "VpcLinkStatusMessage": "VPC link is ready to route traffic",
            "VpcLinkVersion": "V2"
        }
    ]
}

자세한 내용은 Amazon VPC Gateway 개발자 안내서의 HTTP용 APIs 링크 작업을 참조하세요. API

HTTPAPI를 가져오려면

다음 import-api 예제에서는 이름이 인 OpenAPI 3.0 정의 파일에서 HTTP API를 생성합니다api-definition.yaml.

aws apigatewayv2 import-api \
    --body file://api-definition.yaml

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

출력:

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

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP에 대한 OpenAPI 정의 작업을 참조하세요. API

HTTP API를 다시 가져오려면

다음 reimport-api 예제에서는에 지정된 OpenAPI 3.0 정의를 사용하도록 기존 HTTP API를 업데이트합니다api-definition.yaml.

aws apigatewayv2 reimport-api \
    --body file://api-definition.yaml \
    --api-id a1b2c3d4

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:12356789012:function:hello/invocations
                connectionType: INTERNET

출력:

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

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP에 대한 OpenAPI 정의 작업을 참조하세요. API

리소스에 태그를 지정하려면

다음 tag-resource 예제에서는 키 이름과 Department 값이 인 태그를 지정된 APIAccounting에 추가합니다.

aws apigatewayv2 tag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tags Department=Accounting

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway 리소스 태그 지정을 참조하세요. API

리소스에서 태그를 제거하려면

다음 untag-resource 예제에서는 키 이름이 Project 이고 지정된 APIOwner에서 태그를 제거합니다.

aws apigatewayv2 untag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tag-keys Project Owner

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway 리소스 태그 지정을 참조하세요. API

API 매핑을 업데이트하려면

다음 update-api-mapping 예제에서는 사용자 지정 도메인 이름에 대한 API 매핑을 변경합니다. 따라서 지정된 URL 및 단계의 사용자 지정 도메인 이름을 사용하는 기본 API는가 됩니다https://api.example.com/dev.

aws apigatewayv2 update-api-mapping \
    --api-id a1b2c3d4 \
    --stage dev \
    --domain-name api.example.com \
    --api-mapping-id 0qzs2sy7bh \
    --api-mapping-key dev

출력:

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "dev"
    "Stage": "dev"
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

CORS for a API HTTP를 활성화하려면

다음 update-api 예제에서는 지정된 API's CORS 구성을 업데이트하여의 요청을 허용합니다https://www.example.com.

aws apigatewayv2 update-api \
    --api-id a1b2c3d4 \
    --cors-configuration AllowOrigins=https://www.example.com

출력:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CorsConfiguration": {
        "AllowCredentials": false,
        "AllowHeaders": [
            "header1",
            "header2"
        ],
        "AllowMethods": [
            "GET",
            "OPTIONS"
        ],
        "AllowOrigins": [
            "https://www.example.com"
        ]
    },
    "CreatedDate": "2020-04-08T18:39:37+00:00",
    "Name": "my-http-api",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {},
    "Version": "v1.0"
}

자세한 내용은 Amazon CORS Gateway 개발자 안내서의 API HTTP for a Word 구성을 참조하세요. API

권한 부여자를 업데이트하려면

다음 update-authorizer 예제에서는 JWT 권한 부여자의 자격 증명 소스를 라는 헤더로 변경합니다Authorization.

aws apigatewayv2 update-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3 \
    --identity-source '$request.header.Authorization'

출력:

{
    "AuthorizerId": "a1b2c3",
    "AuthorizerType": "JWT",
    "IdentitySource": [
        "$request.header.Authorization"
    ],
    "JwtConfiguration": {
        "Audience": [
            "123456abc"
        ],
        "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
    },
    "Name": "my-jwt-authorizer"
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP JWT 권한 부여자를 사용하여 Word에 대한 액세스 제어를 참조하세요. API

배포의 설명을 변경하려면

다음 update-deployment 예제에서는 배포의 설명을 업데이트합니다.

aws apigatewayv2 update-deployment \
    --api-id a1b2c3d4 \
    --deployment-id abcdef \
    --description 'Manual deployment to fix integration test failures.'

출력:

{
    "AutoDeployed": false,
    "CreatedDate": "2020-02-05T16:21:48+00:00",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Manual deployment to fix integration test failures."
}

자세한 내용은 Amazon API HTTP Gateway 개발자 안내서의 API Gateway에서 Word Word 개발을 참조하세요. API

사용자 지정 도메인 이름을 업데이트하려면

다음 update-domain-name 예제에서는 api.example.com 사용자 지정 도메인 이름에 대한 새 ACM 인증서를 지정합니다.

aws apigatewayv2 update-domain-name \
    --domain-name api.example.com \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

출력:

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "regional.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "123456789111",
            "SecurityPolicy": "TLS_1_2",
            "DomainNameStatus": "AVAILABLE"
        }
    ]
}

자세한 내용은 Amazon API Gateway 개발자 안내서의 Word Gateway에서 리전 사용자 지정 도메인 이름 설정을 참조하세요. API

Lambda 통합을 업데이트하려면

다음 update-integration 예제에서는 지정된 AWS Lambda 함수를 사용하도록 기존 Lambda 통합을 업데이트합니다.

aws apigatewayv2 update-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3 \
    --integration-uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations

출력:

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "a1b2c3",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 5000
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP용 통합 구성 및 WebSocket API Word통합 설정을 참조하세요. API

예제 1: 라우팅 통합 업데이트

다음 update-route 예제에서는 지정된 경로의 통합을 업데이트합니다.

aws apigatewayv2 update-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3 \
    --target integrations/a1b2c6

출력:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "a1b2c3",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c6"
}

예제 2: 경로에 권한 부여자를 추가하려면

다음 update-route 예제에서는 지정된 경로를 업데이트하여 JWT 권한 부여자를 사용합니다.

aws apigatewayv2 update-route \
    --api-id a1b2c3d4  \
    --route-id a1b2c3  \
    --authorization-type JWT \
    --authorizer-id a1b2c5 \
    --authorization-scopes user.id user.email

출력:

{
    "ApiKeyRequired": false,
    "AuthorizationScopes": [
        "user.id",
        "user.email"
    ],
    "AuthorizationType": "JWT",
    "AuthorizerId": "a1b2c5",
    "OperationName": "GET HTTP",
    "RequestParameters": {},
    "RouteId": "a1b2c3",
    "RouteKey": "GET /pets",
    "Target": "integrations/a1b2c6"
}

자세한 내용은 Amazon APIs Gateway 개발자 안내서의 HTTP JWT 권한 부여자를 사용하여 Word Word에 대한 액세스 제어를 참조하세요. API

사용자 지정 제한 구성

다음 update-stage 예제에서는 API의 지정된 단계 및 경로에 대한 사용자 지정 제한을 구성합니다.

aws apigatewayv2 update-stage \
    --api-id a1b2c3d4 \
    --stage-name dev \
    --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}'

출력:

{
    "CreatedDate": "2020-04-05T16:21:16+00:00",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "DeploymentId": "shktxb",
    "LastUpdatedDate": "2020-04-08T22:23:17+00:00",
    "RouteSettings": {
        "GET /pets": {
            "ThrottlingBurstLimit": 100,
            "ThrottlingRateLimit": 2000.0
        }
    },
    "StageName": "dev",
    "StageVariables": {},
    "Tags": {}
}

자세한 내용은 Amazon API HTTP Gateway 개발자 안내서의 Word 보호를 참조하세요. API

VPC 링크를 업데이트하려면

다음 update-vpc-link 예제에서는 VPC 링크의 이름을 업데이트합니다. VPC 링크를 생성한 후에는 해당 보안 그룹 또는 서브넷을 변경할 수 없습니다.

aws apigatewayv2 update-vpc-link \
    --vpc-link-id abcd123 \
    --name MyUpdatedVpcLink

출력:

{
    "CreatedDate": "2020-04-07T00:27:47Z",
    "Name": "MyUpdatedVpcLink",
    "SecurityGroupIds": [
        "sg1234",
        "sg5678"
    ],
    "SubnetIds": [
        "subnet-aaaa",
        "subnet-bbbb"
    ],
    "Tags": {},
    "VpcLinkId": "abcd123",
    "VpcLinkStatus": "AVAILABLE",
    "VpcLinkStatusMessage": "VPC link is ready to route traffic",
    "VpcLinkVersion": "V2"
}

자세한 내용은 Amazon VPC Gateway 개발자 안내서의 APIs HTTP용 Word 링크 작업을 참조하세요. API