{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.STS.GetFederationToken
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a set of temporary security credentials (consisting of an access
-- key ID, a secret access key, and a security token) for a federated user.
-- A typical use is in a proxy application that gets temporary security
-- credentials on behalf of distributed applications inside a corporate
-- network. You must call the @GetFederationToken@ operation using the
-- long-term security credentials of an IAM user. As a result, this call is
-- appropriate in contexts where those credentials can be safely stored,
-- usually in a server-based application. For a comparison of
-- @GetFederationToken@ with the other API operations that produce
-- temporary credentials, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html Requesting Temporary Security Credentials>
-- and
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison Comparing the Amazon Web Services STS API operations>
-- in the /IAM User Guide/.
--
-- You can create a mobile-based or browser-based app that can authenticate
-- users using a web identity provider like Login with Amazon, Facebook,
-- Google, or an OpenID Connect-compatible identity provider. In this case,
-- we recommend that you use
-- <http://aws.amazon.com/cognito/ Amazon Cognito> or
-- @AssumeRoleWithWebIdentity@. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity Federation Through a Web-based Identity Provider>
-- in the /IAM User Guide/.
--
-- You can also call @GetFederationToken@ using the security credentials of
-- an Amazon Web Services account root user, but we do not recommend it.
-- Instead, we recommend that you create an IAM user for the purpose of the
-- proxy application. Then attach a policy to the IAM user that limits
-- federated users to only the actions and resources that they need to
-- access. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html IAM Best Practices>
-- in the /IAM User Guide/.
--
-- __Session duration__
--
-- The temporary credentials are valid for the specified duration, from 900
-- seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The
-- default session duration is 43,200 seconds (12 hours). Temporary
-- credentials obtained by using the Amazon Web Services account root user
-- credentials have a maximum duration of 3,600 seconds (1 hour).
--
-- __Permissions__
--
-- You can use the temporary credentials created by @GetFederationToken@ in
-- any Amazon Web Services service except the following:
--
-- -   You cannot call any IAM operations using the CLI or the Amazon Web
--     Services API.
--
-- -   You cannot call any STS operations except @GetCallerIdentity@.
--
-- You must pass an inline or managed
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session session policy>
-- to this operation. You can pass a single JSON policy document to use as
-- an inline session policy. You can also specify up to 10 managed policy
-- Amazon Resource Names (ARNs) to use as managed session policies. The
-- plaintext that you use for both inline and managed session policies
-- can\'t exceed 2,048 characters.
--
-- Though the session policy parameters are optional, if you do not pass a
-- policy, then the resulting federated user session has no permissions.
-- When you pass session policies, the session permissions are the
-- intersection of the IAM user policies and the session policies that you
-- pass. This gives you a way to further restrict the permissions for a
-- federated user. You cannot use session policies to grant more
-- permissions than those that are defined in the permissions policy of the
-- IAM user. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Session Policies>
-- in the /IAM User Guide/. For information about using
-- @GetFederationToken@ to create temporary security credentials, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken GetFederationToken—Federation Through a Custom Identity Broker>.
--
-- You can use the credentials to access a resource that has a
-- resource-based policy. If that policy specifically references the
-- federated user session in the @Principal@ element of the policy, the
-- session has the permissions allowed by the policy. These permissions are
-- granted in addition to the permissions granted by the session policies.
--
-- __Tags__
--
-- (Optional) You can pass tag key-value pairs to your session. These are
-- called session tags. For more information about session tags, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html Passing Session Tags in STS>
-- in the /IAM User Guide/.
--
-- You can create a mobile-based or browser-based app that can authenticate
-- users using a web identity provider like Login with Amazon, Facebook,
-- Google, or an OpenID Connect-compatible identity provider. In this case,
-- we recommend that you use
-- <http://aws.amazon.com/cognito/ Amazon Cognito> or
-- @AssumeRoleWithWebIdentity@. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity Federation Through a Web-based Identity Provider>
-- in the /IAM User Guide/.
--
-- An administrator must grant you the permissions necessary to pass
-- session tags. The administrator can also create granular permissions to
-- allow you to pass only specific session tags. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html Tutorial: Using Tags for Attribute-Based Access Control>
-- in the /IAM User Guide/.
--
-- Tag key–value pairs are not case sensitive, but case is preserved. This
-- means that you cannot have separate @Department@ and @department@ tag
-- keys. Assume that the user that you are federating has the
-- @Department@=@Marketing@ tag and you pass the @department@=@engineering@
-- session tag. @Department@ and @department@ are not saved as separate
-- tags, and the session tag passed in the request takes precedence over
-- the user tag.
module Amazonka.STS.GetFederationToken
  ( -- * Creating a Request
    GetFederationToken (..),
    newGetFederationToken,

    -- * Request Lenses
    getFederationToken_durationSeconds,
    getFederationToken_policy,
    getFederationToken_policyArns,
    getFederationToken_tags,
    getFederationToken_name,

    -- * Destructuring the Response
    GetFederationTokenResponse (..),
    newGetFederationTokenResponse,

    -- * Response Lenses
    getFederationTokenResponse_credentials,
    getFederationTokenResponse_federatedUser,
    getFederationTokenResponse_packedPolicySize,
    getFederationTokenResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.STS.Types

-- | /See:/ 'newGetFederationToken' smart constructor.
data GetFederationToken = GetFederationToken'
  { -- | The duration, in seconds, that the session should last. Acceptable
    -- durations for federation sessions range from 900 seconds (15 minutes) to
    -- 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the
    -- default. Sessions obtained using Amazon Web Services account root user
    -- credentials are restricted to a maximum of 3,600 seconds (one hour). If
    -- the specified duration is longer than one hour, the session obtained by
    -- using root user credentials defaults to one hour.
    GetFederationToken -> Maybe Natural
durationSeconds :: Prelude.Maybe Prelude.Natural,
    -- | An IAM policy in JSON format that you want to use as an inline session
    -- policy.
    --
    -- You must pass an inline or managed
    -- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session session policy>
    -- to this operation. You can pass a single JSON policy document to use as
    -- an inline session policy. You can also specify up to 10 managed policy
    -- Amazon Resource Names (ARNs) to use as managed session policies.
    --
    -- This parameter is optional. However, if you do not pass any session
    -- policies, then the resulting federated user session has no permissions.
    --
    -- When you pass session policies, the session permissions are the
    -- intersection of the IAM user policies and the session policies that you
    -- pass. This gives you a way to further restrict the permissions for a
    -- federated user. You cannot use session policies to grant more
    -- permissions than those that are defined in the permissions policy of the
    -- IAM user. For more information, see
    -- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Session Policies>
    -- in the /IAM User Guide/.
    --
    -- The resulting credentials can be used to access a resource that has a
    -- resource-based policy. If that policy specifically references the
    -- federated user session in the @Principal@ element of the policy, the
    -- session has the permissions allowed by the policy. These permissions are
    -- granted in addition to the permissions that are granted by the session
    -- policies.
    --
    -- The plaintext that you use for both inline and managed session policies
    -- can\'t exceed 2,048 characters. The JSON policy characters can be any
    -- ASCII character from the space character to the end of the valid
    -- character list (\\u0020 through \\u00FF). It can also include the tab
    -- (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
    --
    -- An Amazon Web Services conversion compresses the passed inline session
    -- policy, managed policy ARNs, and session tags into a packed binary
    -- format that has a separate limit. Your request can fail for this limit
    -- even if your plaintext meets the other requirements. The
    -- @PackedPolicySize@ response element indicates by percentage how close
    -- the policies and tags for your request are to the upper size limit.
    GetFederationToken -> Maybe Text
policy :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Names (ARNs) of the IAM managed policies that you
    -- want to use as a managed session policy. The policies must exist in the
    -- same account as the IAM user that is requesting federated access.
    --
    -- You must pass an inline or managed
    -- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session session policy>
    -- to this operation. You can pass a single JSON policy document to use as
    -- an inline session policy. You can also specify up to 10 managed policy
    -- Amazon Resource Names (ARNs) to use as managed session policies. The
    -- plaintext that you use for both inline and managed session policies
    -- can\'t exceed 2,048 characters. You can provide up to 10 managed policy
    -- ARNs. For more information about ARNs, see
    -- <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces>
    -- in the Amazon Web Services General Reference.
    --
    -- This parameter is optional. However, if you do not pass any session
    -- policies, then the resulting federated user session has no permissions.
    --
    -- When you pass session policies, the session permissions are the
    -- intersection of the IAM user policies and the session policies that you
    -- pass. This gives you a way to further restrict the permissions for a
    -- federated user. You cannot use session policies to grant more
    -- permissions than those that are defined in the permissions policy of the
    -- IAM user. For more information, see
    -- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Session Policies>
    -- in the /IAM User Guide/.
    --
    -- The resulting credentials can be used to access a resource that has a
    -- resource-based policy. If that policy specifically references the
    -- federated user session in the @Principal@ element of the policy, the
    -- session has the permissions allowed by the policy. These permissions are
    -- granted in addition to the permissions that are granted by the session
    -- policies.
    --
    -- An Amazon Web Services conversion compresses the passed inline session
    -- policy, managed policy ARNs, and session tags into a packed binary
    -- format that has a separate limit. Your request can fail for this limit
    -- even if your plaintext meets the other requirements. The
    -- @PackedPolicySize@ response element indicates by percentage how close
    -- the policies and tags for your request are to the upper size limit.
    GetFederationToken -> Maybe [PolicyDescriptorType]
policyArns :: Prelude.Maybe [PolicyDescriptorType],
    -- | A list of session tags. Each session tag consists of a key name and an
    -- associated value. For more information about session tags, see
    -- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html Passing Session Tags in STS>
    -- in the /IAM User Guide/.
    --
    -- This parameter is optional. You can pass up to 50 session tags. The
    -- plaintext session tag keys can’t exceed 128 characters and the values
    -- can’t exceed 256 characters. For these and additional limits, see
    -- <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length IAM and STS Character Limits>
    -- in the /IAM User Guide/.
    --
    -- An Amazon Web Services conversion compresses the passed inline session
    -- policy, managed policy ARNs, and session tags into a packed binary
    -- format that has a separate limit. Your request can fail for this limit
    -- even if your plaintext meets the other requirements. The
    -- @PackedPolicySize@ response element indicates by percentage how close
    -- the policies and tags for your request are to the upper size limit.
    --
    -- You can pass a session tag with the same key as a tag that is already
    -- attached to the user you are federating. When you do, session tags
    -- override a user tag with the same key.
    --
    -- Tag key–value pairs are not case sensitive, but case is preserved. This
    -- means that you cannot have separate @Department@ and @department@ tag
    -- keys. Assume that the role has the @Department@=@Marketing@ tag and you
    -- pass the @department@=@engineering@ session tag. @Department@ and
    -- @department@ are not saved as separate tags, and the session tag passed
    -- in the request takes precedence over the role tag.
    GetFederationToken -> Maybe [Tag]
tags :: Prelude.Maybe [Tag],
    -- | The name of the federated user. The name is used as an identifier for
    -- the temporary security credentials (such as @Bob@). For example, you can
    -- reference the federated user name in a resource-based policy, such as in
    -- an Amazon S3 bucket policy.
    --
    -- The regex used to validate this parameter is a string of characters
    -- consisting of upper- and lower-case alphanumeric characters with no
    -- spaces. You can also include underscores or any of the following
    -- characters: =,.\@-
    GetFederationToken -> Text
name :: Prelude.Text
  }
  deriving (GetFederationToken -> GetFederationToken -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetFederationToken -> GetFederationToken -> Bool
$c/= :: GetFederationToken -> GetFederationToken -> Bool
== :: GetFederationToken -> GetFederationToken -> Bool
$c== :: GetFederationToken -> GetFederationToken -> Bool
Prelude.Eq, ReadPrec [GetFederationToken]
ReadPrec GetFederationToken
Int -> ReadS GetFederationToken
ReadS [GetFederationToken]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetFederationToken]
$creadListPrec :: ReadPrec [GetFederationToken]
readPrec :: ReadPrec GetFederationToken
$creadPrec :: ReadPrec GetFederationToken
readList :: ReadS [GetFederationToken]
$creadList :: ReadS [GetFederationToken]
readsPrec :: Int -> ReadS GetFederationToken
$creadsPrec :: Int -> ReadS GetFederationToken
Prelude.Read, Int -> GetFederationToken -> ShowS
[GetFederationToken] -> ShowS
GetFederationToken -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetFederationToken] -> ShowS
$cshowList :: [GetFederationToken] -> ShowS
show :: GetFederationToken -> String
$cshow :: GetFederationToken -> String
showsPrec :: Int -> GetFederationToken -> ShowS
$cshowsPrec :: Int -> GetFederationToken -> ShowS
Prelude.Show, forall x. Rep GetFederationToken x -> GetFederationToken
forall x. GetFederationToken -> Rep GetFederationToken x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetFederationToken x -> GetFederationToken
$cfrom :: forall x. GetFederationToken -> Rep GetFederationToken x
Prelude.Generic)

-- |
-- Create a value of 'GetFederationToken' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'durationSeconds', 'getFederationToken_durationSeconds' - The duration, in seconds, that the session should last. Acceptable
-- durations for federation sessions range from 900 seconds (15 minutes) to
-- 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the
-- default. Sessions obtained using Amazon Web Services account root user
-- credentials are restricted to a maximum of 3,600 seconds (one hour). If
-- the specified duration is longer than one hour, the session obtained by
-- using root user credentials defaults to one hour.
--
-- 'policy', 'getFederationToken_policy' - An IAM policy in JSON format that you want to use as an inline session
-- policy.
--
-- You must pass an inline or managed
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session session policy>
-- to this operation. You can pass a single JSON policy document to use as
-- an inline session policy. You can also specify up to 10 managed policy
-- Amazon Resource Names (ARNs) to use as managed session policies.
--
-- This parameter is optional. However, if you do not pass any session
-- policies, then the resulting federated user session has no permissions.
--
-- When you pass session policies, the session permissions are the
-- intersection of the IAM user policies and the session policies that you
-- pass. This gives you a way to further restrict the permissions for a
-- federated user. You cannot use session policies to grant more
-- permissions than those that are defined in the permissions policy of the
-- IAM user. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Session Policies>
-- in the /IAM User Guide/.
--
-- The resulting credentials can be used to access a resource that has a
-- resource-based policy. If that policy specifically references the
-- federated user session in the @Principal@ element of the policy, the
-- session has the permissions allowed by the policy. These permissions are
-- granted in addition to the permissions that are granted by the session
-- policies.
--
-- The plaintext that you use for both inline and managed session policies
-- can\'t exceed 2,048 characters. The JSON policy characters can be any
-- ASCII character from the space character to the end of the valid
-- character list (\\u0020 through \\u00FF). It can also include the tab
-- (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
--
-- An Amazon Web Services conversion compresses the passed inline session
-- policy, managed policy ARNs, and session tags into a packed binary
-- format that has a separate limit. Your request can fail for this limit
-- even if your plaintext meets the other requirements. The
-- @PackedPolicySize@ response element indicates by percentage how close
-- the policies and tags for your request are to the upper size limit.
--
-- 'policyArns', 'getFederationToken_policyArns' - The Amazon Resource Names (ARNs) of the IAM managed policies that you
-- want to use as a managed session policy. The policies must exist in the
-- same account as the IAM user that is requesting federated access.
--
-- You must pass an inline or managed
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session session policy>
-- to this operation. You can pass a single JSON policy document to use as
-- an inline session policy. You can also specify up to 10 managed policy
-- Amazon Resource Names (ARNs) to use as managed session policies. The
-- plaintext that you use for both inline and managed session policies
-- can\'t exceed 2,048 characters. You can provide up to 10 managed policy
-- ARNs. For more information about ARNs, see
-- <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces>
-- in the Amazon Web Services General Reference.
--
-- This parameter is optional. However, if you do not pass any session
-- policies, then the resulting federated user session has no permissions.
--
-- When you pass session policies, the session permissions are the
-- intersection of the IAM user policies and the session policies that you
-- pass. This gives you a way to further restrict the permissions for a
-- federated user. You cannot use session policies to grant more
-- permissions than those that are defined in the permissions policy of the
-- IAM user. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Session Policies>
-- in the /IAM User Guide/.
--
-- The resulting credentials can be used to access a resource that has a
-- resource-based policy. If that policy specifically references the
-- federated user session in the @Principal@ element of the policy, the
-- session has the permissions allowed by the policy. These permissions are
-- granted in addition to the permissions that are granted by the session
-- policies.
--
-- An Amazon Web Services conversion compresses the passed inline session
-- policy, managed policy ARNs, and session tags into a packed binary
-- format that has a separate limit. Your request can fail for this limit
-- even if your plaintext meets the other requirements. The
-- @PackedPolicySize@ response element indicates by percentage how close
-- the policies and tags for your request are to the upper size limit.
--
-- 'tags', 'getFederationToken_tags' - A list of session tags. Each session tag consists of a key name and an
-- associated value. For more information about session tags, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html Passing Session Tags in STS>
-- in the /IAM User Guide/.
--
-- This parameter is optional. You can pass up to 50 session tags. The
-- plaintext session tag keys can’t exceed 128 characters and the values
-- can’t exceed 256 characters. For these and additional limits, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length IAM and STS Character Limits>
-- in the /IAM User Guide/.
--
-- An Amazon Web Services conversion compresses the passed inline session
-- policy, managed policy ARNs, and session tags into a packed binary
-- format that has a separate limit. Your request can fail for this limit
-- even if your plaintext meets the other requirements. The
-- @PackedPolicySize@ response element indicates by percentage how close
-- the policies and tags for your request are to the upper size limit.
--
-- You can pass a session tag with the same key as a tag that is already
-- attached to the user you are federating. When you do, session tags
-- override a user tag with the same key.
--
-- Tag key–value pairs are not case sensitive, but case is preserved. This
-- means that you cannot have separate @Department@ and @department@ tag
-- keys. Assume that the role has the @Department@=@Marketing@ tag and you
-- pass the @department@=@engineering@ session tag. @Department@ and
-- @department@ are not saved as separate tags, and the session tag passed
-- in the request takes precedence over the role tag.
--
-- 'name', 'getFederationToken_name' - The name of the federated user. The name is used as an identifier for
-- the temporary security credentials (such as @Bob@). For example, you can
-- reference the federated user name in a resource-based policy, such as in
-- an Amazon S3 bucket policy.
--
-- The regex used to validate this parameter is a string of characters
-- consisting of upper- and lower-case alphanumeric characters with no
-- spaces. You can also include underscores or any of the following
-- characters: =,.\@-
newGetFederationToken ::
  -- | 'name'
  Prelude.Text ->
  GetFederationToken
newGetFederationToken :: Text -> GetFederationToken
newGetFederationToken Text
pName_ =
  GetFederationToken'
    { $sel:durationSeconds:GetFederationToken' :: Maybe Natural
durationSeconds =
        forall a. Maybe a
Prelude.Nothing,
      $sel:policy:GetFederationToken' :: Maybe Text
policy = forall a. Maybe a
Prelude.Nothing,
      $sel:policyArns:GetFederationToken' :: Maybe [PolicyDescriptorType]
policyArns = forall a. Maybe a
Prelude.Nothing,
      $sel:tags:GetFederationToken' :: Maybe [Tag]
tags = forall a. Maybe a
Prelude.Nothing,
      $sel:name:GetFederationToken' :: Text
name = Text
pName_
    }

-- | The duration, in seconds, that the session should last. Acceptable
-- durations for federation sessions range from 900 seconds (15 minutes) to
-- 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the
-- default. Sessions obtained using Amazon Web Services account root user
-- credentials are restricted to a maximum of 3,600 seconds (one hour). If
-- the specified duration is longer than one hour, the session obtained by
-- using root user credentials defaults to one hour.
getFederationToken_durationSeconds :: Lens.Lens' GetFederationToken (Prelude.Maybe Prelude.Natural)
getFederationToken_durationSeconds :: Lens' GetFederationToken (Maybe Natural)
getFederationToken_durationSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationToken' {Maybe Natural
durationSeconds :: Maybe Natural
$sel:durationSeconds:GetFederationToken' :: GetFederationToken -> Maybe Natural
durationSeconds} -> Maybe Natural
durationSeconds) (\s :: GetFederationToken
s@GetFederationToken' {} Maybe Natural
a -> GetFederationToken
s {$sel:durationSeconds:GetFederationToken' :: Maybe Natural
durationSeconds = Maybe Natural
a} :: GetFederationToken)

