ECS / Client / describe_daemon_deployments

describe_daemon_deployments¶

ECS.Client.describe_daemon_deployments(**kwargs)¶

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

response = client.describe_daemon_deployments(
    daemonDeploymentArns=[
        'string',
    ]
)

Parameters:

daemonDeploymentArns (list) –

[REQUIRED]

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

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'failures': [
        {
            'arn': 'string',
            'reason': 'string',
            'detail': 'string'
        },
    ],
    'daemonDeployments': [
        {
            'daemonDeploymentArn': 'string',
            'clusterArn': 'string',
            'status': 'PENDING'|'SUCCESSFUL'|'STOPPED'|'STOP_REQUESTED'|'IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_SUCCESSFUL'|'ROLLBACK_FAILED',
            'statusReason': 'string',
            'targetDaemonRevision': {
                'arn': 'string',
                'capacityProviders': [
                    {
                        'arn': 'string',
                        'runningInstanceCount': 123,
                        'drainingInstanceCount': 123
                    },
                ],
                'totalRunningInstanceCount': 123,
                'totalDrainingInstanceCount': 123
            },
            'sourceDaemonRevisions': [
                {
                    'arn': 'string',
                    'capacityProviders': [
                        {
                            'arn': 'string',
                            'runningInstanceCount': 123,
                            'drainingInstanceCount': 123
                        },
                    ],
                    'totalRunningInstanceCount': 123,
                    'totalDrainingInstanceCount': 123
                },
            ],
            'circuitBreaker': {
                'failureCount': 123,
                'status': 'TRIGGERED'|'MONITORING'|'MONITORING_COMPLETE'|'DISABLED',
                'threshold': 123
            },
            'alarms': {
                'status': 'TRIGGERED'|'MONITORING'|'MONITORING_COMPLETE'|'DISABLED',
                'alarmNames': [
                    'string',
                ],
                'triggeredAlarmNames': [
                    'string',
                ]
            },
            'rollback': {
                'reason': 'string',
                'startedAt': datetime(2015, 1, 1),
                'rollbackTargetDaemonRevisionArn': 'string',
                'rollbackCapacityProviders': [
                    'string',
                ]
            },
            'deploymentConfiguration': {
                'drainPercent': 123.0,
                'alarms': {
                    'alarmNames': [
                        'string',
                    ],
                    'enable': True|False
                },
                'bakeTimeInMinutes': 123
            },
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'finishedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- failures (list) –
  
  Any failures associated with the call.
  - (dict) –
    
    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.
  - (dict) –
    
    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.
    - statusReason (string) –
      
      Information about why the daemon deployment is in the current status.
    - targetDaemonRevision (dict) –
      
      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.
        
        (dict) –
        
        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.
      - (dict) –
        
        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.
        
        (dict) –
        
        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 (dict) –
      
      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.
      - threshold (integer) –
        
        The threshold which determines that the daemon deployment failed.
    - alarms (dict) –
      
      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.
      - 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 (dict) –
      
      The rollback options for the daemon deployment.
      - reason (string) –
        
        The reason the rollback happened. For example, the circuit breaker initiated the rollback operation.
      - startedAt (datetime) –
        
        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 (dict) –
      
      The deployment configuration used for this daemon deployment.
      - drainPercent (float) –
        
        The percentage of container instances to drain simultaneously during a daemon deployment. Valid values are between 0.0 and 100.0.
      - alarms (dict) –
        
        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 (datetime) –
      
      The time the daemon deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
    - startedAt (datetime) –
      
      The time the daemon deployment started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
    - stoppedAt (datetime) –
      
      The time the daemon deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
    - finishedAt (datetime) –
      
      The time the daemon deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

describe_daemon_deployments¶

Request Syntax

Response Syntax

Response Structure

Exceptions