decodeAuthorizationMessage method

Future<DecodeAuthorizationMessageResponse> decodeAuthorizationMessage({ required String encodedMessage, })

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 operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure. The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation 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 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.

May throw InvalidAuthorizationMessageException.

Parameter encodedMessage : The encoded message that was returned with the response.

Implementation

Future<DecodeAuthorizationMessageResponse> decodeAuthorizationMessage({
  required String encodedMessage,
}) async {
  ArgumentError.checkNotNull(encodedMessage, 'encodedMessage');
  _s.validateStringLength(
    'encodedMessage',
    encodedMessage,
    1,
    10240,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['EncodedMessage'] = encodedMessage;
  final $result = await _protocol.send(
    $request,
    action: 'DecodeAuthorizationMessage',
    version: '2011-06-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DecodeAuthorizationMessageRequest'],
    shapes: shapes,
    resultWrapper: 'DecodeAuthorizationMessageResult',
  );
  return DecodeAuthorizationMessageResponse.fromXml($result);
}