-- | An IAM policy in JSON format that you want to use as an inline session
-- policy.
--
-- You must pass an inline or managed
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session session policy>
-- to this operation. You can pass a single JSON policy document to use as
-- an inline session policy. You can also specify up to 10 managed policy
-- Amazon Resource Names (ARNs) to use as managed session policies.
--
-- This parameter is optional. However, if you do not pass any session
-- policies, then the resulting federated user session has no permissions.
--
-- When you pass session policies, the session permissions are the
-- intersection of the IAM user policies and the session policies that you
-- pass. This gives you a way to further restrict the permissions for a
-- federated user. You cannot use session policies to grant more
-- permissions than those that are defined in the permissions policy of the
-- IAM user. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Session Policies>
-- in the /IAM User Guide/.
--
-- The resulting credentials can be used to access a resource that has a
-- resource-based policy. If that policy specifically references the
-- federated user session in the @Principal@ element of the policy, the
-- session has the permissions allowed by the policy. These permissions are
-- granted in addition to the permissions that are granted by the session
-- policies.
--
-- The plaintext that you use for both inline and managed session policies
-- can\'t exceed 2,048 characters. The JSON policy characters can be any
-- ASCII character from the space character to the end of the valid
-- character list (\\u0020 through \\u00FF). It can also include the tab
-- (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
--
-- An Amazon Web Services conversion compresses the passed inline session
-- policy, managed policy ARNs, and session tags into a packed binary
-- format that has a separate limit. Your request can fail for this limit
-- even if your plaintext meets the other requirements. The
-- @PackedPolicySize@ response element indicates by percentage how close
-- the policies and tags for your request are to the upper size limit.
getFederationToken_policy :: Lens.Lens' GetFederationToken (Prelude.Maybe Prelude.Text)
getFederationToken_policy :: Lens' GetFederationToken (Maybe Text)
getFederationToken_policy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationToken' {Maybe Text
policy :: Maybe Text
$sel:policy:GetFederationToken' :: GetFederationToken -> Maybe Text
policy} -> Maybe Text
policy) (\s :: GetFederationToken
s@GetFederationToken' {} Maybe Text
a -> GetFederationToken
s {$sel:policy:GetFederationToken' :: Maybe Text
policy = Maybe Text
a} :: GetFederationToken)

