2019/11/25 - Amazon AppConfig - 29 new api methods
Changes Introducing AWS AppConfig, a new service that enables customers to quickly deploy validated configurations to applications of any size in a controlled and monitored fashion.
Delete an environment. Deleting an environment does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
client.delete_environment(
ApplicationId='string',
EnvironmentId='string'
)
string
[REQUIRED]
The application ID that includes the environment you want to delete.
string
[REQUIRED]
The ID of the environment you want to delete.
None
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',
'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.
Updates an application.
See also: AWS API Documentation
Request Syntax
client.update_application(
ApplicationId='string',
Name='string',
Description='string'
)
string
[REQUIRED]
The application ID.
string
The name of the application.
string
A description of the application.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Id (string) --
The application ID.
Name (string) --
The application name.
Description (string) --
The description of the application.
Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
client.delete_configuration_profile(
ApplicationId='string',
ConfigurationProfileId='string'
)
string
[REQUIRED]
The application ID that includes the configuration profile you want to delete.
string
[REQUIRED]
The ID of the configuration profile you want to delete.
None
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',
'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.
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',
'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.
Lists the configuration profiles for an application.
See also: AWS API Documentation
Request Syntax
client.list_configuration_profiles(
ApplicationId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The application 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': [
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'LocationUri': 'string',
'ValidatorTypes': [
'JSON_SCHEMA'|'LAMBDA',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The elements from this collection.
(dict) --
A summary of a configuration profile.
ApplicationId (string) --
The application ID.
Id (string) --
The ID of the configuration profile.
Name (string) --
The name of the configuration profile.
LocationUri (string) --
The URI location of the configuration.
ValidatorTypes (list) --
The types of validators in the configuration profile.
(string) --
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Deletes a tag key and value from an AppConfig resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource for which to remove tags.
list
[REQUIRED]
The tag keys to delete.
(string) --
None
Uses the validators in a configuration profile to validate a configuration.
See also: AWS API Documentation
Request Syntax
client.validate_configuration(
ApplicationId='string',
ConfigurationProfileId='string',
ConfigurationVersion='string'
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The configuration profile ID.
string
[REQUIRED]
The version of the configuration to validate.
None
Updates an environment.
See also: AWS API Documentation
Request Syntax
client.update_environment(
ApplicationId='string',
EnvironmentId='string',
Name='string',
Description='string',
Monitors=[
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
]
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
string
The name of the environment.
string
A description of the environment.
list
Amazon CloudWatch alarms to monitor during the deployment process.
(dict) --
Amazon CloudWatch alarms to monitor during the deployment process.
AlarmArn (string) --
ARN of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an IAM role for AppConfig to monitor AlarmArn .
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK',
'Monitors': [
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
Id (string) --
The environment ID.
Name (string) --
The name of the environment.
Description (string) --
The description of the environment.
State (string) --
The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK
Monitors (list) --
Amazon CloudWatch alarms monitored during the deployment.
(dict) --
Amazon CloudWatch alarms to monitor during the deployment process.
AlarmArn (string) --
ARN of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an IAM role for AppConfig to monitor AlarmArn .
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',
'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.
For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
See also: AWS API Documentation
Request Syntax
client.create_environment(
ApplicationId='string',
Name='string',
Description='string',
Monitors=[
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
],
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
A name for the environment.
string
A description of the environment.
list
Amazon CloudWatch alarms to monitor during the deployment process.
(dict) --
Amazon CloudWatch alarms to monitor during the deployment process.
AlarmArn (string) --
ARN of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an IAM role for AppConfig to monitor AlarmArn .
dict
Metadata to assign to the environment. 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',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK',
'Monitors': [
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
Id (string) --
The environment ID.
Name (string) --
The name of the environment.
Description (string) --
The description of the environment.
State (string) --
The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK
Monitors (list) --
Amazon CloudWatch alarms monitored during the deployment.
(dict) --
Amazon CloudWatch alarms to monitor during the deployment process.
AlarmArn (string) --
ARN of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an IAM role for AppConfig to monitor AlarmArn .
List all applications in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_applications(
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'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The elements from this collection.
(dict) --
Id (string) --
The application ID.
Name (string) --
The application name.
Description (string) --
The description of the application.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
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',
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.
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',
'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.
Retrieves the list of key-value tags assigned to the resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The resource ARN.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
Metadata to assign to AppConfig resources. 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) --
An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.
See also: AWS API Documentation
Request Syntax
client.create_application(
Name='string',
Description='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
A name for the application.
string
A description of the application.
dict
Metadata to assign to the application. 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'
}
Response Structure
(dict) --
Id (string) --
The application ID.
Name (string) --
The application name.
Description (string) --
The description of the application.
Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
client.delete_deployment_strategy(
DeploymentStrategyId='string'
)
string
[REQUIRED]
The ID of the deployment strategy you want to delete.
None
Metadata to assign to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource for which to retrieve tags.
dict
[REQUIRED]
The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.
(string) --
(string) --
None
Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents and SSM Parameter Store parameters. A configuration profile includes the following information.
The Uri location of the configuration data.
The AWS Identity and Access Management (IAM) role that provides access to the configuration data.
A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function.
See also: AWS API Documentation
Request Syntax
client.create_configuration_profile(
ApplicationId='string',
Name='string',
Description='string',
LocationUri='string',
RetrievalRoleArn='string',
Validators=[
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
],
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
A name for the configuration profile.
string
A description of the configuration profile.
string
[REQUIRED]
A URI to locate the configuration. You can specify either a Systems Manager (SSM) document or an SSM Parameter Store parameter. For an SSM document, specify either the document name in the format ssm-document://<Document name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter name> or the ARN.
string
[REQUIRED]
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
list
A list of methods for validating the configuration.
(dict) --
A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
Type (string) -- [REQUIRED]
AppConfig supports validators of type JSON_SCHEMA and LAMBDA
Content (string) -- [REQUIRED]
Either the JSON Schema content or an AWS Lambda function name.
dict
Metadata to assign to the configuration profile. 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',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'RetrievalRoleArn': 'string',
'Validators': [
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
Id (string) --
The configuration profile ID.
Name (string) --
The name of the configuration profile.
Description (string) --
The configuration profile description.
LocationUri (string) --
The URI location of the configuration.
RetrievalRoleArn (string) --
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
Validators (list) --
A list of methods for validating the configuration.
(dict) --
A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
Type (string) --
AppConfig supports validators of type JSON_SCHEMA and LAMBDA
Content (string) --
Either the JSON Schema content or an AWS Lambda function name.
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'
)
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.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR',
'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.
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',
'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.
Retrieve information about an application.
See also: AWS API Documentation
Request Syntax
client.get_application(
ApplicationId='string'
)
string
[REQUIRED]
The ID of the application you want to get.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Id (string) --
The application ID.
Name (string) --
The application name.
Description (string) --
The description of the application.
List the environments for an application.
See also: AWS API Documentation
Request Syntax
client.list_environments(
ApplicationId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The application 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': [
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK',
'Monitors': [
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The elements from this collection.
(dict) --
ApplicationId (string) --
The application ID.
Id (string) --
The environment ID.
Name (string) --
The name of the environment.
Description (string) --
The description of the environment.
State (string) --
The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK
Monitors (list) --
Amazon CloudWatch alarms monitored during the deployment.
(dict) --
Amazon CloudWatch alarms to monitor during the deployment process.
AlarmArn (string) --
ARN of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an IAM role for AppConfig to monitor AlarmArn .
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Delete an application. Deleting an application does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
client.delete_application(
ApplicationId='string'
)
string
[REQUIRED]
The ID of the application to delete.
None
Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
See also: AWS API Documentation
Request Syntax
client.get_environment(
ApplicationId='string',
EnvironmentId='string'
)
string
[REQUIRED]
The ID of the application that includes the environment you want to get.
string
[REQUIRED]
The ID of the environment you wnat to get.
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK',
'Monitors': [
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
Id (string) --
The environment ID.
Name (string) --
The name of the environment.
Description (string) --
The description of the environment.
State (string) --
The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK
Monitors (list) --
Amazon CloudWatch alarms monitored during the deployment.
(dict) --
Amazon CloudWatch alarms to monitor during the deployment process.
AlarmArn (string) --
ARN of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an IAM role for AppConfig to monitor AlarmArn .
Retrieve information about a configuration profile.
See also: AWS API Documentation
Request Syntax
client.get_configuration_profile(
ApplicationId='string',
ConfigurationProfileId='string'
)
string
[REQUIRED]
The ID of the application that includes the configuration profile you want to get.
string
[REQUIRED]
The ID of the configuration profile you want to get.
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'RetrievalRoleArn': 'string',
'Validators': [
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
Id (string) --
The configuration profile ID.
Name (string) --
The name of the configuration profile.
Description (string) --
The configuration profile description.
LocationUri (string) --
The URI location of the configuration.
RetrievalRoleArn (string) --
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
Validators (list) --
A list of methods for validating the configuration.
(dict) --
A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
Type (string) --
AppConfig supports validators of type JSON_SCHEMA and LAMBDA
Content (string) --
Either the JSON Schema content or an AWS Lambda function name.
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',
'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.
Retrieve information about a configuration.
See also: AWS API Documentation
Request Syntax
client.get_configuration(
Application='string',
Environment='string',
Configuration='string',
ClientId='string',
ClientConfigurationVersion='string'
)
string
[REQUIRED]
The application to get.
string
[REQUIRED]
The environment to get.
string
[REQUIRED]
The configuration to get.
string
[REQUIRED]
A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
string
The configuration version returned in the most recent GetConfiguration response.
dict
Response Syntax
{
'Content': StreamingBody(),
'ConfigurationVersion': 'string',
'ContentType': 'string'
}
Response Structure
(dict) --
Content (:class:`.StreamingBody`) --
The content of the configuration or the configuration data.
ConfigurationVersion (string) --
The configuration version.
ContentType (string) --
A standard MIME type describing the format of the configuration content. For more information, see Content-Type .
Updates a configuration profile.
See also: AWS API Documentation
Request Syntax
client.update_configuration_profile(
ApplicationId='string',
ConfigurationProfileId='string',
Name='string',
Description='string',
RetrievalRoleArn='string',
Validators=[
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
]
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The ID of the configuration profile.
string
The name of the configuration profile.
string
A description of the configuration profile.
string
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
list
A list of methods for validating the configuration.
(dict) --
A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
Type (string) -- [REQUIRED]
AppConfig supports validators of type JSON_SCHEMA and LAMBDA
Content (string) -- [REQUIRED]
Either the JSON Schema content or an AWS Lambda function name.
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'RetrievalRoleArn': 'string',
'Validators': [
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
]
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
Id (string) --
The configuration profile ID.
Name (string) --
The name of the configuration profile.
Description (string) --
The configuration profile description.
LocationUri (string) --
The URI location of the configuration.
RetrievalRoleArn (string) --
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
Validators (list) --
A list of methods for validating the configuration.
(dict) --
A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
Type (string) --
AppConfig supports validators of type JSON_SCHEMA and LAMBDA
Content (string) --
Either the JSON Schema content or an AWS Lambda function name.