aws_sdk_waf/client/
get_byte_match_set.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 [`GetByteMatchSet`](crate::operation::get_byte_match_set::builders::GetByteMatchSetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`byte_match_set_id(impl Into<String>)`](crate::operation::get_byte_match_set::builders::GetByteMatchSetFluentBuilder::byte_match_set_id) / [`set_byte_match_set_id(Option<String>)`](crate::operation::get_byte_match_set::builders::GetByteMatchSetFluentBuilder::set_byte_match_set_id):<br>required: **true**<br><p>The <code>ByteMatchSetId</code> of the <code>ByteMatchSet</code> that you want to get. <code>ByteMatchSetId</code> is returned by <code>CreateByteMatchSet</code> and by <code>ListByteMatchSets</code>.</p><br>
7    /// - On success, responds with [`GetByteMatchSetOutput`](crate::operation::get_byte_match_set::GetByteMatchSetOutput) with field(s):
8    ///   - [`byte_match_set(Option<ByteMatchSet>)`](crate::operation::get_byte_match_set::GetByteMatchSetOutput::byte_match_set): <p>Information about the <code>ByteMatchSet</code> that you specified in the <code>GetByteMatchSet</code> request. For more information, see the following topics:</p> <ul>  <li>   <p><code>ByteMatchSet</code>: Contains <code>ByteMatchSetId</code>, <code>ByteMatchTuples</code>, and <code>Name</code></p></li>  <li>   <p><code>ByteMatchTuples</code>: Contains an array of <code>ByteMatchTuple</code> objects. Each <code>ByteMatchTuple</code> object contains <code>FieldToMatch</code>, <code>PositionalConstraint</code>, <code>TargetString</code>, and <code>TextTransformation</code></p></li>  <li>   <p><code>FieldToMatch</code>: Contains <code>Data</code> and <code>Type</code></p></li> </ul>
9    /// - On failure, responds with [`SdkError<GetByteMatchSetError>`](crate::operation::get_byte_match_set::GetByteMatchSetError)
10    pub fn get_byte_match_set(&self) -> crate::operation::get_byte_match_set::builders::GetByteMatchSetFluentBuilder {
11        crate::operation::get_byte_match_set::builders::GetByteMatchSetFluentBuilder::new(self.handle.clone())
12    }
13}