GuardDuty / Client / list_custom_detection_rule_associations

list_custom_detection_rule_associations

GuardDuty.Client.list_custom_detection_rule_associations(**kwargs)

Returns all custom detection rule associations for your account. You can filter by rule ID and mode.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_detection_rule_associations(
    MaxResults=123,
    NextToken='string',
    RuleId='string',
    Mode='LIVE'|'DRY_RUN'
)
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.

  • RuleId (string) – The unique identifier for the custom detection rule to filter associations by.

  • Mode (string) – The rule execution mode to filter associations by.

Return type:

dict

Returns:

Response Syntax

{
    'RuleAssociations': [
        {
            'AssociationId': 'string',
            'Arn': 'string',
            'RuleId': 'string',
            'Mode': 'LIVE'|'DRY_RUN',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'ExpiresAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RuleAssociations (list) –

      A list of custom detection rule association summaries.

      • (dict) –

        Contains summary information about a custom detection rule association.

        • AssociationId (string) –

          The unique identifier for the association.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the association.

        • RuleId (string) –

          The unique identifier for the custom detection rule.

        • Mode (string) –

          The rule execution mode. Valid values: LIVE | DRY_RUN.

        • CreatedAt (datetime) –

          The timestamp when the association was created.

        • UpdatedAt (datetime) –

          The timestamp when the association was last updated.

        • ExpiresAt (datetime) –

          The timestamp when the association expires.

    • NextToken (string) –

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

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException

  • GuardDuty.Client.exceptions.AccessDeniedException