GuardDuty / Paginator / ListCustomDetectionRuleOrgConfigurations

ListCustomDetectionRuleOrgConfigurations

class GuardDuty.Paginator.ListCustomDetectionRuleOrgConfigurations

paginator = client.get_paginator('list_custom_detection_rule_org_configurations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Status='ACTIVE'|'PROCESSING'|'FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Status (string) – The configuration status to filter by.

• 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

{
    'Configurations': [
        {
            'RuleId': 'string',
            'Mode': 'LIVE'|'DRY_RUN',
            'Status': 'ACTIVE'|'PROCESSING'|'FAILED',
            'StatusReason': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'ExpiresAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Configurations (list) –

    A list of organization configurations for custom detection rules.

    • (dict) –

      Contains summary information about an organization-level configuration for a custom detection rule.

      • RuleId (string) –

        The unique identifier for the custom detection rule.

      • Mode (string) –

        The rule execution mode.

      • Status (string) –

        The configuration status.

      • StatusReason (string) –

        The reason for the current configuration status.

      • CreatedAt (datetime) –

        The timestamp when the organization configuration was created.

      • UpdatedAt (datetime) –

        The timestamp when the organization configuration was last updated.

      • ExpiresAt (datetime) –

        The timestamp when the organization configuration expires.