Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- decodeAuthorizationMessage :: Text -> DecodeAuthorizationMessage
- data DecodeAuthorizationMessage
- damEncodedMessage :: Lens' DecodeAuthorizationMessage Text
- decodeAuthorizationMessageResponse :: Int -> DecodeAuthorizationMessageResponse
- data DecodeAuthorizationMessageResponse
- damrsDecodedMessage :: Lens' DecodeAuthorizationMessageResponse (Maybe Text)
- damrsStatus :: Lens' DecodeAuthorizationMessageResponse Int
Creating a Request
decodeAuthorizationMessage Source
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:
data DecodeAuthorizationMessage Source
See: decodeAuthorizationMessage
smart constructor.
Request Lenses
damEncodedMessage :: Lens' DecodeAuthorizationMessage Text Source
The encoded message that was returned with the response.
Destructuring the Response
decodeAuthorizationMessageResponse Source
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:
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 AWS request.
See: decodeAuthorizationMessageResponse
smart constructor.
Response Lenses
damrsDecodedMessage :: Lens' DecodeAuthorizationMessageResponse (Maybe Text) Source
An XML document that contains the decoded message. For more information,
see DecodeAuthorizationMessage
.
damrsStatus :: Lens' DecodeAuthorizationMessageResponse Int Source
The response status code.