ResilienceHubV2 / Client / list_resources

list_resources

ResilienceHubV2.Client.list_resources(**kwargs)

List resources.

See also: AWS API Documentation

Request Syntax

response = client.list_resources(
    serviceArn='string',
    serviceFunctionId='string',
    awsRegion='string',
    maxResults=123,
    nextToken='string'
)
Parameters:
  • serviceArn (string) –

    [REQUIRED]

    ARN identifier.

  • serviceFunctionId (string) – Filter resources by service function identifier.

  • awsRegion (string) – Filter resources by AWS Region.

  • maxResults (integer) – Pagination page size.

  • nextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'serviceFunctionId': 'string',
    'serviceResources': [
        {
            'resourceIdentifier': 'string',
            'inputSource': {
                'identifier': 'string',
                'type': 'CFN_STACK'|'TAGS'|'EKS'|'TERRAFORM'|'DESIGN_FILE'|'MONITORING'
            },
            'resource': {
                'identifier': 'string',
                'awsRegion': 'string',
                'awsAccountId': 'string',
                'resourceType': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • serviceFunctionId (string) –

      The service function identifier for the returned resources.

    • serviceResources (list) –

      The list of service resources.

      • (dict) –

        Represents a resource associated with a service.

        • resourceIdentifier (string) –

          The identifier of the resource.

        • inputSource (dict) –

          The input source that discovered the resource.

          • identifier (string) –

            The identifier of the input source.

          • type (string) –

            The type of the input source.

        • resource (dict) –

          The resource details.

          • identifier (string) –

            The identifier of the resource.

          • awsRegion (string) –

            The AWS Region where the resource is located.

          • awsAccountId (string) –

            The AWS account ID that owns the resource.

          • resourceType (string) –

            The type of the resource.

    • nextToken (string) –

      Pagination token.

Exceptions

  • ResilienceHubV2.Client.exceptions.InternalServerException

  • ResilienceHubV2.Client.exceptions.ResourceNotFoundException

  • ResilienceHubV2.Client.exceptions.ValidationException

  • ResilienceHubV2.Client.exceptions.AccessDeniedException