EventBridge / Client / test_event_pattern

test_event_pattern#

EventBridge.Client.test_event_pattern(**kwargs)#

Tests whether the specified event pattern matches the provided event.

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

See also: AWS API Documentation

Request Syntax

response = client.test_event_pattern(
    EventPattern='string',
    Event='string'
)
Parameters:

  • EventPattern (string) –

    [REQUIRED]

    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

  • Event (string) –

    [REQUIRED]

    The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory:

    • id

    • account

    • source

    • time

    • region

    • resources

    • detail-type

Return type:

dict

Returns:

Response Syntax

{
    'Result': True|False
}

Response Structure

  • (dict) –

    • Result (boolean) –

      Indicates whether the event matches the event pattern.

Exceptions

  • EventBridge.Client.exceptions.InvalidEventPatternException

  • EventBridge.Client.exceptions.InternalException