AppConfig / Client / list_configuration_profiles

list_configuration_profiles#

AppConfig.Client.list_configuration_profiles(**kwargs)#

Lists the configuration profiles for an application.

See also: AWS API Documentation

Request Syntax

response = client.list_configuration_profiles(
    ApplicationId='string',
    MaxResults=123,
    NextToken='string',
    Type='string'
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The application ID.

  • MaxResults (integer) – The maximum number of items to return for this call. 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.

  • Type (string) – A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ApplicationId': 'string',
            'Id': 'string',
            'Name': 'string',
            'LocationUri': 'string',
            'ValidatorTypes': [
                'JSON_SCHEMA'|'LAMBDA',
            ],
            'Type': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The elements from this collection.

      • (dict) –

        A summary of a configuration profile.

        • ApplicationId (string) –

          The application ID.

        • Id (string) –

          The ID of the configuration profile.

        • Name (string) –

          The name of the configuration profile.

        • LocationUri (string) –

          The URI location of the configuration.

        • ValidatorTypes (list) –

          The types of validators in the configuration profile.

          • (string) –

        • Type (string) –

          The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

          AWS.AppConfig.FeatureFlags

          AWS.Freeform

    • NextToken (string) –

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

Exceptions

  • AppConfig.Client.exceptions.ResourceNotFoundException

  • AppConfig.Client.exceptions.InternalServerException

  • AppConfig.Client.exceptions.BadRequestException

Examples

The following list-configuration-profiles example lists the available configuration profiles for the specified application.

response = client.list_configuration_profiles(
    ApplicationId='339ohji',
)

print(response)

Expected Output:

{
    'Items': [
        {
            'ApplicationId': '339ohji',
            'Id': 'ur8hx2f',
            'LocationUri': 'ssm-parameter://Example-Parameter',
            'Name': 'Example-Configuration-Profile',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}