aws_sdk_redshift/client/
get_identity_center_auth_token.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 [`GetIdentityCenterAuthToken`](crate::operation::get_identity_center_auth_token::builders::GetIdentityCenterAuthTokenFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_ids(impl Into<String>)`](crate::operation::get_identity_center_auth_token::builders::GetIdentityCenterAuthTokenFluentBuilder::cluster_ids) / [`set_cluster_ids(Option<Vec::<String>>)`](crate::operation::get_identity_center_auth_token::builders::GetIdentityCenterAuthTokenFluentBuilder::set_cluster_ids):<br>required: **true**<br><p>A list of cluster identifiers that the generated token can be used with. The token will be scoped to only allow authentication to the specified clusters.</p> <p>Constraints:</p> <ul>  <li>   <p><code>ClusterIds</code> must contain at least 1 cluster identifier.</p></li>  <li>   <p><code>ClusterIds</code> can hold a maximum of 20 cluster identifiers.</p></li>  <li>   <p>Cluster identifiers must be 1 to 63 characters in length.</p></li>  <li>   <p>The characters accepted for cluster identifiers are the following:</p>   <ul>    <li>     <p>Alphanumeric characters</p></li>    <li>     <p>Hyphens</p></li>   </ul></li>  <li>   <p>Cluster identifiers must start with a letter.</p></li>  <li>   <p>Cluster identifiers can't end with a hyphen or contain two consecutive hyphens.</p></li> </ul><br>
7    /// - On success, responds with [`GetIdentityCenterAuthTokenOutput`](crate::operation::get_identity_center_auth_token::GetIdentityCenterAuthTokenOutput) with field(s):
8    ///   - [`token(Option<String>)`](crate::operation::get_identity_center_auth_token::GetIdentityCenterAuthTokenOutput::token): <p>The encrypted authentication token containing the caller's Amazon Web Services IAM Identity Center identity information. This token is encrypted using Key Management Service and can only be decrypted by the specified Amazon Redshift clusters. Use this token with Amazon Redshift drivers to authenticate using your Amazon Web Services IAM Identity Center identity.</p>
9    ///   - [`expiration_time(Option<DateTime>)`](crate::operation::get_identity_center_auth_token::GetIdentityCenterAuthTokenOutput::expiration_time): <p>The time (UTC) when the token expires. After this timestamp, the token will no longer be valid for authentication.</p>
10    /// - On failure, responds with [`SdkError<GetIdentityCenterAuthTokenError>`](crate::operation::get_identity_center_auth_token::GetIdentityCenterAuthTokenError)
11    pub fn get_identity_center_auth_token(
12        &self,
13    ) -> crate::operation::get_identity_center_auth_token::builders::GetIdentityCenterAuthTokenFluentBuilder {
14        crate::operation::get_identity_center_auth_token::builders::GetIdentityCenterAuthTokenFluentBuilder::new(self.handle.clone())
15    }
16}