-- | The Amazon Resource Names (ARNs) of the IAM managed policies that you
-- want to use as a managed session policy. The policies must exist in the
-- same account as the IAM user that is requesting federated access.
--
-- You must pass an inline or managed
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session session policy>
-- to this operation. You can pass a single JSON policy document to use as
-- an inline session policy. You can also specify up to 10 managed policy
-- Amazon Resource Names (ARNs) to use as managed session policies. The
-- plaintext that you use for both inline and managed session policies
-- can\'t exceed 2,048 characters. You can provide up to 10 managed policy
-- ARNs. For more information about ARNs, see
-- <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces>
-- in the Amazon Web Services General Reference.
--
-- This parameter is optional. However, if you do not pass any session
-- policies, then the resulting federated user session has no permissions.
--
-- When you pass session policies, the session permissions are the
-- intersection of the IAM user policies and the session policies that you
-- pass. This gives you a way to further restrict the permissions for a
-- federated user. You cannot use session policies to grant more
-- permissions than those that are defined in the permissions policy of the
-- IAM user. For more information, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Session Policies>
-- in the /IAM User Guide/.
--
-- The resulting credentials can be used to access a resource that has a
-- resource-based policy. If that policy specifically references the
-- federated user session in the @Principal@ element of the policy, the
-- session has the permissions allowed by the policy. These permissions are
-- granted in addition to the permissions that are granted by the session
-- policies.
--
-- An Amazon Web Services conversion compresses the passed inline session
-- policy, managed policy ARNs, and session tags into a packed binary
-- format that has a separate limit. Your request can fail for this limit
-- even if your plaintext meets the other requirements. The
-- @PackedPolicySize@ response element indicates by percentage how close
-- the policies and tags for your request are to the upper size limit.
getFederationToken_policyArns :: Lens.Lens' GetFederationToken (Prelude.Maybe [PolicyDescriptorType])
getFederationToken_policyArns :: Lens' GetFederationToken (Maybe [PolicyDescriptorType])
getFederationToken_policyArns = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationToken' {Maybe [PolicyDescriptorType]
policyArns :: Maybe [PolicyDescriptorType]
$sel:policyArns:GetFederationToken' :: GetFederationToken -> Maybe [PolicyDescriptorType]
policyArns} -> Maybe [PolicyDescriptorType]
policyArns) (\s :: GetFederationToken
s@GetFederationToken' {} Maybe [PolicyDescriptorType]
a -> GetFederationToken
s {$sel:policyArns:GetFederationToken' :: Maybe [PolicyDescriptorType]
policyArns = Maybe [PolicyDescriptorType]
a} :: GetFederationToken) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of session tags. Each session tag consists of a key name and an
-- associated value. For more information about session tags, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html Passing Session Tags in STS>
-- in the /IAM User Guide/.
--
-- This parameter is optional. You can pass up to 50 session tags. The
-- plaintext session tag keys can’t exceed 128 characters and the values
-- can’t exceed 256 characters. For these and additional limits, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length IAM and STS Character Limits>
-- in the /IAM User Guide/.
--
-- An Amazon Web Services conversion compresses the passed inline session
-- policy, managed policy ARNs, and session tags into a packed binary
-- format that has a separate limit. Your request can fail for this limit
-- even if your plaintext meets the other requirements. The
-- @PackedPolicySize@ response element indicates by percentage how close
-- the policies and tags for your request are to the upper size limit.
--
-- You can pass a session tag with the same key as a tag that is already
-- attached to the user you are federating. When you do, session tags
-- override a user tag with the same key.
--
-- Tag key–value pairs are not case sensitive, but case is preserved. This
-- means that you cannot have separate @Department@ and @department@ tag
-- keys. Assume that the role has the @Department@=@Marketing@ tag and you
-- pass the @department@=@engineering@ session tag. @Department@ and
-- @department@ are not saved as separate tags, and the session tag passed
-- in the request takes precedence over the role tag.
getFederationToken_tags :: Lens.Lens' GetFederationToken (Prelude.Maybe [Tag])
getFederationToken_tags :: Lens' GetFederationToken (Maybe [Tag])
getFederationToken_tags = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationToken' {Maybe [Tag]
tags :: Maybe [Tag]
$sel:tags:GetFederationToken' :: GetFederationToken -> Maybe [Tag]
tags} -> Maybe [Tag]
tags) (\s :: GetFederationToken
s@GetFederationToken' {} Maybe [Tag]
a -> GetFederationToken
s {$sel:tags:GetFederationToken' :: Maybe [Tag]
tags = Maybe [Tag]
a} :: GetFederationToken) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The name of the federated user. The name is used as an identifier for
-- the temporary security credentials (such as @Bob@). For example, you can
-- reference the federated user name in a resource-based policy, such as in
-- an Amazon S3 bucket policy.
--
-- The regex used to validate this parameter is a string of characters
-- consisting of upper- and lower-case alphanumeric characters with no
-- spaces. You can also include underscores or any of the following
-- characters: =,.\@-
getFederationToken_name :: Lens.Lens' GetFederationToken Prelude.Text
getFederationToken_name :: Lens' GetFederationToken Text
getFederationToken_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationToken' {Text
name :: Text
$sel:name:GetFederationToken' :: GetFederationToken -> Text
name} -> Text
name) (\s :: GetFederationToken
s@GetFederationToken' {} Text
a -> GetFederationToken
s {$sel:name:GetFederationToken' :: Text
name = Text
a} :: GetFederationToken)

