AppConfig / Client / get_extension

get_extension

AppConfig.Client.get_extension(**kwargs)

Returns information about an AppConfig extension.

See also: AWS API Documentation

Request Syntax

response = client.get_extension(
    ExtensionIdentifier='string',
    VersionNumber=123
)

Parameters:

• ExtensionIdentifier (string) –

  [REQUIRED]

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

• VersionNumber (integer) – The extension version number. If no version number was defined, AppConfig uses the highest version.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Name': 'string',
    'VersionNumber': 123,
    'Arn': 'string',
    'Description': 'string',
    'Actions': {
        'string': [
            {
                'Name': 'string',
                'Description': 'string',
                'Uri': 'string',
                'RoleArn': 'string'
            },
        ]
    },
    'Parameters': {
        'string': {
            'Description': 'string',
            'Required': True|False,
            'Dynamic': True|False
        }
    }
}

Response Structure

• (dict) –

  • Id (string) –

    The system-generated ID of the extension.

  • Name (string) –

    The extension name.

  • VersionNumber (integer) –

    The extension version number.

  • Arn (string) –

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

  • Description (string) –

    Information about the extension.

  • Actions (dict) –

    The actions defined in the extension.

    • (string) –

      • (list) –

        • (dict) –

          An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point, as shown in the following list:

          • PRE_CREATE_HOSTED_CONFIGURATION_VERSION

          • PRE_START_DEPLOYMENT

          • AT_DEPLOYMENT_TICK

          • ON_DEPLOYMENT_START

          • ON_DEPLOYMENT_STEP

          • ON_DEPLOYMENT_BAKING

          • ON_DEPLOYMENT_COMPLETE

          • ON_DEPLOYMENT_ROLLED_BACK

          Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension.

          • Name (string) –

            The action name.

          • Description (string) –

            Information about the action.

          • Uri (string) –

            The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

          • RoleArn (string) –

            An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

  • Parameters (dict) –

    The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

    • (string) –

      • (dict) –

        A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Extending workflows in the AppConfig User Guide.

        • Description (string) –

          Information about the parameter.

        • Required (boolean) –

          A parameter value must be specified in the extension association.

        • Dynamic (boolean) –

          Indicates whether this parameter’s value can be supplied at the extension’s action point instead of during extension association. Dynamic parameters can’t be marked Required.

Exceptions

• AppConfig.Client.exceptions.ResourceNotFoundException

• AppConfig.Client.exceptions.InternalServerException

• AppConfig.Client.exceptions.BadRequestException