Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Connect.Types.Credentials

Description

Documentation

data Credentials Source #

Contains credentials to use for federation.

See: newCredentials smart constructor.

Constructors

Credentials'

Fields

accessTokenExpiration :: Maybe POSIX
A token generated with an expiration time for the session a user is logged in to Amazon Connect.
accessToken :: Maybe (Sensitive Text)
An access token generated for a federated user to access 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

Instances details

Eq Credentials Source #
Instance details Defined in Amazonka.Connect.Types.Credentials Methods (==) :: Credentials -> Credentials -> Bool # (/=) :: Credentials -> Credentials -> Bool #
Show Credentials Source #
Instance details Defined in Amazonka.Connect.Types.Credentials Methods showsPrec :: Int -> Credentials -> ShowS # show :: Credentials -> String # showList :: [Credentials] -> ShowS #
Generic Credentials Source #
Instance details Defined in Amazonka.Connect.Types.Credentials Associated Types type Rep Credentials :: Type -> Type # Methods from :: Credentials -> Rep Credentials x # to :: Rep Credentials x -> Credentials #
NFData Credentials Source #
Instance details Defined in Amazonka.Connect.Types.Credentials Methods rnf :: Credentials -> () #
Hashable Credentials Source #
Instance details Defined in Amazonka.Connect.Types.Credentials Methods hashWithSalt :: Int -> Credentials -> Int # hash :: Credentials -> Int #
FromJSON Credentials Source #
Instance details Defined in Amazonka.Connect.Types.Credentials Methods parseJSON :: Value -> Parser Credentials # parseJSONList :: Value -> Parser [Credentials] #
type Rep Credentials Source #
Instance details Defined in Amazonka.Connect.Types.Credentials type Rep Credentials = D1 ('MetaData "Credentials" "Amazonka.Connect.Types.Credentials" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "Credentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessTokenExpiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "refreshTokenExpiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newCredentials :: Credentials Source #

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:accessTokenExpiration:Credentials', credentials_accessTokenExpiration - A token generated with an expiration time for the session a user is logged in to Amazon Connect.

$sel:accessToken:Credentials', credentials_accessToken - An access token generated for a federated user to access 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_accessTokenExpiration :: Lens' Credentials (Maybe UTCTime) Source #

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

credentials_accessToken :: Lens' Credentials (Maybe Text) Source #

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

credentials_refreshToken :: Lens' Credentials (Maybe Text) Source #

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

credentials_refreshTokenExpiration :: Lens' Credentials (Maybe UTCTime) Source #

Renews the expiration timer for a generated token.