instance Core.AWSRequest GetFederationToken where
  type
    AWSResponse GetFederationToken =
      GetFederationTokenResponse
  request :: (Service -> Service)
-> GetFederationToken -> Request GetFederationToken
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy GetFederationToken
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetFederationToken)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"GetFederationTokenResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe AuthEnv
-> Maybe FederatedUser
-> Maybe Natural
-> Int
-> GetFederationTokenResponse
GetFederationTokenResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Credentials")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"FederatedUser")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"PackedPolicySize")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable GetFederationToken where
  hashWithSalt :: Int -> GetFederationToken -> Int
hashWithSalt Int
_salt GetFederationToken' {Maybe Natural
Maybe [PolicyDescriptorType]
Maybe [Tag]
Maybe Text
Text
name :: Text
tags :: Maybe [Tag]
policyArns :: Maybe [PolicyDescriptorType]
policy :: Maybe Text
durationSeconds :: Maybe Natural
$sel:name:GetFederationToken' :: GetFederationToken -> Text
$sel:tags:GetFederationToken' :: GetFederationToken -> Maybe [Tag]
$sel:policyArns:GetFederationToken' :: GetFederationToken -> Maybe [PolicyDescriptorType]
$sel:policy:GetFederationToken' :: GetFederationToken -> Maybe Text
$sel:durationSeconds:GetFederationToken' :: GetFederationToken -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
durationSeconds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
policy
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [PolicyDescriptorType]
policyArns
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Tag]
tags
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name

