Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeDaemonDeployments

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.

Request Syntax


{
   "daemonDeploymentArns": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

daemonDeploymentArns

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

Type: Array of strings

Required: Yes

Response Syntax


{
   "daemonDeployments": [ 
      { 
         "alarms": { 
            "alarmNames": [ "string" ],
            "status": "string",
            "triggeredAlarmNames": [ "string" ]
         },
         "circuitBreaker": { 
            "failureCount": number,
            "status": "string",
            "threshold": number
         },
         "clusterArn": "string",
         "createdAt": number,
         "daemonDeploymentArn": "string",
         "deploymentConfiguration": { 
            "alarms": { 
               "alarmNames": [ "string" ],
               "enable": boolean
            },
            "bakeTimeInMinutes": number,
            "drainPercent": number
         },
         "finishedAt": number,
         "rollback": { 
            "reason": "string",
            "rollbackCapacityProviders": [ "string" ],
            "rollbackTargetDaemonRevisionArn": "string",
            "startedAt": number
         },
         "sourceDaemonRevisions": [ 
            { 
               "arn": "string",
               "capacityProviders": [ 
                  { 
                     "arn": "string",
                     "drainingInstanceCount": number,
                     "runningInstanceCount": number
                  }
               ],
               "totalDrainingInstanceCount": number,
               "totalRunningInstanceCount": number
            }
         ],
         "startedAt": number,
         "status": "string",
         "statusReason": "string",
         "stoppedAt": number,
         "targetDaemonRevision": { 
            "arn": "string",
            "capacityProviders": [ 
               { 
                  "arn": "string",
                  "drainingInstanceCount": number,
                  "runningInstanceCount": number
               }
            ],
            "totalDrainingInstanceCount": number,
            "totalRunningInstanceCount": number
         }
      }
   ],
   "failures": [ 
      { 
         "arn": "string",
         "detail": "string",
         "reason": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

daemonDeployments

The list of daemon deployments.

Type: Array of DaemonDeployment objects

failures

Any failures associated with the call.

Type: Array of Failure objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have authorization to perform the requested action.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ClientException

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ClusterNotFoundException

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

InvalidParameterException

The specified parameter isn't valid. Review the available parameters for the API request.

For more information about service event errors, see Amazon ECS service event messages.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

message: Message that describes the cause of the exception.

HTTP Status Code: 500

UnsupportedFeatureException

The specified task isn't supported in this Region.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the AWS Command Line Interface or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.

Example

This example describes a daemon deployment for the my-monitoring-daemon daemon.

Sample Request


POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 143
X-Amz-Target: AmazonEC2ContainerServiceV20141113.DescribeDaemonDeployments
X-Amz-Date: 20250320T161500Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS

{
  "daemonDeploymentArns": [
    "arn:aws:ecs:us-east-1:123456789012:daemon-deployment/my-cluster/my-monitoring-daemon/aB1cD2eF3gH4iJ5k"
  ]
}

Sample Response


HTTP/1.1 200 OK
Server: Server
Date: Thu, 20 Mar 2025 16:15:00 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 1455
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f

{
  "daemonDeployments": [
    {
      "daemonDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:daemon-deployment/my-cluster/my-monitoring-daemon/aB1cD2eF3gH4iJ5k",
      "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/my-cluster",
      "status": "SUCCESSFUL",
      "statusReason": "Deployment completed successfully.",
      "targetDaemonRevision": {
        "arn": "arn:aws:ecs:us-east-1:123456789012:daemon-revision/my-cluster/my-monitoring-daemon/4980306466373577095",
        "capacityProviders": [
          {
            "arn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/my-capacity-provider",
            "runningInstanceCount": 3,
            "drainingInstanceCount": 0
          }
        ],
        "totalRunningInstanceCount": 3,
        "totalDrainingInstanceCount": 0
      },
      "sourceDaemonRevisions": [],
      "circuitBreaker": {
        "failureCount": 0,
        "status": "MONITORING_COMPLETE",
        "threshold": 10
      },
      "alarms": {
        "status": "DISABLED",
        "alarmNames": [],
        "triggeredAlarmNames": []
      },
      "deploymentConfiguration": {
        "drainPercent": 10.0,
        "bakeTimeInMinutes": 5,
        "alarms": {
          "alarmNames": [],
          "enable": false
        }
      },
      "createdAt": "2025-03-15T12:00:00.000Z",
      "startedAt": "2025-03-15T12:00:05.000Z",
      "finishedAt": "2025-03-15T12:15:00.000Z"
    }
  ],
  "failures": []
}