AWS AppConfig

Manage and retrieve configuration with AWS AppConfig

Nutzungsanweisungen

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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID or name to retrieve configuration for
`environmentId`	string	Ja	The environment ID or name to retrieve configuration for
`configurationProfileId`	string	Ja	The configuration profile ID or name to retrieve

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`maxResults`	number	Nein	Maximum number of applications to return (1-50)
`nextToken`	string	Nein	Pagination token from a previous response

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`name`	string	Ja	Name of the application to create
`description`	string	Nein	Description of the application

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID to retrieve

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID to update
`name`	string	Nein	New name for the application
`description`	string	Nein	New description for the application

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID to delete

Ausgabe

Parameter	Typ	Beschreibung
`message`	string	Operation status message
`id`	string	ID of the deleted application

`appconfig_list_environments`

List environments for an AWS AppConfig application

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the environments
`maxResults`	number	Nein	Maximum number of environments to return (1-50)
`nextToken`	string	Nein	Pagination token from a previous response

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID to create the environment in
`name`	string	Ja	Name of the environment to create
`description`	string	Nein	Description of the environment

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the environment
`environmentId`	string	Ja	The environment ID to retrieve

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the environment
`environmentId`	string	Ja	The environment ID to update
`name`	string	Nein	New name for the environment
`description`	string	Nein	New description for the environment

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the environment
`environmentId`	string	Ja	The environment ID to delete

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the configuration profiles
`maxResults`	number	Nein	Maximum number of configuration profiles to return (1-50)
`nextToken`	string	Nein	Pagination token from a previous response

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the configuration profile
`configurationProfileId`	string	Ja	The configuration profile ID to retrieve

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the configuration profile
`configurationProfileId`	string	Ja	The configuration profile ID to update
`name`	string	Nein	New name for the configuration profile
`description`	string	Nein	New description for the configuration profile
`retrievalRoleArn`	string	Nein	New ARN of the IAM role used to retrieve the configuration

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the configuration profile
`configurationProfileId`	string	Ja	The configuration profile ID to delete

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID that owns the configuration profile
`configurationProfileId`	string	Ja	The configuration profile ID that owns the version
`versionNumber`	number	Ja	The version number to delete

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`maxResults`	number	Nein	Maximum number of deployment strategies to return (1-50)
`nextToken`	string	Nein	Pagination token from a previous response

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID of the deployment
`environmentId`	string	Ja	The environment ID of the deployment
`deploymentNumber`	number	Ja	The sequence number of the deployment

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID of the deployments
`environmentId`	string	Ja	The environment ID of the deployments
`maxResults`	number	Nein	Maximum number of deployments to return (1-50)
`nextToken`	string	Nein	Pagination token from a previous response

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`region`	string	Ja	AWS region (e.g., us-east-1)
`accessKeyId`	string	Ja	AWS access key ID
`secretAccessKey`	string	Ja	AWS secret access key
`applicationId`	string	Ja	The application ID of the deployment
`environmentId`	string	Ja	The environment ID of the deployment
`deploymentNumber`	number	Ja	The sequence number of the deployment to stop

Ausgabe

Parameter	Typ	Beschreibung
`message`	string	Operation status message
`deploymentNumber`	number	Deployment sequence number
`state`	string	Deployment state after stopping

On this page

Nutzungsanweisungen

appconfig_get_configuration

appconfig_list_applications

appconfig_create_application

appconfig_get_application

appconfig_update_application

appconfig_delete_application

appconfig_list_environments

appconfig_create_environment

appconfig_get_environment

appconfig_update_environment

appconfig_delete_environment

appconfig_list_configuration_profiles

appconfig_create_configuration_profile

appconfig_get_configuration_profile

appconfig_update_configuration_profile

appconfig_delete_configuration_profile

appconfig_create_hosted_configuration_version

appconfig_get_hosted_configuration_version

appconfig_list_hosted_configuration_versions

appconfig_delete_hosted_configuration_version

appconfig_list_deployment_strategies

appconfig_start_deployment

appconfig_get_deployment

appconfig_list_deployments

appconfig_stop_deployment