AWS CodeDeploy

2017/06/01 - AWS CodeDeploy - 1 new4 updated api methods

Changes  Update codedeploy client to latest version

ListGitHubAccountTokenNames (new) Link ¶

Lists the names of stored connections to GitHub accounts.

See also: AWS API Documentation

Request Syntax

client.list_git_hub_account_token_names(
    nextToken='string'
)
type nextToken:

string

param nextToken:

An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.

rtype:

dict

returns:

Response Syntax

{
    'tokenNameList': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a ListGitHubAccountTokenNames operation.

    • tokenNameList (list) --

      A list of names of connections to GitHub accounts.

      • (string) --

    • nextToken (string) --

      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames call to return the next set of names in the list.

BatchGetApplications (updated) Link ¶
Changes (response)
{'applicationsInfo': {'gitHubAccountName': 'string'}}

Gets information about one or more applications.

See also: AWS API Documentation

Request Syntax

client.batch_get_applications(
    applicationNames=[
        'string',
    ]
)
type applicationNames:

list

param applicationNames:

A list of application names separated by spaces.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'applicationsInfo': [
        {
            'applicationId': 'string',
            'applicationName': 'string',
            'createTime': datetime(2015, 1, 1),
            'linkedToGitHub': True|False,
            'gitHubAccountName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Represents the output of a BatchGetApplications operation.

    • applicationsInfo (list) --

      Information about the applications.

      • (dict) --

        Information about an application.

        • applicationId (string) --

          The application ID.

        • applicationName (string) --

          The application name.

        • createTime (datetime) --

          The time at which the application was created.

        • linkedToGitHub (boolean) --

          True if the user has authenticated with GitHub for the specified application; otherwise, false.

        • gitHubAccountName (string) --

          The name for a connection to a GitHub account.

BatchGetDeploymentGroups (updated) Link ¶
Changes (response)
{'deploymentGroupsInfo': {'lastAttemptedDeployment': {'createTime': 'timestamp',
                                                      'deploymentId': 'string',
                                                      'endTime': 'timestamp',
                                                      'status': 'Created | '
                                                                'Queued | '
                                                                'InProgress | '
                                                                'Succeeded | '
                                                                'Failed | '
                                                                'Stopped | '
                                                                'Ready'},
                          'lastSuccessfulDeployment': {'createTime': 'timestamp',
                                                       'deploymentId': 'string',
                                                       'endTime': 'timestamp',
                                                       'status': 'Created | '
                                                                 'Queued | '
                                                                 'InProgress | '
                                                                 'Succeeded | '
                                                                 'Failed | '
                                                                 'Stopped | '
                                                                 'Ready'}}}

Gets information about one or more deployment groups.

See also: AWS API Documentation

Request Syntax

client.batch_get_deployment_groups(
    applicationName='string',
    deploymentGroupNames=[
        'string',
    ]
)
type applicationName:

string

param applicationName:

[REQUIRED]

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

type deploymentGroupNames:

list

param deploymentGroupNames:

[REQUIRED]

The deployment groups' names.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'deploymentGroupsInfo': [
        {
            'applicationName': 'string',
            'deploymentGroupId': 'string',
            'deploymentGroupName': 'string',
            'deploymentConfigName': 'string',
            'ec2TagFilters': [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
                },
            ],
            'onPremisesInstanceTagFilters': [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
                },
            ],
            'autoScalingGroups': [
                {
                    'name': 'string',
                    'hook': 'string'
                },
            ],
            'serviceRoleArn': 'string',
            'targetRevision': {
                'revisionType': 'S3'|'GitHub',
                's3Location': {
                    'bucket': 'string',
                    'key': 'string',
                    'bundleType': 'tar'|'tgz'|'zip',
                    'version': 'string',
                    'eTag': 'string'
                },
                'gitHubLocation': {
                    'repository': 'string',
                    'commitId': 'string'
                }
            },
            'triggerConfigurations': [
                {
                    'triggerName': 'string',
                    'triggerTargetArn': 'string',
                    'triggerEvents': [
                        'DeploymentStart'|'DeploymentSuccess'|'DeploymentFailure'|'DeploymentStop'|'DeploymentRollback'|'DeploymentReady'|'InstanceStart'|'InstanceSuccess'|'InstanceFailure'|'InstanceReady',
                    ]
                },
            ],
            'alarmConfiguration': {
                'enabled': True|False,
                'ignorePollAlarmFailure': True|False,
                'alarms': [
                    {
                        'name': 'string'
                    },
                ]
            },
            'autoRollbackConfiguration': {
                'enabled': True|False,
                'events': [
                    'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
                ]
            },
            'deploymentStyle': {
                'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
                'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
            },
            'blueGreenDeploymentConfiguration': {
                'terminateBlueInstancesOnDeploymentSuccess': {
                    'action': 'TERMINATE'|'KEEP_ALIVE',
                    'terminationWaitTimeInMinutes': 123
                },
                'deploymentReadyOption': {
                    'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
                    'waitTimeInMinutes': 123
                },
                'greenFleetProvisioningOption': {
                    'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
                }
            },
            'loadBalancerInfo': {
                'elbInfoList': [
                    {
                        'name': 'string'
                    },
                ]
            },
            'lastSuccessfulDeployment': {
                'deploymentId': 'string',
                'status': 'Created'|'Queued'|'InProgress'|'Succeeded'|'Failed'|'Stopped'|'Ready',
                'endTime': datetime(2015, 1, 1),
                'createTime': datetime(2015, 1, 1)
            },
            'lastAttemptedDeployment': {
                'deploymentId': 'string',
                'status': 'Created'|'Queued'|'InProgress'|'Succeeded'|'Failed'|'Stopped'|'Ready',
                'endTime': datetime(2015, 1, 1),
                'createTime': datetime(2015, 1, 1)
            }
        },
    ],
    'errorMessage': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a BatchGetDeploymentGroups operation.

    • deploymentGroupsInfo (list) --

      Information about the deployment groups.

      • (dict) --

        Information about a deployment group.

        • applicationName (string) --

          The application name.

        • deploymentGroupId (string) --

          The deployment group ID.

        • deploymentGroupName (string) --

          The deployment group name.

        • deploymentConfigName (string) --

          The deployment configuration name.

        • ec2TagFilters (list) --

          The Amazon EC2 tags on which to filter.

          • (dict) --

            Information about an EC2 tag filter.

            • Key (string) --

              The tag filter key.

            • Value (string) --

              The tag filter value.

            • Type (string) --

              The tag filter type:

              • KEY_ONLY: Key only.

              • VALUE_ONLY: Value only.

              • KEY_AND_VALUE: Key and value.

        • onPremisesInstanceTagFilters (list) --

          The on-premises instance tags on which to filter.

          • (dict) --

            Information about an on-premises instance tag filter.

            • Key (string) --

              The on-premises instance tag filter key.

            • Value (string) --

              The on-premises instance tag filter value.

            • Type (string) --

              The on-premises instance tag filter type:

              • KEY_ONLY: Key only.

              • VALUE_ONLY: Value only.

              • KEY_AND_VALUE: Key and value.

        • autoScalingGroups (list) --

          A list of associated Auto Scaling groups.

          • (dict) --

            Information about an Auto Scaling group.

            • name (string) --

              The Auto Scaling group name.

            • hook (string) --

              An Auto Scaling lifecycle event hook name.

        • serviceRoleArn (string) --

          A service role ARN.

        • targetRevision (dict) --

          Information about the deployment group's target revision, including type and location.

          • revisionType (string) --

            The type of application revision:

            • S3: An application revision stored in Amazon S3.

            • GitHub: An application revision stored in GitHub.

          • s3Location (dict) --

            Information about the location of application artifacts stored in Amazon S3.

            • bucket (string) --

              The name of the Amazon S3 bucket where the application revision is stored.

            • key (string) --

              The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

            • bundleType (string) --

              The file type of the application revision. Must be one of the following:

              • tar: A tar archive file.

              • tgz: A compressed tar archive file.

              • zip: A zip archive file.

            • version (string) --

              A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

              If the version is not specified, the system will use the most recent version by default.

            • eTag (string) --

              The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

              If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.

          • gitHubLocation (dict) --

            Information about the location of application artifacts stored in GitHub.

            • repository (string) --

              The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

              Specified as account/repository.

            • commitId (string) --

              The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

        • triggerConfigurations (list) --

          Information about triggers associated with the deployment group.

          • (dict) --

            Information about notification triggers for the deployment group.

            • triggerName (string) --

              The name of the notification trigger.

            • triggerTargetArn (string) --

              The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.

            • triggerEvents (list) --

              The event type or types for which notifications are triggered.

              • (string) --

        • alarmConfiguration (dict) --

          A list of alarms associated with the deployment group.

          • enabled (boolean) --

            Indicates whether the alarm configuration is enabled.

          • ignorePollAlarmFailure (boolean) --

            Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

            • true: The deployment will proceed even if alarm status information can't be retrieved from Amazon CloudWatch.

            • false: The deployment will stop if alarm status information can't be retrieved from Amazon CloudWatch.

          • alarms (list) --

            A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.

            • (dict) --

              Information about an alarm.

              • name (string) --

                The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

        • autoRollbackConfiguration (dict) --

          Information about the automatic rollback configuration associated with the deployment group.

          • enabled (boolean) --

            Indicates whether a defined automatic rollback configuration is currently enabled.

          • events (list) --

            The event type or types that trigger a rollback.

            • (string) --

        • deploymentStyle (dict) --

          Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

          • deploymentType (string) --

            Indicates whether to run an in-place deployment or a blue/green deployment.

          • deploymentOption (string) --

            Indicates whether to route deployment traffic behind a load balancer.

        • blueGreenDeploymentConfiguration (dict) --

          Information about blue/green deployment options for a deployment group.

          • terminateBlueInstancesOnDeploymentSuccess (dict) --

            Information about whether to terminate instances in the original fleet during a blue/green deployment.

            • action (string) --

              The action to take on instances in the original environment after a successful blue/green deployment.

              • TERMINATE: Instances are terminated after a specified wait time.

              • KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

            • terminationWaitTimeInMinutes (integer) --

              The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

          • deploymentReadyOption (dict) --

            Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

            • actionOnTimeout (string) --

              Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

              • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

              • STOP_DEPLOYMENT: Do not register new instances with load balancer unless traffic is rerouted manually. If traffic is not rerouted manually before the end of the specified wait period, the deployment status is changed to Stopped.

            • waitTimeInMinutes (integer) --

              The number of minutes to wait before the status of a blue/green deployment changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout

          • greenFleetProvisioningOption (dict) --

            Information about how instances are provisioned for a replacement environment in a blue/green deployment.

            • action (string) --

              The method used to add instances to a replacement environment.

              • DISCOVER_EXISTING: Use instances that already exist or will be created manually.

              • COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.

        • loadBalancerInfo (dict) --

          Information about the load balancer to use in a deployment.

          • elbInfoList (list) --

            An array containing information about the load balancer in Elastic Load Balancing to use in a deployment.

            • (dict) --

              Information about a load balancer in Elastic Load Balancing to use in a deployment.

              • name (string) --

                For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.

        • lastSuccessfulDeployment (dict) --

          Information about the most recent successful deployment to the deployment group.

          • deploymentId (string) --

            The deployment ID.

          • status (string) --

            The status of the most recent deployment.

          • endTime (datetime) --

            A timestamp indicating when the most recent deployment to the deployment group completed.

          • createTime (datetime) --

            A timestamp indicating when the most recent deployment to the deployment group started.

        • lastAttemptedDeployment (dict) --

          Information about the most recent attempted deployment to the deployment group.

          • deploymentId (string) --

            The deployment ID.

          • status (string) --

            The status of the most recent deployment.

          • endTime (datetime) --

            A timestamp indicating when the most recent deployment to the deployment group completed.

          • createTime (datetime) --

            A timestamp indicating when the most recent deployment to the deployment group started.

    • errorMessage (string) --

      Information about errors that may have occurred during the API call.

