Mandala
Tools

AWS AppConfig

Manage and retrieve configuration with AWS AppConfig

Usage Instructions

Integrate AWS AppConfig into workflows. Manage applications, environments, and configuration profiles, create and read hosted configuration versions, run and inspect deployments, and retrieve the latest deployed configuration at runtime. Requires AWS access key and secret access key.

Tools

appconfig_get_configuration

Retrieve the latest deployed configuration for an AppConfig application, environment, and profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID or name to retrieve configuration for
environmentIdstringYesThe environment ID or name to retrieve configuration for
configurationProfileIdstringYesThe configuration profile ID or name to retrieve

Output

ParameterTypeDescription
configurationstringThe deployed configuration content
contentTypestringContent type of the configuration
versionLabelstringLabel of the retrieved configuration version

appconfig_list_applications

List applications in AWS AppConfig

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
maxResultsnumberNoMaximum number of applications to return (1-50)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
applicationsarrayList of AppConfig applications
nextTokenstringPagination token for the next page
countnumberNumber of applications returned

appconfig_create_application

Create an application in AWS AppConfig

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
namestringYesName of the application to create
descriptionstringNoDescription of the application

Output

ParameterTypeDescription
messagestringOperation status message
idstringID of the created application
namestringName of the created application
descriptionstringDescription of the created application

appconfig_get_application

Get details about a single AWS AppConfig application

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID to retrieve

Output

ParameterTypeDescription
idstringApplication ID
namestringApplication name
descriptionstringApplication description

appconfig_update_application

Update the name or description of an AWS AppConfig application

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID to update
namestringNoNew name for the application
descriptionstringNoNew description for the application

Output

ParameterTypeDescription
messagestringOperation status message
idstringID of the updated application
namestringName of the updated application
descriptionstringDescription of the updated application

appconfig_delete_application

Delete an AWS AppConfig application

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID to delete

Output

ParameterTypeDescription
messagestringOperation status message
idstringID of the deleted application

appconfig_list_environments

List environments for an AWS AppConfig application

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the environments
maxResultsnumberNoMaximum number of environments to return (1-50)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
environmentsarrayList of AppConfig environments
nextTokenstringPagination token for the next page
countnumberNumber of environments returned

appconfig_create_environment

Create an environment for an AWS AppConfig application

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID to create the environment in
namestringYesName of the environment to create
descriptionstringNoDescription of the environment

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
idstringID of the created environment
namestringName of the created environment
statestringState of the created environment

appconfig_get_environment

Get details about a single AWS AppConfig environment

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the environment
environmentIdstringYesThe environment ID to retrieve

Output

ParameterTypeDescription
applicationIdstringOwning application ID
idstringEnvironment ID
namestringEnvironment name
descriptionstringEnvironment description
statestringEnvironment state
monitorsarrayCloudWatch alarms monitoring this environment

appconfig_update_environment

Update the name or description of an AWS AppConfig environment

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the environment
environmentIdstringYesThe environment ID to update
namestringNoNew name for the environment
descriptionstringNoNew description for the environment

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
idstringID of the updated environment
namestringName of the updated environment
statestringState of the updated environment

appconfig_delete_environment

Delete an AWS AppConfig environment

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the environment
environmentIdstringYesThe environment ID to delete

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
idstringID of the deleted environment

appconfig_list_configuration_profiles

List configuration profiles for an AWS AppConfig application

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profiles
maxResultsnumberNoMaximum number of configuration profiles to return (1-50)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
configurationProfilesarrayList of AppConfig configuration profiles
nextTokenstringPagination token for the next page
countnumberNumber of configuration profiles returned

appconfig_create_configuration_profile

Create a configuration profile in an AWS AppConfig application

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID to create the configuration profile in
namestringYesName of the configuration profile
locationUristringYesWhere the configuration is stored. Use "hosted" for AppConfig-hosted configurations, or an SSM/S3 URI
descriptionstringNoDescription of the configuration profile
retrievalRoleArnstringNoARN of an IAM role to retrieve the configuration (required for non-hosted URIs)
typestringNoProfile type: AWS.Freeform (default) or AWS.AppConfig.FeatureFlags

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
idstringID of the created configuration profile
namestringName of the created configuration profile
locationUristringLocation URI of the config
typestringProfile type

appconfig_get_configuration_profile

Get details about a single AWS AppConfig configuration profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profile
configurationProfileIdstringYesThe configuration profile ID to retrieve

Output

ParameterTypeDescription
applicationIdstringOwning application ID
idstringConfiguration profile ID
namestringConfiguration profile name
descriptionstringProfile description
locationUristringLocation URI of the config
retrievalRoleArnstringIAM retrieval role ARN
typestringProfile type (e.g., AWS.Freeform)
validatorsarrayValidators configured on the profile

appconfig_update_configuration_profile

Update the name, description, or retrieval role of an AppConfig configuration profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profile
configurationProfileIdstringYesThe configuration profile ID to update
namestringNoNew name for the configuration profile
descriptionstringNoNew description for the configuration profile
retrievalRoleArnstringNoNew ARN of the IAM role used to retrieve the configuration

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
idstringID of the updated configuration profile
namestringName of the updated configuration profile
descriptionstringDescription of the profile
typestringProfile type

appconfig_delete_configuration_profile

Delete an AWS AppConfig configuration profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profile
configurationProfileIdstringYesThe configuration profile ID to delete

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
idstringID of the deleted configuration profile

appconfig_create_hosted_configuration_version

