aws_sdk_eventbridge/client/
describe_connection.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 [`DescribeConnection`](crate::operation::describe_connection::builders::DescribeConnectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::describe_connection::builders::DescribeConnectionFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_connection::builders::DescribeConnectionFluentBuilder::set_name):<br>required: **true**<br><p>The name of the connection to retrieve.</p><br>
7    /// - On success, responds with [`DescribeConnectionOutput`](crate::operation::describe_connection::DescribeConnectionOutput) with field(s):
8    ///   - [`connection_arn(Option<String>)`](crate::operation::describe_connection::DescribeConnectionOutput::connection_arn): <p>The ARN of the connection retrieved.</p>
9    ///   - [`name(Option<String>)`](crate::operation::describe_connection::DescribeConnectionOutput::name): <p>The name of the connection retrieved.</p>
10    ///   - [`description(Option<String>)`](crate::operation::describe_connection::DescribeConnectionOutput::description): <p>The description for the connection retrieved.</p>
11    ///   - [`invocation_connectivity_parameters(Option<DescribeConnectionConnectivityParameters>)`](crate::operation::describe_connection::DescribeConnectionOutput::invocation_connectivity_parameters): <p>For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html">Connecting to private APIs</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>
12    ///   - [`connection_state(Option<ConnectionState>)`](crate::operation::describe_connection::DescribeConnectionOutput::connection_state): <p>The state of the connection retrieved.</p>
13    ///   - [`state_reason(Option<String>)`](crate::operation::describe_connection::DescribeConnectionOutput::state_reason): <p>The reason that the connection is in the current connection state.</p>
14    ///   - [`authorization_type(Option<ConnectionAuthorizationType>)`](crate::operation::describe_connection::DescribeConnectionOutput::authorization_type): <p>The type of authorization specified for the connection.</p>
15    ///   - [`secret_arn(Option<String>)`](crate::operation::describe_connection::DescribeConnectionOutput::secret_arn): <p>The ARN of the secret created from the authorization parameters specified for the connection.</p>
16    ///   - [`kms_key_identifier(Option<String>)`](crate::operation::describe_connection::DescribeConnectionOutput::kms_key_identifier): <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-connections.html">Encrypting connections</a> in the <i>Amazon EventBridge User Guide</i>.</p>
17    ///   - [`auth_parameters(Option<ConnectionAuthResponseParameters>)`](crate::operation::describe_connection::DescribeConnectionOutput::auth_parameters): <p>The parameters to use for authorization for the connection.</p>
18    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_connection::DescribeConnectionOutput::creation_time): <p>A time stamp for the time that the connection was created.</p>
19    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_connection::DescribeConnectionOutput::last_modified_time): <p>A time stamp for the time that the connection was last modified.</p>
20    ///   - [`last_authorized_time(Option<DateTime>)`](crate::operation::describe_connection::DescribeConnectionOutput::last_authorized_time): <p>A time stamp for the time that the connection was last authorized.</p>
21    /// - On failure, responds with [`SdkError<DescribeConnectionError>`](crate::operation::describe_connection::DescribeConnectionError)
22    pub fn describe_connection(&self) -> crate::operation::describe_connection::builders::DescribeConnectionFluentBuilder {
23        crate::operation::describe_connection::builders::DescribeConnectionFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_eventbridge/client/describe_connection.rs

aws_sdk_eventbridge/client/
describe_connection.rs
