deployments_list_only

Lists deployments in a region or regions, for all properties use deployments

Overview

Name	deployments_list_only
Type	Resource
Description	The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
Id	aws.apigateway.deployments_list_only

Fields

Name	Datatype	Description
deployment_id	string
description	string	The description for the Deployment resource to create.
stage_description	object	The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
stage_name	string	The name of the Stage resource for the Deployment resource to create.
rest_api_id	string	The string identifier of the associated RestApi.
deployment_canary_settings	object	The input configuration for a canary deployment.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all deployments in a region.

SELECT
region,
deployment_id,
rest_api_id
FROM aws.apigateway.deployments_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the deployments_list_only resource, see deployments