GuardDuty / Client / get_custom_detection_rule_org_configuration

get_custom_detection_rule_org_configuration

GuardDuty.Client.get_custom_detection_rule_org_configuration(**kwargs)

Returns the organization-level configuration for a custom detection rule.

See also: AWS API Documentation

Request Syntax

response = client.get_custom_detection_rule_org_configuration(
    RuleId='string',
    Mode='LIVE'|'DRY_RUN'
)

Parameters:

• RuleId (string) –

  [REQUIRED]

  The unique identifier for the custom detection rule.

• Mode (string) –

  [REQUIRED]

  The execution mode of the organization configuration to retrieve. Valid values: LIVE | DRY_RUN.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • Configuration (dict) –

    The details of the organization configuration.

    • RuleId (string) –

      The unique identifier for the custom detection rule.

    • Mode (string) –

      The execution mode of the organization configuration. Valid values: LIVE | DRY_RUN.

    • Status (string) –

      The configuration status. Valid values: ACTIVE | PROCESSING | FAILED.

    • StatusReason (string) –

      The reason for the current configuration status.

    • IncludeAccountIds (list) –

      A list of member account IDs included in the organization configuration. Mutually exclusive with ExcludeAccountIds.

      • (string) –

    • ExcludeAccountIds (list) –

      A list of member account IDs excluded from the organization configuration. Mutually exclusive with IncludeAccountIds.

      • (string) –

    • 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.

Exceptions

• GuardDuty.Client.exceptions.BadRequestException

• GuardDuty.Client.exceptions.InternalServerErrorException

• GuardDuty.Client.exceptions.AccessDeniedException

• GuardDuty.Client.exceptions.ResourceNotFoundException