Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatchEvents.TestEventPattern

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

data TestEventPattern Source #

See: newTestEventPattern smart constructor.

Constructors

TestEventPattern'
Fields eventPattern :: Text The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. event :: Text 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

Instances

Instances details

Eq TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods (==) :: TestEventPattern -> TestEventPattern -> Bool # (/=) :: TestEventPattern -> TestEventPattern -> Bool #
Read TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods readsPrec :: Int -> ReadS TestEventPattern # readList :: ReadS [TestEventPattern] # readPrec :: ReadPrec TestEventPattern # readListPrec :: ReadPrec [TestEventPattern] #
Show TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods showsPrec :: Int -> TestEventPattern -> ShowS # show :: TestEventPattern -> String # showList :: [TestEventPattern] -> ShowS #
Generic TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Associated Types type Rep TestEventPattern :: Type -> Type # Methods from :: TestEventPattern -> Rep TestEventPattern x # to :: Rep TestEventPattern x -> TestEventPattern #
NFData TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods rnf :: TestEventPattern -> () #
Hashable TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods hashWithSalt :: Int -> TestEventPattern -> Int # hash :: TestEventPattern -> Int #
ToJSON TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods toJSON :: TestEventPattern -> Value # toEncoding :: TestEventPattern -> Encoding # toJSONList :: [TestEventPattern] -> Value # toEncodingList :: [TestEventPattern] -> Encoding #
AWSRequest TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Associated Types type AWSResponse TestEventPattern # Methods request :: TestEventPattern -> Request TestEventPattern # response :: MonadResource m => Logger -> Service -> Proxy TestEventPattern -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestEventPattern))) #
ToHeaders TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods toHeaders :: TestEventPattern -> [Header] #
ToPath TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods toPath :: TestEventPattern -> ByteString #
ToQuery TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods toQuery :: TestEventPattern -> QueryString #
type Rep TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern type Rep TestEventPattern = D1 ('MetaData "TestEventPattern" "Amazonka.CloudWatchEvents.TestEventPattern" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "TestEventPattern'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "event") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse TestEventPattern Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern type AWSResponse TestEventPattern = TestEventPatternResponse

newTestEventPattern Source #

Arguments

:: Text	`$sel:eventPattern:TestEventPattern'`
-> Text	`$sel:event:TestEventPattern'`
-> TestEventPattern

Create a value of TestEventPattern with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventPattern:TestEventPattern', testEventPattern_eventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

$sel:event:TestEventPattern', testEventPattern_event - 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
```

Request Lenses

testEventPattern_eventPattern :: Lens' TestEventPattern Text Source #

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

testEventPattern_event :: Lens' TestEventPattern Text Source #

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
```

Destructuring the Response

data TestEventPatternResponse Source #

See: newTestEventPatternResponse smart constructor.

Constructors

TestEventPatternResponse'
Fields result :: Maybe Bool Indicates whether the event matches the event pattern. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq TestEventPatternResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods (==) :: TestEventPatternResponse -> TestEventPatternResponse -> Bool # (/=) :: TestEventPatternResponse -> TestEventPatternResponse -> Bool #
Read TestEventPatternResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods readsPrec :: Int -> ReadS TestEventPatternResponse # readList :: ReadS [TestEventPatternResponse] # readPrec :: ReadPrec TestEventPatternResponse # readListPrec :: ReadPrec [TestEventPatternResponse] #
Show TestEventPatternResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods showsPrec :: Int -> TestEventPatternResponse -> ShowS # show :: TestEventPatternResponse -> String # showList :: [TestEventPatternResponse] -> ShowS #
Generic TestEventPatternResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Associated Types type Rep TestEventPatternResponse :: Type -> Type # Methods from :: TestEventPatternResponse -> Rep TestEventPatternResponse x # to :: Rep TestEventPatternResponse x -> TestEventPatternResponse #
NFData TestEventPatternResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern Methods rnf :: TestEventPatternResponse -> () #
type Rep TestEventPatternResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.TestEventPattern type Rep TestEventPatternResponse = D1 ('MetaData "TestEventPatternResponse" "Amazonka.CloudWatchEvents.TestEventPattern" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "TestEventPatternResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTestEventPatternResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestEventPatternResponse'`
-> TestEventPatternResponse

Create a value of TestEventPatternResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:result:TestEventPatternResponse', testEventPatternResponse_result - Indicates whether the event matches the event pattern.

$sel:httpStatus:TestEventPatternResponse', testEventPatternResponse_httpStatus - The response's http status code.

Response Lenses

testEventPatternResponse_result :: Lens' TestEventPatternResponse (Maybe Bool) Source #

Indicates whether the event matches the event pattern.

testEventPatternResponse_httpStatus :: Lens' TestEventPatternResponse Int Source #

The response's http status code.