AppConfig / Client / get_configuration_profile

get_configuration_profile#

AppConfig.Client.get_configuration_profile(**kwargs)#

Retrieves information about a configuration profile.

Request Syntax

response = client.get_configuration_profile(
    ApplicationId='string',
    ConfigurationProfileId='string'
)

Parameters:

ApplicationId (string) –
[REQUIRED]

The ID of the application that includes the configuration profile you want to get.
ConfigurationProfileId (string) –
[REQUIRED]

The ID of the configuration profile that you want to get.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationId': 'string',
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'LocationUri': 'string',
    'RetrievalRoleArn': 'string',
    'Validators': [
        {
            'Type': 'JSON_SCHEMA'|'LAMBDA',
            'Content': 'string'
        },
    ],
    'Type': 'string',
    'KmsKeyArn': 'string',
    'KmsKeyIdentifier': 'string'
}

Response Structure

(dict) –
- 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 specified LocationUri.
- Validators (list) –
  
  A list of methods for validating the configuration.
  - (dict) –
    
    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.
    - Type (string) –
      
      AppConfig supports validators of type JSON_SCHEMA and LAMBDA
    - 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 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
- 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 for hosted 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.

Exceptions

AppConfig.Client.exceptions.ResourceNotFoundException
AppConfig.Client.exceptions.InternalServerException
AppConfig.Client.exceptions.BadRequestException

Examples

The following get-configuration-profile example returns the details of the specified configuration profile.

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

print(response)

Expected Output:

{
    'ApplicationId': '339ohji',
    'Id': 'ur8hx2f',
    'LocationUri': 'ssm-parameter://Example-Parameter',
    'Name': 'Example-Configuration-Profile',
    'RetrievalRoleArn': 'arn:aws:iam::111122223333:role/Example-App-Config-Role',
    'ResponseMetadata': {
        '...': '...',
    },
}