GuardDuty / Client / list_custom_detection_rule_org_configurations

list_custom_detection_rule_org_configurations

GuardDuty.Client.list_custom_detection_rule_org_configurations(**kwargs)

Returns all organization-level configurations for custom detection rules. You can filter the results by status.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_detection_rule_org_configurations(
    MaxResults=123,
    NextToken='string',
    Status='ACTIVE'|'PROCESSING'|'FAILED'
)
Parameters:

  • MaxResults (integer) – The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.

  • NextToken (string) – A pagination token from a previous response. Use this token to retrieve the next page of results.

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

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)
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      A pagination token to retrieve the next page of results. If this field is empty, there are no additional results.

Exceptions