deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	deployments
Type	Resource
Id	aws.proton.deployments

Fields

The following fields are returned by SELECT queries:

get_deployment

Name	Datatype	Description
id	string	The ID of the deployment. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
arn	string	The Amazon Resource Name (ARN) of the deployment.
completed_at	string (date-time)	The date and time the deployment was completed.
component_name	string	The name of the component associated with this deployment. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
created_at	string (date-time)	The date and time the deployment was created.
deployment_status	string	The status of the deployment. (IN_PROGRESS, FAILED, SUCCEEDED, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, CANCELLING, CANCELLED)
deployment_status_message	string	The deployment status message.
environment_name	string	The name of the environment associated with this deployment. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
initial_state	object	The initial state of the target resource at the time of the deployment.
last_attempted_deployment_id	string	The ID of the last attempted deployment. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
last_modified_at	string (date-time)	The date and time the deployment was last modified.
last_succeeded_deployment_id	string	The ID of the last successful deployment. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
service_instance_name	string	The name of the deployment's service instance. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
service_name	string	The name of the service in this deployment. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
target_arn	string	The Amazon Resource Name (ARN) of the target of the deployment. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]:\d{12}:([\w+=,.@-]+[/:])[\w+=,.@-]+$</code>)
target_resource_created_at	string (date-time)	The date and time the depoyment target was created.
target_resource_type	string	The resource type of the deployment target. It can be an environment, service, service instance, or component. (ENVIRONMENT, SERVICE_PIPELINE, SERVICE_INSTANCE, COMPONENT)
target_state	object	The target state of the target resource at the time of the deployment.

list_deployments

Name	Datatype	Description
id	string	The ID of the deployment. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
arn	string	The Amazon Resource Name (ARN) of the deployment.
completed_at	string (date-time)	The date and time the deployment was completed.
component_name	string	The name of the component associated with the deployment. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
created_at	string (date-time)	The date and time the deployment was created.
deployment_status	string	The current status of the deployment. (IN_PROGRESS, FAILED, SUCCEEDED, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, CANCELLING, CANCELLED)
environment_name	string	The name of the environment associated with the deployment. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
last_attempted_deployment_id	string	The ID of the last attempted deployment. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
last_modified_at	string (date-time)	The date and time the deployment was last modified.
last_succeeded_deployment_id	string	The ID of the last successful deployment. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
service_instance_name	string	The name of the service instance associated with the deployment. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
service_name	string	The name of the service associated with the deployment. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
target_arn	string	The Amazon Resource Name (ARN) of the target of the deployment. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]:\d{12}:([\w+=,.@-]+[/:])[\w+=,.@-]+$</code>)
target_resource_created_at	string (date-time)	The date and time the target resource was created.
target_resource_type	string	The resource type of the deployment target. It can be an environment, service, service instance, or component. (ENVIRONMENT, SERVICE_PIPELINE, SERVICE_INSTANCE, COMPONENT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment	select	region		Get detailed data for a deployment.
list_deployments	select	region		List deployments. You can filter the result list by environment, service, or a single service instance.
delete_deployment	delete	region		Delete the deployment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_deployment

Get detailed data for a deployment.

SELECT
id,
arn,
completed_at,
component_name,
created_at,
deployment_status,
deployment_status_message,
environment_name,
initial_state,
last_attempted_deployment_id,
last_modified_at,
last_succeeded_deployment_id,
service_instance_name,
service_name,
target_arn,
target_resource_created_at,
target_resource_type,
target_state
FROM aws.proton.deployments
WHERE region = '{{ region }}' -- required
;

list_deployments

List deployments. You can filter the result list by environment, service, or a single service instance.

SELECT
id,
arn,
completed_at,
component_name,
created_at,
deployment_status,
environment_name,
last_attempted_deployment_id,
last_modified_at,
last_succeeded_deployment_id,
service_instance_name,
service_name,
target_arn,
target_resource_created_at,
target_resource_type
FROM aws.proton.deployments
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_deployment

Delete the deployment.

DELETE FROM aws.proton.deployments
WHERE region = '{{ region }}' --required
;