[ aws . appconfig ]

list-configuration-profiles

Description

Lists the configuration profiles for an application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-configuration-profiles
--application-id <value>
[--max-results <value>]
[--next-token <value>]
[--type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The application ID.

--max-results (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.

--next-token (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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list the available configuration profiles

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

aws appconfig list-configuration-profiles \
    --application-id 339ohji

Output:

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

For more information, see Step 3: Creating a configuration and a configuration profile in the AWS AppConfig User Guide.

Output

Items -> (list)

The elements from this collection.

(structure)

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.