aws_sdk_connectparticipant/client/
get_authentication_url.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAuthenticationUrl`](crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`session_id(impl Into<String>)`](crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder::set_session_id):<br>required: **true**<br><p>The sessionId provided in the authenticationInitiated event.</p><br>
    ///   - [`redirect_uri(impl Into<String>)`](crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder::redirect_uri) / [`set_redirect_uri(Option<String>)`](crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder::set_redirect_uri):<br>required: **true**<br><p>The URL where the customer will be redirected after Amazon Cognito authorizes the user.</p><br>
    ///   - [`connection_token(impl Into<String>)`](crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder::connection_token) / [`set_connection_token(Option<String>)`](crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder::set_connection_token):<br>required: **true**<br><p>The authentication token associated with the participant's connection.</p><br>
    /// - On success, responds with [`GetAuthenticationUrlOutput`](crate::operation::get_authentication_url::GetAuthenticationUrlOutput) with field(s):
    ///   - [`authentication_url(Option<String>)`](crate::operation::get_authentication_url::GetAuthenticationUrlOutput::authentication_url): <p>The URL where the customer will sign in to the identity provider. This URL contains the authorize endpoint for the Cognito UserPool used in the authentication.</p>
    /// - On failure, responds with [`SdkError<GetAuthenticationUrlError>`](crate::operation::get_authentication_url::GetAuthenticationUrlError)
    pub fn get_authentication_url(&self) -> crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder {
        crate::operation::get_authentication_url::builders::GetAuthenticationUrlFluentBuilder::new(self.handle.clone())
    }
}