aws_sdk_connect/client/
update_participant_authentication.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateParticipantAuthentication`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`state(impl Into<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::state) / [`set_state(Option<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::set_state):<br>required: **true**<br><p>The <code>state</code> query parameter that was provided by Cognito in the <code>redirectUri</code>. This will also match the <code>state</code> parameter provided in the <code>AuthenticationUrl</code> from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html">GetAuthenticationUrl</a> response.</p><br>
    ///   - [`instance_id(impl Into<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`code(impl Into<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::code) / [`set_code(Option<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::set_code):<br>required: **false**<br><p>The <code>code</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p><br>
    ///   - [`error(impl Into<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::error) / [`set_error(Option<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::set_error):<br>required: **false**<br><p>The <code>error</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p><br>
    ///   - [`error_description(impl Into<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::error_description) / [`set_error_description(Option<String>)`](crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::set_error_description):<br>required: **false**<br><p>The <code>error_description</code> parameter provided by Cognito in the <code>redirectUri</code>.</p><br>
    /// - On success, responds with [`UpdateParticipantAuthenticationOutput`](crate::operation::update_participant_authentication::UpdateParticipantAuthenticationOutput)
    /// - On failure, responds with [`SdkError<UpdateParticipantAuthenticationError>`](crate::operation::update_participant_authentication::UpdateParticipantAuthenticationError)
    pub fn update_participant_authentication(
        &self,
    ) -> crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder {
        crate::operation::update_participant_authentication::builders::UpdateParticipantAuthenticationFluentBuilder::new(self.handle.clone())
    }
}