AWS API Changes

2020/03/31 - Amazon AppConfig - 3 updated api methods

Changes This release adds an event log to deployments. In the case of a deployment rollback, the event log details the rollback reason.

GetDeployment (updated)

Link ¶
Changes (response)

{'EventLog': [{'Description': 'string',
               'EventType': 'PERCENTAGE_UPDATED | ROLLBACK_STARTED | '
                            'ROLLBACK_COMPLETED | BAKE_TIME_STARTED | '
                            'DEPLOYMENT_STARTED | DEPLOYMENT_COMPLETED',
               'OccurredAt': 'timestamp',
               'TriggeredBy': 'USER | APPCONFIG | CLOUDWATCH_ALARM | '
                              'INTERNAL_ERROR'}]}

Retrieve information about a configuration deployment.

See also: AWS API Documentation

Request Syntax

client.get_deployment(
    ApplicationId='string',
    EnvironmentId='string',
    DeploymentNumber=123
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The ID of the application that includes the deployment you want to get.

type EnvironmentId

string

param EnvironmentId

[REQUIRED]

The ID of the environment that includes the deployment you want to get.

type DeploymentNumber

integer

param DeploymentNumber

[REQUIRED]

The sequence number of the deployment.

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'EnvironmentId': 'string',
    'DeploymentStrategyId': 'string',
    'ConfigurationProfileId': 'string',
    'DeploymentNumber': 123,
    'ConfigurationName': 'string',
    'ConfigurationLocationUri': 'string',
    'ConfigurationVersion': 'string',
    'Description': 'string',
    'DeploymentDurationInMinutes': 123,
    'GrowthType': 'LINEAR'|'EXPONENTIAL',
    'GrowthFactor': ...,
    'FinalBakeTimeInMinutes': 123,
    'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
    'EventLog': [
        {
            'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
            'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
            'Description': 'string',
            'OccurredAt': datetime(2015, 1, 1)
        },
    ],
    'PercentageComplete': ...,
    'StartedAt': datetime(2015, 1, 1),
    'CompletedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- ApplicationId (string) --
  
  The ID of the application that was deployed.
- EnvironmentId (string) --
  
  The ID of the environment that was deployed.
- DeploymentStrategyId (string) --
  
  The ID of the deployment strategy that was deployed.
- ConfigurationProfileId (string) --
  
  The ID of the configuration profile that was deployed.
- DeploymentNumber (integer) --
  
  The sequence number of the deployment.
- ConfigurationName (string) --
  
  The name of the configuration.
- ConfigurationLocationUri (string) --
  
  Information about the source location of the configuration.
- ConfigurationVersion (string) --
  
  The configuration version that was deployed.
- Description (string) --
  
  The description of the deployment.
- DeploymentDurationInMinutes (integer) --
  
  Total amount of time the deployment lasted.
- GrowthType (string) --
  
  The algorithm used to define how percentage grew over time.
- GrowthFactor (float) --
  
  The percentage of targets to receive a deployed configuration during each interval.
- FinalBakeTimeInMinutes (integer) --
  
  The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
- State (string) --
  
  The state of the deployment.
- EventLog (list) --
  
  A list containing all events related to a deployment. The most recent events are displayed first.
  - (dict) --
    
    An object that describes a deployment event.
    - EventType (string) --
      
      The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.
    - TriggeredBy (string) --
      
      The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.
    - Description (string) --
      
      A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.
    - OccurredAt (datetime) --
      
      The date and time the event occurred.
- PercentageComplete (float) --
  
  The percentage of targets for which the deployment is available.
- StartedAt (datetime) --
  
  The time the deployment started.
- CompletedAt (datetime) --
  
  The time the deployment completed.

StartDeployment (updated)

Link ¶
Changes (response)

{'EventLog': [{'Description': 'string',
               'EventType': 'PERCENTAGE_UPDATED | ROLLBACK_STARTED | '
                            'ROLLBACK_COMPLETED | BAKE_TIME_STARTED | '
                            'DEPLOYMENT_STARTED | DEPLOYMENT_COMPLETED',
               'OccurredAt': 'timestamp',
               'TriggeredBy': 'USER | APPCONFIG | CLOUDWATCH_ALARM | '
                              'INTERNAL_ERROR'}]}

Starts a deployment.

See also: AWS API Documentation

Request Syntax

client.start_deployment(
    ApplicationId='string',
    EnvironmentId='string',
    DeploymentStrategyId='string',
    ConfigurationProfileId='string',
    ConfigurationVersion='string',
    Description='string',
    Tags={
        'string': 'string'
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type EnvironmentId

string

param EnvironmentId

[REQUIRED]

The environment ID.

type DeploymentStrategyId

string

param DeploymentStrategyId

[REQUIRED]

The deployment strategy ID.

type ConfigurationProfileId

string

param ConfigurationProfileId

[REQUIRED]

The configuration profile ID.

type ConfigurationVersion

string

param ConfigurationVersion

[REQUIRED]

The configuration version to deploy.

type Description

string

param Description

A description of the deployment.

type Tags

dict

param Tags

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'EnvironmentId': 'string',
    'DeploymentStrategyId': 'string',
    'ConfigurationProfileId': 'string',
    'DeploymentNumber': 123,
    'ConfigurationName': 'string',
    'ConfigurationLocationUri': 'string',
    'ConfigurationVersion': 'string',
    'Description': 'string',
    'DeploymentDurationInMinutes': 123,
    'GrowthType': 'LINEAR'|'EXPONENTIAL',
    'GrowthFactor': ...,
    'FinalBakeTimeInMinutes': 123,
    'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
    'EventLog': [
        {
            'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
            'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
            'Description': 'string',
            'OccurredAt': datetime(2015, 1, 1)
        },
    ],
    'PercentageComplete': ...,
    'StartedAt': datetime(2015, 1, 1),
    'CompletedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- ApplicationId (string) --
  
  The ID of the application that was deployed.
- EnvironmentId (string) --
  
  The ID of the environment that was deployed.
- DeploymentStrategyId (string) --
  
  The ID of the deployment strategy that was deployed.
- ConfigurationProfileId (string) --
  
  The ID of the configuration profile that was deployed.
- DeploymentNumber (integer) --
  
  The sequence number of the deployment.
- ConfigurationName (string) --
  
  The name of the configuration.
- ConfigurationLocationUri (string) --
  
  Information about the source location of the configuration.
- ConfigurationVersion (string) --
  
  The configuration version that was deployed.
- Description (string) --
  
  The description of the deployment.
- DeploymentDurationInMinutes (integer) --
  
  Total amount of time the deployment lasted.
- GrowthType (string) --
  
  The algorithm used to define how percentage grew over time.
- GrowthFactor (float) --
  
  The percentage of targets to receive a deployed configuration during each interval.
- FinalBakeTimeInMinutes (integer) --
  
  The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
- State (string) --
  
  The state of the deployment.
- EventLog (list) --
  
  A list containing all events related to a deployment. The most recent events are displayed first.
  - (dict) --
    
    An object that describes a deployment event.
    - EventType (string) --
      
      The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.
    - TriggeredBy (string) --
      
      The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.
    - Description (string) --
      
      A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.
    - OccurredAt (datetime) --
      
      The date and time the event occurred.
- PercentageComplete (float) --
  
  The percentage of targets for which the deployment is available.
- StartedAt (datetime) --
  
  The time the deployment started.
- CompletedAt (datetime) --
  
  The time the deployment completed.

StopDeployment (updated)

Link ¶
Changes (response)

{'EventLog': [{'Description': 'string',
               'EventType': 'PERCENTAGE_UPDATED | ROLLBACK_STARTED | '
                            'ROLLBACK_COMPLETED | BAKE_TIME_STARTED | '
                            'DEPLOYMENT_STARTED | DEPLOYMENT_COMPLETED',
               'OccurredAt': 'timestamp',
               'TriggeredBy': 'USER | APPCONFIG | CLOUDWATCH_ALARM | '
                              'INTERNAL_ERROR'}]}

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING . This action moves the deployment to a status of ROLLED_BACK .

See also: AWS API Documentation

Request Syntax

client.stop_deployment(
    ApplicationId='string',
    EnvironmentId='string',
    DeploymentNumber=123
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type EnvironmentId

string

param EnvironmentId

[REQUIRED]

The environment ID.

type DeploymentNumber

integer

param DeploymentNumber

[REQUIRED]

The sequence number of the deployment.

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'EnvironmentId': 'string',
    'DeploymentStrategyId': 'string',
    'ConfigurationProfileId': 'string',
    'DeploymentNumber': 123,
    'ConfigurationName': 'string',
    'ConfigurationLocationUri': 'string',
    'ConfigurationVersion': 'string',
    'Description': 'string',
    'DeploymentDurationInMinutes': 123,
    'GrowthType': 'LINEAR'|'EXPONENTIAL',
    'GrowthFactor': ...,
    'FinalBakeTimeInMinutes': 123,
    'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
    'EventLog': [
        {
            'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
            'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
            'Description': 'string',
            'OccurredAt': datetime(2015, 1, 1)
        },
    ],
    'PercentageComplete': ...,
    'StartedAt': datetime(2015, 1, 1),
    'CompletedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- ApplicationId (string) --
  
  The ID of the application that was deployed.
- EnvironmentId (string) --
  
  The ID of the environment that was deployed.
- DeploymentStrategyId (string) --
  
  The ID of the deployment strategy that was deployed.
- ConfigurationProfileId (string) --
  
  The ID of the configuration profile that was deployed.
- DeploymentNumber (integer) --
  
  The sequence number of the deployment.
- ConfigurationName (string) --
  
  The name of the configuration.
- ConfigurationLocationUri (string) --
  
  Information about the source location of the configuration.
- ConfigurationVersion (string) --
  
  The configuration version that was deployed.
- Description (string) --
  
  The description of the deployment.
- DeploymentDurationInMinutes (integer) --
  
  Total amount of time the deployment lasted.
- GrowthType (string) --
  
  The algorithm used to define how percentage grew over time.
- GrowthFactor (float) --
  
  The percentage of targets to receive a deployed configuration during each interval.
- FinalBakeTimeInMinutes (integer) --
  
  The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
- State (string) --
  
  The state of the deployment.
- EventLog (list) --
  
  A list containing all events related to a deployment. The most recent events are displayed first.
  - (dict) --
    
    An object that describes a deployment event.
    - EventType (string) --
      
      The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.
    - TriggeredBy (string) --
      
      The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.
    - Description (string) --
      
      A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.
    - OccurredAt (datetime) --
      
      The date and time the event occurred.
- PercentageComplete (float) --
  
  The percentage of targets for which the deployment is available.
- StartedAt (datetime) --
  
  The time the deployment started.
- CompletedAt (datetime) --
  
  The time the deployment completed.