Skip to content
Try for free
On this page

Integrations

AWS AppConfig

Manage and retrieve configuration with AWS AppConfig

Use AWS AppConfig to manage applications, environments, configuration profiles, and deployments. Read deployed configuration at runtime or create hosted configuration versions for a rollout.

Authentication uses an AWS access key ID and secret access key. The associated IAM principal needs the relevant appconfig:* permissions (for example appconfig:GetLatestConfiguration and appconfig:StartConfigurationSession for retrieval, and appconfig:StartDeployment for rollouts).

Use the block

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.

Actions

AppConfig Get Configuration

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

Inputs and outputs

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

Inputs and outputs

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
↳ idstringApplication ID
↳ namestringApplication name
↳ descriptionstringApplication description
nextTokenstringPagination token for the next page
countnumberNumber of applications returned

AppConfig Create Application

Create an application in AWS AppConfig

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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
↳ applicationIdstringOwning application ID
↳ idstringEnvironment ID
↳ namestringEnvironment name
↳ descriptionstringEnvironment description
↳ statestringEnvironment state
nextTokenstringPagination token for the next page
countnumberNumber of environments returned

AppConfig Create Environment

Create an environment for an AWS AppConfig application

Inputs and outputs

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

Inputs and outputs

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
↳ alarmArnstringCloudWatch alarm ARN
↳ alarmRoleArnstringIAM role ARN for the alarm

AppConfig Update Environment

Update the name or description of an AWS AppConfig environment

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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
↳ applicationIdstringOwning application ID
↳ idstringConfiguration profile ID
↳ namestringConfiguration profile name
↳ locationUristringLocation URI of the config
↳ typestringProfile type (e.g., AWS.Freeform)
↳ validatorTypesarrayValidator types configured
nextTokenstringPagination token for the next page
countnumberNumber of configuration profiles returned

AppConfig Create Configuration Profile

Create a configuration profile in an AWS AppConfig application

Inputs and outputs

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

Inputs and outputs

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
↳ typestringValidator type (JSON_SCHEMA or LAMBDA)

AppConfig Update Configuration Profile

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

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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
↳ applicationIdstringOwning application ID
↳ configurationProfileIdstringOwning configuration profile ID
↳ versionNumbernumberVersion number
↳ descriptionstringDescription of the version
↳ contentTypestringContent type of the configuration
↳ versionLabelstringLabel of the configuration version
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

Inputs and outputs

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

Inputs and outputs

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
↳ idstringDeployment strategy ID
↳ namestringDeployment strategy name
↳ descriptionstringStrategy description
↳ deploymentDurationInMinutesnumberTotal deployment duration in minutes
↳ growthTypestringGrowth type (LINEAR or EXPONENTIAL)
↳ growthFactornumberGrowth factor percentage
↳ finalBakeTimeInMinutesnumberFinal bake time in minutes
↳ replicateTostringWhere the strategy is replicated
nextTokenstringPagination token for the next page
countnumberNumber of deployment strategies returned

AppConfig Start Deployment

Start deploying a configuration version to an AWS AppConfig environment

Inputs and outputs

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

Inputs and outputs

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

Inputs and outputs

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
↳ deploymentNumbernumberDeployment sequence number
↳ configurationNamestringConfiguration name
↳ configurationVersionstringConfiguration version
↳ statestringCurrent deployment state
↳ percentageCompletenumberPercentage completed
↳ startedAtstringWhen the deployment started
↳ completedAtstringWhen the deployment completed
↳ versionLabelstringConfiguration version label
nextTokenstringPagination token for the next page
countnumberNumber of deployments returned

AppConfig Stop Deployment

Stop an in-progress AWS AppConfig deployment

Inputs and outputs

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
Was this helpful?
Suggest an edit