instance Prelude.NFData GetFederationToken where
  rnf :: GetFederationToken -> ()
rnf GetFederationToken' {Maybe Natural
Maybe [PolicyDescriptorType]
Maybe [Tag]
Maybe Text
Text
name :: Text
tags :: Maybe [Tag]
policyArns :: Maybe [PolicyDescriptorType]
policy :: Maybe Text
durationSeconds :: Maybe Natural
$sel:name:GetFederationToken' :: GetFederationToken -> Text
$sel:tags:GetFederationToken' :: GetFederationToken -> Maybe [Tag]
$sel:policyArns:GetFederationToken' :: GetFederationToken -> Maybe [PolicyDescriptorType]
$sel:policy:GetFederationToken' :: GetFederationToken -> Maybe Text
$sel:durationSeconds:GetFederationToken' :: GetFederationToken -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
durationSeconds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
policy
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [PolicyDescriptorType]
policyArns
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Tag]
tags
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name

instance Data.ToHeaders GetFederationToken where
  toHeaders :: GetFederationToken -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToPath GetFederationToken where
  toPath :: GetFederationToken -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery GetFederationToken where
  toQuery :: GetFederationToken -> QueryString
toQuery GetFederationToken' {Maybe Natural
Maybe [PolicyDescriptorType]
Maybe [Tag]
Maybe Text
Text
name :: Text
tags :: Maybe [Tag]
policyArns :: Maybe [PolicyDescriptorType]
policy :: Maybe Text
durationSeconds :: Maybe Natural
$sel:name:GetFederationToken' :: GetFederationToken -> Text
$sel:tags:GetFederationToken' :: GetFederationToken -> Maybe [Tag]
$sel:policyArns:GetFederationToken' :: GetFederationToken -> Maybe [PolicyDescriptorType]
$sel:policy:GetFederationToken' :: GetFederationToken -> Maybe Text
$sel:durationSeconds:GetFederationToken' :: GetFederationToken -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"GetFederationToken" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2011-06-15" :: Prelude.ByteString),
        ByteString
