Struct Credentials

#[non_exhaustive]
pub struct Credentials {
    pub access_token: Option<String>,
    pub access_token_expiration: Option<DateTime>,
    pub refresh_token: Option<String>,
    pub refresh_token_expiration: Option<DateTime>,
}

Contains credentials to use for federation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

access_token: Option<String>

An access token generated for a federated user to access Amazon Connect.

access_token_expiration: Option<DateTime>

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

refresh_token: Option<String>

Renews a token generated for a user to access the Amazon Connect instance.

refresh_token_expiration: Option<DateTime>

Renews the expiration timer for a generated token.

Implementations

impl Credentials

pub fn access_token(&self) -> Option<&str>

An access token generated for a federated user to access Amazon Connect.

pub fn access_token_expiration(&self) -> Option<&DateTime>

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

pub fn refresh_token(&self) -> Option<&str>

Renews a token generated for a user to access the Amazon Connect instance.

pub fn refresh_token_expiration(&self) -> Option<&DateTime>

Renews the expiration timer for a generated token.

impl Credentials

pub fn builder() -> CredentialsBuilder

Creates a new builder-style object to manufacture Credentials.

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Credentials

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Credentials

fn eq(&self, other: &Credentials) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Credentials