Network.AWS.STS.DecodeAuthorizationMessage

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

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

Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code.

The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via 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 Using IAM.
• 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.

See: AWS API Reference for DecodeAuthorizationMessage.

Creating a Request

decodeAuthorizationMessage

Arguments

:: Text

damEncodedMessage

-> DecodeAuthorizationMessage

Creates a value of DecodeAuthorizationMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• damEncodedMessage

data DecodeAuthorizationMessage

See: decodeAuthorizationMessage smart constructor.

Instances

Eq DecodeAuthorizationMessage

Data DecodeAuthorizationMessage

Read DecodeAuthorizationMessage

Show DecodeAuthorizationMessage

Generic DecodeAuthorizationMessage

AWSRequest DecodeAuthorizationMessage

ToPath DecodeAuthorizationMessage

ToHeaders DecodeAuthorizationMessage

ToQuery DecodeAuthorizationMessage

Typeable * DecodeAuthorizationMessage

type Rep DecodeAuthorizationMessage

type Rs DecodeAuthorizationMessage = DecodeAuthorizationMessageResponse

Request Lenses

damEncodedMessage :: Lens' DecodeAuthorizationMessage Text

The encoded message that was returned with the response.

Destructuring the Response

decodeAuthorizationMessageResponse

Arguments

:: Int

damrsStatus

-> DecodeAuthorizationMessageResponse

Creates a value of DecodeAuthorizationMessageResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• damrsDecodedMessage
• damrsStatus

data DecodeAuthorizationMessageResponse

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

See: decodeAuthorizationMessageResponse smart constructor.

Instances

Eq DecodeAuthorizationMessageResponse

Data DecodeAuthorizationMessageResponse

Read DecodeAuthorizationMessageResponse

Show DecodeAuthorizationMessageResponse

Generic DecodeAuthorizationMessageResponse

Typeable * DecodeAuthorizationMessageResponse

type Rep DecodeAuthorizationMessageResponse

Response Lenses

damrsDecodedMessage :: Lens' DecodeAuthorizationMessageResponse (Maybe Text)

An XML document that contains the decoded message. For more information, see DecodeAuthorizationMessage.

damrsStatus :: Lens' DecodeAuthorizationMessageResponse Int

The response status code.