"DurationSeconds" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
durationSeconds,
        ByteString
"Policy" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
policy,
        ByteString
"PolicyArns"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            (forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member" forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [PolicyDescriptorType]
policyArns),
        ByteString
"Tags"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            (forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member" forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Tag]
tags),
        ByteString
"Name" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
name
      ]

-- | Contains the response to a successful GetFederationToken request,
-- including temporary Amazon Web Services credentials that can be used to
-- make Amazon Web Services requests.
--
-- /See:/ 'newGetFederationTokenResponse' smart constructor.
data GetFederationTokenResponse = GetFederationTokenResponse'
  { -- | The temporary security credentials, which include an access key ID, a
    -- secret access key, and a security (or session) token.
    --
    -- The size of the security token that STS API operations return is not
    -- fixed. We strongly recommend that you make no assumptions about the
    -- maximum size.
    GetFederationTokenResponse -> Maybe AuthEnv
credentials :: Prelude.Maybe Core.AuthEnv,
    -- | Identifiers for the federated user associated with the credentials (such
    -- as @arn:aws:sts::123456789012:federated-user\/Bob@ or
    -- @123456789012:Bob@). You can use the federated user\'s ARN in your
    -- resource-based policies, such as an Amazon S3 bucket policy.
    GetFederationTokenResponse -> Maybe FederatedUser
federatedUser :: Prelude.Maybe FederatedUser,
    -- | A percentage value that indicates the packed size of the session
    -- policies and session tags combined passed in the request. The request
    -- fails if the packed size is greater than 100 percent, which means the
    -- policies and tags exceeded the allowed space.
    GetFederationTokenResponse -> Maybe Natural
packedPolicySize :: Prelude.Maybe Prelude.Natural,
    -- | The response's http status code.
    GetFederationTokenResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetFederationTokenResponse -> GetFederationTokenResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetFederationTokenResponse -> GetFederationTokenResponse -> Bool
$c/= :: GetFederationTokenResponse -> GetFederationTokenResponse -> Bool
== :: GetFederationTokenResponse -> GetFederationTokenResponse -> Bool
$c== :: GetFederationTokenResponse -> GetFederationTokenResponse -> Bool
Prelude.Eq, Int -> GetFederationTokenResponse -> ShowS
[GetFederationTokenResponse] -> ShowS
GetFederationTokenResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetFederationTokenResponse] -> ShowS
$cshowList :: [GetFederationTokenResponse] -> ShowS
show :: GetFederationTokenResponse -> String
$cshow :: GetFederationTokenResponse -> String
showsPrec :: Int -> GetFederationTokenResponse -> ShowS
$cshowsPrec :: Int -> GetFederationTokenResponse -> ShowS
Prelude.Show, forall x.
Rep GetFederationTokenResponse x -> GetFederationTokenResponse
forall x.
GetFederationTokenResponse -> Rep GetFederationTokenResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetFederationTokenResponse x -> GetFederationTokenResponse
$cfrom :: forall x.
GetFederationTokenResponse -> Rep GetFederationTokenResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetFederationTokenResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'credentials', 'getFederationTokenResponse_credentials' - The temporary security credentials, which include an access key ID, a
-- secret access key, and a security (or session) token.
--
-- The size of the security token that STS API operations return is not
-- fixed. We strongly recommend that you make no assumptions about the
-- maximum size.
--
-- 'federatedUser', 'getFederationTokenResponse_federatedUser' - Identifiers for the federated user associated with the credentials (such
-- as @arn:aws:sts::123456789012:federated-user\/Bob@ or
-- @123456789012:Bob@). You can use the federated user\'s ARN in your
-- resource-based policies, such as an Amazon S3 bucket policy.
--
-- 'packedPolicySize', 'getFederationTokenResponse_packedPolicySize' - A percentage value that indicates the packed size of the session
-- policies and session tags combined passed in the request. The request
-- fails if the packed size is greater than 100 percent, which means the
-- policies and tags exceeded the allowed space.
--
-- 'httpStatus', 'getFederationTokenResponse_httpStatus' - The response's http status code.
newGetFederationTokenResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetFederationTokenResponse
newGetFederationTokenResponse :: Int -> GetFederationTokenResponse
newGetFederationTokenResponse Int
pHttpStatus_ =
  GetFederationTokenResponse'
    { $sel:credentials:GetFederationTokenResponse' :: Maybe AuthEnv
credentials =
        forall a. Maybe a
Prelude.Nothing,
      $sel:federatedUser:GetFederationTokenResponse' :: Maybe FederatedUser
federatedUser = forall a. Maybe a
Prelude.Nothing,
      $sel:packedPolicySize:GetFederationTokenResponse' :: Maybe Natural
packedPolicySize = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetFederationTokenResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The temporary security credentials, which include an access key ID, a
-- secret access key, and a security (or session) token.
--
-- The size of the security token that STS API operations return is not
-- fixed. We strongly recommend that you make no assumptions about the
-- maximum size.
getFederationTokenResponse_credentials :: Lens.Lens' GetFederationTokenResponse (Prelude.Maybe Core.AuthEnv)
getFederationTokenResponse_credentials :: Lens' GetFederationTokenResponse (Maybe AuthEnv)
getFederationTokenResponse_credentials = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationTokenResponse' {Maybe AuthEnv
credentials :: Maybe AuthEnv
$sel:credentials:GetFederationTokenResponse' :: GetFederationTokenResponse -> Maybe AuthEnv
credentials} -> Maybe AuthEnv
credentials) (\s :: GetFederationTokenResponse
s@GetFederationTokenResponse' {} Maybe AuthEnv
a -> GetFederationTokenResponse
s {$sel:credentials:GetFederationTokenResponse' :: Maybe AuthEnv
credentials = Maybe AuthEnv
a} :: GetFederationTokenResponse)

