AppRegistry / Client / list_associated_resources

list_associated_resources#

AppRegistry.Client.list_associated_resources(**kwargs)#

Lists all of the resources that are associated with the specified application. Results are paginated.

Note

If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.

See also: AWS API Documentation

Request Syntax

response = client.list_associated_resources(
    application='string',
    nextToken='string',
    maxResults=123
)
Parameters:
  • application (string) –

    [REQUIRED]

    The name, ID, or ARN of the application.

  • nextToken (string) – The token to use to get the next page of results after a previous API call.

  • maxResults (integer) – The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Return type:

dict

Returns:

Response Syntax

{
    'resources': [
        {
            'name': 'string',
            'arn': 'string',
            'resourceType': 'CFN_STACK'|'RESOURCE_TAG_VALUE',
            'resourceDetails': {
                'tagValue': 'string'
            },
            'options': [
                'APPLY_APPLICATION_TAG'|'SKIP_APPLICATION_TAG',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • resources (list) –

      Information about the resources.

      • (dict) –

        The information about the resource.

        • name (string) –

          The name of the resource.

        • arn (string) –

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

        • resourceType (string) –

          Provides information about the Service Catalog App Registry resource type.

        • resourceDetails (dict) –

          The details related to the resource.

          • tagValue (string) –

            The value of the tag.

        • options (list) –

          Determines whether an application tag is applied or skipped.

          • (string) –

    • nextToken (string) –

      The token to use to get the next page of results after a previous API call.

Exceptions

  • AppRegistry.Client.exceptions.ResourceNotFoundException

  • AppRegistry.Client.exceptions.ValidationException

  • AppRegistry.Client.exceptions.InternalServerException