aws_sdk_bedrockagentcorecontrol/client/

update_gateway.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateGateway`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`gateway_identifier(impl Into<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::gateway_identifier) / [`set_gateway_identifier(Option<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_gateway_identifier):<br>required: **true**<br><p>The identifier of the gateway to update.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_name):<br>required: **true**<br><p>The name of the gateway. This name must be the same as the one when the gateway was created.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_description):<br>required: **false**<br><p>The updated description for the gateway.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_role_arn):<br>required: **true**<br><p>The updated IAM role ARN that provides permissions for the gateway.</p><br>
    ///   - [`protocol_type(GatewayProtocolType)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::protocol_type) / [`set_protocol_type(Option<GatewayProtocolType>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_protocol_type):<br>required: **true**<br><p>The updated protocol type for the gateway.</p><br>
    ///   - [`protocol_configuration(GatewayProtocolConfiguration)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::protocol_configuration) / [`set_protocol_configuration(Option<GatewayProtocolConfiguration>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_protocol_configuration):<br>required: **false**<br><p>The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.</p><br>
    ///   - [`authorizer_type(AuthorizerType)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::authorizer_type) / [`set_authorizer_type(Option<AuthorizerType>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_authorizer_type):<br>required: **true**<br><p>The updated authorizer type for the gateway.</p><br>
    ///   - [`authorizer_configuration(AuthorizerConfiguration)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::authorizer_configuration) / [`set_authorizer_configuration(Option<AuthorizerConfiguration>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_authorizer_configuration):<br>required: **false**<br><p>The updated authorizer configuration for the gateway.</p><br>
    ///   - [`kms_key_arn(impl Into<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_kms_key_arn):<br>required: **false**<br><p>The updated ARN of the KMS key used to encrypt the gateway.</p><br>
    ///   - [`exception_level(ExceptionLevel)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::exception_level) / [`set_exception_level(Option<ExceptionLevel>)`](crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::set_exception_level):<br>required: **false**<br><p>The level of detail in error messages returned when invoking the gateway.</p> <ul>  <li>   <p>If the value is <code>DEBUG</code>, granular exception messages are returned to help a user debug the gateway.</p></li>  <li>   <p>If the value is omitted, a generic error message is returned to the end user.</p></li> </ul><br>
    /// - On success, responds with [`UpdateGatewayOutput`](crate::operation::update_gateway::UpdateGatewayOutput) with field(s):
    ///   - [`gateway_arn(String)`](crate::operation::update_gateway::UpdateGatewayOutput::gateway_arn): <p>The Amazon Resource Name (ARN) of the updated gateway.</p>
    ///   - [`gateway_id(String)`](crate::operation::update_gateway::UpdateGatewayOutput::gateway_id): <p>The unique identifier of the updated gateway.</p>
    ///   - [`gateway_url(Option<String>)`](crate::operation::update_gateway::UpdateGatewayOutput::gateway_url): <p>An endpoint for invoking the updated gateway.</p>
    ///   - [`created_at(DateTime)`](crate::operation::update_gateway::UpdateGatewayOutput::created_at): <p>The timestamp when the gateway was created.</p>
    ///   - [`updated_at(DateTime)`](crate::operation::update_gateway::UpdateGatewayOutput::updated_at): <p>The timestamp when the gateway was last updated.</p>
    ///   - [`status(GatewayStatus)`](crate::operation::update_gateway::UpdateGatewayOutput::status): <p>The current status of the updated gateway.</p>
    ///   - [`status_reasons(Option<Vec::<String>>)`](crate::operation::update_gateway::UpdateGatewayOutput::status_reasons): <p>The reasons for the current status of the updated gateway.</p>
    ///   - [`name(String)`](crate::operation::update_gateway::UpdateGatewayOutput::name): <p>The name of the gateway.</p>
    ///   - [`description(Option<String>)`](crate::operation::update_gateway::UpdateGatewayOutput::description): <p>The updated description of the gateway.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::update_gateway::UpdateGatewayOutput::role_arn): <p>The updated IAM role ARN that provides permissions for the gateway.</p>
    ///   - [`protocol_type(GatewayProtocolType)`](crate::operation::update_gateway::UpdateGatewayOutput::protocol_type): <p>The updated protocol type for the gateway.</p>
    ///   - [`protocol_configuration(Option<GatewayProtocolConfiguration>)`](crate::operation::update_gateway::UpdateGatewayOutput::protocol_configuration): <p>The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.</p>
    ///   - [`authorizer_type(AuthorizerType)`](crate::operation::update_gateway::UpdateGatewayOutput::authorizer_type): <p>The updated authorizer type for the gateway.</p>
    ///   - [`authorizer_configuration(Option<AuthorizerConfiguration>)`](crate::operation::update_gateway::UpdateGatewayOutput::authorizer_configuration): <p>The updated authorizer configuration for the gateway.</p>
    ///   - [`kms_key_arn(Option<String>)`](crate::operation::update_gateway::UpdateGatewayOutput::kms_key_arn): <p>The updated ARN of the KMS key used to encrypt the gateway.</p>
    ///   - [`workload_identity_details(Option<WorkloadIdentityDetails>)`](crate::operation::update_gateway::UpdateGatewayOutput::workload_identity_details): <p>The workload identity details for the updated gateway.</p>
    ///   - [`exception_level(Option<ExceptionLevel>)`](crate::operation::update_gateway::UpdateGatewayOutput::exception_level): <p>The level of detail in error messages returned when invoking the gateway.</p> <ul>  <li>   <p>If the value is <code>DEBUG</code>, granular exception messages are returned to help a user debug the gateway.</p></li>  <li>   <p>If the value is omitted, a generic error message is returned to the end user.</p></li> </ul>
    /// - On failure, responds with [`SdkError<UpdateGatewayError>`](crate::operation::update_gateway::UpdateGatewayError)
    pub fn update_gateway(&self) -> crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder {
        crate::operation::update_gateway::builders::UpdateGatewayFluentBuilder::new(self.handle.clone())
    }
}