AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
get-configuration-profile
--application-id <value>
--configuration-profile-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--application-id
(string)
The ID of the application that includes the configuration profile you want to get.
--configuration-profile-id
(string)
The ID of the configuration profile that you want to get.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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 retrieve configuration profile details
The following get-configuration-profile
example returns the details of the specified configuration profile.
aws appconfig get-configuration-profile \
--application-id 339ohji \
--configuration-profile-id ur8hx2f
Output:
{
"ApplicationId": "339ohji",
"Id": "ur8hx2f",
"Name": "Example-Configuration-Profile",
"LocationUri": "ssm-parameter://Example-Parameter",
"RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
}
For more information, see Step 3: Creating a configuration and a configuration profile in the AWS AppConfig User Guide.
ApplicationId -> (string)
The application ID.
Id -> (string)
The configuration profile ID.
Name -> (string)
The name of the configuration profile.
Description -> (string)
The configuration profile description.
LocationUri -> (string)
The URI location of the configuration.
RetrievalRoleArn -> (string)
The ARN of an IAM role with permission to access the configuration at the specifiedLocationUri
.
Validators -> (list)
A list of methods for validating the configuration.
(structure)
A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid. For more information, see About validators in the AppConfig User Guide .
Type -> (string)
AppConfig supports validators of typeJSON_SCHEMA
andLAMBDA
Content -> (string)
Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
Type -> (string)
The type of configurations contained in the profile. AppConfig supports
feature flags
andfreeform
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 forType
:
AWS.AppConfig.FeatureFlags
AWS.Freeform
KmsKeyArn -> (string)
The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used forhosted
configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.
KmsKeyIdentifier -> (string)
The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.