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

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID or name to retrieve configuration for
environmentId	string	Yes	The environment ID or name to retrieve configuration for
configurationProfileId	string	Yes	The configuration profile ID or name to retrieve

Output

Parameter	Type	Description
configuration	string	The deployed configuration content
contentType	string	Content type of the configuration
versionLabel	string	Label of the retrieved configuration version

AppConfig List Applications

List applications in AWS AppConfig

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
maxResults	number	No	Maximum number of applications to return (1-50)
nextToken	string	No	Pagination token from a previous response

Output

Parameter	Type	Description
applications	array	List of AppConfig applications
↳ id	string	Application ID
↳ name	string	Application name
↳ description	string	Application description
nextToken	string	Pagination token for the next page
count	number	Number of applications returned

AppConfig Create Application

Create an application in AWS AppConfig

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
name	string	Yes	Name of the application to create
description	string	No	Description of the application

Output

Parameter	Type	Description
message	string	Operation status message
id	string	ID of the created application
name	string	Name of the created application
description	string	Description of the created application

AppConfig Get Application

Get details about a single AWS AppConfig application

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID to retrieve

Output

Parameter	Type	Description
id	string	Application ID
name	string	Application name
description	string	Application description

AppConfig Update Application

Update the name or description of an AWS AppConfig application

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID to update
name	string	No	New name for the application
description	string	No	New description for the application

Output

Parameter	Type	Description
message	string	Operation status message
id	string	ID of the updated application
name	string	Name of the updated application
description	string	Description of the updated application

AppConfig Delete Application

Delete an AWS AppConfig application

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID to delete

Output

Parameter	Type	Description
message	string	Operation status message
id	string	ID of the deleted application

AppConfig List Environments

List environments for an AWS AppConfig application

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the environments
maxResults	number	No	Maximum number of environments to return (1-50)
nextToken	string	No	Pagination token from a previous response

Output

Parameter	Type	Description
environments	array	List of AppConfig environments
↳ applicationId	string	Owning application ID
↳ id	string	Environment ID
↳ name	string	Environment name
↳ description	string	Environment description
↳ state	string	Environment state
nextToken	string	Pagination token for the next page
count	number	Number of environments returned

AppConfig Create Environment

Create an environment for an AWS AppConfig application

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID to create the environment in
name	string	Yes	Name of the environment to create
description	string	No	Description of the environment

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
id	string	ID of the created environment
name	string	Name of the created environment
state	string	State of the created environment

AppConfig Get Environment

Get details about a single AWS AppConfig environment

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the environment
environmentId	string	Yes	The environment ID to retrieve

Output

Parameter	Type	Description
applicationId	string	Owning application ID
id	string	Environment ID
name	string	Environment name
description	string	Environment description
state	string	Environment state
monitors	array	CloudWatch alarms monitoring this environment
↳ alarmArn	string	CloudWatch alarm ARN
↳ alarmRoleArn	string	IAM role ARN for the alarm

AppConfig Update Environment

Update the name or description of an AWS AppConfig environment

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the environment
environmentId	string	Yes	The environment ID to update
name	string	No	New name for the environment
description	string	No	New description for the environment

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
id	string	ID of the updated environment
name	string	Name of the updated environment
state	string	State of the updated environment

AppConfig Delete Environment

Delete an AWS AppConfig environment

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the environment
environmentId	string	Yes	The environment ID to delete

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
id	string	ID of the deleted environment

AppConfig List Configuration Profiles

List configuration profiles for an AWS AppConfig application

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profiles
maxResults	number	No	Maximum number of configuration profiles to return (1-50)
nextToken	string	No	Pagination token from a previous response

Output

Parameter	Type	Description
configurationProfiles	array	List of AppConfig configuration profiles
↳ applicationId	string	Owning application ID
↳ id	string	Configuration profile ID
↳ name	string	Configuration profile name
↳ locationUri	string	Location URI of the config
↳ type	string	Profile type (e.g., AWS.Freeform)
↳ validatorTypes	array	Validator types configured
nextToken	string	Pagination token for the next page
count	number	Number of configuration profiles returned

