Amazonka.Connect.Types.Credentials

Documentation

data Credentials

Contains credentials to use for federation.

See: newCredentials smart constructor.

Constructors

Credentials'

Fields

• accessToken :: Maybe (Sensitive Text)

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

• accessTokenExpiration :: Maybe POSIX

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

• refreshToken :: Maybe (Sensitive Text)

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

• refreshTokenExpiration :: Maybe POSIX

  Renews the expiration timer for a generated token.

Instances

FromJSON Credentials

Defined in Amazonka.Connect.Types.Credentials

Methods

parseJSON :: Value -> Parser Credentials

parseJSONList :: Value -> Parser [Credentials]

Generic Credentials

Defined in Amazonka.Connect.Types.Credentials

Associated Types

type Rep Credentials :: Type -> Type

Methods

from :: Credentials -> Rep Credentials x

to :: Rep Credentials x -> Credentials

Show Credentials

Defined in Amazonka.Connect.Types.Credentials

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

NFData Credentials

Defined in Amazonka.Connect.Types.Credentials

Methods

rnf :: Credentials -> ()

Eq Credentials

Defined in Amazonka.Connect.Types.Credentials

Methods

(==) :: Credentials -> Credentials -> Bool

(/=) :: Credentials -> Credentials -> Bool

Hashable Credentials

Defined in Amazonka.Connect.Types.Credentials

Methods

hashWithSalt :: Int -> Credentials -> Int

hash :: Credentials -> Int

type Rep Credentials

Defined in Amazonka.Connect.Types.Credentials

type Rep Credentials = D1 ('MetaData "Credentials" "Amazonka.Connect.Types.Credentials" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "Credentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "accessTokenExpiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "refreshTokenExpiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newCredentials :: Credentials

Create a value of Credentials with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessToken:Credentials', credentials_accessToken - An access token generated for a federated user to access Amazon Connect.

$sel:accessTokenExpiration:Credentials', credentials_accessTokenExpiration - A token generated with an expiration time for the session a user is logged in to Amazon Connect.

$sel:refreshToken:Credentials', credentials_refreshToken - Renews a token generated for a user to access the Amazon Connect instance.

$sel:refreshTokenExpiration:Credentials', credentials_refreshTokenExpiration - Renews the expiration timer for a generated token.

credentials_accessToken :: Lens' Credentials (Maybe Text)

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

credentials_accessTokenExpiration :: Lens' Credentials (Maybe UTCTime)

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

credentials_refreshToken :: Lens' Credentials (Maybe Text)

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

credentials_refreshTokenExpiration :: Lens' Credentials (Maybe UTCTime)

Renews the expiration timer for a generated token.