GuardDuty / Paginator / ListCoverage

ListCoverage

class GuardDuty.Paginator.ListCoverage

paginator = client.get_paginator('list_coverage')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_coverage().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DetectorId='string',
    FilterCriteria={
        'FilterCriterion': [
            {
                'CriterionKey': 'ACCOUNT_ID'|'CLUSTER_NAME'|'RESOURCE_TYPE'|'COVERAGE_STATUS'|'ADDON_VERSION'|'MANAGEMENT_TYPE'|'EKS_CLUSTER_NAME',
                'FilterCondition': {
                    'Equals': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ]
                }
            },
        ]
    },
    SortCriteria={
        'AttributeName': 'ACCOUNT_ID'|'CLUSTER_NAME'|'COVERAGE_STATUS'|'ISSUE'|'ADDON_VERSION'|'UPDATED_AT'|'EKS_CLUSTER_NAME',
        'OrderBy': 'ASC'|'DESC'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DetectorId (string) –

  [REQUIRED]

  The unique ID of the detector whose coverage details you want to retrieve.

• FilterCriteria (dict) –

  Represents the criteria used to filter the coverage details.

  • FilterCriterion (list) –

    Represents a condition that when matched will be added to the response of the operation.

    • (dict) –

      Represents a condition that when matched will be added to the response of the operation.

      • CriterionKey (string) –

        An enum value representing possible filter fields.

        Note

        Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. CLUSTER_NAME has been deprecated.

      • FilterCondition (dict) –

        Contains information about the condition.

        • Equals (list) –

          Represents an equal condition that is applied to a single field while retrieving the coverage details.

          • (string) –

        • NotEquals (list) –

          Represents a not equal condition that is applied to a single field while retrieving the coverage details.

          • (string) –

• SortCriteria (dict) –

  Represents the criteria used to sort the coverage details.

  • AttributeName (string) –

    Represents the field name used to sort the coverage details.

    Note

    Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. CLUSTER_NAME has been deprecated.

  • OrderBy (string) –

    The order in which the sorted findings are to be displayed.

• 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

{
    'Resources': [
        {
            'ResourceId': 'string',
            'DetectorId': 'string',
            'AccountId': 'string',
            'ResourceDetails': {
                'EksClusterDetails': {
                    'ClusterName': 'string',
                    'CoveredNodes': 123,
                    'CompatibleNodes': 123,
                    'AddonDetails': {
                        'AddonVersion': 'string',
                        'AddonStatus': 'string'
                    },
                    'ManagementType': 'AUTO_MANAGED'|'MANUAL'
                },
                'ResourceType': 'EKS'
            },
            'CoverageStatus': 'HEALTHY'|'UNHEALTHY',
            'Issue': 'string',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Resources (list) –

    A list of resources and their attributes providing cluster details.

    • (dict) –

      Information about the resource of the GuardDuty account.

      • ResourceId (string) –

        The unique ID of the resource.

      • DetectorId (string) –

        The unique ID of the GuardDuty detector associated with the resource.

      • AccountId (string) –

        The unique ID of the Amazon Web Services account.

      • ResourceDetails (dict) –

        Information about the resource for which the coverage statistics are retrieved.

        • EksClusterDetails (dict) –

          EKS cluster details involved in the coverage statistics.

          • ClusterName (string) –

            Name of the EKS cluster.

          • CoveredNodes (integer) –

            Represents the nodes within the EKS cluster that have a HEALTHY coverage status.

          • CompatibleNodes (integer) –

            Represents all the nodes within the EKS cluster in your account.

          • AddonDetails (dict) –

            Information about the installed EKS add-on.

            • AddonVersion (string) –

              Version of the installed EKS add-on.

            • AddonStatus (string) –

              Status of the installed EKS add-on.

          • ManagementType (string) –

            Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS cluster.

            AUTO_MANAGED indicates GuardDuty deploys and manages updates for this resource.

            MANUAL indicates that you are responsible to deploy, update, and manage the Amazon EKS add-on GuardDuty agent for this resource.

        • ResourceType (string) –

          The type of Amazon Web Services resource.

      • CoverageStatus (string) –

        Represents the status of the EKS cluster coverage.

      • Issue (string) –

        Represents the reason why a coverage status was UNHEALTHY for the EKS cluster.

      • UpdatedAt (datetime) –

        The timestamp at which the coverage details for the resource were last updated. This is in UTC format.