aws_sdk_eventbridge/client/
describe_endpoint.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeEndpoint`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::set_name):<br>required: **true**<br><p>The name of the endpoint you want to get information about. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p><br>
    ///   - [`home_region(impl Into<String>)`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::home_region) / [`set_home_region(Option<String>)`](crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::set_home_region):<br>required: **false**<br><p>The primary Region of the endpoint you want to get information about. For example <code>"HomeRegion": "us-east-1"</code>.</p><br>
    /// - On success, responds with [`DescribeEndpointOutput`](crate::operation::describe_endpoint::DescribeEndpointOutput) with field(s):
    ///   - [`name(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::name): <p>The name of the endpoint you asked for information about.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::description): <p>The description of the endpoint you asked for information about.</p>
    ///   - [`arn(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::arn): <p>The ARN of the endpoint you asked for information about.</p>
    ///   - [`routing_config(Option<RoutingConfig>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::routing_config): <p>The routing configuration of the endpoint you asked for information about.</p>
    ///   - [`replication_config(Option<ReplicationConfig>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::replication_config): <p>Whether replication is enabled or disabled for the endpoint you asked for information about.</p>
    ///   - [`event_buses(Option<Vec::<EndpointEventBus>>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::event_buses): <p>The event buses being used by the endpoint you asked for information about.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::role_arn): <p>The ARN of the role used by the endpoint you asked for information about.</p>
    ///   - [`endpoint_id(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::endpoint_id): <p>The ID of the endpoint you asked for information about.</p>
    ///   - [`endpoint_url(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::endpoint_url): <p>The URL of the endpoint you asked for information about.</p>
    ///   - [`state(Option<EndpointState>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::state): <p>The current state of the endpoint you asked for information about.</p>
    ///   - [`state_reason(Option<String>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::state_reason): <p>The reason the endpoint you asked for information about is in its current state.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::creation_time): <p>The time the endpoint you asked for information about was created.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_endpoint::DescribeEndpointOutput::last_modified_time): <p>The last time the endpoint you asked for information about was modified.</p>
    /// - On failure, responds with [`SdkError<DescribeEndpointError>`](crate::operation::describe_endpoint::DescribeEndpointError)
    pub fn describe_endpoint(&self) -> crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder {
        crate::operation::describe_endpoint::builders::DescribeEndpointFluentBuilder::new(self.handle.clone())
    }
}