Table of Contents
AppConfig.Client¶A low-level client representing Amazon AppConfig
Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT devices.
To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.
AppConfig supports multiple use cases. Here are some examples:
This reference is intended to be used with the AppConfig User Guide.
import boto3
client = boto3.client('appconfig')
These are the available methods:
can_paginate()close()create_application()create_configuration_profile()create_deployment_strategy()create_environment()create_extension()create_extension_association()create_hosted_configuration_version()delete_application()delete_configuration_profile()delete_deployment_strategy()delete_environment()delete_extension()delete_extension_association()delete_hosted_configuration_version()get_application()get_configuration()get_configuration_profile()get_deployment()get_deployment_strategy()get_environment()get_extension()get_extension_association()get_hosted_configuration_version()get_paginator()get_waiter()list_applications()list_configuration_profiles()list_deployment_strategies()list_deployments()list_environments()list_extension_associations()list_extensions()list_hosted_configuration_versions()list_tags_for_resource()start_deployment()stop_deployment()tag_resource()untag_resource()update_application()update_configuration_profile()update_deployment_strategy()update_environment()update_extension()update_extension_association()validate_configuration()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_application(**kwargs)¶Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
See also: AWS API Documentation
Request Syntax
response = client.create_application(
Name='string',
Description='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
A name for the application.
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.
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.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following create-application example creates an application in AWS AppConfig.
response = client.create_application(
Description='An application used for creating an example.',
Name='example-application',
)
print(response)
Expected Output:
{
'Description': 'An application used for creating an example.',
'Id': '339ohji',
'Name': 'example-application',
'ResponseMetadata': {
'...': '...',
},
}
create_configuration_profile(**kwargs)¶Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:
A configuration profile includes the following information:
For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_configuration_profile(
ApplicationId='string',
Name='string',
Description='string',
LocationUri='string',
RetrievalRoleArn='string',
Validators=[
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
],
Tags={
'string': 'string'
},
Type='string'
)
[REQUIRED]
The application ID.
[REQUIRED]
A name for the configuration profile.
[REQUIRED]
A URI to locate the configuration. You can specify the following:
hosted .ssm-parameter://<parameter name> or the ARN.secrets-manager ://<secret name>.s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.jsonssm-document://<document name> or the Amazon Resource Name (ARN).The ARN of an IAM role with permission to access the configuration at the specified LocationUri .
Warning
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
A list of methods for validating the configuration.
A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
AppConfig supports validators of type JSON_SCHEMA and LAMBDA
Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
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.
The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :
AWS.AppConfig.FeatureFlags
AWS.Freeform
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'RetrievalRoleArn': 'string',
'Validators': [
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
],
'Type': '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 that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services 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 the Amazon Resource Name (ARN) of an Lambda function.
Type (string) --
The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :
AWS.AppConfig.FeatureFlags
AWS.Freeform
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager.
response = client.create_configuration_profile(
ApplicationId='339ohji',
LocationUri='ssm-parameter://Example-Parameter',
Name='Example-Configuration-Profile',
RetrievalRoleArn='arn:aws:iam::111122223333:role/Example-App-Config-Role',
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'Id': 'ur8hx2f',
'LocationUri': 'ssm-parameter://Example-Parameter',
'Name': 'Example-Configuration-Profile',
'RetrievalRoleArn': 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
'ResponseMetadata': {
'...': '...',
},
}
create_deployment_strategy(**kwargs)¶Creates a deployment strategy that 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
response = client.create_deployment_strategy(
Name='string',
Description='string',
DeploymentDurationInMinutes=123,
FinalBakeTimeInMinutes=123,
GrowthFactor=...,
GrowthType='LINEAR'|'EXPONENTIAL',
ReplicateTo='NONE'|'SSM_DOCUMENT',
Tags={
'string': 'string'
}
)
[REQUIRED]
A name for the deployment strategy.
[REQUIRED]
Total amount of time for a deployment to last.
[REQUIRED]
The percentage of targets to receive a deployed configuration during each interval.
The algorithm used to define how percentage grows over time. 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 forStep percentage. For example, a linear deployment that uses aStep percentageof 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,Gis the growth factor specified by the user andNis 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.
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.
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
ReplicateTo (string) --
Save the deployment strategy to a Systems Manager (SSM) document.
Exceptions
AppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following create-deployment-strategy example creates a deployment strategy called Example-Deployment that takes 15 minutes and deploys the configuration to 25% of the application at a time. The strategy is also copied to an SSM Document.
response = client.create_deployment_strategy(
DeploymentDurationInMinutes=15,
GrowthFactor=25,
Name='Example-Deployment',
ReplicateTo='SSM_DOCUMENT',
)
print(response)
Expected Output:
{
'DeploymentDurationInMinutes': 15,
'FinalBakeTimeInMinutes': 0,
'GrowthFactor': 25,
'GrowthType': 'LINEAR',
'Id': '1225qzk',
'Name': 'Example-Deployment',
'ReplicateTo': 'SSM_DOCUMENT',
'ResponseMetadata': {
'...': '...',
},
}
create_environment(**kwargs)¶Creates an environment. For each application, you define one or more environments. An environment is a 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
response = client.create_environment(
ApplicationId='string',
Name='string',
Description='string',
Monitors=[
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
],
Tags={
'string': 'string'
}
)
[REQUIRED]
The application ID.
[REQUIRED]
A name for the environment.
Amazon CloudWatch alarms to monitor during the deployment process.
Amazon CloudWatch alarms to monitor during the deployment process.
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn .
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.
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) --
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn .
Exceptions
AppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following create-environment example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application
response = client.create_environment(
ApplicationId='339ohji',
Name='Example-Environment',
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'Id': '54j1r29',
'Name': 'Example-Environment',
'State': 'READY_FOR_DEPLOYMENT',
'ResponseMetadata': {
'...': '...',
},
}
create_extension(**kwargs)¶Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For most use cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_extension(
Name='string',
Description='string',
Actions={
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
Parameters={
'string': {
'Description': 'string',
'Required': True|False
}
},
Tags={
'string': 'string'
},
LatestVersionNumber=123
)
[REQUIRED]
A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.
[REQUIRED]
The actions defined in the extension.
An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSIONPRE_START_DEPLOYMENTON_DEPLOYMENT_STARTON_DEPLOYMENT_STEPON_DEPLOYMENT_BAKINGON_DEPLOYMENT_COMPLETEON_DEPLOYMENT_ROLLED_BACKThe action name.
Information about the action.
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
Information about the parameter.
A parameter value must be specified in the extension association.
Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'Actions': {
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
'Parameters': {
'string': {
'Description': 'string',
'Required': True|False
}
}
}
Response Structure
(dict) --
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
Actions (dict) --
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSIONPRE_START_DEPLOYMENTON_DEPLOYMENT_STARTON_DEPLOYMENT_STEPON_DEPLOYMENT_BAKINGON_DEPLOYMENT_COMPLETEON_DEPLOYMENT_ROLLED_BACKName (string) --
The action name.
Description (string) --
Information about the action.
Uri (string) --
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
Parameters (dict) --
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.
(string) --
(dict) --
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ConflictExceptionAppConfig.Client.exceptions.ServiceQuotaExceededExceptionAppConfig.Client.exceptions.InternalServerExceptioncreate_extension_association(**kwargs)¶When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association . An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_extension_association(
ExtensionIdentifier='string',
ExtensionVersionNumber=123,
ResourceIdentifier='string',
Parameters={
'string': 'string'
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
[REQUIRED]
The ARN of an application, configuration profile, or environment.
The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.
Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
dict
Response Syntax
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string',
'Arn': 'string',
'Parameters': {
'string': 'string'
},
'ExtensionVersionNumber': 123
}
Response Structure
(dict) --
Id (string) --
The system-generated ID for the association.
ExtensionArn (string) --
The ARN of the extension defined in the association.
ResourceArn (string) --
The ARNs of applications, configuration profiles, or environments defined in the association.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Parameters (dict) --
The parameter names and values defined in the association.
ExtensionVersionNumber (integer) --
The version number for the extension defined in the association.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.ServiceQuotaExceededExceptioncreate_hosted_configuration_version(**kwargs)¶Creates a new configuration in the AppConfig hosted configuration store.
See also: AWS API Documentation
Request Syntax
response = client.create_hosted_configuration_version(
ApplicationId='string',
ConfigurationProfileId='string',
Description='string',
Content=b'bytes'|file,
ContentType='string',
LatestVersionNumber=123,
VersionLabel='string'
)
[REQUIRED]
The application ID.
[REQUIRED]
The configuration profile ID.
[REQUIRED]
The content of the configuration or the configuration data.
[REQUIRED]
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
dict
Response Syntax
{
'ApplicationId': 'string',
'ConfigurationProfileId': 'string',
'VersionNumber': 123,
'Description': 'string',
'Content': StreamingBody(),
'ContentType': 'string',
'VersionLabel': 'string'
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
ConfigurationProfileId (string) --
The configuration profile ID.
VersionNumber (integer) --
The configuration version.
Description (string) --
A description of the configuration.
Content (StreamingBody) --
The content of the configuration or the configuration data.
ContentType (string) --
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
VersionLabel (string) --
A user-defined label for an AppConfig hosted configuration version.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ServiceQuotaExceededExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.ConflictExceptionAppConfig.Client.exceptions.PayloadTooLargeExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration store.
response = client.create_hosted_configuration_version(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
Content='eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9',
ContentType='text',
LatestVersionNumber=1,
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'ConfigurationProfileId': 'ur8hx2f',
'ContentType': 'text',
'VersionNumber': 1,
'ResponseMetadata': {
'...': '...',
},
}
delete_application(**kwargs)¶Deletes an application. Deleting an application does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
response = client.delete_application(
ApplicationId='string'
)
[REQUIRED]
The ID of the application to delete.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following delete-application example deletes the specified application.
response = client.delete_application(
ApplicationId='339ohji',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_configuration_profile(**kwargs)¶Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_profile(
ApplicationId='string',
ConfigurationProfileId='string'
)
[REQUIRED]
The application ID that includes the configuration profile you want to delete.
[REQUIRED]
The ID of the configuration profile you want to delete.
None
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.ConflictExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following delete-configuration-profile example deletes the specified configuration profile.
response = client.delete_configuration_profile(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_deployment_strategy(**kwargs)¶Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
response = client.delete_deployment_strategy(
DeploymentStrategyId='string'
)
[REQUIRED]
The ID of the deployment strategy you want to delete.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following delete-deployment-strategy example deletes the specified deployment strategy.
response = client.delete_deployment_strategy(
DeploymentStrategyId='1225qzk',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_environment(**kwargs)¶Deletes an environment. Deleting an environment does not delete a configuration from a host.
See also: AWS API Documentation
Request Syntax
response = client.delete_environment(
ApplicationId='string',
EnvironmentId='string'
)
[REQUIRED]
The application ID that includes the environment that you want to delete.
[REQUIRED]
The ID of the environment that you want to delete.
None
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.ConflictExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following delete-environment example deletes the specified application environment.
response = client.delete_environment(
ApplicationId='339ohji',
EnvironmentId='54j1r29',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_extension(**kwargs)¶Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
See also: AWS API Documentation
Request Syntax
response = client.delete_extension(
ExtensionIdentifier='string',
VersionNumber=123
)
[REQUIRED]
The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
None
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptiondelete_extension_association(**kwargs)¶Deletes an extension association. This action doesn't delete extensions defined in the association.
See also: AWS API Documentation
Request Syntax
response = client.delete_extension_association(
ExtensionAssociationId='string'
)
[REQUIRED]
The ID of the extension association to delete.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptiondelete_hosted_configuration_version(**kwargs)¶Deletes a version of a configuration from the AppConfig hosted configuration store.
See also: AWS API Documentation
Request Syntax
response = client.delete_hosted_configuration_version(
ApplicationId='string',
ConfigurationProfileId='string',
VersionNumber=123
)
[REQUIRED]
The application ID.
[REQUIRED]
The configuration profile ID.
[REQUIRED]
The versions number to delete.
None
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig configuration store.
response = client.delete_hosted_configuration_version(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
VersionNumber=1,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
get_application(**kwargs)¶Retrieves information about an application.
See also: AWS API Documentation
Request Syntax
response = client.get_application(
ApplicationId='string'
)
[REQUIRED]
The ID of the application you want to get.
{
'Id': 'string',
'Name': 'string',
'Description': 'string'
}
Response Structure
The application ID.
The application name.
The description of the application.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following get-application example lists the details of the specified application.
response = client.get_application(
ApplicationId='339ohji',
)
print(response)
Expected Output:
{
'Id': '339ohji',
'Name': 'example-application',
'ResponseMetadata': {
'...': '...',
},
}
get_configuration(**kwargs)¶(Deprecated) Retrieves the latest deployed configuration.
Warning
Note the following important information.
GetConfiguration is a priced call. For more information, see Pricing.Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.get_configuration(
Application='string',
Environment='string',
Configuration='string',
ClientId='string',
ClientConfigurationVersion='string'
)
[REQUIRED]
The application to get. Specify either the application name or the application ID.
[REQUIRED]
The environment to get. Specify either the environment name or the environment ID.
[REQUIRED]
The configuration to get. Specify either the configuration name or the configuration ID.
[REQUIRED]
The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
The configuration version returned in the most recent GetConfiguration response.
Warning
AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration , your clients receive the current configuration. You are charged each time your clients receive a configuration.
To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration , we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration . The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration .
For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide .
dict
Response Syntax
{
'Content': StreamingBody(),
'ConfigurationVersion': 'string',
'ContentType': 'string'
}
Response Structure
(dict) --
Content (StreamingBody) --
The content of the configuration or the configuration data.
Warning
The Content attribute only contains data if the system finds new or updated configuration data. If there is no new or updated data and ClientConfigurationVersion matches the version of the current configuration, AppConfig returns a 204 No Content HTTP response code and the Content value will be empty.
ConfigurationVersion (string) --
The configuration version.
ContentType (string) --
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following get-configuration example returns the configuration details of the example application. On subsequent calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration.
response = client.get_configuration(
Application='example-application',
ClientId='example-id',
Configuration='Example-Configuration-Profile',
Environment='Example-Environment',
)
print(response)
Expected Output:
{
'ConfigurationVersion': '1',
'ContentType': 'application/octet-stream',
'ResponseMetadata': {
'...': '...',
},
}
get_configuration_profile(**kwargs)¶Retrieves information about a configuration profile.
See also: AWS API Documentation
Request Syntax
response = client.get_configuration_profile(
ApplicationId='string',
ConfigurationProfileId='string'
)
[REQUIRED]
The ID of the application that includes the configuration profile you want to get.
[REQUIRED]
The ID of the configuration profile that 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'
},
],
'Type': '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 that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services 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 the Amazon Resource Name (ARN) of an Lambda function.
Type (string) --
The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :
AWS.AppConfig.FeatureFlags
AWS.Freeform
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following get-configuration-profile example returns the details of the specified configuration profile.
response = client.get_configuration_profile(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'Id': 'ur8hx2f',
'LocationUri': 'ssm-parameter://Example-Parameter',
'Name': 'Example-Configuration-Profile',
'RetrievalRoleArn': 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
'ResponseMetadata': {
'...': '...',
},
}
get_deployment(**kwargs)¶Retrieves information about a configuration deployment.
See also: AWS API Documentation
Request Syntax
response = client.get_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentNumber=123
)
[REQUIRED]
The ID of the application that includes the deployment you want to get.
[REQUIRED]
The ID of the environment that includes the deployment you want to get.
[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',
'EventLog': [
{
'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'Description': 'string',
'ActionInvocations': [
{
'ExtensionIdentifier': 'string',
'ActionName': 'string',
'Uri': 'string',
'RoleArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'InvocationId': 'string'
},
],
'OccurredAt': datetime(2015, 1, 1)
},
],
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'AppliedExtensions': [
{
'ExtensionId': 'string',
'ExtensionAssociationId': 'string',
'VersionNumber': 123,
'Parameters': {
'string': 'string'
}
},
],
'KmsKeyArn': 'string',
'KmsKeyIdentifier': 'string'
}
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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; and the start or completion of a rollback.
TriggeredBy (string) --
The entity that triggered the deployment event. Events can be triggered by a user, 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 Amazon 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.
ActionInvocations (list) --
The list of extensions that were invoked as part of the deployment.
(dict) --
An extension that was invoked as part of a deployment event.
ExtensionIdentifier (string) --
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ActionName (string) --
The name of the action.
Uri (string) --
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
ErrorMessage (string) --
The error message when an extension invocation fails.
ErrorCode (string) --
The error code when an extension invocation fails.
InvocationId (string) --
A system-generated ID for this invocation.
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.
AppliedExtensions (list) --
A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.
(dict) --
An extension that was invoked during a deployment.
ExtensionId (string) --
The system-generated ID of the extension.
ExtensionAssociationId (string) --
The system-generated ID for the association.
VersionNumber (integer) --
The extension version number.
Parameters (dict) --
One or more parameters for the actions called by the extension.
KmsKeyArn (string) --
The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
KmsKeyIdentifier (string) --
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following get-deployment example lists details of the deployment to the application in the specified environment and deployment.
response = client.get_deployment(
ApplicationId='339ohji',
DeploymentNumber=1,
EnvironmentId='54j1r29',
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'CompletedAt': datetime(2021, 9, 17, 21, 59, 3, 4, 260, 0),
'ConfigurationLocationUri': 'ssm-parameter://Example-Parameter',
'ConfigurationName': 'Example-Configuration-Profile',
'ConfigurationProfileId': 'ur8hx2f',
'ConfigurationVersion': '1',
'DeploymentDurationInMinutes': 15,
'DeploymentNumber': 1,
'DeploymentStrategyId': '1225qzk',
'EnvironmentId': '54j1r29',
'EventLog': [
{
'Description': 'Deployment completed',
'EventType': 'DEPLOYMENT_COMPLETED',
'OccurredAt': datetime(2021, 9, 17, 21, 59, 3, 4, 260, 0),
'TriggeredBy': 'APPCONFIG',
},
{
'Description': 'Deployment bake time started',
'EventType': 'BAKE_TIME_STARTED',
'OccurredAt': datetime(2021, 9, 17, 21, 58, 57, 4, 260, 0),
'TriggeredBy': 'APPCONFIG',
},
{
'Description': 'Configuration available to 100.00% of clients',
'EventType': 'PERCENTAGE_UPDATED',
'OccurredAt': datetime(2021, 9, 17, 21, 55, 56, 4, 260, 0),
'TriggeredBy': 'APPCONFIG',
},
{
'Description': 'Configuration available to 75.00% of clients',
'EventType': 'PERCENTAGE_UPDATED',
'OccurredAt': datetime(2021, 9, 17, 21, 52, 56, 4, 260, 0),
'TriggeredBy': 'APPCONFIG',
},
{
'Description': 'Configuration available to 50.00% of clients',
'EventType': 'PERCENTAGE_UPDATED',
'OccurredAt': datetime(2021, 9, 17, 21, 49, 55, 4, 260, 0),
'TriggeredBy': 'APPCONFIG',
},
{
'Description': 'Configuration available to 25.00% of clients',
'EventType': 'PERCENTAGE_UPDATED',
'OccurredAt': datetime(2021, 9, 17, 21, 46, 55, 4, 260, 0),
'TriggeredBy': 'APPCONFIG',
},
{
'Description': 'Deployment started',
'EventType': 'DEPLOYMENT_STARTED',
'OccurredAt': datetime(2021, 9, 17, 21, 43, 54, 4, 260, 0),
'TriggeredBy': 'USER',
},
],
'FinalBakeTimeInMinutes': 0,
'GrowthFactor': 25,
'GrowthType': 'LINEAR',
'PercentageComplete': 100,
'StartedAt': datetime(2021, 9, 17, 21, 43, 54, 4, 260, 0),
'State': 'COMPLETE',
'ResponseMetadata': {
'...': '...',
},
}
get_deployment_strategy(**kwargs)¶Retrieves 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
response = client.get_deployment_strategy(
DeploymentStrategyId='string'
)
[REQUIRED]
The ID of the deployment strategy to get.
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'ReplicateTo': 'NONE'|'SSM_DOCUMENT'
}
Response Structure
The deployment strategy ID.
The name of the deployment strategy.
The description of the deployment strategy.
Total amount of time the deployment lasted.
The algorithm used to define how percentage grew over time.
The percentage of targets that received a deployed configuration during each interval.
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
Save the deployment strategy to a Systems Manager (SSM) document.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following get-deployment-strategy example lists the details of the specified deployment strategy.
response = client.get_deployment_strategy(
DeploymentStrategyId='1225qzk',
)
print(response)
Expected Output:
{
'DeploymentDurationInMinutes': 15,
'FinalBakeTimeInMinutes': 0,
'GrowthFactor': 25,
'GrowthType': 'LINEAR',
'Id': '1225qzk',
'Name': 'Example-Deployment',
'ReplicateTo': 'SSM_DOCUMENT',
'ResponseMetadata': {
'...': '...',
},
}
get_environment(**kwargs)¶Retrieves information about an environment. An environment is a 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
response = client.get_environment(
ApplicationId='string',
EnvironmentId='string'
)
[REQUIRED]
The ID of the application that includes the environment you want to get.
[REQUIRED]
The ID of the environment that you want 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) --
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn .
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following get-environment example returns the details and state of the specified environment.
response = client.get_environment(
ApplicationId='339ohji',
EnvironmentId='54j1r29',
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'Id': '54j1r29',
'Name': 'Example-Environment',
'State': 'READY_FOR_DEPLOYMENT',
'ResponseMetadata': {
'...': '...',
},
}
get_extension(**kwargs)¶Returns information about an AppConfig extension.
See also: AWS API Documentation
Request Syntax
response = client.get_extension(
ExtensionIdentifier='string',
VersionNumber=123
)
[REQUIRED]
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'Actions': {
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
'Parameters': {
'string': {
'Description': 'string',
'Required': True|False
}
}
}
Response Structure
(dict) --
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
Actions (dict) --
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSIONPRE_START_DEPLOYMENTON_DEPLOYMENT_STARTON_DEPLOYMENT_STEPON_DEPLOYMENT_BAKINGON_DEPLOYMENT_COMPLETEON_DEPLOYMENT_ROLLED_BACKName (string) --
The action name.
Description (string) --
Information about the action.
Uri (string) --
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
Parameters (dict) --
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.
(string) --
(dict) --
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionget_extension_association(**kwargs)¶Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_extension_association(
ExtensionAssociationId='string'
)
[REQUIRED]
The extension association ID to get.
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string',
'Arn': 'string',
'Parameters': {
'string': 'string'
},
'ExtensionVersionNumber': 123
}
Response Structure
The system-generated ID for the association.
The ARN of the extension defined in the association.
The ARNs of applications, configuration profiles, or environments defined in the association.
The system-generated Amazon Resource Name (ARN) for the extension.
The parameter names and values defined in the association.
The version number for the extension defined in the association.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionget_hosted_configuration_version(**kwargs)¶Retrieves information about a specific configuration version.
See also: AWS API Documentation
Request Syntax
response = client.get_hosted_configuration_version(
ApplicationId='string',
ConfigurationProfileId='string',
VersionNumber=123
)
[REQUIRED]
The application ID.
[REQUIRED]
The configuration profile ID.
[REQUIRED]
The version.
dict
Response Syntax
{
'ApplicationId': 'string',
'ConfigurationProfileId': 'string',
'VersionNumber': 123,
'Description': 'string',
'Content': StreamingBody(),
'ContentType': 'string',
'VersionLabel': 'string'
}
Response Structure
(dict) --
ApplicationId (string) --
The application ID.
ConfigurationProfileId (string) --
The configuration profile ID.
VersionNumber (integer) --
The configuration version.
Description (string) --
A description of the configuration.
Content (StreamingBody) --
The content of the configuration or the configuration data.
ContentType (string) --
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
VersionLabel (string) --
A user-defined label for an AppConfig hosted configuration version.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted configuration.
response = client.get_hosted_configuration_version(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
VersionNumber=1,
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'ConfigurationProfileId': 'ur8hx2f',
'ContentType': 'application/json',
'VersionNumber': 1,
'ResponseMetadata': {
'...': '...',
},
}
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_applications(**kwargs)¶Lists all applications in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_applications(
MaxResults=123,
NextToken='string'
)
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.
Exceptions
AppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following list-applications example lists the available applications in your AWS account.
response = client.list_applications(
)
print(response)
Expected Output:
{
'Items': [
{
'Description': 'An application used for creating an example.',
'Id': '339ohji',
'Name': 'test-application',
},
{
'Id': 'rwalwu7',
'Name': 'Test-Application',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_configuration_profiles(**kwargs)¶Lists the configuration profiles for an application.
See also: AWS API Documentation
Request Syntax
response = client.list_configuration_profiles(
ApplicationId='string',
MaxResults=123,
NextToken='string',
Type='string'
)
[REQUIRED]
The application ID.
dict
Response Syntax
{
'Items': [
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'LocationUri': 'string',
'ValidatorTypes': [
'JSON_SCHEMA'|'LAMBDA',
],
'Type': 'string'
},
],
'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.
Type (string) --
The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :
AWS.AppConfig.FeatureFlags
AWS.Freeform
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following list-configuration-profiles example lists the available configuration profiles for the specified application.
response = client.list_configuration_profiles(
ApplicationId='339ohji',
)
print(response)
Expected Output:
{
'Items': [
{
'ApplicationId': '339ohji',
'Id': 'ur8hx2f',
'LocationUri': 'ssm-parameter://Example-Parameter',
'Name': 'Example-Configuration-Profile',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_deployment_strategies(**kwargs)¶Lists deployment strategies.
See also: AWS API Documentation
Request Syntax
response = client.list_deployment_strategies(
MaxResults=123,
NextToken='string'
)
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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.
Exceptions
AppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following list-deployment-strategies example lists the available deployment strategies in your AWS account.
response = client.list_deployment_strategies(
)
print(response)
Expected Output:
{
'Items': [
{
'DeploymentDurationInMinutes': 15,
'FinalBakeTimeInMinutes': 0,
'GrowthFactor': 25,
'GrowthType': 'LINEAR',
'Id': '1225qzk',
'Name': 'Example-Deployment',
'ReplicateTo': 'SSM_DOCUMENT',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_deployments(**kwargs)¶Lists the deployments for an environment in descending deployment number order.
See also: AWS API Documentation
Request Syntax
response = client.list_deployments(
ApplicationId='string',
EnvironmentId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The application ID.
[REQUIRED]
The environment ID.
NextToken that you can provide in a subsequent call 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 that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following list-deployments example lists the available deployments in your AWS account for the specified application and environment.
response = client.list_deployments(
ApplicationId='339ohji',
EnvironmentId='54j1r29',
)
print(response)
Expected Output:
{
'Items': [
{
'CompletedAt': datetime(2021, 9, 17, 21, 59, 3, 4, 260, 0),
'ConfigurationName': 'Example-Configuration-Profile',
'ConfigurationVersion': '1',
'DeploymentDurationInMinutes': 15,
'DeploymentNumber': 1,
'FinalBakeTimeInMinutes': 0,
'GrowthFactor': 25,
'GrowthType': 'LINEAR',
'PercentageComplete': 100,
'StartedAt': datetime(2021, 9, 17, 21, 43, 54, 4, 260, 0),
'State': 'COMPLETE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_environments(**kwargs)¶Lists the environments for an application.
See also: AWS API Documentation
Request Syntax
response = client.list_environments(
ApplicationId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The application ID.
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) --
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an Identity and Access Management (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.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following list-environments example lists the available environments in your AWS account for the specified application.
response = client.list_environments(
ApplicationId='339ohji',
)
print(response)
Expected Output:
{
'Items': [
{
'ApplicationId': '339ohji',
'Id': '54j1r29',
'Name': 'Example-Environment',
'State': 'READY_FOR_DEPLOYMENT',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_extension_associations(**kwargs)¶Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_extension_associations(
ResourceIdentifier='string',
ExtensionIdentifier='string',
ExtensionVersionNumber=123,
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of extension associations. Each item represents an extension association to an application, environment, or configuration profile.
(dict) --
Information about an association between an extension and an AppConfig resource such as an application, environment, or configuration profile. Call GetExtensionAssociation to get more information about an association.
Id (string) --
The extension association ID. This ID is used to call other ExtensionAssociation API actions such as GetExtensionAssociation or DeleteExtensionAssociation .
ExtensionArn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
ResourceArn (string) --
The ARNs of applications, configuration profiles, or environments defined in the association.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Exceptions
AppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionlist_extensions(**kwargs)¶Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_extensions(
MaxResults=123,
NextToken='string',
Name='string'
)
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of available extensions. The list includes Amazon Web Services authored and user-created extensions.
(dict) --
Information about an extension. Call GetExtension to get more information about an extension.
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Exceptions
AppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionlist_hosted_configuration_versions(**kwargs)¶Lists configurations stored in the AppConfig hosted configuration store by version.
See also: AWS API Documentation
Request Syntax
response = client.list_hosted_configuration_versions(
ApplicationId='string',
ConfigurationProfileId='string',
MaxResults=123,
NextToken='string',
VersionLabel='string'
)
[REQUIRED]
The application ID.
[REQUIRED]
The configuration profile ID.
dict
Response Syntax
{
'Items': [
{
'ApplicationId': 'string',
'ConfigurationProfileId': 'string',
'VersionNumber': 123,
'Description': 'string',
'ContentType': 'string',
'VersionLabel': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The elements from this collection.
(dict) --
Information about the configuration.
ApplicationId (string) --
The application ID.
ConfigurationProfileId (string) --
The configuration profile ID.
VersionNumber (integer) --
The configuration version.
Description (string) --
A description of the configuration.
ContentType (string) --
A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
VersionLabel (string) --
A user-defined label for an AppConfig hosted configuration version.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile.
response = client.list_hosted_configuration_versions(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
)
print(response)
Expected Output:
{
'Items': [
{
'ApplicationId': '339ohji',
'ConfigurationProfileId': 'ur8hx2f',
'ContentType': 'application/json',
'VersionNumber': 1,
},
],
'ResponseMetadata': {
'...': '...',
},
}
Retrieves the list of key-value tags assigned to the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The resource ARN.
{
'Tags': {
'string': 'string'
}
}
Response Structure
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.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following list-tags-for-resource example lists the tags of a specified application.
response = client.list_tags_for_resource(
ResourceArn='arn:aws:appconfig:us-east-1:111122223333:application/339ohji',
)
print(response)
Expected Output:
{
'Tags': {
'group1': '1',
},
'ResponseMetadata': {
'...': '...',
},
}
start_deployment(**kwargs)¶Starts a deployment.
See also: AWS API Documentation
Request Syntax
response = client.start_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentStrategyId='string',
ConfigurationProfileId='string',
ConfigurationVersion='string',
Description='string',
Tags={
'string': 'string'
},
KmsKeyIdentifier='string'
)
[REQUIRED]
The application ID.
[REQUIRED]
The environment ID.
[REQUIRED]
The deployment strategy ID.
[REQUIRED]
The configuration profile ID.
[REQUIRED]
The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.
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.
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',
'EventLog': [
{
'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'Description': 'string',
'ActionInvocations': [
{
'ExtensionIdentifier': 'string',
'ActionName': 'string',
'Uri': 'string',
'RoleArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'InvocationId': 'string'
},
],
'OccurredAt': datetime(2015, 1, 1)
},
],
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'AppliedExtensions': [
{
'ExtensionId': 'string',
'ExtensionAssociationId': 'string',
'VersionNumber': 123,
'Parameters': {
'string': 'string'
}
},
],
'KmsKeyArn': 'string',
'KmsKeyIdentifier': 'string'
}
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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; and the start or completion of a rollback.
TriggeredBy (string) --
The entity that triggered the deployment event. Events can be triggered by a user, 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 Amazon 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.
ActionInvocations (list) --
The list of extensions that were invoked as part of the deployment.
(dict) --
An extension that was invoked as part of a deployment event.
ExtensionIdentifier (string) --
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ActionName (string) --
The name of the action.
Uri (string) --
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
ErrorMessage (string) --
The error message when an extension invocation fails.
ErrorCode (string) --
The error code when an extension invocation fails.
InvocationId (string) --
A system-generated ID for this invocation.
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.
AppliedExtensions (list) --
A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.
(dict) --
An extension that was invoked during a deployment.
ExtensionId (string) --
The system-generated ID of the extension.
ExtensionAssociationId (string) --
The system-generated ID for the association.
VersionNumber (integer) --
The extension version number.
Parameters (dict) --
One or more parameters for the actions called by the extension.
KmsKeyArn (string) --
The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
KmsKeyIdentifier (string) --
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.ConflictExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.
response = client.start_deployment(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
ConfigurationVersion='1',
DeploymentStrategyId='1225qzk',
Description='',
EnvironmentId='54j1r29',
Tags={
},
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'ConfigurationLocationUri': 'ssm-parameter://Example-Parameter',
'ConfigurationName': 'Example-Configuration-Profile',
'ConfigurationProfileId': 'ur8hx2f',
'ConfigurationVersion': '1',
'DeploymentDurationInMinutes': 15,
'DeploymentNumber': 1,
'DeploymentStrategyId': '1225qzk',
'EnvironmentId': '54j1r29',
'EventLog': [
{
'Description': 'Deployment started',
'EventType': 'DEPLOYMENT_STARTED',
'OccurredAt': datetime(2021, 9, 17, 21, 43, 54, 4, 260, 0),
'TriggeredBy': 'USER',
},
],
'FinalBakeTimeInMinutes': 0,
'GrowthFactor': 25,
'GrowthType': 'LINEAR',
'PercentageComplete': 1.0,
'StartedAt': datetime(2021, 9, 17, 21, 43, 54, 4, 260, 0),
'State': 'DEPLOYING',
'ResponseMetadata': {
'...': '...',
},
}
stop_deployment(**kwargs)¶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
response = client.stop_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentNumber=123
)
[REQUIRED]
The application ID.
[REQUIRED]
The environment ID.
[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',
'EventLog': [
{
'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED',
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'Description': 'string',
'ActionInvocations': [
{
'ExtensionIdentifier': 'string',
'ActionName': 'string',
'Uri': 'string',
'RoleArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'InvocationId': 'string'
},
],
'OccurredAt': datetime(2015, 1, 1)
},
],
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'AppliedExtensions': [
{
'ExtensionId': 'string',
'ExtensionAssociationId': 'string',
'VersionNumber': 123,
'Parameters': {
'string': 'string'
}
},
],
'KmsKeyArn': 'string',
'KmsKeyIdentifier': 'string'
}
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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
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; and the start or completion of a rollback.
TriggeredBy (string) --
The entity that triggered the deployment event. Events can be triggered by a user, 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 Amazon 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.
ActionInvocations (list) --
The list of extensions that were invoked as part of the deployment.
(dict) --
An extension that was invoked as part of a deployment event.
ExtensionIdentifier (string) --
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ActionName (string) --
The name of the action.
Uri (string) --
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
ErrorMessage (string) --
The error message when an extension invocation fails.
ErrorCode (string) --
The error code when an extension invocation fails.
InvocationId (string) --
A system-generated ID for this invocation.
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.
AppliedExtensions (list) --
A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.
(dict) --
An extension that was invoked during a deployment.
ExtensionId (string) --
The system-generated ID of the extension.
ExtensionAssociationId (string) --
The system-generated ID for the association.
VersionNumber (integer) --
The extension version number.
Parameters (dict) --
One or more parameters for the actions called by the extension.
KmsKeyArn (string) --
The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
KmsKeyIdentifier (string) --
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionAppConfig.Client.exceptions.BadRequestExceptionExamples
The following stop-deployment example stops the deployment of an application configuration to the specified environment.
response = client.stop_deployment(
ApplicationId='339ohji',
DeploymentNumber=2,
EnvironmentId='54j1r29',
)
print(response)
Expected Output:
{
'DeploymentDurationInMinutes': 15,
'DeploymentNumber': 2,
'FinalBakeTimeInMinutes': 0,
'GrowthFactor': 25.0,
'PercentageComplete': 1.0,
'ResponseMetadata': {
'...': '...',
},
}
tag_resource(**kwargs)¶Assigns metadata 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
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource for which to retrieve tags.
[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.
None
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following tag-resource example tags an application resource.
response = client.tag_resource(
ResourceArn='arn:aws:appconfig:us-east-1:111122223333:application/339ohji',
Tags={
'group1': '1',
},
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
untag_resource(**kwargs)¶Deletes a tag key and value from an AppConfig resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource for which to remove tags.
[REQUIRED]
The tag keys to delete.
None
Exceptions
AppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following untag-resource example removes the group1 tag from the specified application.
response = client.untag_resource(
ResourceArn='arn:aws:appconfig:us-east-1:111122223333:application/339ohji',
TagKeys=[
'group1',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
update_application(**kwargs)¶Updates an application.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
ApplicationId='string',
Name='string',
Description='string'
)
[REQUIRED]
The application ID.
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.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following update-application example updates the name of the specified application.
response = client.update_application(
ApplicationId='339ohji',
Description='',
Name='Example-Application',
)
print(response)
Expected Output:
{
'Description': 'An application used for creating an example.',
'Id': '339ohji',
'Name': 'Example-Application',
'ResponseMetadata': {
'...': '...',
},
}
update_configuration_profile(**kwargs)¶Updates a configuration profile.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_profile(
ApplicationId='string',
ConfigurationProfileId='string',
Name='string',
Description='string',
RetrievalRoleArn='string',
Validators=[
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
]
)
[REQUIRED]
The application ID.
[REQUIRED]
The ID of the configuration profile.
LocationUri .A list of methods for validating the configuration.
A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
AppConfig supports validators of type JSON_SCHEMA and LAMBDA
Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'LocationUri': 'string',
'RetrievalRoleArn': 'string',
'Validators': [
{
'Type': 'JSON_SCHEMA'|'LAMBDA',
'Content': 'string'
},
],
'Type': '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 that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services 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 the Amazon Resource Name (ARN) of an Lambda function.
Type (string) --
The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :
AWS.AppConfig.FeatureFlags
AWS.Freeform
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following update-configuration-profile example updates the description of the specified configuration profile.
response = client.update_configuration_profile(
ApplicationId='339ohji',
ConfigurationProfileId='ur8hx2f',
Description='Configuration profile used for examples.',
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'Description': 'Configuration profile used for examples.',
'Id': 'ur8hx2f',
'LocationUri': 'ssm-parameter://Example-Parameter',
'Name': 'Example-Configuration-Profile',
'RetrievalRoleArn': 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
'ResponseMetadata': {
'...': '...',
},
}
update_deployment_strategy(**kwargs)¶Updates a deployment strategy.
See also: AWS API Documentation
Request Syntax
response = client.update_deployment_strategy(
DeploymentStrategyId='string',
Description='string',
DeploymentDurationInMinutes=123,
FinalBakeTimeInMinutes=123,
GrowthFactor=...,
GrowthType='LINEAR'|'EXPONENTIAL'
)
[REQUIRED]
The deployment strategy ID.
The algorithm used to define how percentage grows over time. 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,Gis the growth factor specified by the user andNis 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 that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
ReplicateTo (string) --
Save the deployment strategy to a Systems Manager (SSM) document.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following update-deployment-strategy example updates final bake time to 20 minutes in the specified deployment strategy.
::
- response = client.update_deployment_strategy(
- DeploymentStrategyId='1225qzk', FinalBakeTimeInMinutes=20,
)
print(response)
Expected Output:
{
'DeploymentDurationInMinutes': 15,
'FinalBakeTimeInMinutes': 20,
'GrowthFactor': 25,
'GrowthType': 'LINEAR',
'Id': '1225qzk',
'Name': 'Example-Deployment',
'ReplicateTo': 'SSM_DOCUMENT',
'ResponseMetadata': {
'...': '...',
},
}
update_environment(**kwargs)¶Updates an environment.
See also: AWS API Documentation
Request Syntax
response = client.update_environment(
ApplicationId='string',
EnvironmentId='string',
Name='string',
Description='string',
Monitors=[
{
'AlarmArn': 'string',
'AlarmRoleArn': 'string'
},
]
)
[REQUIRED]
The application ID.
[REQUIRED]
The environment ID.
Amazon CloudWatch alarms to monitor during the deployment process.
Amazon CloudWatch alarms to monitor during the deployment process.
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
ARN of an Identity and Access Management (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) --
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
AlarmRoleArn (string) --
ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn .
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following update-environment example updates an environment's description.
response = client.update_environment(
ApplicationId='339ohji',
Description='An environment for examples.',
EnvironmentId='54j1r29',
)
print(response)
Expected Output:
{
'ApplicationId': '339ohji',
'Description': 'An environment for examples.',
'Id': '54j1r29',
'Name': 'Example-Environment',
'State': 'ROLLED_BACK',
'ResponseMetadata': {
'...': '...',
},
}
update_extension(**kwargs)¶Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_extension(
ExtensionIdentifier='string',
Description='string',
Actions={
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
Parameters={
'string': {
'Description': 'string',
'Required': True|False
}
},
VersionNumber=123
)
[REQUIRED]
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
The actions defined in the extension.
An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSIONPRE_START_DEPLOYMENTON_DEPLOYMENT_STARTON_DEPLOYMENT_STEPON_DEPLOYMENT_BAKINGON_DEPLOYMENT_COMPLETEON_DEPLOYMENT_ROLLED_BACKThe action name.
Information about the action.
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
One or more parameters for the actions called by the extension.
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
Information about the parameter.
A parameter value must be specified in the extension association.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'VersionNumber': 123,
'Arn': 'string',
'Description': 'string',
'Actions': {
'string': [
{
'Name': 'string',
'Description': 'string',
'Uri': 'string',
'RoleArn': 'string'
},
]
},
'Parameters': {
'string': {
'Description': 'string',
'Required': True|False
}
}
}
Response Structure
(dict) --
Id (string) --
The system-generated ID of the extension.
Name (string) --
The extension name.
VersionNumber (integer) --
The extension version number.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Description (string) --
Information about the extension.
Actions (dict) --
The actions defined in the extension.
(string) --
(list) --
(dict) --
An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSIONPRE_START_DEPLOYMENTON_DEPLOYMENT_STARTON_DEPLOYMENT_STEPON_DEPLOYMENT_BAKINGON_DEPLOYMENT_COMPLETEON_DEPLOYMENT_ROLLED_BACKName (string) --
The action name.
Description (string) --
Information about the action.
Uri (string) --
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
Parameters (dict) --
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.
(string) --
(dict) --
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
Description (string) --
Information about the parameter.
Required (boolean) --
A parameter value must be specified in the extension association.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.ConflictExceptionAppConfig.Client.exceptions.InternalServerExceptionupdate_extension_association(**kwargs)¶Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_extension_association(
ExtensionAssociationId='string',
Parameters={
'string': 'string'
}
)
[REQUIRED]
The system-generated ID for the association.
The parameter names and values defined in the extension.
dict
Response Syntax
{
'Id': 'string',
'ExtensionArn': 'string',
'ResourceArn': 'string',
'Arn': 'string',
'Parameters': {
'string': 'string'
},
'ExtensionVersionNumber': 123
}
Response Structure
(dict) --
Id (string) --
The system-generated ID for the association.
ExtensionArn (string) --
The ARN of the extension defined in the association.
ResourceArn (string) --
The ARNs of applications, configuration profiles, or environments defined in the association.
Arn (string) --
The system-generated Amazon Resource Name (ARN) for the extension.
Parameters (dict) --
The parameter names and values defined in the association.
ExtensionVersionNumber (integer) --
The version number for the extension defined in the association.
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionvalidate_configuration(**kwargs)¶Uses the validators in a configuration profile to validate a configuration.
See also: AWS API Documentation
Request Syntax
response = client.validate_configuration(
ApplicationId='string',
ConfigurationProfileId='string',
ConfigurationVersion='string'
)
[REQUIRED]
The application ID.
[REQUIRED]
The configuration profile ID.
[REQUIRED]
The version of the configuration to validate.
None
Exceptions
AppConfig.Client.exceptions.BadRequestExceptionAppConfig.Client.exceptions.ResourceNotFoundExceptionAppConfig.Client.exceptions.InternalServerExceptionExamples
The following validate-configuration example uses the validators in a configuration profile to validate a configuration.
response = client.validate_configuration(
ApplicationId='abc1234',
ConfigurationProfileId='ur8hx2f',
ConfigurationVersion='1',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are: