decode_authorization_message

STS.Client.decode_authorization_message(**kwargs)

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.decode_authorization_message(
    EncodedMessage='string'
)

Parameters

EncodedMessage (string) --

[REQUIRED]

The encoded message that was returned with the response.

Return type

dict

Returns

Response Syntax

{
    'DecodedMessage': 'string'
}

Response Structure

• (dict) --

  A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an Amazon Web Services request.

  • DecodedMessage (string) --

    The API returns a response with the decoded message.

Exceptions

• STS.Client.exceptions.InvalidAuthorizationMessageException

Examples

response = client.decode_authorization_message(
    EncodedMessage='<encoded-message>',
)

print(response)

Expected Output:

{
    'DecodedMessage': '{"allowed": "false","explicitDeny": "false","matchedStatements": "","failures": "","context": {"principal": {"id": "AIDACKCEVSQ6C2EXAMPLE","name": "Bob","arn": "arn:aws:iam::123456789012:user/Bob"},"action": "ec2:StopInstances","resource": "arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd","conditions": [{"item": {"key": "ec2:Tenancy","values": ["default"]},{"item": {"key": "ec2:ResourceTag/elasticbeanstalk:environment-name","values": ["Default-Environment"]}},(Additional items ...)]}}',
    'ResponseMetadata': {
        '...': '...',
    },
}