GetApplication (updated) Link ¶
Changes (response)
{'application': {'gitHubAccountName': 'string'}}

Gets information about an application.

See also: AWS API Documentation

Request Syntax

client.get_application(
    applicationName='string'
)
type applicationName:

string

param applicationName:

[REQUIRED]

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

rtype:

dict

returns:

Response Syntax

{
    'application': {
        'applicationId': 'string',
        'applicationName': 'string',
        'createTime': datetime(2015, 1, 1),
        'linkedToGitHub': True|False,
        'gitHubAccountName': 'string'
    }
}

Response Structure

  • (dict) --

    Represents the output of a GetApplication operation.

    • application (dict) --

      Information about the application.

      • applicationId (string) --

        The application ID.

      • applicationName (string) --

        The application name.

      • createTime (datetime) --

        The time at which the application was created.

      • linkedToGitHub (boolean) --

        True if the user has authenticated with GitHub for the specified application; otherwise, false.

      • gitHubAccountName (string) --

        The name for a connection to a GitHub account.

GetDeploymentGroup (updated) Link ¶
Changes (response)
{'deploymentGroupInfo': {'lastAttemptedDeployment': {'createTime': 'timestamp',
                                                     'deploymentId': 'string',
                                                     'endTime': 'timestamp',
                                                     'status': 'Created | '
                                                               'Queued | '
                                                               'InProgress | '
                                                               'Succeeded | '
                                                               'Failed | '
                                                               'Stopped | '
                                                               'Ready'},
                         'lastSuccessfulDeployment': {'createTime': 'timestamp',
                                                      'deploymentId': 'string',
                                                      'endTime': 'timestamp',
                                                      'status': 'Created | '
                                                                'Queued | '
                                                                'InProgress | '
                                                                'Succeeded | '
                                                                'Failed | '
                                                                'Stopped | '
                                                                'Ready'}}}