-- | Identifiers for the federated user associated with the credentials (such
-- as @arn:aws:sts::123456789012:federated-user\/Bob@ or
-- @123456789012:Bob@). You can use the federated user\'s ARN in your
-- resource-based policies, such as an Amazon S3 bucket policy.
getFederationTokenResponse_federatedUser :: Lens.Lens' GetFederationTokenResponse (Prelude.Maybe FederatedUser)
getFederationTokenResponse_federatedUser :: Lens' GetFederationTokenResponse (Maybe FederatedUser)
getFederationTokenResponse_federatedUser = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationTokenResponse' {Maybe FederatedUser
federatedUser :: Maybe FederatedUser
$sel:federatedUser:GetFederationTokenResponse' :: GetFederationTokenResponse -> Maybe FederatedUser
federatedUser} -> Maybe FederatedUser
federatedUser) (\s :: GetFederationTokenResponse
s@GetFederationTokenResponse' {} Maybe FederatedUser
a -> GetFederationTokenResponse
s {$sel:federatedUser:GetFederationTokenResponse' :: Maybe FederatedUser
federatedUser = Maybe FederatedUser
a} :: GetFederationTokenResponse)

-- | A percentage value that indicates the packed size of the session
-- policies and session tags combined passed in the request. The request
-- fails if the packed size is greater than 100 percent, which means the
-- policies and tags exceeded the allowed space.
getFederationTokenResponse_packedPolicySize :: Lens.Lens' GetFederationTokenResponse (Prelude.Maybe Prelude.Natural)
getFederationTokenResponse_packedPolicySize :: Lens' GetFederationTokenResponse (Maybe Natural)
getFederationTokenResponse_packedPolicySize = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationTokenResponse' {Maybe Natural
packedPolicySize :: Maybe Natural
$sel:packedPolicySize:GetFederationTokenResponse' :: GetFederationTokenResponse -> Maybe Natural
packedPolicySize} -> Maybe Natural
packedPolicySize) (\s :: GetFederationTokenResponse
s@GetFederationTokenResponse' {} Maybe Natural
a -> GetFederationTokenResponse
s {$sel:packedPolicySize:GetFederationTokenResponse' :: Maybe Natural
packedPolicySize = Maybe Natural
a} :: GetFederationTokenResponse)

