Amazon AppConfig

{'Type': 'string'}

Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. A configuration profile includes the following information:

• The URI location of the configuration data.

• The Identity and Access Management (IAM) role that provides access to the configuration data.

• A validator for the configuration data. Available validators include either a JSON Schema or an Lambda function.

For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide .

See also: AWS API Documentation

Request Syntax

client.create_configuration_profile(
    ApplicationId='string',
    Name='string',
    Description='string',
    LocationUri='string',
    RetrievalRoleArn='string',
    Validators=[
        {
            'Type': 'JSON_SCHEMA'|'LAMBDA',
            'Content': 'string'
        },
    ],
    Tags={
        'string': 'string'
    },
    Type='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type Name

string

param Name

[REQUIRED]

A name for the configuration profile.

type Description

string

param Description

A description of the configuration profile.

type LocationUri

string

param LocationUri

[REQUIRED]

A URI to locate the configuration. You can specify the AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store and for feature flags, specify hosted . For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

type RetrievalRoleArn

string

param RetrievalRoleArn

The ARN of an IAM role with permission to access the configuration at the specified LocationUri .

Warning

A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.

type Validators

list

param Validators

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 a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

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

type Tags

dict

param Tags

Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

• (string) --

  • (string) --

type Type

string

param Type

The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

rtype

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'
}

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 a 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 that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

{'Type': 'string'}

Retrieves information about a configuration profile.

See also: AWS API Documentation

Request Syntax

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

type ApplicationId

string

param ApplicationId

[REQUIRED]

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

type ConfigurationProfileId

string

param ConfigurationProfileId

[REQUIRED]

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

rtype

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'
}

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 a 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 that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

{'Type': 'string'}

{'Items': {'Type': 'string'}}

Lists the configuration profiles for an application.

See also: AWS API Documentation

Request Syntax

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

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type MaxResults

integer

param MaxResults

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.

type NextToken

string

param NextToken

A token to start the list. Use this token to get the next set of results.

type Type

string

param Type

A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a free-form configuration.

rtype

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 that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used to introduce changes to your application.

  • NextToken (string) --

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

{'Type': 'string'}

Updates a configuration profile.

See also: AWS API Documentation

Request Syntax

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

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type ConfigurationProfileId

string

param ConfigurationProfileId

[REQUIRED]

The ID of the configuration profile.

type Name

string

param Name

The name of the configuration profile.

type Description

string

param Description

A description of the configuration profile.

type RetrievalRoleArn

string

param RetrievalRoleArn

The ARN of an IAM role with permission to access the configuration at the specified LocationUri .

type Validators

list

param Validators

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 a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

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

rtype

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'
}

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 a 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 that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.