AppRegistry / Client / get_application

get_application

AppRegistry.Client.get_application(**kwargs)

Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    application='string'
)

Parameters:

application (string) –

[REQUIRED]

The name, ID, or ARN of the application.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastUpdateTime': datetime(2015, 1, 1),
    'associatedResourceCount': 123,
    'tags': {
        'string': 'string'
    },
    'integrations': {
        'resourceGroup': {
            'state': 'CREATING'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
            'arn': 'string',
            'errorMessage': 'string'
        },
        'applicationTagResourceGroup': {
            'state': 'CREATING'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
            'arn': 'string',
            'errorMessage': 'string'
        }
    },
    'applicationTag': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • id (string) –

    The identifier of the application.

  • arn (string) –

    The Amazon resource name (ARN) that specifies the application across services.

  • name (string) –

    The name of the application. The name must be unique in the region in which you are creating the application.

  • description (string) –

    The description of the application.

  • creationTime (datetime) –

    The ISO-8601 formatted timestamp of the moment when the application was created.

  • lastUpdateTime (datetime) –

    The ISO-8601 formatted timestamp of the moment when the application was last updated.

  • associatedResourceCount (integer) –

    The number of top-level resources that were registered as part of this application.

  • tags (dict) –

    Key-value pairs associated with the application.

    • (string) –

      • (string) –

  • integrations (dict) –

    The information about the integration of the application with other services, such as Resource Groups.

    • resourceGroup (dict) –

      The information about the resource group integration.

      • state (string) –

        The state of the propagation process for the resource group. The states includes:

        ``CREATING ``if the resource group is in the process of being created.

        CREATE_COMPLETE if the resource group was created successfully.

        CREATE_FAILED if the resource group failed to be created.

        UPDATING if the resource group is in the process of being updated.

        UPDATE_COMPLETE if the resource group updated successfully.

        UPDATE_FAILED if the resource group could not update successfully.

      • arn (string) –

        The Amazon resource name (ARN) of the resource group.

      • errorMessage (string) –

        The error message that generates when the propagation process for the resource group fails.

    • applicationTagResourceGroup (dict) –

      The information about the resource group integration.

      • state (string) –

        The state of the propagation process for the resource group. The states includes:

        ``CREATING ``if the resource group is in the process of being created.

        CREATE_COMPLETE if the resource group was created successfully.

        CREATE_FAILED if the resource group failed to be created.

        UPDATING if the resource group is in the process of being updated.

        UPDATE_COMPLETE if the resource group updated successfully.

        UPDATE_FAILED if the resource group could not update successfully.

      • arn (string) –

        The Amazon resource name (ARN) of the resource group.

      • errorMessage (string) –

        The error message that generates when the propagation process for the resource group fails.

  • applicationTag (dict) –

    A key-value pair that identifies an associated resource.

    • (string) –

      • (string) –

Exceptions

• AppRegistry.Client.exceptions.ResourceNotFoundException

• AppRegistry.Client.exceptions.ValidationException

• AppRegistry.Client.exceptions.InternalServerException

• AppRegistry.Client.exceptions.ConflictException