-- | The response's http status code.
getFederationTokenResponse_httpStatus :: Lens.Lens' GetFederationTokenResponse Prelude.Int
getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int
getFederationTokenResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetFederationTokenResponse' {Int
httpStatus :: Int
$sel:httpStatus:GetFederationTokenResponse' :: GetFederationTokenResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: GetFederationTokenResponse
s@GetFederationTokenResponse' {} Int
a -> GetFederationTokenResponse
s {$sel:httpStatus:GetFederationTokenResponse' :: Int
httpStatus = Int
a} :: GetFederationTokenResponse)

instance Prelude.NFData GetFederationTokenResponse where
  rnf :: GetFederationTokenResponse -> ()
rnf GetFederationTokenResponse' {Int
Maybe Natural
Maybe AuthEnv
Maybe FederatedUser
httpStatus :: Int
packedPolicySize :: Maybe Natural
federatedUser :: Maybe FederatedUser
credentials :: Maybe AuthEnv
$sel:httpStatus:GetFederationTokenResponse' :: GetFederationTokenResponse -> Int
$sel:packedPolicySize:GetFederationTokenResponse' :: GetFederationTokenResponse -> Maybe Natural
$sel:federatedUser:GetFederationTokenResponse' :: GetFederationTokenResponse -> Maybe FederatedUser
$sel:credentials:GetFederationTokenResponse' :: GetFederationTokenResponse -> Maybe AuthEnv
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe AuthEnv
credentials
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe FederatedUser
federatedUser
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
packedPolicySize
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus