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.IAM.SetSecurityTokenServicePreferences

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.

By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference.

If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

Synopsis

data SetSecurityTokenServicePreferences = SetSecurityTokenServicePreferences' {
- globalEndpointTokenVersion :: GlobalEndpointTokenVersion
}
newSetSecurityTokenServicePreferences :: GlobalEndpointTokenVersion -> SetSecurityTokenServicePreferences
setSecurityTokenServicePreferences_globalEndpointTokenVersion :: Lens' SetSecurityTokenServicePreferences GlobalEndpointTokenVersion
data SetSecurityTokenServicePreferencesResponse = SetSecurityTokenServicePreferencesResponse' {
}
newSetSecurityTokenServicePreferencesResponse :: SetSecurityTokenServicePreferencesResponse

Creating a Request

data SetSecurityTokenServicePreferences Source #

See: newSetSecurityTokenServicePreferences smart constructor.

Constructors

SetSecurityTokenServicePreferences'

Fields

globalEndpointTokenVersion :: GlobalEndpointTokenVersion
The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.
For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

Instances

Instances details

Eq SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods (==) :: SetSecurityTokenServicePreferences -> SetSecurityTokenServicePreferences -> Bool # (/=) :: SetSecurityTokenServicePreferences -> SetSecurityTokenServicePreferences -> Bool #
Read SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods readsPrec :: Int -> ReadS SetSecurityTokenServicePreferences # readList :: ReadS [SetSecurityTokenServicePreferences] # readPrec :: ReadPrec SetSecurityTokenServicePreferences # readListPrec :: ReadPrec [SetSecurityTokenServicePreferences] #
Show SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods showsPrec :: Int -> SetSecurityTokenServicePreferences -> ShowS # show :: SetSecurityTokenServicePreferences -> String # showList :: [SetSecurityTokenServicePreferences] -> ShowS #
Generic SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Associated Types type Rep SetSecurityTokenServicePreferences :: Type -> Type # Methods from :: SetSecurityTokenServicePreferences -> Rep SetSecurityTokenServicePreferences x # to :: Rep SetSecurityTokenServicePreferences x -> SetSecurityTokenServicePreferences #
NFData SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods rnf :: SetSecurityTokenServicePreferences -> () #
Hashable SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods hashWithSalt :: Int -> SetSecurityTokenServicePreferences -> Int # hash :: SetSecurityTokenServicePreferences -> Int #
AWSRequest SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Associated Types type AWSResponse SetSecurityTokenServicePreferences # Methods request :: SetSecurityTokenServicePreferences -> Request SetSecurityTokenServicePreferences # response :: MonadResource m => Logger -> Service -> Proxy SetSecurityTokenServicePreferences -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetSecurityTokenServicePreferences))) #
ToHeaders SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods toHeaders :: SetSecurityTokenServicePreferences -> [Header] #
ToPath SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods toPath :: SetSecurityTokenServicePreferences -> ByteString #
ToQuery SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods toQuery :: SetSecurityTokenServicePreferences -> QueryString #
type Rep SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences type Rep SetSecurityTokenServicePreferences = D1 ('MetaData "SetSecurityTokenServicePreferences" "Amazonka.IAM.SetSecurityTokenServicePreferences" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "SetSecurityTokenServicePreferences'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalEndpointTokenVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GlobalEndpointTokenVersion)))
type AWSResponse SetSecurityTokenServicePreferences Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences type AWSResponse SetSecurityTokenServicePreferences = SetSecurityTokenServicePreferencesResponse

newSetSecurityTokenServicePreferences Source #

Arguments

:: GlobalEndpointTokenVersion	`$sel:globalEndpointTokenVersion:SetSecurityTokenServicePreferences'`
-> SetSecurityTokenServicePreferences

Create a value of SetSecurityTokenServicePreferences 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:globalEndpointTokenVersion:SetSecurityTokenServicePreferences', setSecurityTokenServicePreferences_globalEndpointTokenVersion - The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

Request Lenses

setSecurityTokenServicePreferences_globalEndpointTokenVersion :: Lens' SetSecurityTokenServicePreferences GlobalEndpointTokenVersion Source #

The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

Destructuring the Response

data SetSecurityTokenServicePreferencesResponse Source #

See: newSetSecurityTokenServicePreferencesResponse smart constructor.

Constructors

SetSecurityTokenServicePreferencesResponse'

Instances

Instances details

Eq SetSecurityTokenServicePreferencesResponse Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods (==) :: SetSecurityTokenServicePreferencesResponse -> SetSecurityTokenServicePreferencesResponse -> Bool # (/=) :: SetSecurityTokenServicePreferencesResponse -> SetSecurityTokenServicePreferencesResponse -> Bool #
Read SetSecurityTokenServicePreferencesResponse Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods readsPrec :: Int -> ReadS SetSecurityTokenServicePreferencesResponse # readList :: ReadS [SetSecurityTokenServicePreferencesResponse] # readPrec :: ReadPrec SetSecurityTokenServicePreferencesResponse # readListPrec :: ReadPrec [SetSecurityTokenServicePreferencesResponse] #
Show SetSecurityTokenServicePreferencesResponse Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods showsPrec :: Int -> SetSecurityTokenServicePreferencesResponse -> ShowS # show :: SetSecurityTokenServicePreferencesResponse -> String # showList :: [SetSecurityTokenServicePreferencesResponse] -> ShowS #
Generic SetSecurityTokenServicePreferencesResponse Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Associated Types type Rep SetSecurityTokenServicePreferencesResponse :: Type -> Type # Methods from :: SetSecurityTokenServicePreferencesResponse -> Rep SetSecurityTokenServicePreferencesResponse x # to :: Rep SetSecurityTokenServicePreferencesResponse x -> SetSecurityTokenServicePreferencesResponse #
NFData SetSecurityTokenServicePreferencesResponse Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences Methods rnf :: SetSecurityTokenServicePreferencesResponse -> () #
type Rep SetSecurityTokenServicePreferencesResponse Source #
Instance details Defined in Amazonka.IAM.SetSecurityTokenServicePreferences type Rep SetSecurityTokenServicePreferencesResponse = D1 ('MetaData "SetSecurityTokenServicePreferencesResponse" "Amazonka.IAM.SetSecurityTokenServicePreferences" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "SetSecurityTokenServicePreferencesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetSecurityTokenServicePreferencesResponse :: SetSecurityTokenServicePreferencesResponse Source #

Create a value of SetSecurityTokenServicePreferencesResponse with all optional fields omitted.

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