AppConfig Create Configuration Profile

Create a configuration profile in an AWS AppConfig application

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID to create the configuration profile in
name	string	Yes	Name of the configuration profile
locationUri	string	Yes	Where the configuration is stored. Use "hosted" for AppConfig-hosted configurations, or an SSM/S3 URI
description	string	No	Description of the configuration profile
retrievalRoleArn	string	No	ARN of an IAM role to retrieve the configuration (required for non-hosted URIs)
type	string	No	Profile type: AWS.Freeform (default) or AWS.AppConfig.FeatureFlags

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
id	string	ID of the created configuration profile
name	string	Name of the created configuration profile
locationUri	string	Location URI of the config
type	string	Profile type

AppConfig Get Configuration Profile

Get details about a single AWS AppConfig configuration profile

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profile
configurationProfileId	string	Yes	The configuration profile ID to retrieve

Output

Parameter	Type	Description
applicationId	string	Owning application ID
id	string	Configuration profile ID
name	string	Configuration profile name
description	string	Profile description
locationUri	string	Location URI of the config
retrievalRoleArn	string	IAM retrieval role ARN
type	string	Profile type (e.g., AWS.Freeform)
validators	array	Validators configured on the profile
↳ type	string	Validator 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

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profile
configurationProfileId	string	Yes	The configuration profile ID to update
name	string	No	New name for the configuration profile
description	string	No	New description for the configuration profile
retrievalRoleArn	string	No	New ARN of the IAM role used to retrieve the configuration

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
id	string	ID of the updated configuration profile
name	string	Name of the updated configuration profile
description	string	Description of the profile
type	string	Profile type

AppConfig Delete Configuration Profile

Delete an AWS AppConfig configuration profile

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profile
configurationProfileId	string	Yes	The configuration profile ID to delete

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
id	string	ID 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

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profile
configurationProfileId	string	Yes	The configuration profile ID to add the version to
content	string	Yes	The configuration content (e.g., a JSON or YAML document)
contentType	string	Yes	Content type of the configuration (e.g., application/json, text/plain)
description	string	No	Description of the configuration version
latestVersionNumber	number	No	The version number of the latest version, used for optimistic concurrency
versionLabel	string	No	A user-defined label for the configuration version

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
configurationProfileId	string	Owning configuration profile ID
versionNumber	number	Version number of the created configuration
contentType	string	Content type of the configuration
versionLabel	string	Label of the configuration version

AppConfig Get Hosted Configuration Version

Retrieve a specific hosted configuration version from an AppConfig profile

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profile
configurationProfileId	string	Yes	The configuration profile ID to read the version from
versionNumber	number	Yes	The version number to retrieve

Output

Parameter	Type	Description
applicationId	string	Owning application ID
configurationProfileId	string	Owning configuration profile ID
versionNumber	number	Version number
description	string	Description of the version
content	string	The configuration content
contentType	string	Content type of the configuration
versionLabel	string	Label of the configuration version

AppConfig List Hosted Configuration Versions

List hosted configuration versions for an AWS AppConfig configuration profile

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profile
configurationProfileId	string	Yes	The configuration profile ID to list versions for
maxResults	number	No	Maximum number of versions to return (1-50)
nextToken	string	No	Pagination token from a previous response

Output

Parameter	Type	Description
versions	array	List of hosted configuration versions
↳ applicationId	string	Owning application ID
↳ configurationProfileId	string	Owning configuration profile ID
↳ versionNumber	number	Version number
↳ description	string	Description of the version
↳ contentType	string	Content type of the configuration
↳ versionLabel	string	Label of the configuration version
nextToken	string	Pagination token for the next page
count	number	Number of versions returned

AppConfig Delete Hosted Configuration Version

