AppConfig / Client / update_configuration_profile

update_configuration_profile#

AppConfig.Client.update_configuration_profile(**kwargs)#

Updates a configuration profile.

See also: AWS API Documentation

Request Syntax

response = client.update_configuration_profile(
    ApplicationId='string',
    ConfigurationProfileId='string',
    Name='string',
    Description='string',
    RetrievalRoleArn='string',
    Validators=[
        {
            'Type': 'JSON_SCHEMA'|'LAMBDA',
            'Content': 'string'
        },
    ],
    KmsKeyIdentifier='string'
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The application ID.

  • ConfigurationProfileId (string) –

    [REQUIRED]

    The ID of the configuration profile.

  • Name (string) – The name of the configuration profile.

  • Description (string) – A description of the configuration profile.

  • 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. For more information, see About validators in the AppConfig User Guide.

      • Type (string) – [REQUIRED]

        AppConfig supports validators of type JSON_SCHEMA and LAMBDA

      • Content (string) – [REQUIRED]

        Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

  • KmsKeyIdentifier (string) – The identifier for a 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. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

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. For more information, see About validators in the AppConfig User Guide.

        • 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.BadRequestException

  • AppConfig.Client.exceptions.ResourceNotFoundException

  • AppConfig.Client.exceptions.InternalServerException

Examples

The following update-configuration-profile example updates the description of the specified configuration profile.

response = client.update_configuration_profile(
    ApplicationId='339ohji',
    ConfigurationProfileId='ur8hx2f',
    Description='Configuration profile used for examples.',
)

print(response)

Expected Output:

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