aws_sdk_eventbridge/client/test_event_pattern.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`TestEventPattern`](crate::operation::test_event_pattern::builders::TestEventPatternFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`event_pattern(impl Into<String>)`](crate::operation::test_event_pattern::builders::TestEventPatternFluentBuilder::event_pattern) / [`set_event_pattern(Option<String>)`](crate::operation::test_event_pattern::builders::TestEventPatternFluentBuilder::set_event_pattern):<br>required: **true**<br><p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p><br>
7 /// - [`event(impl Into<String>)`](crate::operation::test_event_pattern::builders::TestEventPatternFluentBuilder::event) / [`set_event(Option<String>)`](crate::operation::test_event_pattern::builders::TestEventPatternFluentBuilder::set_event):<br>required: **true**<br><p>The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html">Amazon Web Services Events</a>, and the following fields are mandatory:</p> <ul> <li> <p><code>id</code></p></li> <li> <p><code>account</code></p></li> <li> <p><code>source</code></p></li> <li> <p><code>time</code></p></li> <li> <p><code>region</code></p></li> <li> <p><code>resources</code></p></li> <li> <p><code>detail-type</code></p></li> </ul><br>
8 /// - On success, responds with [`TestEventPatternOutput`](crate::operation::test_event_pattern::TestEventPatternOutput) with field(s):
9 /// - [`result(bool)`](crate::operation::test_event_pattern::TestEventPatternOutput::result): <p>Indicates whether the event matches the event pattern.</p>
10 /// - On failure, responds with [`SdkError<TestEventPatternError>`](crate::operation::test_event_pattern::TestEventPatternError)
11 pub fn test_event_pattern(&self) -> crate::operation::test_event_pattern::builders::TestEventPatternFluentBuilder {
12 crate::operation::test_event_pattern::builders::TestEventPatternFluentBuilder::new(self.handle.clone())
13 }
14}