AppConfig ********* Client ====== class AppConfig.Client A low-level client representing Amazon AppConfig AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments. Note: AppConfig is a tool in Amazon Web Services Systems Manager. Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs: * **Feature flags and toggles** - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem. * **Application tuning** - Carefully introduce application changes while testing the impact of those changes with users in production environments. * **Allow list or block list** - Control access to premium features or instantly block specific users without deploying new code. * **Centralized configuration storage** - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3. **How AppConfig works** This section provides a high-level description of how AppConfig works and how you get started. 1. Identify configuration values in code you want to manage in the cloud Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few. If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management. 2. Create an application namespace To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder. 3. Create environments For each AppConfig application, you define one or more environments. An environment is a logical grouping of targets, such as applications in a "Beta" or "Production" environment, Lambda functions, or containers. You can also define environments for application subcomponents, such as the "Web", "Mobile", and "Back- end". 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. 4. Create a configuration profile A configuration profile includes, among other things, a URI that enables AppConfig to locate your configuration data in its stored location and a profile type. AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AppConfig hosted configuration store and the URI is simply "hosted". For freeform configuration profiles, you can store your data in the AppConfig hosted configuration store or any Amazon Web Services service that integrates with AppConfig, as described in Creating a free form configuration profile in the the *AppConfig User Guide*. A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data. 5. Deploy configuration data When you create a new deployment, you specify the following: * An application ID * A configuration profile ID * A configuration version * An environment ID where you want to deploy the configuration data * A deployment strategy ID that defines how fast you want the changes to take effect When you call the StartDeployment API action, AppConfig performs the following tasks: * Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile. * Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile. * Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the *deployed data*. 6. Retrieve the configuration You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the *AppConfig User Guide*. If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions. 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_account_settings * 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_account_settings * update_application * update_configuration_profile * update_deployment_strategy * update_environment * update_extension * update_extension_association * validate_configuration Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplications * ListConfigurationProfiles * ListDeploymentStrategies * ListDeployments * ListEnvironments * ListExtensionAssociations * ListExtensions * ListHostedConfigurationVersions Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * DeploymentComplete * EnvironmentReadyForDeployment AppConfig / Waiter / DeploymentComplete DeploymentComplete ****************** class AppConfig.Waiter.DeploymentComplete waiter = client.get_waiter('deployment_complete') wait(**kwargs) Polls "AppConfig.Client.get_deployment()" every 30 seconds until a successful state is reached. An error is raised after 999 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ApplicationId='string', EnvironmentId='string', DeploymentNumber=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application that includes the deployment you want to get. * **EnvironmentId** (*string*) -- **[REQUIRED]** The ID of the environment that includes the deployment you want to get. * **DeploymentNumber** (*integer*) -- **[REQUIRED]** The sequence number of the deployment. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 999 Returns: None AppConfig / Waiter / EnvironmentReadyForDeployment EnvironmentReadyForDeployment ***************************** class AppConfig.Waiter.EnvironmentReadyForDeployment waiter = client.get_waiter('environment_ready_for_deployment') wait(**kwargs) Polls "AppConfig.Client.get_environment()" every 30 seconds until a successful state is reached. An error is raised after 999 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ApplicationId='string', EnvironmentId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application that includes the environment you want to get. * **EnvironmentId** (*string*) -- **[REQUIRED]** The ID of the environment that you want to get. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 999 Returns: None AppConfig / Paginator / ListExtensions ListExtensions ************** class AppConfig.Paginator.ListExtensions paginator = client.get_paginator('list_extensions') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_extensions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Name** (*string*) -- The extension name. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'Name': 'string', 'VersionNumber': 123, 'Arn': 'string', 'Description': '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. AppConfig / Paginator / ListHostedConfigurationVersions ListHostedConfigurationVersions ******************************* class AppConfig.Paginator.ListHostedConfigurationVersions paginator = client.get_paginator('list_hosted_configuration_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_hosted_configuration_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationId='string', ConfigurationProfileId='string', VersionLabel='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The configuration profile ID. * **VersionLabel** (*string*) -- An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ApplicationId': 'string', 'ConfigurationProfileId': 'string', 'VersionNumber': 123, 'Description': 'string', 'ContentType': 'string', 'VersionLabel': 'string', 'KmsKeyArn': '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. * **KmsKeyArn** *(string) --* The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store. AppConfig / Paginator / ListDeployments ListDeployments *************** class AppConfig.Paginator.ListDeployments paginator = client.get_paginator('list_deployments') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_deployments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationId='string', EnvironmentId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **EnvironmentId** (*string*) -- **[REQUIRED]** The environment ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'REVERTED', 'PercentageComplete': ..., 'StartedAt': datetime(2015, 1, 1), 'CompletedAt': datetime(2015, 1, 1), 'VersionLabel': '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. * **VersionLabel** *(string) --* A user-defined label for an AppConfig hosted configuration version. AppConfig / Paginator / ListConfigurationProfiles ListConfigurationProfiles ************************* class AppConfig.Paginator.ListConfigurationProfiles paginator = client.get_paginator('list_configuration_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_configuration_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationId='string', Type='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **Type** (*string*) -- A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'LocationUri': 'string', 'ValidatorTypes': [ 'JSON_SCHEMA'|'LAMBDA', ], 'Type': 'string' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The elements from this collection. * *(dict) --* A summary of a configuration profile. * **ApplicationId** *(string) --* The application ID. * **Id** *(string) --* The ID of the configuration profile. * **Name** *(string) --* The name of the configuration profile. * **LocationUri** *(string) --* The URI location of the configuration. * **ValidatorTypes** *(list) --* The types of validators in the configuration profile. * *(string) --* * **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" AppConfig / Paginator / ListExtensionAssociations ListExtensionAssociations ************************* class AppConfig.Paginator.ListExtensionAssociations paginator = client.get_paginator('list_extension_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_extension_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ResourceIdentifier='string', ExtensionIdentifier='string', ExtensionVersionNumber=123, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ResourceIdentifier** (*string*) -- The ARN of an application, configuration profile, or environment. * **ExtensionIdentifier** (*string*) -- The name, the ID, or the Amazon Resource Name (ARN) of the extension. * **ExtensionVersionNumber** (*integer*) -- The version number for the extension defined in the association. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'ExtensionArn': 'string', 'ResourceArn': '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. AppConfig / Paginator / ListDeploymentStrategies ListDeploymentStrategies ************************ class AppConfig.Paginator.ListDeploymentStrategies paginator = client.get_paginator('list_deployment_strategies') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_deployment_strategies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'Name': 'string', 'Description': 'string', 'DeploymentDurationInMinutes': 123, 'GrowthType': 'LINEAR'|'EXPONENTIAL', 'GrowthFactor': ..., 'FinalBakeTimeInMinutes': 123, 'ReplicateTo': 'NONE'|'SSM_DOCUMENT' }, ], } **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. AppConfig / Paginator / ListApplications ListApplications **************** class AppConfig.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'Name': 'string', 'Description': '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. AppConfig / Paginator / ListEnvironments ListEnvironments **************** class AppConfig.Paginator.ListEnvironments paginator = client.get_paginator('list_environments') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppConfig.Client.list_environments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', 'Monitors': [ { 'AlarmArn': 'string', 'AlarmRoleArn': '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". AppConfig / Client / get_environment get_environment *************** AppConfig.Client.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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application that includes the environment you want to get. * **EnvironmentId** (*string*) -- **[REQUIRED]** The ID of the environment that you want to get. Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', '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.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / list_applications list_applications ***************** AppConfig.Client.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' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **NextToken** (*string*) -- A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results. Return type: dict Returns: **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.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / delete_extension_association delete_extension_association **************************** AppConfig.Client.delete_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' ) Parameters: **ExtensionAssociationId** (*string*) -- **[REQUIRED]** The ID of the extension association to delete. Returns: None **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" AppConfig / Client / get_paginator get_paginator ************* AppConfig.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. AppConfig / Client / get_deployment_strategy get_deployment_strategy *********************** AppConfig.Client.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' ) Parameters: **DeploymentStrategyId** (*string*) -- **[REQUIRED]** The ID of the deployment strategy to get. Return type: dict Returns: **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.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / delete_environment delete_environment ****************** AppConfig.Client.delete_environment(**kwargs) Deletes an environment. To prevent users from unintentionally deleting actively-used environments, enable deletion protection. See also: AWS API Documentation **Request Syntax** response = client.delete_environment( EnvironmentId='string', ApplicationId='string', DeletionProtectionCheck='ACCOUNT_DEFAULT'|'APPLY'|'BYPASS' ) Parameters: * **EnvironmentId** (*string*) -- **[REQUIRED]** The ID of the environment that you want to delete. * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID that includes the environment that you want to delete. * **DeletionProtectionCheck** (*string*) -- A parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval. This parameter supports the following values: * "BYPASS": Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it. * "APPLY": Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. "APPLY" also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks. * "ACCOUNT_DEFAULT": The default setting, which instructs AppConfig to implement the deletion protection value specified in the "UpdateAccountSettings" API. Returns: None **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.ConflictException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** The following delete-environment example deletes the specified application environment. response = client.delete_environment( ApplicationId='339ohji', EnvironmentId='54j1r29', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } AppConfig / Client / can_paginate can_paginate ************ AppConfig.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. AppConfig / Client / create_environment create_environment ****************** AppConfig.Client.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' } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **Name** (*string*) -- **[REQUIRED]** A name for the environment. * **Description** (*string*) -- A description of the environment. * **Monitors** (*list*) -- Amazon CloudWatch alarms to monitor during the deployment process. * *(dict) --* Amazon CloudWatch alarms to monitor during the deployment process. * **AlarmArn** *(string) --* **[REQUIRED]** 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". * **Tags** (*dict*) -- Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', '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.InternalServerException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ServiceQuotaExceededException" **Examples** 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': { '...': '...', }, } AppConfig / Client / delete_deployment_strategy delete_deployment_strategy ************************** AppConfig.Client.delete_deployment_strategy(**kwargs) Deletes a deployment strategy. See also: AWS API Documentation **Request Syntax** response = client.delete_deployment_strategy( DeploymentStrategyId='string' ) Parameters: **DeploymentStrategyId** (*string*) -- **[REQUIRED]** The ID of the deployment strategy you want to delete. Returns: None **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** The following delete-deployment-strategy example deletes the specified deployment strategy. response = client.delete_deployment_strategy( DeploymentStrategyId='1225qzk', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } AppConfig / Client / delete_hosted_configuration_version delete_hosted_configuration_version *********************************** AppConfig.Client.delete_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 ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The configuration profile ID. * **VersionNumber** (*integer*) -- **[REQUIRED]** The versions number to delete. Returns: None **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / update_extension_association update_extension_association **************************** AppConfig.Client.update_extension_association(**kwargs) Updates an association. For more information about extensions and associations, see Extending workflows in the *AppConfig User Guide*. See also: AWS API Documentation **Request Syntax** response = client.update_extension_association( ExtensionAssociationId='string', Parameters={ 'string': 'string' } ) Parameters: * **ExtensionAssociationId** (*string*) -- **[REQUIRED]** The system-generated ID for the association. * **Parameters** (*dict*) -- The parameter names and values defined in the extension. * *(string) --* * *(string) --* Return type: dict Returns: **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. * *(string) --* * *(string) --* * **ExtensionVersionNumber** *(integer) --* The version number for the extension defined in the association. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" AppConfig / Client / list_environments list_environments ***************** AppConfig.Client.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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **MaxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **NextToken** (*string*) -- A token to start the list. Use this token to get the next set of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', '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.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / list_deployment_strategies list_deployment_strategies ************************** AppConfig.Client.list_deployment_strategies(**kwargs) Lists deployment strategies. See also: AWS API Documentation **Request Syntax** response = client.list_deployment_strategies( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **NextToken** (*string*) -- A token to start the list. Use this token to get the next set of results. Return type: dict Returns: **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.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / get_account_settings get_account_settings ******************** AppConfig.Client.get_account_settings() Returns information about the status of the "DeletionProtection" parameter. See also: AWS API Documentation **Request Syntax** response = client.get_account_settings() Return type: dict Returns: **Response Syntax** { 'DeletionProtection': { 'Enabled': True|False, 'ProtectionPeriodInMinutes': 123 } } **Response Structure** * *(dict) --* * **DeletionProtection** *(dict) --* A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for "ProtectionPeriodInMinutes" is 60. * **Enabled** *(boolean) --* A parameter that indicates if deletion protection is enabled or not. * **ProtectionPeriodInMinutes** *(integer) --* The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify "BYPASS" for the "DeletionProtectionCheck" parameter for either or . **Exceptions** * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" AppConfig / Client / list_configuration_profiles list_configuration_profiles *************************** AppConfig.Client.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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **MaxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **NextToken** (*string*) -- A token to start the list. Use this token to get the next set of results. * **Type** (*string*) -- A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration. Return type: dict Returns: **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. * *(string) --* * **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.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / create_extension create_extension **************** AppConfig.Client.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 an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the "Uri" field for the new extension version. * For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the "Uri" field. * For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the "Uri" field. * For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the "Uri" field. For more information about extensions, see Extending workflows 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, 'Dynamic': True|False } }, Tags={ 'string': 'string' }, LatestVersionNumber=123 ) Parameters: * **Name** (*string*) -- **[REQUIRED]** A name for the extension. Each extension name in your account must be unique. Extension versions use the same name. * **Description** (*string*) -- Information about the extension. * **Actions** (*dict*) -- **[REQUIRED]** 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, as shown in the following list: * "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" * "PRE_START_DEPLOYMENT" * "AT_DEPLOYMENT_TICK" * "ON_DEPLOYMENT_START" * "ON_DEPLOYMENT_STEP" * "ON_DEPLOYMENT_BAKING" * "ON_DEPLOYMENT_COMPLETE" * "ON_DEPLOYMENT_ROLLED_BACK" 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. * **Name** *(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 Extending workflows in the *AppConfig User Guide*. * **Description** *(string) --* Information about the parameter. * **Required** *(boolean) --* A parameter value must be specified in the extension association. * **Dynamic** *(boolean) --* Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked "Required". * **Tags** (*dict*) -- 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. * *(string) --* * *(string) --* * **LatestVersionNumber** (*integer*) -- You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Return type: dict Returns: **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, 'Dynamic': 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, as shown in the following list: * "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" * "PRE_START_DEPLOYMENT" * "AT_DEPLOYMENT_TICK" * "ON_DEPLOYMENT_START" * "ON_DEPLOYMENT_STEP" * "ON_DEPLOYMENT_BAKING" * "ON_DEPLOYMENT_COMPLETE" * "ON_DEPLOYMENT_ROLLED_BACK" 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. * **Name** *(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 Extending workflows in the *AppConfig User Guide*. * **Description** *(string) --* Information about the parameter. * **Required** *(boolean) --* A parameter value must be specified in the extension association. * **Dynamic** *(boolean) --* Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked "Required". **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ConflictException" * "AppConfig.Client.exceptions.ServiceQuotaExceededException" * "AppConfig.Client.exceptions.InternalServerException" AppConfig / Client / delete_extension delete_extension **************** AppConfig.Client.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 ) Parameters: * **ExtensionIdentifier** (*string*) -- **[REQUIRED]** The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete. * **VersionNumber** (*integer*) -- A specific version of an extension to delete. If omitted, the highest version is deleted. Returns: None **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" AppConfig / Client / update_account_settings update_account_settings *********************** AppConfig.Client.update_account_settings(**kwargs) Updates the value of the "DeletionProtection" parameter. See also: AWS API Documentation **Request Syntax** response = client.update_account_settings( DeletionProtection={ 'Enabled': True|False, 'ProtectionPeriodInMinutes': 123 } ) Parameters: **DeletionProtection** (*dict*) -- A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for "ProtectionPeriodInMinutes" is 60. * **Enabled** *(boolean) --* A parameter that indicates if deletion protection is enabled or not. * **ProtectionPeriodInMinutes** *(integer) --* The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify "BYPASS" for the "DeletionProtectionCheck" parameter for either or . Return type: dict Returns: **Response Syntax** { 'DeletionProtection': { 'Enabled': True|False, 'ProtectionPeriodInMinutes': 123 } } **Response Structure** * *(dict) --* * **DeletionProtection** *(dict) --* A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for "ProtectionPeriodInMinutes" is 60. * **Enabled** *(boolean) --* A parameter that indicates if deletion protection is enabled or not. * **ProtectionPeriodInMinutes** *(integer) --* The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify "BYPASS" for the "DeletionProtectionCheck" parameter for either or . **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.InternalServerException" AppConfig / Client / list_tags_for_resource list_tags_for_resource ********************** AppConfig.Client.list_tags_for_resource(**kwargs) 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' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The resource ARN. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* Metadata to assign to AppConfig resources. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / update_environment update_environment ****************** AppConfig.Client.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' }, ] ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **EnvironmentId** (*string*) -- **[REQUIRED]** The environment ID. * **Name** (*string*) -- The name of the environment. * **Description** (*string*) -- A description of the environment. * **Monitors** (*list*) -- Amazon CloudWatch alarms to monitor during the deployment process. * *(dict) --* Amazon CloudWatch alarms to monitor during the deployment process. * **AlarmArn** *(string) --* **[REQUIRED]** 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". Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'State': 'READY_FOR_DEPLOYMENT'|'DEPLOYING'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', '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.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / get_configuration get_configuration ***************** AppConfig.Client.get_configuration(**kwargs) (Deprecated) Retrieves the latest deployed configuration. Warning: Note the following important information. * This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead. * 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' ) Parameters: * **Application** (*string*) -- **[REQUIRED]** The application to get. Specify either the application name or the application ID. * **Environment** (*string*) -- **[REQUIRED]** The environment to get. Specify either the environment name or the environment ID. * **Configuration** (*string*) -- **[REQUIRED]** The configuration to get. Specify either the configuration name or the configuration ID. * **ClientId** (*string*) -- **[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. * **ClientConfigurationVersion** (*string*) -- 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 feature flags and configuration data in AppConfig in the *AppConfig User Guide*. Return type: dict Returns: **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.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / untag_resource untag_resource ************** AppConfig.Client.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', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource for which to remove tags. * **TagKeys** (*list*) -- **[REQUIRED]** The tag keys to delete. * *(string) --* Returns: None **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / list_hosted_configuration_versions list_hosted_configuration_versions ********************************** AppConfig.Client.list_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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The configuration profile ID. * **MaxResults** (*integer*) -- The maximum number of items to return for this call. If "MaxResults" is not provided in the call, AppConfig returns the maximum of 50. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **NextToken** (*string*) -- A token to start the list. Use this token to get the next set of results. * **VersionLabel** (*string*) -- An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ApplicationId': 'string', 'ConfigurationProfileId': 'string', 'VersionNumber': 123, 'Description': 'string', 'ContentType': 'string', 'VersionLabel': 'string', 'KmsKeyArn': '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. * **KmsKeyArn** *(string) --* The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store. * **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.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / get_waiter get_waiter ********** AppConfig.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" AppConfig / Client / create_extension_association create_extension_association **************************** AppConfig.Client.create_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 Extending workflows 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' } ) Parameters: * **ExtensionIdentifier** (*string*) -- **[REQUIRED]** The name, the ID, or the Amazon Resource Name (ARN) of the extension. * **ExtensionVersionNumber** (*integer*) -- The version number of the extension. If not specified, AppConfig uses the maximum version of the extension. * **ResourceIdentifier** (*string*) -- **[REQUIRED]** The ARN of an application, configuration profile, or environment. * **Parameters** (*dict*) -- The parameter names and values defined in the extensions. Extension parameters marked "Required" must be entered for this field. * *(string) --* * *(string) --* * **Tags** (*dict*) -- 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. * *(string) --* * *(string) --* Return type: dict Returns: **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. * *(string) --* * *(string) --* * **ExtensionVersionNumber** *(integer) --* The version number for the extension defined in the association. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.ServiceQuotaExceededException" AppConfig / Client / get_configuration_profile get_configuration_profile ************************* AppConfig.Client.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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application that includes the configuration profile you want to get. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The ID of the configuration profile that you want to get. Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'LocationUri': 'string', 'RetrievalRoleArn': 'string', 'Validators': [ { 'Type': 'JSON_SCHEMA'|'LAMBDA', 'Content': 'string' }, ], 'Type': 'string', 'KmsKeyArn': 'string', 'KmsKeyIdentifier': '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. For more information, see About validators in the *AppConfig User Guide*. * **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" * **KmsKeyArn** *(string) --* The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for "hosted" configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service. * **KmsKeyIdentifier** *(string) --* The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / list_extensions list_extensions *************** AppConfig.Client.list_extensions(**kwargs) Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the *AppConfig User Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_extensions( MaxResults=123, NextToken='string', Name='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **NextToken** (*string*) -- A token to start the list. Use this token to get the next set of results. * **Name** (*string*) -- The extension name. Return type: dict Returns: **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.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" AppConfig / Client / list_deployments list_deployments **************** AppConfig.Client.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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **EnvironmentId** (*string*) -- **[REQUIRED]** The environment ID. * **MaxResults** (*integer*) -- The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null "NextToken" that you can provide in a subsequent call to get the next set of results. * **NextToken** (*string*) -- The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first set of results. Return type: dict Returns: **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'|'REVERTED', 'PercentageComplete': ..., 'StartedAt': datetime(2015, 1, 1), 'CompletedAt': datetime(2015, 1, 1), 'VersionLabel': 'string' }, ], '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. * **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.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / get_deployment get_deployment ************** AppConfig.Client.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 ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application that includes the deployment you want to get. * **EnvironmentId** (*string*) -- **[REQUIRED]** The ID of the environment that includes the deployment you want to get. * **DeploymentNumber** (*integer*) -- **[REQUIRED]** The sequence number of the deployment. Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'EnvironmentId': 'string', 'DeploymentStrategyId': 'string', 'ConfigurationProfileId': 'string', 'DeploymentNumber': 123, 'ConfigurationName': 'string', 'ConfigurationLocationUri': 'string', 'ConfigurationVersion': 'string', 'Description': 'string', 'DeploymentDurationInMinutes': 123, 'GrowthType': 'LINEAR'|'EXPONENTIAL', 'GrowthFactor': ..., 'FinalBakeTimeInMinutes': 123, 'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', 'EventLog': [ { 'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED'|'REVERT_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', 'VersionLabel': '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 following: * The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback. * The percentage of hosts that received the deployment. * A recommendation to attempt a new deployment (in the case of an internal error). * **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. * *(string) --* * *(string) --* * **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 Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. * **VersionLabel** *(string) --* A user-defined label for an AppConfig hosted configuration version. **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / get_hosted_configuration_version get_hosted_configuration_version ******************************** AppConfig.Client.get_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 ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The configuration profile ID. * **VersionNumber** (*integer*) -- **[REQUIRED]** The version. Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'ConfigurationProfileId': 'string', 'VersionNumber': 123, 'Description': 'string', 'Content': StreamingBody(), 'ContentType': 'string', 'VersionLabel': 'string', 'KmsKeyArn': '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. * **KmsKeyArn** *(string) --* The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / start_deployment start_deployment **************** AppConfig.Client.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', DynamicExtensionParameters={ 'string': 'string' } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **EnvironmentId** (*string*) -- **[REQUIRED]** The environment ID. * **DeploymentStrategyId** (*string*) -- **[REQUIRED]** The deployment strategy ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The configuration profile ID. * **ConfigurationVersion** (*string*) -- **[REQUIRED]** The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number. * **Description** (*string*) -- A description of the deployment. * **Tags** (*dict*) -- Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* * **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. * **DynamicExtensionParameters** (*dict*) -- A map of dynamic extension parameter names to values to pass to associated extensions with "PRE_START_DEPLOYMENT" actions. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'EnvironmentId': 'string', 'DeploymentStrategyId': 'string', 'ConfigurationProfileId': 'string', 'DeploymentNumber': 123, 'ConfigurationName': 'string', 'ConfigurationLocationUri': 'string', 'ConfigurationVersion': 'string', 'Description': 'string', 'DeploymentDurationInMinutes': 123, 'GrowthType': 'LINEAR'|'EXPONENTIAL', 'GrowthFactor': ..., 'FinalBakeTimeInMinutes': 123, 'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', 'EventLog': [ { 'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED'|'REVERT_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', 'VersionLabel': '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 following: * The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback. * The percentage of hosts that received the deployment. * A recommendation to attempt a new deployment (in the case of an internal error). * **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. * *(string) --* * *(string) --* * **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 Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. * **VersionLabel** *(string) --* A user-defined label for an AppConfig hosted configuration version. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.ConflictException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / update_application update_application ****************** AppConfig.Client.update_application(**kwargs) Updates an application. See also: AWS API Documentation **Request Syntax** response = client.update_application( ApplicationId='string', Name='string', Description='string' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **Name** (*string*) -- The name of the application. * **Description** (*string*) -- A description of the application. Return type: dict Returns: **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.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / get_extension_association get_extension_association ************************* AppConfig.Client.get_extension_association(**kwargs) Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the *AppConfig User Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_extension_association( ExtensionAssociationId='string' ) Parameters: **ExtensionAssociationId** (*string*) -- **[REQUIRED]** The extension association ID to get. Return type: dict Returns: **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. * *(string) --* * *(string) --* * **ExtensionVersionNumber** *(integer) --* The version number for the extension defined in the association. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" AppConfig / Client / create_configuration_profile create_configuration_profile **************************** AppConfig.Client.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: * Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store * Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket * Pipelines stored in CodePipeline * Secrets stored in Secrets Manager * Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store * Configuration data in SSM documents stored in the Systems Manager document store A configuration profile includes the following information: * The URI location of the configuration data. * The Identity and Access Management (IAM) role that provides access to the configuration data. * A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function. 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', KmsKeyIdentifier='string' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **Name** (*string*) -- **[REQUIRED]** A name for the configuration profile. * **Description** (*string*) -- A description of the configuration profile. * **LocationUri** (*string*) -- **[REQUIRED]** A URI to locate the configuration. You can specify the following: * For the AppConfig hosted configuration store and for feature flags, specify "hosted". * For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format "ssm-parameter://" or the ARN. * For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: "codepipeline"://. * For an Secrets Manager secret, specify the URI in the following format: "secretsmanager"://. * For an Amazon S3 object, specify the URI in the following format: "s3:/// ``. Here is an example: ``s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json" * For an SSM document, specify either the document name in the format "ssm-document://" or the Amazon Resource Name (ARN). * **RetrievalRoleArn** (*string*) -- 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 CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that store your configuration. * **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. For more information, see About validators in the *AppConfig User Guide*. * **Type** *(string) --* **[REQUIRED]** AppConfig supports validators of type "JSON_SCHEMA" and "LAMBDA" * **Content** *(string) --* **[REQUIRED]** Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function. * **Tags** (*dict*) -- Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* * **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" * **KmsKeyIdentifier** (*string*) -- The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for "hosted" configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service. Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'LocationUri': 'string', 'RetrievalRoleArn': 'string', 'Validators': [ { 'Type': 'JSON_SCHEMA'|'LAMBDA', 'Content': 'string' }, ], 'Type': 'string', 'KmsKeyArn': 'string', 'KmsKeyIdentifier': '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. For more information, see About validators in the *AppConfig User Guide*. * **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" * **KmsKeyArn** *(string) --* The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for "hosted" configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service. * **KmsKeyIdentifier** *(string) --* The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.ServiceQuotaExceededException" **Examples** 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': { '...': '...', }, } AppConfig / Client / list_extension_associations list_extension_associations *************************** AppConfig.Client.list_extension_associations(**kwargs) Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows 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' ) Parameters: * **ResourceIdentifier** (*string*) -- The ARN of an application, configuration profile, or environment. * **ExtensionIdentifier** (*string*) -- The name, the ID, or the Amazon Resource Name (ARN) of the extension. * **ExtensionVersionNumber** (*integer*) -- The version number for the extension defined in the association. * **MaxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **NextToken** (*string*) -- A token to start the list. Use this token to get the next set of results or pass null to get the first set of results. Return type: dict Returns: **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.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" AppConfig / Client / close close ***** AppConfig.Client.close() Closes underlying endpoint connections. AppConfig / Client / update_deployment_strategy update_deployment_strategy ************************** AppConfig.Client.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' ) Parameters: * **DeploymentStrategyId** (*string*) -- **[REQUIRED]** The deployment strategy ID. * **Description** (*string*) -- A description of the deployment strategy. * **DeploymentDurationInMinutes** (*integer*) -- Total amount of time for a deployment to last. * **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. * **GrowthFactor** (*float*) -- The percentage of targets to receive a deployed configuration during each interval. * **GrowthType** (*string*) -- 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, "G" is the growth factor specified by the user and "N" is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: "2*(2^0)" "2*(2^1)" "2*(2^2)" Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. Return type: dict Returns: **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.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / create_deployment_strategy create_deployment_strategy ************************** AppConfig.Client.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' } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** A name for the deployment strategy. * **Description** (*string*) -- A description of the deployment strategy. * **DeploymentDurationInMinutes** (*integer*) -- **[REQUIRED]** Total amount of time for a deployment to last. * **FinalBakeTimeInMinutes** (*integer*) -- Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the *AppConfig User Guide*. * **GrowthFactor** (*float*) -- **[REQUIRED]** The percentage of targets to receive a deployed configuration during each interval. * **GrowthType** (*string*) -- 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 for "Step percentage". For example, a linear deployment that uses a "Step percentage" of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration. **Exponential**: For this type, AppConfig processes the deployment exponentially using the following formula: "G*(2^N)". In this formula, "G" is the growth factor specified by the user and "N" is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: "2*(2^0)" "2*(2^1)" "2*(2^2)" Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. * **ReplicateTo** (*string*) -- Save the deployment strategy to a Systems Manager (SSM) document. * **Tags** (*dict*) -- Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* Return type: dict Returns: **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.InternalServerException" * "AppConfig.Client.exceptions.ServiceQuotaExceededException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / stop_deployment stop_deployment *************** AppConfig.Client.stop_deployment(**kwargs) Stops a deployment. This API action works only on deployments that have a status of "DEPLOYING", unless an "AllowRevert" parameter is supplied. If the "AllowRevert" parameter is supplied, the status of an in-progress deployment will be "ROLLED_BACK". The status of a completed deployment will be "REVERTED". AppConfig only allows a revert within 72 hours of deployment completion. See also: AWS API Documentation **Request Syntax** response = client.stop_deployment( ApplicationId='string', EnvironmentId='string', DeploymentNumber=123, AllowRevert=True|False ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **EnvironmentId** (*string*) -- **[REQUIRED]** The environment ID. * **DeploymentNumber** (*integer*) -- **[REQUIRED]** The sequence number of the deployment. * **AllowRevert** (*boolean*) -- A Boolean that enables AppConfig to rollback a "COMPLETED" deployment to the previous configuration version. This action moves the deployment to a status of "REVERTED". Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'EnvironmentId': 'string', 'DeploymentStrategyId': 'string', 'ConfigurationProfileId': 'string', 'DeploymentNumber': 123, 'ConfigurationName': 'string', 'ConfigurationLocationUri': 'string', 'ConfigurationVersion': 'string', 'Description': 'string', 'DeploymentDurationInMinutes': 123, 'GrowthType': 'LINEAR'|'EXPONENTIAL', 'GrowthFactor': ..., 'FinalBakeTimeInMinutes': 123, 'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED', 'EventLog': [ { 'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED'|'REVERT_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', 'VersionLabel': '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 following: * The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback. * The percentage of hosts that received the deployment. * A recommendation to attempt a new deployment (in the case of an internal error). * **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. * *(string) --* * *(string) --* * **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 Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. * **VersionLabel** *(string) --* A user-defined label for an AppConfig hosted configuration version. **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / delete_configuration_profile delete_configuration_profile **************************** AppConfig.Client.delete_configuration_profile(**kwargs) Deletes a configuration profile. To prevent users from unintentionally deleting actively-used configuration profiles, enable deletion protection. See also: AWS API Documentation **Request Syntax** response = client.delete_configuration_profile( ApplicationId='string', ConfigurationProfileId='string', DeletionProtectionCheck='ACCOUNT_DEFAULT'|'APPLY'|'BYPASS' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID that includes the configuration profile you want to delete. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The ID of the configuration profile you want to delete. * **DeletionProtectionCheck** (*string*) -- A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the configuration profile during the specified interval. This parameter supports the following values: * "BYPASS": Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it. * "APPLY": Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. "APPLY" also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks. * "ACCOUNT_DEFAULT": The default setting, which instructs AppConfig to implement the deletion protection value specified in the "UpdateAccountSettings" API. Returns: None **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.ConflictException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / delete_application delete_application ****************** AppConfig.Client.delete_application(**kwargs) Deletes an application. See also: AWS API Documentation **Request Syntax** response = client.delete_application( ApplicationId='string' ) Parameters: **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application to delete. Returns: None **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** The following delete-application example deletes the specified application. response = client.delete_application( ApplicationId='339ohji', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } AppConfig / Client / create_application create_application ****************** AppConfig.Client.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' } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** A name for the application. * **Description** (*string*) -- A description of the application. * **Tags** (*dict*) -- Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. * *(string) --* * *(string) --* Return type: dict Returns: **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.BadRequestException" * "AppConfig.Client.exceptions.ServiceQuotaExceededException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / update_extension update_extension **************** AppConfig.Client.update_extension(**kwargs) Updates an AppConfig extension. For more information about extensions, see Extending workflows 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, 'Dynamic': True|False } }, VersionNumber=123 ) Parameters: * **ExtensionIdentifier** (*string*) -- **[REQUIRED]** The name, the ID, or the Amazon Resource Name (ARN) of 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, as shown in the following list: * "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" * "PRE_START_DEPLOYMENT" * "AT_DEPLOYMENT_TICK" * "ON_DEPLOYMENT_START" * "ON_DEPLOYMENT_STEP" * "ON_DEPLOYMENT_BAKING" * "ON_DEPLOYMENT_COMPLETE" * "ON_DEPLOYMENT_ROLLED_BACK" 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. * **Name** *(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*) -- One or more parameters for the actions called by the extension. * *(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 Extending workflows in the *AppConfig User Guide*. * **Description** *(string) --* Information about the parameter. * **Required** *(boolean) --* A parameter value must be specified in the extension association. * **Dynamic** *(boolean) --* Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked "Required". * **VersionNumber** (*integer*) -- The extension version number. Return type: dict Returns: **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, 'Dynamic': 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, as shown in the following list: * "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" * "PRE_START_DEPLOYMENT" * "AT_DEPLOYMENT_TICK" * "ON_DEPLOYMENT_START" * "ON_DEPLOYMENT_STEP" * "ON_DEPLOYMENT_BAKING" * "ON_DEPLOYMENT_COMPLETE" * "ON_DEPLOYMENT_ROLLED_BACK" 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. * **Name** *(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 Extending workflows in the *AppConfig User Guide*. * **Description** *(string) --* Information about the parameter. * **Required** *(boolean) --* A parameter value must be specified in the extension association. * **Dynamic** *(boolean) --* Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked "Required". **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.ConflictException" * "AppConfig.Client.exceptions.InternalServerException" AppConfig / Client / get_extension get_extension ************* AppConfig.Client.get_extension(**kwargs) Returns information about an AppConfig extension. See also: AWS API Documentation **Request Syntax** response = client.get_extension( ExtensionIdentifier='string', VersionNumber=123 ) Parameters: * **ExtensionIdentifier** (*string*) -- **[REQUIRED]** The name, the ID, or the Amazon Resource Name (ARN) of the extension. * **VersionNumber** (*integer*) -- The extension version number. If no version number was defined, AppConfig uses the highest version. Return type: dict Returns: **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, 'Dynamic': 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, as shown in the following list: * "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" * "PRE_START_DEPLOYMENT" * "AT_DEPLOYMENT_TICK" * "ON_DEPLOYMENT_START" * "ON_DEPLOYMENT_STEP" * "ON_DEPLOYMENT_BAKING" * "ON_DEPLOYMENT_COMPLETE" * "ON_DEPLOYMENT_ROLLED_BACK" 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. * **Name** *(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 Extending workflows in the *AppConfig User Guide*. * **Description** *(string) --* Information about the parameter. * **Required** *(boolean) --* A parameter value must be specified in the extension association. * **Dynamic** *(boolean) --* Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked "Required". **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" AppConfig / Client / tag_resource tag_resource ************ AppConfig.Client.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' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource for which to retrieve tags. * **Tags** (*dict*) -- **[REQUIRED]** The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with "aws:". The tag value can be up to 256 characters. * *(string) --* * *(string) --* Returns: None **Exceptions** * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / update_configuration_profile update_configuration_profile **************************** AppConfig.Client.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' }, ], KmsKeyIdentifier='string' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The ID of the configuration profile. * **Name** (*string*) -- The name of the configuration profile. * **Description** (*string*) -- A description of the configuration profile. * **RetrievalRoleArn** (*string*) -- 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 CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that store your configuration. * **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. For more information, see About validators in the *AppConfig User Guide*. * **Type** *(string) --* **[REQUIRED]** AppConfig supports validators of type "JSON_SCHEMA" and "LAMBDA" * **Content** *(string) --* **[REQUIRED]** Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function. * **KmsKeyIdentifier** (*string*) -- The identifier for a Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for "hosted" configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service. Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'LocationUri': 'string', 'RetrievalRoleArn': 'string', 'Validators': [ { 'Type': 'JSON_SCHEMA'|'LAMBDA', 'Content': 'string' }, ], 'Type': 'string', 'KmsKeyArn': 'string', 'KmsKeyIdentifier': '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. For more information, see About validators in the *AppConfig User Guide*. * **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" * **KmsKeyArn** *(string) --* The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for "hosted" configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service. * **KmsKeyIdentifier** *(string) --* The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / validate_configuration validate_configuration ********************** AppConfig.Client.validate_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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The configuration profile ID. * **ConfigurationVersion** (*string*) -- **[REQUIRED]** The version of the configuration to validate. Returns: None **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, } AppConfig / Client / get_application get_application *************** AppConfig.Client.get_application(**kwargs) Retrieves information about an application. See also: AWS API Documentation **Request Syntax** response = client.get_application( ApplicationId='string' ) Parameters: **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application you want to get. Return type: dict Returns: **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.ResourceNotFoundException" * "AppConfig.Client.exceptions.InternalServerException" * "AppConfig.Client.exceptions.BadRequestException" **Examples** 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': { '...': '...', }, } AppConfig / Client / create_hosted_configuration_version create_hosted_configuration_version *********************************** AppConfig.Client.create_hosted_configuration_version(**kwargs) Creates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the *AppConfig User Guide*. 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' ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The application ID. * **ConfigurationProfileId** (*string*) -- **[REQUIRED]** The configuration profile ID. * **Description** (*string*) -- A description of the configuration. * **Content** (*bytes** or **seekable file-like object*) -- **[REQUIRED]** The configuration data, as bytes. Note: AppConfig accepts any type of data, including text formats like JSON or TOML, or binary formats like protocol buffers or compressed data. * **ContentType** (*string*) -- **[REQUIRED]** A standard MIME type describing the format of the configuration content. For more information, see Content-Type. * **LatestVersionNumber** (*integer*) -- An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version. * **VersionLabel** (*string*) -- An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0". Return type: dict Returns: **Response Syntax** { 'ApplicationId': 'string', 'ConfigurationProfileId': 'string', 'VersionNumber': 123, 'Description': 'string', 'Content': StreamingBody(), 'ContentType': 'string', 'VersionLabel': 'string', 'KmsKeyArn': '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. * **KmsKeyArn** *(string) --* The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store. **Exceptions** * "AppConfig.Client.exceptions.BadRequestException" * "AppConfig.Client.exceptions.ServiceQuotaExceededException" * "AppConfig.Client.exceptions.ResourceNotFoundException" * "AppConfig.Client.exceptions.ConflictException" * "AppConfig.Client.exceptions.PayloadTooLargeException" * "AppConfig.Client.exceptions.InternalServerException" **Examples** 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': { '...': '...', }, }