Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AmplifyUiBuilder.RefreshToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Refreshes a previously issued access token that might have expired.

Creating a Request

data RefreshToken Source #

See: newRefreshToken smart constructor.

Constructors

RefreshToken'
Fields provider :: TokenProviders The third-party provider for the token. The only valid value is `figma`. refreshTokenBody :: RefreshTokenRequestBody Information about the refresh token request.

Instances

Instances details

ToJSON RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods toJSON :: RefreshToken -> Value # toEncoding :: RefreshToken -> Encoding # toJSONList :: [RefreshToken] -> Value # toEncodingList :: [RefreshToken] -> Encoding #
ToHeaders RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods toHeaders :: RefreshToken -> [Header] #
ToPath RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods toPath :: RefreshToken -> ByteString #
ToQuery RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods toQuery :: RefreshToken -> QueryString #
AWSRequest RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Associated Types type AWSResponse RefreshToken # Methods request :: (Service -> Service) -> RefreshToken -> Request RefreshToken # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RefreshToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RefreshToken))) #
Generic RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Associated Types type Rep RefreshToken :: Type -> Type # Methods from :: RefreshToken -> Rep RefreshToken x # to :: Rep RefreshToken x -> RefreshToken #
Show RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods showsPrec :: Int -> RefreshToken -> ShowS # show :: RefreshToken -> String # showList :: [RefreshToken] -> ShowS #
NFData RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods rnf :: RefreshToken -> () #
Eq RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods (==) :: RefreshToken -> RefreshToken -> Bool # (/=) :: RefreshToken -> RefreshToken -> Bool #
Hashable RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods hashWithSalt :: Int -> RefreshToken -> Int # hash :: RefreshToken -> Int #
type AWSResponse RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken type AWSResponse RefreshToken = RefreshTokenResponse
type Rep RefreshToken Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken type Rep RefreshToken = D1 ('MetaData "RefreshToken" "Amazonka.AmplifyUiBuilder.RefreshToken" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "RefreshToken'" 'PrefixI 'True) (S1 ('MetaSel ('Just "provider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TokenProviders) :*: S1 ('MetaSel ('Just "refreshTokenBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RefreshTokenRequestBody)))

newRefreshToken Source #

Arguments

:: TokenProviders	`$sel:provider:RefreshToken'`
-> RefreshTokenRequestBody	`$sel:refreshTokenBody:RefreshToken'`
-> RefreshToken

Create a value of RefreshToken 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:provider:RefreshToken', refreshToken_provider - The third-party provider for the token. The only valid value is figma.

$sel:refreshTokenBody:RefreshToken', refreshToken_refreshTokenBody - Information about the refresh token request.

Request Lenses

refreshToken_provider :: Lens' RefreshToken TokenProviders Source #

The third-party provider for the token. The only valid value is figma.

refreshToken_refreshTokenBody :: Lens' RefreshToken RefreshTokenRequestBody Source #

Information about the refresh token request.

Destructuring the Response

data RefreshTokenResponse Source #

See: newRefreshTokenResponse smart constructor.

Constructors

RefreshTokenResponse'
Fields httpStatus :: Int The response's http status code. accessToken :: Sensitive Text The access token. expiresIn :: Int The date and time when the new access token expires.

Instances

Instances details

Generic RefreshTokenResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Associated Types type Rep RefreshTokenResponse :: Type -> Type # Methods from :: RefreshTokenResponse -> Rep RefreshTokenResponse x # to :: Rep RefreshTokenResponse x -> RefreshTokenResponse #
Show RefreshTokenResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods showsPrec :: Int -> RefreshTokenResponse -> ShowS # show :: RefreshTokenResponse -> String # showList :: [RefreshTokenResponse] -> ShowS #
NFData RefreshTokenResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods rnf :: RefreshTokenResponse -> () #
Eq RefreshTokenResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken Methods (==) :: RefreshTokenResponse -> RefreshTokenResponse -> Bool # (/=) :: RefreshTokenResponse -> RefreshTokenResponse -> Bool #
type Rep RefreshTokenResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.RefreshToken type Rep RefreshTokenResponse = D1 ('MetaData "RefreshTokenResponse" "Amazonka.AmplifyUiBuilder.RefreshToken" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "RefreshTokenResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRefreshTokenResponse Source #

Arguments

:: Int	`$sel:httpStatus:RefreshTokenResponse'`
-> Text	`$sel:accessToken:RefreshTokenResponse'`
-> Int	`$sel:expiresIn:RefreshTokenResponse'`
-> RefreshTokenResponse

Create a value of RefreshTokenResponse 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:httpStatus:RefreshTokenResponse', refreshTokenResponse_httpStatus - The response's http status code.

$sel:accessToken:RefreshTokenResponse', refreshTokenResponse_accessToken - The access token.

$sel:expiresIn:RefreshTokenResponse', refreshTokenResponse_expiresIn - The date and time when the new access token expires.

Response Lenses

refreshTokenResponse_httpStatus :: Lens' RefreshTokenResponse Int Source #

The response's http status code.

refreshTokenResponse_accessToken :: Lens' RefreshTokenResponse Text Source #

The access token.

refreshTokenResponse_expiresIn :: Lens' RefreshTokenResponse Int Source #

The date and time when the new access token expires.