aws_sdk_connect/client/
get_federation_token.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetFederationToken`](crate::operation::get_federation_token::builders::GetFederationTokenFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::get_federation_token::builders::GetFederationTokenFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::get_federation_token::builders::GetFederationTokenFluentBuilder::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>
    /// - On success, responds with [`GetFederationTokenOutput`](crate::operation::get_federation_token::GetFederationTokenOutput) with field(s):
    ///   - [`credentials(Option<Credentials>)`](crate::operation::get_federation_token::GetFederationTokenOutput::credentials): <p>The credentials to use for federation.</p>
    ///   - [`sign_in_url(Option<String>)`](crate::operation::get_federation_token::GetFederationTokenOutput::sign_in_url): <p>The URL to sign into the user's instance.</p>
    ///   - [`user_arn(Option<String>)`](crate::operation::get_federation_token::GetFederationTokenOutput::user_arn): <p>The Amazon Resource Name (ARN) of the user.</p>
    ///   - [`user_id(Option<String>)`](crate::operation::get_federation_token::GetFederationTokenOutput::user_id): <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
    /// - On failure, responds with [`SdkError<GetFederationTokenError>`](crate::operation::get_federation_token::GetFederationTokenError)
    pub fn get_federation_token(&self) -> crate::operation::get_federation_token::builders::GetFederationTokenFluentBuilder {
        crate::operation::get_federation_token::builders::GetFederationTokenFluentBuilder::new(self.handle.clone())
    }
}