Application Service

• 1: API Gateway
• 1.1: CLIs
• 1.1.1: Approve PrivateLink Endpoint
• 1.1.1.1: 1.3
• 1.1.1.2: 1.2
• 1.1.2: Connect PrivateLink Endpoint
• 1.1.2.1: 1.3
• 1.1.2.2: 1.2
• 1.1.3: Create AccessControl
• 1.1.3.1: 1.3
• 1.1.3.2: 1.2
• 1.1.3.3: 1.1
• 1.1.3.4: 1.0
• 1.1.4: Create Api
• 1.1.4.1: 1.3
• 1.1.4.2: 1.2
• 1.1.4.3: 1.1
• 1.1.4.4: 1.0
• 1.1.5: Create Api Deployment
• 1.1.5.1: 1.3
• 1.1.5.2: 1.2
• 1.1.5.3: 1.1
• 1.1.5.4: 1.0
• 1.1.6: Create Api Key
• 1.1.6.1: 1.3
• 1.1.6.2: 1.2
• 1.1.6.3: 1.1
• 1.1.7: Create Auth
• 1.1.7.1: 1.3
• 1.1.7.2: 1.2
• 1.1.7.3: 1.1
• 1.1.7.4: 1.0
• 1.1.8: Create Method
• 1.1.8.1: 1.3
• 1.1.8.2: 1.2
• 1.1.8.3: 1.1
• 1.1.8.4: 1.0
• 1.1.9: Create PrivateLink Endpoint
• 1.1.9.1: 1.3
• 1.1.9.2: 1.2
• 1.1.10: Create Resource
• 1.1.10.1: 1.3
• 1.1.10.2: 1.2
• 1.1.10.3: 1.1
• 1.1.10.4: 1.0
• 1.1.11: Create Stage
• 1.1.11.1: 1.3
• 1.1.11.2: 1.2
• 1.1.11.3: 1.1
• 1.1.11.4: 1.0
• 1.1.12: Create Usage Plans
• 1.1.12.1: 1.3
• 1.1.12.2: 1.2
• 1.1.12.3: 1.1
• 1.1.13: Delete Access Control
• 1.1.13.1: 1.3
• 1.1.13.2: 1.2
• 1.1.13.3: 1.1
• 1.1.13.4: 1.0
• 1.1.14: Delete an API Key
• 1.1.14.1: 1.3
• 1.1.14.2: 1.2
• 1.1.14.3: 1.1
• 1.1.15: Delete Api
• 1.1.15.1: 1.3
• 1.1.15.2: 1.2
• 1.1.15.3: 1.1
• 1.1.15.4: 1.0
• 1.1.16: Delete Auth
• 1.1.16.1: 1.3
• 1.1.16.2: 1.2
• 1.1.16.3: 1.1
• 1.1.16.4: 1.0
• 1.1.17: Delete Method
• 1.1.17.1: 1.3
• 1.1.17.2: 1.2
• 1.1.17.3: 1.1
• 1.1.17.4: 1.0
• 1.1.18: Delete PrivateLink Endpoint
• 1.1.18.1: 1.3
• 1.1.18.2: 1.2
• 1.1.19: Delete Resource
• 1.1.19.1: 1.3
• 1.1.19.2: 1.2
• 1.1.19.3: 1.1
• 1.1.19.4: 1.0
• 1.1.20: Delete Resource Policy
• 1.1.20.1: 1.3
• 1.1.21: Delete Stage
• 1.1.21.1: 1.3
• 1.1.21.2: 1.2
• 1.1.21.3: 1.1
• 1.1.21.4: 1.0
• 1.1.22: Delete Usage Plan
• 1.1.22.1: 1.3
• 1.1.22.2: 1.2
• 1.1.22.3: 1.1
• 1.1.23: List AccessControls
• 1.1.23.1: 1.3
• 1.1.23.2: 1.2
• 1.1.23.3: 1.1
• 1.1.23.4: 1.0
• 1.1.24: List Api Deployments
• 1.1.24.1: 1.3
• 1.1.24.2: 1.2
• 1.1.24.3: 1.1
• 1.1.24.4: 1.0
• 1.1.25: List Api Keys
• 1.1.25.1: 1.3
• 1.1.25.2: 1.2
• 1.1.25.3: 1.1
• 1.1.26: List Apis
• 1.1.26.1: 1.3
• 1.1.26.2: 1.2
• 1.1.26.3: 1.1
• 1.1.26.4: 1.0
• 1.1.27: List Auths
• 1.1.27.1: 1.3
• 1.1.27.2: 1.2
• 1.1.27.3: 1.1
• 1.1.27.4: 1.0
• 1.1.28: List Connected PrivateLink Endpoints
• 1.1.28.1: 1.3
• 1.1.28.2: 1.2
• 1.1.29: List Methods
• 1.1.29.1: 1.3
• 1.1.29.2: 1.2
• 1.1.29.3: 1.1
• 1.1.29.4: 1.0
• 1.1.30: List PrivateLink Endpoints
• 1.1.30.1: 1.3
• 1.1.30.2: 1.2
• 1.1.31: List Reports
• 1.1.31.1: 1.3
• 1.1.31.2: 1.2
• 1.1.31.3: 1.1
• 1.1.32: List Resources
• 1.1.32.1: 1.3
• 1.1.32.2: 1.2
• 1.1.32.3: 1.1
• 1.1.32.4: 1.0
• 1.1.33: List Stages
• 1.1.33.1: 1.3
• 1.1.33.2: 1.2
• 1.1.33.3: 1.1
• 1.1.33.4: 1.0
• 1.1.34: List Usage Plans
• 1.1.34.1: 1.3
• 1.1.34.2: 1.2
• 1.1.34.3: 1.1
• 1.1.35: Request PrivateLink Endpoint
• 1.1.35.1: 1.3
• 1.1.35.2: 1.2
• 1.1.36: Set Access Control
• 1.1.36.1: 1.3
• 1.1.36.2: 1.2
• 1.1.36.3: 1.1
• 1.1.36.4: 1.0
• 1.1.37: Set Api Description
• 1.1.37.1: 1.3
• 1.1.37.2: 1.2
• 1.1.37.3: 1.1
• 1.1.37.4: 1.0
• 1.1.38: Set API Key Description
• 1.1.38.1: 1.3
• 1.1.38.2: 1.2
• 1.1.38.3: 1.1
• 1.1.39: Set Auth
• 1.1.39.1: 1.3
• 1.1.39.2: 1.2
• 1.1.39.3: 1.1
• 1.1.39.4: 1.0
• 1.1.40: Set Method
• 1.1.40.1: 1.3
• 1.1.40.2: 1.2
• 1.1.40.3: 1.1
• 1.1.40.4: 1.0
• 1.1.41: Set PrivateLink Endpoint
• 1.1.41.1: 1.3
• 1.1.41.2: 1.2
• 1.1.42: Set Resource Policy
• 1.1.42.1: 1.3
• 1.1.43: Set Stage Active Deployment
• 1.1.43.1: 1.3
• 1.1.43.2: 1.2
• 1.1.43.3: 1.1
• 1.1.43.4: 1.0
• 1.1.44: Set Stage Configuration
• 1.1.44.1: 1.3
• 1.1.44.2: 1.2
• 1.1.44.3: 1.1
• 1.1.44.4: 1.0
• 1.1.45: Set Usage Plan Description
• 1.1.45.1: 1.3
• 1.1.45.2: 1.2
• 1.1.45.3: 1.1
• 1.1.46: Set Usage Plan Quota
• 1.1.46.1: 1.3
• 1.1.46.2: 1.2
• 1.1.46.3: 1.1
• 1.1.47: Show Access Control
• 1.1.47.1: 1.3
• 1.1.47.2: 1.2
• 1.1.47.3: 1.1
• 1.1.47.4: 1.0
• 1.1.48: Show Api
• 1.1.48.1: 1.3
• 1.1.48.2: 1.2
• 1.1.48.3: 1.1
• 1.1.48.4: 1.0
• 1.1.49: Show Auth
• 1.1.49.1: 1.3
• 1.1.49.2: 1.2
• 1.1.49.3: 1.1
• 1.1.49.4: 1.0
• 1.1.50: Show Method
• 1.1.50.1: 1.3
• 1.1.50.2: 1.2
• 1.1.50.3: 1.1
• 1.1.50.4: 1.0
• 1.1.51: Show PrivateLink Endpoint
• 1.1.51.1: 1.3
• 1.1.51.2: 1.2
• 1.1.52: Show Resource
• 1.1.52.1: 1.3
• 1.1.52.2: 1.2
• 1.1.52.3: 1.1
• 1.1.52.4: 1.0
• 1.1.53: Show Resource Policy
• 1.1.53.1: 1.3
• 1.1.54: Show Stage
• 1.1.54.1: 1.3
• 1.1.54.2: 1.2
• 1.1.54.3: 1.1
• 1.1.54.4: 1.0
• 1.1.55: Show Usage Plan
• 1.1.55.1: 1.3
• 1.1.55.2: 1.2
• 1.1.55.3: 1.1
• 2: Queue Service
• 2.1: CLIs
• 2.1.1: Check Queue Name Duplication
• 2.1.1.1: 1.2
• 2.1.1.2: 1.1
• 2.1.1.3: 1.0
• 2.1.2: Create Queue
• 2.1.2.1: 1.2
• 2.1.2.2: 1.1
• 2.1.2.3: 1.0
• 2.1.3: Delete Acl
• 2.1.3.1: 1.2
• 2.1.3.2: 1.1
• 2.1.3.3: 1.0
• 2.1.4: Delete Queue
• 2.1.4.1: 1.2
• 2.1.4.2: 1.1
• 2.1.4.3: 1.0
• 2.1.5: Get Queue Attributes
• 2.1.5.1: 1.2
• 2.1.5.2: 1.1
• 2.1.6: List Queue
• 2.1.6.1: 1.2
• 2.1.6.2: 1.1
• 2.1.6.3: 1.0
• 2.1.7: Set Acl
• 2.1.7.1: 1.2
• 2.1.7.2: 1.1
• 2.1.7.3: 1.0
• 2.1.8: Show Queue
• 2.1.8.1: 1.2
• 2.1.8.2: 1.1
• 2.1.8.3: 1.0
• 2.1.9: Update Queue Config
• 2.1.9.1: 1.2
• 2.1.9.2: 1.1
• 2.1.9.3: 1.0
• 2.1.10: Update Queue Deduplication
• 2.1.10.1: 1.2
• 2.1.11: Update Queue Deduplication Scope
• 2.1.11.1: 1.2
• 2.1.12: Update Queue Description
• 2.1.12.1: 1.2
• 2.1.12.2: 1.1
• 2.1.12.3: 1.0