Create a new hosted configuration version for an AppConfig configuration profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profile
configurationProfileIdstringYesThe configuration profile ID to add the version to
contentstringYesThe configuration content (e.g., a JSON or YAML document)
contentTypestringYesContent type of the configuration (e.g., application/json, text/plain)
descriptionstringNoDescription of the configuration version
latestVersionNumbernumberNoThe version number of the latest version, used for optimistic concurrency
versionLabelstringNoA user-defined label for the configuration version

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
configurationProfileIdstringOwning configuration profile ID
versionNumbernumberVersion number of the created configuration
contentTypestringContent type of the configuration
versionLabelstringLabel of the configuration version

appconfig_get_hosted_configuration_version

Retrieve a specific hosted configuration version from an AppConfig profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profile
configurationProfileIdstringYesThe configuration profile ID to read the version from
versionNumbernumberYesThe version number to retrieve

Output

ParameterTypeDescription
applicationIdstringOwning application ID
configurationProfileIdstringOwning configuration profile ID
versionNumbernumberVersion number
descriptionstringDescription of the version
contentstringThe configuration content
contentTypestringContent type of the configuration
versionLabelstringLabel of the configuration version

appconfig_list_hosted_configuration_versions

List hosted configuration versions for an AWS AppConfig configuration profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profile
configurationProfileIdstringYesThe configuration profile ID to list versions for
maxResultsnumberNoMaximum number of versions to return (1-50)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
versionsarrayList of hosted configuration versions
nextTokenstringPagination token for the next page
countnumberNumber of versions returned

appconfig_delete_hosted_configuration_version

Delete a specific hosted configuration version from an AppConfig profile

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID that owns the configuration profile
configurationProfileIdstringYesThe configuration profile ID that owns the version
versionNumbernumberYesThe version number to delete

Output

ParameterTypeDescription
messagestringOperation status message
applicationIdstringOwning application ID
configurationProfileIdstringOwning configuration profile ID
versionNumbernumberVersion number that was deleted

appconfig_list_deployment_strategies

List deployment strategies available in AWS AppConfig

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
maxResultsnumberNoMaximum number of deployment strategies to return (1-50)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
deploymentStrategiesarrayList of AppConfig deployment strategies
nextTokenstringPagination token for the next page
countnumberNumber of deployment strategies returned

appconfig_start_deployment

Start deploying a configuration version to an AWS AppConfig environment

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID to deploy in
environmentIdstringYesThe environment ID to deploy to
deploymentStrategyIdstringYesThe deployment strategy ID to use
configurationProfileIdstringYesThe configuration profile ID to deploy
configurationVersionstringYesThe configuration version to deploy
descriptionstringNoDescription of the deployment

Output

ParameterTypeDescription
messagestringOperation status message
deploymentNumbernumberSequence number of the deployment
statestringCurrent deployment state
percentageCompletenumberPercentage of the deployment that has completed

appconfig_get_deployment

Get details about a specific AWS AppConfig deployment

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID of the deployment
environmentIdstringYesThe environment ID of the deployment
deploymentNumbernumberYesThe sequence number of the deployment

Output

ParameterTypeDescription
applicationIdstringApplication ID
environmentIdstringEnvironment ID
deploymentStrategyIdstringDeployment strategy ID
configurationProfileIdstringConfiguration profile ID
deploymentNumbernumberDeployment sequence number
configurationNamestringConfiguration name
configurationVersionstringConfiguration version
descriptionstringDeployment description
statestringCurrent deployment state
percentageCompletenumberPercentage completed
startedAtstringWhen the deployment started
completedAtstringWhen the deployment completed

appconfig_list_deployments

List deployments for an AWS AppConfig environment

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID of the deployments
environmentIdstringYesThe environment ID of the deployments
maxResultsnumberNoMaximum number of deployments to return (1-50)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
deploymentsarrayList of AppConfig deployments
nextTokenstringPagination token for the next page
countnumberNumber of deployments returned

appconfig_stop_deployment

Stop an in-progress AWS AppConfig deployment

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
applicationIdstringYesThe application ID of the deployment
environmentIdstringYesThe environment ID of the deployment
deploymentNumbernumberYesThe sequence number of the deployment to stop

Output

ParameterTypeDescription
messagestringOperation status message
deploymentNumbernumberDeployment sequence number
statestringDeployment state after stopping

Notes

  • Category: tools
  • Type: appconfig
ApolloArXiv
On this page

On this page

Usage Instructions
Tools
appconfig_get_configuration
Input
Output
appconfig_list_applications
Input
Output
appconfig_create_application
Input
Output
appconfig_get_application
Input
Output
appconfig_update_application
Input
Output
appconfig_delete_application
Input
Output
appconfig_list_environments
Input
Output
appconfig_create_environment
Input
Output
appconfig_get_environment
Input
Output
appconfig_update_environment
Input
Output
appconfig_delete_environment
Input
Output
appconfig_list_configuration_profiles
Input
Output
appconfig_create_configuration_profile
Input
Output
appconfig_get_configuration_profile
Input
Output
appconfig_update_configuration_profile
Input
Output
appconfig_delete_configuration_profile
Input
Output
appconfig_create_hosted_configuration_version
Input
Output
appconfig_get_hosted_configuration_version
Input
Output
appconfig_list_hosted_configuration_versions
Input
Output
appconfig_delete_hosted_configuration_version
Input
Output
appconfig_list_deployment_strategies
Input
Output
appconfig_start_deployment
Input
Output
appconfig_get_deployment
Input
Output
appconfig_list_deployments
Input
Output
appconfig_stop_deployment
Input
Output
Notes
AWS AppConfig