service_deployments

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

Overview

Name	service_deployments
Type	Resource
Id	aws.ecs.service_deployments

Fields

The following fields are returned by SELECT queries:

describe_service_deployments

Name	Datatype	Description
failures	array	Any failures associated with the call. If you decsribe a deployment with a service revision created before October 25, 2024, the call fails. The failure includes the service revision ARN and the reason set to MISSING.
service_deployments	array	The list of service deployments described.

list_service_deployments

Name	Datatype	Description
next_token	string	The nextToken value to include in a future ListServiceDeployments request. When the results of a ListServiceDeployments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
service_deployments	array	An overview of the service deployment, including the following properties: The ARN of the service deployment. The ARN of the service being deployed. The ARN of the cluster that hosts the service in the service deployment. The time that the service deployment started. The time that the service deployment completed. The service deployment status. Information about why the service deployment is in the current state. The ARN of the service revision that is being deployed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_service_deployments	select	region		Describes one or more of your service deployments. A service deployment happens when you release a software update for the service. For more information, see View service history using Amazon ECS service deployments.
list_service_deployments	select	region		This operation lists all the service deployments that meet the specified filter criteria. A service deployment happens when you release a software update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks. This API returns the values that you use for the request parameters in DescribeServiceRevisions.
continue_service_deployment	exec	region, serviceDeploymentArn, hookId		Continues or rolls back an Amazon ECS service deployment that is paused at a lifecycle hook. When a service deployment reaches a lifecycle stage that has a PAUSE hook configured, the deployment pauses and waits for an explicit action. Use this API to either continue the deployment to the next stage or roll back to the previous service revision. To find the hookId of the paused hook, call DescribeServiceDeployments and inspect the lifecycleHookDetails field. For more information, see Continuing Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.

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

describe_service_deployments

Describes one or more of your service deployments. A service deployment happens when you release a software update for the service. For more information, see View service history using Amazon ECS service deployments.

SELECT
failures,
service_deployments
FROM aws.ecs.service_deployments
WHERE region = '{{ region }}' -- required
;

list_service_deployments

This operation lists all the service deployments that meet the specified filter criteria. A service deployment happens when you release a software update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks. This API returns the values that you use for the request parameters in DescribeServiceRevisions.

SELECT
next_token,
service_deployments
FROM aws.ecs.service_deployments
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

continue_service_deployment

Continues or rolls back an Amazon ECS service deployment that is paused at a lifecycle hook. When a service deployment reaches a lifecycle stage that has a PAUSE hook configured, the deployment pauses and waits for an explicit action. Use this API to either continue the deployment to the next stage or roll back to the previous service revision. To find the hookId of the paused hook, call DescribeServiceDeployments and inspect the lifecycleHookDetails field. For more information, see Continuing Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.

EXEC aws.ecs.service_deployments.continue_service_deployment 
@region='{{ region }}' --required 
@@json=
'{
"serviceDeploymentArn": "{{ serviceDeploymentArn }}", 
"hookId": "{{ hookId }}", 
"action": "{{ action }}"
}'
;