1 - API Gateway

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of API Gateway service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

CLI Version History

1.3

The Resource‑Policy feature has been added.
The response of the List Resources command has been changed.
The response of the Get Resource command has been changed.
The response of the List Methods command has been changed.
The request of the Create Method command has been changed.
The request of the Set Method command has been changed.
The response of the Get Method command has been changed.
The response of the List Stages command has been changed.
The response of the Get Stage command has been changed.

CLI Changes

• [New] application-apigateway resource policy show --api_id <value> - Show Resource Policy command has been added.
• [New] application-apigateway resource policy set --api_id <value> --version <value> --statement <value> - Set Resource Policy command has been added.
• [New] application-apigateway resource policy delete --api_id <value> - Delete Resource Policy command has been added.
• [Updated] application-apigateway resource list --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway resource show --resource_id <value> --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway method list --resource_id <value> --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - The following field has been added to the request.
  • iam_enabled
• [Updated] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - The following field has been added to the request.
  • iam_enabled
• [Updated] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway stage list --api_id <value> - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] application-apigateway stage list --api_id <value> - The following field has been removed to the response..
  • api_key_required
• [Updated] application-apigateway stage list --api_id <value> - The following field has been changed to the response.
  • Before "methods": [{"type": GET", "api_key_required": true}]
  • After "methods": [{"type": GET", "api_key_required": true, "iam_enabled": true}]
• [Updated] application-apigateway stage show --api_id <value> --stage_name <value> - The following field has been removed to the response.
  • api_key_required

1.2

The PrivateLink feature has been added.
The response of the List APIs command has been changed.
The request of the Create APi command has been changed.
The response of the Get APi command has been changed.
The response of the List Resources command has been changed.
The response of the Get Resource command has been changed.
The response of the List Methods command has been changed.
The request of the Create Method command has been changed.
The request of the Set Method command has been changed.
The response of the Get Method command has been changed.

CLI Changes

• [New] application-apigateway api connected endpoint list --api_id <value> - List Connected PrivateLink Endpoints command has been added.
• [New] application-apigateway privatelink endpoint list - List PrivateLink Endpoints command has been added.
• [New] application-apigateway privatelink endpoint create --privatelink_service_id <value> --name <value> - Create PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint delete --privatelink_endpoint_id <value> - Delete PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint set --privatelink_endpoint_id <value> - Set PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint approve --privatelink_endpoint_id <value> --type <value> --api_id <value> - Approve PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint connect --privatelink_endpoint_id <value> --type <value> --api_id <value> - Connect PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint request --privatelink_endpoint_id <value> --type <value> - Request PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint show --privatelink_endpoint_id <value> - Show PrivateLink Endpoint command has been added.
• [Updated] application-apigateway api list - The following field has been added to the response.
  • endpoint_type
• [Updated] application-apigateway api create --name <value> - The following field has been added to the request.
  • endpoint_type
• [Updated] application-apigateway api show --api_id <value> - The following field has been added to the response.
  • endpoint_type
  • privatelink_service_id
• [Updated] application-apigateway resource list --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] application-apigateway resource show --resource_id <value> --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] application-apigateway method list --resource_id <value> --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - The following field has been added to the request.
  • privatelink_endpoint_id
• [Updated] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - The following field has been added to the request.
  • privatelink_endpoint_id
• [Updated] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id

1.1

The Usage‑Policy feature has been added.
The API‑Key Management feature has been added.
The Report feature has been added.
The response of the List Resources command has been changed.
The response of the Get Resource command has been changed.
The response of the List Methods command has been changed.
The request of the Create Method command has been changed.
The request of the Set Method command has been changed.
The response of the Get Method command has been changed.
The response of the List Stages command has been changed.
The request of the Set Stage Configuration command has been changed.
The response of the Get Stage command has been changed.

CLI Changes

• [New] application-apigateway usage plan list --api_id <value> - List Usage Plans command has been added.
• [New] application-apigateway usage plan create --api_id <value> --rate <value> --name <value> --limit <value> - Create Usage Plan command has been added.
• [New] application-apigateway usage plan set description --usage_plan_id <value> --api_id <value> - Set Usage Plan Description command has been added.
• [New] application-apigateway usage plan set quota --usage_plan_id <value> --api_id <value> --rate <value> --limit <value> - Set Usage Plan Quota command has been added.
• [New] application-apigateway usage plan delete --usage_plan_id <value> --api_id <value> - Delete Usage Plan command has been added.
• [New] application-apigateway usage plan show --usage_plan_id <value> --api_id <value> - Show Usage Plan command has been added.
• [New] application-apigateway api key list --usage_plan_id <value> --api_id <value> - List Api Keys command has been added.
• [New] application-apigateway api key create --usage_plan_id <value> --api_id <value> --name <value> - Create APi Key command has been added.
• [New] application-apigateway api key set --api_key_id <value> --usage_plan_id <value> --api_id <value> - Set Api Key Description command has been added.
• [New] application-apigateway api key delete --api_key_id <value> --usage_plan_id <value> --api_id <value> - Delete Api Key command has been added.
• [New] application-apigateway report list --api_id <value> --end_date <value> --start_date <value> --stage_name <value> - List Reports command has been added.
• [Updated] application-apigateway resource list --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway resource show --resource_id <value> --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway method list --resource_id <value> --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - The following field has been added to the request.
  • api_key_required
• [Updated] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - The following field has been added to the request.
  • api_key_required
  • endpoint_url
  • function_id
  • integration_type
• [Updated] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway stage list --api_id <value> - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] application-apigateway stage list --api_id <value> - The following field has been removed to the response.
  • ip_restriction_enabled
• [Updated] application-apigateway stage list --api_id <value> - The following field has been changed to the response.
  • Before "methods": ["GET", "POST"]
  • After "methods": [{"type": GET", "api_key_required": true}]
• [Updated] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - The following field has been added to the request.
  • description
  • usage_plan_id
  • connected_api_keys
• [Updated] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - The following field has been removed to the request.
  • ip_restriction_enabled
• [Updated] application-apigateway stage show --api_id <value> --stage_name <value> - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] application-apigateway stage show --api_id <value> --stage_name <value> - The following field has been removed to the response.
  • ip_restriction_enabled

1.0

Initial CLI release for API Gateway.

CLI Changes

• [New] application-apigateway api list - List APis command has been added.
• [New] application-apigateway api create --name <value> - Create Api command has been added.
• [New] application-apigateway api description set --api_id <value> - Set Api Description command has been added.
• [New] application-apigateway api delete --api_id <value> - Delete Api command has been added.
• [New] application-apigateway api show --api_id <value> - Show Api command has been added.
• [New] application-apigateway api deployment list --api_id <value> - List Api Deployments command has been added.
• [New] application-apigateway api deploy --api_id <value> --stage_type <value> - Create Api Deployment command has been added.
• [New] application-apigateway resource list --api_id <value> - List Resources command has been added.
• [New] application-apigateway resource create --parent_id <value> --api_id <value> --path_part <value> - Create Resource command has been added.
• [New] application-apigateway resource delete --resource_id <value> --api_id <value> - Delete Resource command has been added.
• [New] application-apigateway resource show --resource_id <value> --api_id <value> - Show Resource command has been added.
• [New] application-apigateway method list --resource_id <value> --api_id <value> - List Methods command has been added.
• [New] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - Create Method command has been added.
• [New] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - Set Method command has been added.
• [New] application-apigateway method delete --method_type <value> --resource_id <value> --api_id <value> - Delete Method command has been added.
• [New] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - Show Method command has been added.
• [New] application-apigateway stage list --api_id <value> - List Stages command has been added.
• [New] application-apigateway stage create --api_id <value> --stage_name <value> --deployment_id <value> - Create Stage command has been added.
• [New] application-apigateway stage delete --api_id <value> --stage_name <value> - Delete Stage command has been added.
• [New] application-apigateway stage show --api_id <value> --stage_name <value> - Show Stage command has been added.
• [New] application-apigateway stage set active deployment --api_id <value> --stage_name <value> --deployment_id <value> - Set Stage Active Deployment command has been added.
• [New] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - Set Stage Configuration command has been added.
• [New] application-apigateway auth list --api_id <value> - List Auths command has been added.
• [New] application-apigateway auth create --api_id <value> --name <value> --expiration_period <value> --connected_stages <value> - Create Auth command has been added.
• [New] application-apigateway auth set --auth_id <value> --api_id <value> --connected_stages <value> - Set Auth command has been added.
• [New] application-apigateway auth delete --auth_id <value> --api_id <value> - Delete Auth command has been added.
• [New] application-apigateway auth show --auth_id <value> --api_id <value> - Show Auth command has been added.
• [New] application-apigateway access control list --api_id <value> - List AccessControls command has been added.
• [New] application-apigateway access control create --api_id <value> --name <value> --connected_stages <value> --allowed_ip_addr <value> - Create AccessControl command has been added.
• [New] application-apigateway access control set --access_control_id <value> --api_id <value> --connected_stages <value> --allowed_ip_addr <value> - Set AccessControl command has been added.
• [New] application-apigateway access control delete --access_control_id <value> --api_id <value> - Delete AccessControl command has been added.
• [New] application-apigateway access control show --access_control_id <value> --api_id <value> - Show AccessControl command has been added.

1.1 - CLIs

1.1.1 - Approve PrivateLink Endpoint

1.1.1.1 - 1.3

scp-cli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

Parameters

1.1.1.2 - 1.2

scp-cli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (SUPPORTED)

Parameters

1.1.2 - Connect PrivateLink Endpoint

1.1.2.1 - 1.3

scp-cli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

Parameters

1.1.2.2 - 1.2

scp-cli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (SUPPORTED)

Parameters

1.1.3 - Create AccessControl

1.1.3.1 - 1.3

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (CURRENT)

Parameters

Responses

1.1.3.2 - 1.2

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.3.3 - 1.1

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.3.4 - 1.0

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.4 - Create Api

1.1.4.1 - 1.3

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (CURRENT)

Parameters

Responses

1.1.4.2 - 1.2

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.4.3 - 1.1

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.4.4 - 1.0

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.5 - Create Api Deployment

1.1.5.1 - 1.3

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (CURRENT)

Parameters

Responses

1.1.5.2 - 1.2

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.5.3 - 1.1

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.5.4 - 1.0

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.6 - Create Api Key

1.1.6.1 - 1.3

scp-cli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

Create api key

State ACTIVE (CURRENT)

Parameters

Responses

1.1.6.2 - 1.2

scp-cli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

Create api key

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.6.3 - 1.1

scp-cli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

Create api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.7 - Create Auth

1.1.7.1 - 1.3

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (CURRENT)

Parameters

Responses

1.1.7.2 - 1.2

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.7.3 - 1.1

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.7.4 - 1.0

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.8 - Create Method

1.1.8.1 - 1.3

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (CURRENT)

Parameters

Responses

1.1.8.2 - 1.2

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.8.3 - 1.1

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.8.4 - 1.0

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.9 - Create PrivateLink Endpoint

1.1.9.1 - 1.3

scp-cli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]

Description

Create PrivateLink Endpoint

State ACTIVE (CURRENT)

Parameters

Responses

1.1.9.2 - 1.2

scp-cli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]

Description

Create PrivateLink Endpoint

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.10 - Create Resource

1.1.10.1 - 1.3

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (CURRENT)

Parameters

Responses

1.1.10.2 - 1.2

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.10.3 - 1.1

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.10.4 - 1.0

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.11 - Create Stage

1.1.11.1 - 1.3

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (CURRENT)

Parameters

Responses

1.1.11.2 - 1.2

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.11.3 - 1.1

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.11.4 - 1.0

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.12 - Create Usage Plans

1.1.12.1 - 1.3

scp-cli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

Create usage plan

State ACTIVE (CURRENT)

Parameters

Responses

1.1.12.2 - 1.2

scp-cli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

Create usage plan

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.12.3 - 1.1

scp-cli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

Create usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.13 - Delete Access Control

1.1.13.1 - 1.3

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (CURRENT)

Parameters

1.1.13.2 - 1.2

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (SUPPORTED)

Parameters

1.1.13.3 - 1.1

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.13.4 - 1.0

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.14 - Delete an API Key

1.1.14.1 - 1.3

scp-cli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

Delete api key

State ACTIVE (CURRENT)

Parameters

1.1.14.2 - 1.2

scp-cli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

Delete api key

State ACTIVE (SUPPORTED)

Parameters

1.1.14.3 - 1.1

scp-cli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

Delete api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.15 - Delete Api

1.1.15.1 - 1.3

scp-cli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (CURRENT)

Parameters

1.1.15.2 - 1.2

scp-cli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (SUPPORTED)

Parameters

1.1.15.3 - 1.1

scp-cli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.15.4 - 1.0

scp-cli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.16 - Delete Auth

1.1.16.1 - 1.3

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (CURRENT)

Parameters

1.1.16.2 - 1.2

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (SUPPORTED)

Parameters

1.1.16.3 - 1.1

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.16.4 - 1.0

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.17 - Delete Method

1.1.17.1 - 1.3

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (CURRENT)

Parameters

1.1.17.2 - 1.2

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (SUPPORTED)

Parameters

1.1.17.3 - 1.1

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.17.4 - 1.0

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.18 - Delete PrivateLink Endpoint

1.1.18.1 - 1.3

scp-cli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint

State ACTIVE (CURRENT)

Parameters

1.1.18.2 - 1.2

scp-cli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint

State ACTIVE (SUPPORTED)

Parameters

1.1.19 - Delete Resource

1.1.19.1 - 1.3

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (CURRENT)

Parameters

1.1.19.2 - 1.2

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (SUPPORTED)

Parameters

1.1.19.3 - 1.1

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.19.4 - 1.0

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.20 - Delete Resource Policy

