amazonka-sts-2.0: Amazon Security Token Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.STS.DecodeAuthorizationMessage

Description

Decodes additional information about the authorization status of a request from an encoded message returned in response to an Amazon Web Services request.

For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can provide details about this authorization failure.

Only certain Amazon Web Services operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.

The message is encoded because the details of the authorization status can contain privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions through an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.

The decoded message includes the following type of information:

  • Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide.
  • The principal who made the request.
  • The requested action.
  • The requested resource.
  • The values of condition keys in the context of the user's request.
Synopsis

Creating a Request

data DecodeAuthorizationMessage Source #

See: newDecodeAuthorizationMessage smart constructor.

Constructors

DecodeAuthorizationMessage' 

Fields

Instances

Instances details
ToHeaders DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

ToPath DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

ToQuery DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

AWSRequest DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Generic DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Associated Types

type Rep DecodeAuthorizationMessage :: Type -> Type #

Read DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Show DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

NFData DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Eq DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Hashable DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

type AWSResponse DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

type Rep DecodeAuthorizationMessage Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

type Rep DecodeAuthorizationMessage = D1 ('MetaData "DecodeAuthorizationMessage" "Amazonka.STS.DecodeAuthorizationMessage" "amazonka-sts-2.0-4mYLKqRkMcBDaDLjBZpuhO" 'False) (C1 ('MetaCons "DecodeAuthorizationMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encodedMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDecodeAuthorizationMessage Source #

Create a value of DecodeAuthorizationMessage 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:encodedMessage:DecodeAuthorizationMessage', decodeAuthorizationMessage_encodedMessage - The encoded message that was returned with the response.

Request Lenses

decodeAuthorizationMessage_encodedMessage :: Lens' DecodeAuthorizationMessage Text Source #

The encoded message that was returned with the response.

Destructuring the Response

data DecodeAuthorizationMessageResponse Source #

A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an Amazon Web Services request.

See: newDecodeAuthorizationMessageResponse smart constructor.

Constructors

DecodeAuthorizationMessageResponse' 

Fields

Instances

Instances details
Generic DecodeAuthorizationMessageResponse Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Associated Types

type Rep DecodeAuthorizationMessageResponse :: Type -> Type #

Read DecodeAuthorizationMessageResponse Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Show DecodeAuthorizationMessageResponse Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

NFData DecodeAuthorizationMessageResponse Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

Eq DecodeAuthorizationMessageResponse Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

type Rep DecodeAuthorizationMessageResponse Source # 
Instance details

Defined in Amazonka.STS.DecodeAuthorizationMessage

type Rep DecodeAuthorizationMessageResponse = D1 ('MetaData "DecodeAuthorizationMessageResponse" "Amazonka.STS.DecodeAuthorizationMessage" "amazonka-sts-2.0-4mYLKqRkMcBDaDLjBZpuhO" 'False) (C1 ('MetaCons "DecodeAuthorizationMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "decodedMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDecodeAuthorizationMessageResponse Source #

Create a value of DecodeAuthorizationMessageResponse 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:decodedMessage:DecodeAuthorizationMessageResponse', decodeAuthorizationMessageResponse_decodedMessage - The API returns a response with the decoded message.

$sel:httpStatus:DecodeAuthorizationMessageResponse', decodeAuthorizationMessageResponse_httpStatus - The response's http status code.

Response Lenses