Delete a specific hosted configuration version from an AppConfig profile

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID that owns the configuration profile
configurationProfileId	string	Yes	The configuration profile ID that owns the version
versionNumber	number	Yes	The version number to delete

Output

Parameter	Type	Description
message	string	Operation status message
applicationId	string	Owning application ID
configurationProfileId	string	Owning configuration profile ID
versionNumber	number	Version number that was deleted

AppConfig List Deployment Strategies

List deployment strategies available in AWS AppConfig

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
maxResults	number	No	Maximum number of deployment strategies to return (1-50)
nextToken	string	No	Pagination token from a previous response

Output

Parameter	Type	Description
deploymentStrategies	array	List of AppConfig deployment strategies
↳ id	string	Deployment strategy ID
↳ name	string	Deployment strategy name
↳ description	string	Strategy description
↳ deploymentDurationInMinutes	number	Total deployment duration in minutes
↳ growthType	string	Growth type (LINEAR or EXPONENTIAL)
↳ growthFactor	number	Growth factor percentage
↳ finalBakeTimeInMinutes	number	Final bake time in minutes
↳ replicateTo	string	Where the strategy is replicated
nextToken	string	Pagination token for the next page
count	number	Number of deployment strategies returned

AppConfig Start Deployment

Start deploying a configuration version to an AWS AppConfig environment

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID to deploy in
environmentId	string	Yes	The environment ID to deploy to
deploymentStrategyId	string	Yes	The deployment strategy ID to use
configurationProfileId	string	Yes	The configuration profile ID to deploy
configurationVersion	string	Yes	The configuration version to deploy
description	string	No	Description of the deployment

Output

Parameter	Type	Description
message	string	Operation status message
deploymentNumber	number	Sequence number of the deployment
state	string	Current deployment state
percentageComplete	number	Percentage of the deployment that has completed

AppConfig Get Deployment

Get details about a specific AWS AppConfig deployment

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID of the deployment
environmentId	string	Yes	The environment ID of the deployment
deploymentNumber	number	Yes	The sequence number of the deployment

Output

Parameter	Type	Description
applicationId	string	Application ID
environmentId	string	Environment ID
deploymentStrategyId	string	Deployment strategy ID
configurationProfileId	string	Configuration profile ID
deploymentNumber	number	Deployment sequence number
configurationName	string	Configuration name
configurationVersion	string	Configuration version
description	string	Deployment description
state	string	Current deployment state
percentageComplete	number	Percentage completed
startedAt	string	When the deployment started
completedAt	string	When the deployment completed

AppConfig List Deployments

List deployments for an AWS AppConfig environment

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID of the deployments
environmentId	string	Yes	The environment ID of the deployments
maxResults	number	No	Maximum number of deployments to return (1-50)
nextToken	string	No	Pagination token from a previous response

Output

Parameter	Type	Description
deployments	array	List of AppConfig deployments
↳ deploymentNumber	number	Deployment sequence number
↳ configurationName	string	Configuration name
↳ configurationVersion	string	Configuration version
↳ state	string	Current deployment state
↳ percentageComplete	number	Percentage completed
↳ startedAt	string	When the deployment started
↳ completedAt	string	When the deployment completed
↳ versionLabel	string	Configuration version label
nextToken	string	Pagination token for the next page
count	number	Number of deployments returned

AppConfig Stop Deployment

Stop an in-progress AWS AppConfig deployment

Inputs and outputs

Input

Parameter	Type	Required	Description
region	string	Yes	AWS region (e.g., us-east-1)
accessKeyId	string	Yes	AWS access key ID
secretAccessKey	string	Yes	AWS secret access key
applicationId	string	Yes	The application ID of the deployment
environmentId	string	Yes	The environment ID of the deployment
deploymentNumber	number	Yes	The sequence number of the deployment to stop

Output

Parameter	Type	Description
message	string	Operation status message
deploymentNumber	number	Deployment sequence number
state	string	Deployment state after stopping