AWS SDK for .NET Documentation
DecodeAuthorizationMessage Method (request)
AmazonAmazon.SecurityTokenAmazonSecurityTokenServiceClientDecodeAuthorizationMessage(DecodeAuthorizationMessageRequest) Did this page help you?   Yes   No    Tell us about it...
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

CopyC#
Client.UnauthorizedOperation
response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure.

Note:
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

CopyC#
DecodeAuthorizationMessage
(
CopyC#
sts:DecodeAuthorizationMessage
) action.

The decoded message includes the following type of information:

Declaration Syntax
C#
public DecodeAuthorizationMessageResponse DecodeAuthorizationMessage(
	DecodeAuthorizationMessageRequest request
)
Parameters
request (DecodeAuthorizationMessageRequest)
Container for the necessary parameters to execute the DecodeAuthorizationMessage service method.
Return Value
The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService.
Exceptions
ExceptionCondition
InvalidAuthorizationMessageException The error returned if the message passed to
CopyC#
DecodeAuthorizationMessage
was invalid. This can happen if the token contains invalid characters, such as linebreaks.

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)