AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 Client.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:

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to DecodeAuthorizationMessageAsync.

Namespace: Amazon.SecurityToken
Assembly: AWSSDK.SecurityToken.dll
Version: 3.x.y.z

Syntax

C#
public abstract DecodeAuthorizationMessageResponse DecodeAuthorizationMessage(
         DecodeAuthorizationMessageRequest request
)
Parameters
request
Type: Amazon.SecurityToken.Model.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 DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.

Examples

To decode information about an authorization status of a request


var response = client.DecodeAuthorizationMessage(new DecodeAuthorizationMessageRequest 
{
    EncodedMessage = ""
});

string decodedMessage = response.DecodedMessage;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also