Gets information about a deployment group.

See also: AWS API Documentation

Request Syntax

client.get_deployment_group(
    applicationName='string',
    deploymentGroupName='string'
)
type applicationName:

string

param applicationName:

[REQUIRED]

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

type deploymentGroupName:

string

param deploymentGroupName:

[REQUIRED]

The name of an existing deployment group for the specified application.

rtype:

dict

returns:

Response Syntax

{
    'deploymentGroupInfo': {
        'applicationName': 'string',
        'deploymentGroupId': 'string',
        'deploymentGroupName': 'string',
        'deploymentConfigName': 'string',
        'ec2TagFilters': [
            {
                'Key': 'string',
                'Value': 'string',
                'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
            },
        ],
        'onPremisesInstanceTagFilters': [
            {
                'Key': 'string',
                'Value': 'string',
                'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
            },
        ],
        'autoScalingGroups': [
            {
                'name': 'string',
                'hook': 'string'
            },
        ],
        'serviceRoleArn': 'string',
        'targetRevision': {
            'revisionType': 'S3'|'GitHub',
            's3Location': {
                'bucket': 'string',
                'key': 'string',
                'bundleType': 'tar'|'tgz'|'zip',
                'version': 'string',
                'eTag': 'string'
            },
            'gitHubLocation': {
                'repository': 'string',
                'commitId': 'string'
            }
        },
        'triggerConfigurations': [
            {
                'triggerName': 'string',
                'triggerTargetArn': 'string',
                'triggerEvents': [
                    'DeploymentStart'|'DeploymentSuccess'|'DeploymentFailure'|'DeploymentStop'|'DeploymentRollback'|'DeploymentReady'|'InstanceStart'|'InstanceSuccess'|'InstanceFailure'|'InstanceReady',
                ]
            },
        ],
        'alarmConfiguration': {
            'enabled': True|False,
            'ignorePollAlarmFailure': True|False,
            'alarms': [
                {
                    'name': 'string'
                },
            ]
        },
        'autoRollbackConfiguration': {
            'enabled': True|False,
            'events': [
                'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
            ]
        },
        'deploymentStyle': {
            'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
            'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
        },
        'blueGreenDeploymentConfiguration': {
            'terminateBlueInstancesOnDeploymentSuccess': {
                'action': 'TERMINATE'|'KEEP_ALIVE',
                'terminationWaitTimeInMinutes': 123
            },
            'deploymentReadyOption': {
                'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
                'waitTimeInMinutes': 123
            },
            'greenFleetProvisioningOption': {
                'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
            }
        },
        'loadBalancerInfo': {
            'elbInfoList': [
                {
                    'name': 'string'
                },
            ]
        },
        'lastSuccessfulDeployment': {
            'deploymentId': 'string',
            'status': 'Created'|'Queued'|'InProgress'|'Succeeded'|'Failed'|'Stopped'|'Ready',
            'endTime': datetime(2015, 1, 1),
            'createTime': datetime(2015, 1, 1)
        },
        'lastAttemptedDeployment': {
            'deploymentId': 'string',
            'status': 'Created'|'Queued'|'InProgress'|'Succeeded'|'Failed'|'Stopped'|'Ready',
            'endTime': datetime(2015, 1, 1),
            'createTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    Represents the output of a GetDeploymentGroup operation.

    • deploymentGroupInfo (dict) --

      Information about the deployment group.

      • applicationName (string) --

        The application name.

      • deploymentGroupId (string) --

        The deployment group ID.

      • deploymentGroupName (string) --

        The deployment group name.

      • deploymentConfigName (string) --

        The deployment configuration name.

      • ec2TagFilters (list) --

        The Amazon EC2 tags on which to filter.

        • (dict) --

          Information about an EC2 tag filter.

          • Key (string) --

            The tag filter key.

          • Value (string) --

            The tag filter value.

          • Type (string) --

            The tag filter type:

            • KEY_ONLY: Key only.

            • VALUE_ONLY: Value only.

            • KEY_AND_VALUE: Key and value.

      • onPremisesInstanceTagFilters (list) --

        The on-premises instance tags on which to filter.

        • (dict) --

          Information about an on-premises instance tag filter.

          • Key (string) --

            The on-premises instance tag filter key.

          • Value (string) --

            The on-premises instance tag filter value.

          • Type (string) --

            The on-premises instance tag filter type:

            • KEY_ONLY: Key only.

            • VALUE_ONLY: Value only.

            • KEY_AND_VALUE: Key and value.

      • autoScalingGroups (list) --

        A list of associated Auto Scaling groups.

        • (dict) --

          Information about an Auto Scaling group.

          • name (string) --

            The Auto Scaling group name.

          • hook (string) --

            An Auto Scaling lifecycle event hook name.

      • serviceRoleArn (string) --

        A service role ARN.

      • targetRevision (dict) --

        Information about the deployment group's target revision, including type and location.

        • revisionType (string) --

          The type of application revision:

          • S3: An application revision stored in Amazon S3.

          • GitHub: An application revision stored in GitHub.

        • s3Location (dict) --

          Information about the location of application artifacts stored in Amazon S3.

          • bucket (string) --

            The name of the Amazon S3 bucket where the application revision is stored.

          • key (string) --

            The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

          • bundleType (string) --

            The file type of the application revision. Must be one of the following:

            • tar: A tar archive file.

            • tgz: A compressed tar archive file.

            • zip: A zip archive file.

          • version (string) --

            A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

            If the version is not specified, the system will use the most recent version by default.

          • eTag (string) --

            The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

            If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.

        • gitHubLocation (dict) --

          Information about the location of application artifacts stored in GitHub.

          • repository (string) --

            The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

            Specified as account/repository.

          • commitId (string) --

            The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

      • triggerConfigurations (list) --

        Information about triggers associated with the deployment group.

        • (dict) --

          Information about notification triggers for the deployment group.

          • triggerName (string) --

            The name of the notification trigger.

          • triggerTargetArn (string) --

            The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.

          • triggerEvents (list) --

            The event type or types for which notifications are triggered.

            • (string) --

      • alarmConfiguration (dict) --

        A list of alarms associated with the deployment group.

        • enabled (boolean) --

          Indicates whether the alarm configuration is enabled.

        • ignorePollAlarmFailure (boolean) --

          Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

          • true: The deployment will proceed even if alarm status information can't be retrieved from Amazon CloudWatch.

          • false: The deployment will stop if alarm status information can't be retrieved from Amazon CloudWatch.

        • alarms (list) --

          A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.

          • (dict) --

            Information about an alarm.

            • name (string) --

              The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

      • autoRollbackConfiguration (dict) --

        Information about the automatic rollback configuration associated with the deployment group.

        • enabled (boolean) --

          Indicates whether a defined automatic rollback configuration is currently enabled.

        • events (list) --

          The event type or types that trigger a rollback.

          • (string) --

      • deploymentStyle (dict) --

        Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

        • deploymentType (string) --

          Indicates whether to run an in-place deployment or a blue/green deployment.

        • deploymentOption (string) --

          Indicates whether to route deployment traffic behind a load balancer.

      • blueGreenDeploymentConfiguration (dict) --

        Information about blue/green deployment options for a deployment group.

        • terminateBlueInstancesOnDeploymentSuccess (dict) --

          Information about whether to terminate instances in the original fleet during a blue/green deployment.

          • action (string) --

            The action to take on instances in the original environment after a successful blue/green deployment.

            • TERMINATE: Instances are terminated after a specified wait time.

            • KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

          • terminationWaitTimeInMinutes (integer) --

            The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

        • deploymentReadyOption (dict) --

          Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

          • actionOnTimeout (string) --

            Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

            • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

            • STOP_DEPLOYMENT: Do not register new instances with load balancer unless traffic is rerouted manually. If traffic is not rerouted manually before the end of the specified wait period, the deployment status is changed to Stopped.

          • waitTimeInMinutes (integer) --

            The number of minutes to wait before the status of a blue/green deployment changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout

        • greenFleetProvisioningOption (dict) --

          Information about how instances are provisioned for a replacement environment in a blue/green deployment.

          • action (string) --

            The method used to add instances to a replacement environment.

            • DISCOVER_EXISTING: Use instances that already exist or will be created manually.

            • COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.

      • loadBalancerInfo (dict) --

        Information about the load balancer to use in a deployment.

        • elbInfoList (list) --

          An array containing information about the load balancer in Elastic Load Balancing to use in a deployment.

          • (dict) --

            Information about a load balancer in Elastic Load Balancing to use in a deployment.

            • name (string) --

              For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.

      • lastSuccessfulDeployment (dict) --

        Information about the most recent successful deployment to the deployment group.

        • deploymentId (string) --

          The deployment ID.

        • status (string) --

          The status of the most recent deployment.

        • endTime (datetime) --

          A timestamp indicating when the most recent deployment to the deployment group completed.

        • createTime (datetime) --

          A timestamp indicating when the most recent deployment to the deployment group started.

      • lastAttemptedDeployment (dict) --

        Information about the most recent attempted deployment to the deployment group.

        • deploymentId (string) --

          The deployment ID.

        • status (string) --

          The status of the most recent deployment.

        • endTime (datetime) --

          A timestamp indicating when the most recent deployment to the deployment group completed.

        • createTime (datetime) --

          A timestamp indicating when the most recent deployment to the deployment group started.