2020/02/20 - Amazon AppConfig - 8 updated api methods
Changes This release adds exponential growth type support for deployment strategies.
{'GrowthType': {'EXPONENTIAL'}}
A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
See also: AWS API Documentation
Request Syntax
client.create_deployment_strategy(
Name='string',
Description='string',
DeploymentDurationInMinutes=123,
FinalBakeTimeInMinutes=123,
GrowthFactor=...,
GrowthType='LINEAR'|'EXPONENTIAL',
ReplicateTo='NONE'|'SSM_DOCUMENT',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
A name for the deployment strategy.
string
A description of the deployment strategy.
integer
[REQUIRED]
Total amount of time for a deployment to last.
integer
The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
float
[REQUIRED]
The percentage of targets to receive a deployed configuration during each interval.
string
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:
Linear : For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage . For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.
Exponential : For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N) . In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:
2*(2^0)
2*(2^1)
2*(2^2)
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
string
[REQUIRED]
Save the deployment strategy to a Systems Manager (SSM) document.
dict
Metadata to assign to the deployment strategy. 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) --
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'ReplicateTo': 'NONE'|'SSM_DOCUMENT'
}
Response Structure
(dict) --
Id (string) --
The deployment strategy ID.
Name (string) --
The name of the deployment strategy.
Description (string) --
The description of the deployment strategy.
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 that received 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.
ReplicateTo (string) --
Save the deployment strategy to a Systems Manager (SSM) document.
{'GrowthType': {'EXPONENTIAL'}}
Retrieve information about a configuration deployment.
See also: AWS API Documentation
Request Syntax
client.get_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentNumber=123
)
string
[REQUIRED]
The ID of the application that includes the deployment you want to get.
string
[REQUIRED]
The ID of the environment that includes the deployment you want to get.
integer
[REQUIRED]
The sequence number of the deployment.
dict
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',
'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.
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.
{'GrowthType': {'EXPONENTIAL'}}
Retrieve information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
See also: AWS API Documentation
Request Syntax
client.get_deployment_strategy(
DeploymentStrategyId='string'
)
string
[REQUIRED]
The ID of the deployment strategy to get.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'ReplicateTo': 'NONE'|'SSM_DOCUMENT'
}
Response Structure
(dict) --
Id (string) --
The deployment strategy ID.
Name (string) --
The name of the deployment strategy.
Description (string) --
The description of the deployment strategy.
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 that received 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.
ReplicateTo (string) --
Save the deployment strategy to a Systems Manager (SSM) document.
{'Items': {'GrowthType': {'EXPONENTIAL'}}}
List deployment strategies.
See also: AWS API Documentation
Request Syntax
client.list_deployment_strategies(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
string
A token to start the list. Use this token to get the next set of results.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'ReplicateTo': 'NONE'|'SSM_DOCUMENT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The elements from this collection.
(dict) --
Id (string) --
The deployment strategy ID.
Name (string) --
The name of the deployment strategy.
Description (string) --
The description of the deployment strategy.
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 that received 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.
ReplicateTo (string) --
Save the deployment strategy to a Systems Manager (SSM) document.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
{'Items': {'GrowthType': {'EXPONENTIAL'}}}
Lists the deployments for an environment.
See also: AWS API Documentation
Request Syntax
client.list_deployments(
ApplicationId='string',
EnvironmentId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
integer
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
string
A token to start the list. Use this token to get the next set of results.
dict
Response Syntax
{
'Items': [
{
'DeploymentNumber': 123,
'ConfigurationName': 'string',
'ConfigurationVersion': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The elements from this collection.
(dict) --
Information about the deployment.
DeploymentNumber (integer) --
The sequence number of the deployment.
ConfigurationName (string) --
The name of the configuration.
ConfigurationVersion (string) --
The version of the configuration.
DeploymentDurationInMinutes (integer) --
Total amount of time the deployment lasted.
GrowthType (string) --
The algorithm used to define how percentage grows over time.
GrowthFactor (float) --
The percentage of targets to receive a deployed configuration during each interval.
FinalBakeTimeInMinutes (integer) --
The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
State (string) --
The state of the deployment.
PercentageComplete (float) --
The percentage of targets for which the deployment is available.
StartedAt (datetime) --
Time the deployment started.
CompletedAt (datetime) --
Time the deployment completed.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
{'GrowthType': {'EXPONENTIAL'}}
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'
}
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
string
[REQUIRED]
The deployment strategy ID.
string
[REQUIRED]
The configuration profile ID.
string
[REQUIRED]
The configuration version to deploy.
string
A description of the deployment.
dict
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) --
dict
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',
'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.
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.
{'GrowthType': {'EXPONENTIAL'}}
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
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
integer
[REQUIRED]
The sequence number of the deployment.
dict
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',
'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.
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.
{'GrowthType': {'EXPONENTIAL'}}
Updates a deployment strategy.
See also: AWS API Documentation
Request Syntax
client.update_deployment_strategy(
DeploymentStrategyId='string',
Description='string',
DeploymentDurationInMinutes=123,
FinalBakeTimeInMinutes=123,
GrowthFactor=...,
GrowthType='LINEAR'|'EXPONENTIAL'
)
string
[REQUIRED]
The deployment strategy ID.
string
A description of the deployment strategy.
integer
Total amount of time for a deployment to last.
integer
The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
float
The percentage of targets to receive a deployed configuration during each interval.
string
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:
Linear : For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.
Exponential : For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N) . In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:
2*(2^0)
2*(2^1)
2*(2^2)
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'ReplicateTo': 'NONE'|'SSM_DOCUMENT'
}
Response Structure
(dict) --
Id (string) --
The deployment strategy ID.
Name (string) --
The name of the deployment strategy.
Description (string) --
The description of the deployment strategy.
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 that received 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.
ReplicateTo (string) --
Save the deployment strategy to a Systems Manager (SSM) document.