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 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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDecodeAuthorizationMessage and EndDecodeAuthorizationMessage.
Namespace: Amazon.SecurityToken
Assembly: AWSSDK.SecurityToken.dll
Version: 3.x.y.z
public virtual Task<DecodeAuthorizationMessageResponse> DecodeAuthorizationMessageAsync( DecodeAuthorizationMessageRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DecodeAuthorizationMessage service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InvalidAuthorizationMessageException | The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5