ResilienceHubV2 / Paginator / ListServices

ListServices

class ResilienceHubV2.Paginator.ListServices

paginator = client.get_paginator('list_services')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ResilienceHubV2.Client.list_services().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    systemArn='string',
    userJourneyId='string',
    ouId='string',
    accountId='string',
    assessmentStatus='NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
    policyArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• systemArn (string) – ARN identifier.

• userJourneyId (string) – Filter services by user journey identifier.

• ouId (string) – Filter services by organizational unit (OU) identifier.

• accountId (string) – Filter services by AWS account ID.

• assessmentStatus (string) – Filter services by assessment status.

• policyArn (string) – ARN identifier.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'serviceSummaries': [
        {
            'serviceArn': 'string',
            'name': 'string',
            'associatedSystems': [
                {
                    'systemArn': 'string',
                    'systemName': 'string',
                    'userJourneyIds': [
                        'string',
                    ]
                },
            ],
            'regions': [
                'string',
            ],
            'policyArn': 'string',
            'assessmentStatus': 'NOT_STARTED'|'PENDING'|'IN_PROGRESS'|'FAILED'|'SUCCESS',
            'openFindingsCount': 123,
            'resolvedFindingsCount': 123,
            'dependencyDiscovery': {
                'status': 'ENABLED'|'INITIALIZING'|'DISABLED',
                'updatedAt': datetime(2015, 1, 1)
            },
            'achievability': {
                'availabilitySlo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
                'multiAzRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE',
                'multiRegionRtoRpo': 'ACHIEVABLE'|'NOT_ACHIEVABLE'
            },
            'organizationId': 'string',
            'ouId': 'string',
            'accountId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • serviceSummaries (list) –

    The list of service summaries.

    • (dict) –

      Contains summary information about a service.

      • serviceArn (string) –

        ARN identifier.

      • name (string) –

        Resource name (used in ARN — no spaces allowed).

      • associatedSystems (list) –

        The systems associated with the service.

        • (dict) –

          Represents a system associated with a service.

          • systemArn (string) –

            ARN identifier.

          • systemName (string) –

            Resource name (used in ARN — no spaces allowed).

          • userJourneyIds (list) –

            The list of user journey identifiers that associate this system with the service.

            • (string) –

      • regions (list) –

        The AWS Regions where the service operates.

        • (string) –

      • policyArn (string) –

        ARN identifier.

      • assessmentStatus (string) –

        The current assessment status of the service.

      • openFindingsCount (integer) –

        The number of open findings.

      • resolvedFindingsCount (integer) –

        The number of resolved findings.

      • dependencyDiscovery (dict) –

        The dependency discovery configuration.

        • status (string) –

          The current status of dependency discovery.

        • updatedAt (datetime) –

          The timestamp when dependency discovery was last updated.

      • achievability (dict) –

        The achievability status of the service’s resilience targets.

        • availabilitySlo (string) –

          The achievability status of the availability SLO target for the service.

        • multiAzRtoRpo (string) –

          The achievability status of the multi-AZ RTO and RPO targets for the service.

        • multiRegionRtoRpo (string) –

          The achievability status of the multi-Region RTO and RPO targets for the service.

      • organizationId (string) –

        Displayed only if caller has access.

      • ouId (string) –

        Displayed only if caller has access.

      • accountId (string) –

        Displayed only if caller has access.

      • createdAt (datetime) –

        The timestamp when the service was created.

      • updatedAt (datetime) –

        The timestamp when the service was last updated.

  • NextToken (string) –

    A token to resume pagination.