1.1.20.1 - 1.3

scp-cli application-apigateway resource policy delete
--api_id <value>

Description

Delete Resource Policy

State ACTIVE (CURRENT)

Parameters

1.1.21 - Delete Stage

1.1.21.1 - 1.3

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (CURRENT)

Parameters

1.1.21.2 - 1.2

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (SUPPORTED)

Parameters

1.1.21.3 - 1.1

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.21.4 - 1.0

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.22 - Delete Usage Plan

1.1.22.1 - 1.3

scp-cli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

Delete usage plan

State ACTIVE (CURRENT)

Parameters

1.1.22.2 - 1.2

scp-cli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

Delete usage plan

State ACTIVE (SUPPORTED)

Parameters

1.1.22.3 - 1.1

scp-cli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

Delete usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

1.1.23 - List AccessControls

1.1.23.1 - 1.3

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls list

State ACTIVE (CURRENT)

Parameters

Responses

1.1.23.2 - 1.2

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls list

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.23.3 - 1.1

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.23.4 - 1.0

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses

1.1.24 - List Api Deployments

1.1.24.1 - 1.3

scp-cli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

Get api deployments list

State ACTIVE (CURRENT)

Parameters

Responses

1.1.24.2 - 1.2

scp-cli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

Get api deployments list

State ACTIVE (SUPPORTED)

Parameters

Responses

1.1.24.3 - 1.1

scp-cli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

Get api deployments list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Parameters

Responses