AppRegistry / Client / get_associated_resource

get_associated_resource

AppRegistry.Client.get_associated_resource(**kwargs)

Gets the resource associated with the application.

See also: AWS API Documentation

Request Syntax

response = client.get_associated_resource(
    application='string',
    resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
    resource='string',
    nextToken='string',
    resourceTagStatus=[
        'SUCCESS'|'FAILED'|'IN_PROGRESS'|'SKIPPED',
    ],
    maxResults=123
)

Parameters:

• application (string) –

  [REQUIRED]

  The name, ID, or ARN of the application.

• resourceType (string) –

  [REQUIRED]

  The type of resource associated with the application.

• resource (string) –

  [REQUIRED]

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

• nextToken (string) – A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.

• resourceTagStatus (list) –

  States whether an application tag is applied, not applied, in the process of being applied, or skipped.

  • (string) –

• maxResults (integer) – The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional.

Return type:

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'
            }
        }
    },
    'options': [
        'APPLY_APPLICATION_TAG'|'SKIP_APPLICATION_TAG',
    ],
    'applicationTagResult': {
        'applicationTagStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILURE',
        'errorMessage': 'string',
        'resources': [
            {
                'resourceArn': 'string',
                'errorMessage': 'string',
                'status': 'string',
                'resourceType': 'string'
            },
        ],
        'nextToken': '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.

  • options (list) –

    Determines whether an application tag is applied or skipped.

    • (string) –

  • applicationTagResult (dict) –

    The result of the application that’s tag applied to a resource.

    • applicationTagStatus (string) –

      The application tag is in the process of being applied to a resource, was successfully applied to a resource, or failed to apply to a resource.

    • errorMessage (string) –

      The message returned if the call fails.

    • resources (list) –

      The resources associated with an application

      • (dict) –

        The resource in a list of resources.

        • resourceArn (string) –

          The Amazon resource name (ARN) of the resource.

        • errorMessage (string) –

          The message returned if the call fails.

        • status (string) –

          The status of the list item.

        • resourceType (string) –

          Provides information about the AppRegistry resource type.

    • nextToken (string) –

      A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.

Exceptions

• AppRegistry.Client.exceptions.ResourceNotFoundException

• AppRegistry.Client.exceptions.ValidationException

• AppRegistry.Client.exceptions.InternalServerException