AppConfig / Client / get_configuration

get_configuration#

AppConfig.Client.get_configuration(**kwargs)#

(Deprecated) Retrieves the latest deployed configuration.

Warning

Note the following important information.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.get_configuration(
    Application='string',
    Environment='string',
    Configuration='string',
    ClientId='string',
    ClientConfigurationVersion='string'
)
Parameters:

  • Application (string) –

    [REQUIRED]

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

  • Environment (string) –

    [REQUIRED]

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

  • Configuration (string) –

    [REQUIRED]

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

  • ClientId (string) –

    [REQUIRED]

    The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

  • ClientConfigurationVersion (string) –

    The configuration version returned in the most recent GetConfiguration response.

    Warning

    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 you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.

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

Return type:

dict

Returns:

Response Syntax

{
    'Content': StreamingBody(),
    'ConfigurationVersion': 'string',
    'ContentType': 'string'
}

Response Structure

  • (dict) –

    • Content (StreamingBody) –

      The content of the configuration or the configuration data.

      Warning

      The Content attribute only contains data if the system finds new or updated configuration data. If there is no new or updated data and ClientConfigurationVersion matches the version of the current configuration, AppConfig returns a 204 No Content HTTP response code and the Content value will be empty.

    • ConfigurationVersion (string) –

      The configuration version.

    • ContentType (string) –

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

Exceptions

Examples

The following get-configuration example returns the configuration details of the example application. On subsequent calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration.

response = client.get_configuration(
    Application='example-application',
    ClientId='example-id',
    Configuration='Example-Configuration-Profile',
    Environment='Example-Environment',
)

print(response)

Expected Output:

{
    'ConfigurationVersion': '1',
    'ContentType': 'application/octet-stream',
    'ResponseMetadata': {
        '...': '...',
    },
}