AppConfig / Client / create_extension_association

create_extension_association#

AppConfig.Client.create_extension_association(**kwargs)#

When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_extension_association(
    ExtensionIdentifier='string',
    ExtensionVersionNumber=123,
    ResourceIdentifier='string',
    Parameters={
        'string': 'string'
    },
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ExtensionIdentifier (string) –

    [REQUIRED]

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • ExtensionVersionNumber (integer) – The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

  • ResourceIdentifier (string) –

    [REQUIRED]

    The ARN of an application, configuration profile, or environment.

  • Parameters (dict) –

    The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

    • (string) –

      • (string) –

  • Tags (dict) –

    Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'ExtensionArn': 'string',
    'ResourceArn': 'string',
    'Arn': 'string',
    'Parameters': {
        'string': 'string'
    },
    'ExtensionVersionNumber': 123
}

Response Structure

  • (dict) –

    • Id (string) –

      The system-generated ID for the association.

    • ExtensionArn (string) –

      The ARN of the extension defined in the association.

    • ResourceArn (string) –

      The ARNs of applications, configuration profiles, or environments defined in the association.

    • Arn (string) –

      The system-generated Amazon Resource Name (ARN) for the extension.

    • Parameters (dict) –

      The parameter names and values defined in the association.

      • (string) –

        • (string) –

    • ExtensionVersionNumber (integer) –

      The version number for the extension defined in the association.

Exceptions

  • AppConfig.Client.exceptions.BadRequestException

  • AppConfig.Client.exceptions.ResourceNotFoundException

  • AppConfig.Client.exceptions.InternalServerException

  • AppConfig.Client.exceptions.ServiceQuotaExceededException