Struct aws_sdk_cognitoidentityprovider::types::AuthenticationResultType

#[non_exhaustive]
pub struct AuthenticationResultType {
    pub access_token: Option<String>,
    pub expires_in: i32,
    pub token_type: Option<String>,
    pub refresh_token: Option<String>,
    pub id_token: Option<String>,
    pub new_device_metadata: Option<NewDeviceMetadataType>,
}

The authentication result.

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>

A valid access token that Amazon Cognito issued to the user who you want to authenticate.

expires_in: i32

The expiration period of the authentication result in seconds.

token_type: Option<String>

The token type.

refresh_token: Option<String>

The refresh token.

id_token: Option<String>

The ID token.

new_device_metadata: Option<NewDeviceMetadataType>

The new device metadata from an authentication result.

Implementations

impl AuthenticationResultType

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

A valid access token that Amazon Cognito issued to the user who you want to authenticate.

pub fn expires_in(&self) -> i32

The expiration period of the authentication result in seconds.

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

The token type.

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

The refresh token.

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

The ID token.

pub fn new_device_metadata(&self) -> Option<&NewDeviceMetadataType>

The new device metadata from an authentication result.

impl AuthenticationResultType

pub fn builder() -> AuthenticationResultTypeBuilder

Creates a new builder-style object to manufacture AuthenticationResultType.

Trait Implementations

impl Clone for AuthenticationResultType

fn clone(&self) -> AuthenticationResultType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticationResultType

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

Formats the value using the given formatter.

impl PartialEq for AuthenticationResultType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AuthenticationResultType