[ aws . appconfig ]

get-configuration

Description

Receive information about a configuration.

Warning

AWS 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 that you include the ClientConfigurationVersion value with every call to GetConfiguration . This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-configuration
--application <value>
--environment <value>
--configuration <value>
--client-id <value>
[--client-configuration-version <value>]
<outfile>

Options

--application (string)

The application to get. Specify either the application name or the application ID.

--environment (string)

The environment to get. Specify either the environment name or the environment ID.

--configuration (string)

The configuration to get. Specify either the configuration name or the configuration ID.

--client-id (string)

A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

--client-configuration-version (string)

The configuration version returned in the most recent GetConfiguration response.

Warning

AWS 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 that you include the ClientConfigurationVersion value with every call to GetConfiguration . This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide .

outfile (string) Filename where the content will be saved

See ‘aws help’ for descriptions of global parameters.

Examples

To list the AppConfig applications in your AWS account

This get-configuration example lists the applications in your account in the current Region.

aws appconfig get-configuration \
    --application abc1234 \
    --environment 9x8y7z6 \
    --configuration 9sd1ukd \
    --client-id any-id \
    outfile_name

Output:

{
    "ConfigurationVersion": "2",
    "ContentType": "application/octet-stream"
}

For more information, see Retrieving the Configuration in the AWS Systems Manager User Guide.

Output

Content -> (blob)

The content of the configuration or the configuration data.

ConfigurationVersion -> (string)

The configuration version.

ContentType -> (string)

A standard MIME type describing the format of the configuration content. For more information, see Content-Type .