AppConfig / Client / list_hosted_configuration_versions

list_hosted_configuration_versions#

AppConfig.Client.list_hosted_configuration_versions(**kwargs)#

Lists configurations stored in the AppConfig hosted configuration store by version.

See also: AWS API Documentation

Request Syntax

response = client.list_hosted_configuration_versions(
    ApplicationId='string',
    ConfigurationProfileId='string',
    MaxResults=123,
    NextToken='string',
    VersionLabel='string'
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The application ID.

  • ConfigurationProfileId (string) –

    [REQUIRED]

    The configuration profile ID.

  • MaxResults (integer) – The maximum number of items to return for this call. If MaxResults is not provided in the call, AppConfig returns the maximum of 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.

  • NextToken (string) – A token to start the list. Use this token to get the next set of results.

  • VersionLabel (string) – An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example “v2*”. If you don’t specify an asterisk at the end of the value, only an exact match is returned.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ApplicationId': 'string',
            'ConfigurationProfileId': 'string',
            'VersionNumber': 123,
            'Description': 'string',
            'ContentType': 'string',
            'VersionLabel': 'string',
            'KmsKeyArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The elements from this collection.

      • (dict) –

        Information about the configuration.

        • ApplicationId (string) –

          The application ID.

        • ConfigurationProfileId (string) –

          The configuration profile ID.

        • VersionNumber (integer) –

          The configuration version.

        • Description (string) –

          A description of the configuration.

        • ContentType (string) –

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

        • VersionLabel (string) –

          A user-defined label for an AppConfig hosted configuration version.

        • KmsKeyArn (string) –

          The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store.

    • NextToken (string) –

      The token for the next set of items to return. Use this token to get the next set of results.

Exceptions

Examples

The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile.

response = client.list_hosted_configuration_versions(
    ApplicationId='339ohji',
    ConfigurationProfileId='ur8hx2f',
)

print(response)

Expected Output:

{
    'Items': [
        {
            'ApplicationId': '339ohji',
            'ConfigurationProfileId': 'ur8hx2f',
            'ContentType': 'application/json',
            'VersionNumber': 1,
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}