aws_sdk_bedrockagentcorecontrol/client/
get_gateway.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 [`GetGateway`](crate::operation::get_gateway::builders::GetGatewayFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`gateway_identifier(impl Into<String>)`](crate::operation::get_gateway::builders::GetGatewayFluentBuilder::gateway_identifier) / [`set_gateway_identifier(Option<String>)`](crate::operation::get_gateway::builders::GetGatewayFluentBuilder::set_gateway_identifier):<br>required: **true**<br><p>The identifier of the gateway to retrieve. This can be either the gateway ID or the gateway ARN.</p><br>
7    /// - On success, responds with [`GetGatewayOutput`](crate::operation::get_gateway::GetGatewayOutput) with field(s):
8    ///   - [`gateway_arn(String)`](crate::operation::get_gateway::GetGatewayOutput::gateway_arn): <p>The Amazon Resource Name (ARN) of the Gateway.</p>
9    ///   - [`gateway_id(String)`](crate::operation::get_gateway::GetGatewayOutput::gateway_id): <p>The unique identifier of the Gateway.</p>
10    ///   - [`gateway_url(Option<String>)`](crate::operation::get_gateway::GetGatewayOutput::gateway_url): <p>An endpoint for invoking Gateway.</p>
11    ///   - [`created_at(DateTime)`](crate::operation::get_gateway::GetGatewayOutput::created_at): <p>The timestamp when the Gateway was created.</p>
12    ///   - [`updated_at(DateTime)`](crate::operation::get_gateway::GetGatewayOutput::updated_at): <p>The timestamp when the Gateway was last updated.</p>
13    ///   - [`status(GatewayStatus)`](crate::operation::get_gateway::GetGatewayOutput::status): <p>The current status of the Gateway.</p>
14    ///   - [`status_reasons(Option<Vec::<String>>)`](crate::operation::get_gateway::GetGatewayOutput::status_reasons): <p>The reasons for the current status of the Gateway.</p>
15    ///   - [`name(String)`](crate::operation::get_gateway::GetGatewayOutput::name): <p>The name of the Gateway.</p>
16    ///   - [`description(Option<String>)`](crate::operation::get_gateway::GetGatewayOutput::description): <p>The description of the Gateway.</p>
17    ///   - [`role_arn(Option<String>)`](crate::operation::get_gateway::GetGatewayOutput::role_arn): <p>The IAM role ARN that provides permissions for the Gateway.</p>
18    ///   - [`protocol_type(GatewayProtocolType)`](crate::operation::get_gateway::GetGatewayOutput::protocol_type): <p>Protocol applied to a Gateway.</p>
19    ///   - [`protocol_configuration(Option<GatewayProtocolConfiguration>)`](crate::operation::get_gateway::GetGatewayOutput::protocol_configuration): <p>The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.</p>
20    ///   - [`authorizer_type(AuthorizerType)`](crate::operation::get_gateway::GetGatewayOutput::authorizer_type): <p>Authorizer type for the gateway.</p>
21    ///   - [`authorizer_configuration(Option<AuthorizerConfiguration>)`](crate::operation::get_gateway::GetGatewayOutput::authorizer_configuration): <p>The authorizer configuration for the Gateway.</p>
22    ///   - [`kms_key_arn(Option<String>)`](crate::operation::get_gateway::GetGatewayOutput::kms_key_arn): <p>The ARN of the KMS key used to encrypt the Gateway.</p>
23    ///   - [`workload_identity_details(Option<WorkloadIdentityDetails>)`](crate::operation::get_gateway::GetGatewayOutput::workload_identity_details): <p>The workload identity details for the Gateway.</p>
24    ///   - [`exception_level(Option<ExceptionLevel>)`](crate::operation::get_gateway::GetGatewayOutput::exception_level): <p>The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.</p>
25    /// - On failure, responds with [`SdkError<GetGatewayError>`](crate::operation::get_gateway::GetGatewayError)
26    pub fn get_gateway(&self) -> crate::operation::get_gateway::builders::GetGatewayFluentBuilder {
27        crate::operation::get_gateway::builders::GetGatewayFluentBuilder::new(self.handle.clone())
28    }
29}
aws_sdk_bedrockagentcorecontrol/client/get_gateway.rs

aws_sdk_bedrockagentcorecontrol/client/
get_gateway.rs
