AWS CLI Command Reference

[ aws . ecs ]

describe-daemon-deployments

Description

Describes one or more of your daemon deployments.

A daemon deployment orchestrates the progressive rollout of daemon task updates across container instances managed by the daemon’s capacity providers. Each deployment includes circuit breaker and alarm-based rollback capabilities.

See also: AWS API Documentation

Synopsis

  describe-daemon-deployments
--daemon-deployment-arns <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--daemon-deployment-arns (list) [required]

The ARN of the daemon deployments to describe. You can specify up to 20 ARNs.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

failures -> (list)

Any failures associated with the call.

(structure)

A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide .

arn -> (string)

The Amazon Resource Name (ARN) of the failed resource.

reason -> (string)

The reason for the failure.

detail -> (string)

The details of the failure.

daemonDeployments -> (list)

The list of daemon deployments.

(structure)

Information about a daemon deployment. A daemon deployment orchestrates the progressive rollout of daemon task updates across container instances.

daemonDeploymentArn -> (string)

The Amazon Resource Name (ARN) of the daemon deployment.

clusterArn -> (string)

The Amazon Resource Name (ARN) of the cluster that hosts the daemon.

status -> (string)

The status of the daemon deployment.

Possible values:

  • PENDING
  • SUCCESSFUL
  • STOPPED
  • STOP_REQUESTED
  • IN_PROGRESS
  • ROLLBACK_IN_PROGRESS
  • ROLLBACK_SUCCESSFUL
  • ROLLBACK_FAILED

statusReason -> (string)

Information about why the daemon deployment is in the current status.

targetDaemonRevision -> (structure)

The daemon revision being deployed.

arn -> (string)

The Amazon Resource Name (ARN) of the daemon revision.

capacityProviders -> (list)

The capacity providers associated with this daemon revision during the deployment.

(structure)

Information about a capacity provider during a daemon deployment.

arn -> (string)

The Amazon Resource Name (ARN) of the capacity provider.

runningInstanceCount -> (integer)

The number of instances running daemon tasks on this capacity provider.

drainingInstanceCount -> (integer)

The number of instances being drained on this capacity provider during the deployment.

totalRunningInstanceCount -> (integer)

The total number of instances running daemon tasks for this revision.

totalDrainingInstanceCount -> (integer)

The total number of instances being drained for this revision during the deployment.

sourceDaemonRevisions -> (list)

The currently deployed daemon revisions that are being replaced.

(structure)

Details about a daemon revision during a deployment, including running and draining instance counts per capacity provider.

arn -> (string)

The Amazon Resource Name (ARN) of the daemon revision.

capacityProviders -> (list)

The capacity providers associated with this daemon revision during the deployment.

(structure)

Information about a capacity provider during a daemon deployment.

arn -> (string)

The Amazon Resource Name (ARN) of the capacity provider.

runningInstanceCount -> (integer)

The number of instances running daemon tasks on this capacity provider.

drainingInstanceCount -> (integer)

The number of instances being drained on this capacity provider during the deployment.

totalRunningInstanceCount -> (integer)

The total number of instances running daemon tasks for this revision.

totalDrainingInstanceCount -> (integer)

The total number of instances being drained for this revision during the deployment.

circuitBreaker -> (structure)

The circuit breaker configuration that determines when a daemon deployment has failed.

failureCount -> (integer)

The number of times the circuit breaker detected a daemon deployment failure.

status -> (string)

The circuit breaker status. Amazon ECS is not using the circuit breaker for daemon deployment failures when the status is DISABLED .

Possible values:

  • TRIGGERED
  • MONITORING
  • MONITORING_COMPLETE
  • DISABLED

threshold -> (integer)

The threshold which determines that the daemon deployment failed.

alarms -> (structure)

The CloudWatch alarms that determine when a daemon deployment fails.

status -> (string)

The status of the alarms check. Amazon ECS is not using alarms for daemon deployment failures when the status is DISABLED .

Possible values:

  • TRIGGERED
  • MONITORING
  • MONITORING_COMPLETE
  • DISABLED

alarmNames -> (list)

The name of the CloudWatch alarms that determine when a daemon deployment failed.

(string)

triggeredAlarmNames -> (list)

One or more CloudWatch alarm names that have been triggered during the daemon deployment.

(string)

rollback -> (structure)

The rollback options for the daemon deployment.

reason -> (string)

The reason the rollback happened. For example, the circuit breaker initiated the rollback operation.

startedAt -> (timestamp)

The time that the rollback started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

rollbackTargetDaemonRevisionArn -> (string)

The ARN of the daemon revision deployed as part of the rollback.

rollbackCapacityProviders -> (list)

The capacity providers involved in the rollback.

(string)

deploymentConfiguration -> (structure)

The deployment configuration used for this daemon deployment.

drainPercent -> (double)

The percentage of container instances to drain simultaneously during a daemon deployment. Valid values are between 0.0 and 100.0.

Constraints:

  • min: 0.0
  • max: 100.0

alarms -> (structure)

The CloudWatch alarm configuration for the daemon deployment. When alarms are triggered during a deployment, the deployment can be automatically rolled back.

alarmNames -> (list)

The CloudWatch alarm names to monitor during a daemon deployment.

(string)

enable -> (boolean)

Determines whether to use the CloudWatch alarm option in the daemon deployment process. The default value is false .

bakeTimeInMinutes -> (integer)

The amount of time (in minutes) to wait after a successful deployment step before proceeding. This allows time to monitor for issues before continuing. The default value is 0.

createdAt -> (timestamp)

The time the daemon deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

startedAt -> (timestamp)

The time the daemon deployment started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

stoppedAt -> (timestamp)

The time the daemon deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

finishedAt -> (timestamp)

The time the daemon deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
© Copyright 2026, Amazon Web Services. Created using Sphinx.