AWS Service Catalog App Registry

2021/09/01 - AWS Service Catalog App Registry - 1 new1 updated api methods

Changes  Introduction of GetAssociatedResource API and GetApplication response extension for Resource Groups support.

GetAssociatedResource (new) Link ¶

Gets the resource associated with the application.

See also: AWS API Documentation

Request Syntax

client.get_associated_resource(
    application='string',
    resourceType='CFN_STACK',
    resource='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

type resourceType:

string

param resourceType:

[REQUIRED]

The type of resource associated with the application.

type resource:

string

param resource:

[REQUIRED]

The name or ID of the resource associated with the application.

rtype:

dict

returns:

Response Syntax

{
    'resource': {
        'name': 'string',
        'arn': 'string',
        'associationTime': datetime(2015, 1, 1),
        'integrations': {
            'resourceGroup': {
                'state': 'CREATING'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
                'arn': 'string',
                'errorMessage': 'string'
            }
        }
    }
}

Response Structure

  • (dict) --

    • resource (dict) --

      The resource associated with the application.

      • name (string) --

        The name of the resource.

      • arn (string) --

        The Amazon resource name (ARN) of the resource.

      • associationTime (datetime) --

        The time the resource was associated with the application.

      • integrations (dict) --

        The service integration information about the resource.

        • resourceGroup (dict) --

          The information about the integration of Resource Groups.

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

GetApplication (updated) Link ¶
Changes (response)
{'integrations': {'resourceGroup': {'arn': 'string',
                                    'errorMessage': 'string',
                                    'state': 'CREATING | CREATE_COMPLETE | '
                                             'CREATE_FAILED | UPDATING | '
                                             'UPDATE_COMPLETE | '
                                             'UPDATE_FAILED'}}}

Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by 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

client.get_application(
    application='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

rtype:

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

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.