aws_sdk_pipes/client/
describe_pipe.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 [`DescribePipe`](crate::operation::describe_pipe::builders::DescribePipeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::describe_pipe::builders::DescribePipeFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_pipe::builders::DescribePipeFluentBuilder::set_name):<br>required: **true**<br><p>The name of the pipe.</p><br>
7    /// - On success, responds with [`DescribePipeOutput`](crate::operation::describe_pipe::DescribePipeOutput) with field(s):
8    ///   - [`arn(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::arn): <p>The ARN of the pipe.</p>
9    ///   - [`name(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::name): <p>The name of the pipe.</p>
10    ///   - [`description(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::description): <p>A description of the pipe.</p>
11    ///   - [`desired_state(Option<RequestedPipeStateDescribeResponse>)`](crate::operation::describe_pipe::DescribePipeOutput::desired_state): <p>The state the pipe should be in.</p>
12    ///   - [`current_state(Option<PipeState>)`](crate::operation::describe_pipe::DescribePipeOutput::current_state): <p>The state the pipe is in.</p>
13    ///   - [`state_reason(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::state_reason): <p>The reason the pipe is in its current state.</p>
14    ///   - [`source(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::source): <p>The ARN of the source resource.</p>
15    ///   - [`source_parameters(Option<PipeSourceParameters>)`](crate::operation::describe_pipe::DescribePipeOutput::source_parameters): <p>The parameters required to set up a source for your pipe.</p>
16    ///   - [`enrichment(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::enrichment): <p>The ARN of the enrichment resource.</p>
17    ///   - [`enrichment_parameters(Option<PipeEnrichmentParameters>)`](crate::operation::describe_pipe::DescribePipeOutput::enrichment_parameters): <p>The parameters required to set up enrichment on your pipe.</p>
18    ///   - [`target(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::target): <p>The ARN of the target resource.</p>
19    ///   - [`target_parameters(Option<PipeTargetParameters>)`](crate::operation::describe_pipe::DescribePipeOutput::target_parameters): <p>The parameters required to set up a target for your pipe.</p> <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
20    ///   - [`role_arn(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::role_arn): <p>The ARN of the role that allows the pipe to send data to the target.</p>
21    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_pipe::DescribePipeOutput::tags): <p>The list of key-value pairs to associate with the pipe.</p>
22    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_pipe::DescribePipeOutput::creation_time): <p>The time the pipe was created.</p>
23    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_pipe::DescribePipeOutput::last_modified_time): <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
24    ///   - [`log_configuration(Option<PipeLogConfiguration>)`](crate::operation::describe_pipe::DescribePipeOutput::log_configuration): <p>The logging configuration settings for the pipe.</p>
25    ///   - [`kms_key_identifier(Option<String>)`](crate::operation::describe_pipe::DescribePipeOutput::kms_key_identifier): <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
26    /// - On failure, responds with [`SdkError<DescribePipeError>`](crate::operation::describe_pipe::DescribePipeError)
27    pub fn describe_pipe(&self) -> crate::operation::describe_pipe::builders::DescribePipeFluentBuilder {
28        crate::operation::describe_pipe::builders::DescribePipeFluentBuilder::new(self.handle.clone())
29    }
30}
aws_sdk_pipes/client/describe_pipe.rs

aws_sdk_pipes/client/
describe_pipe.rs
