Skip to content

decode_authorization_message

Operation

decode_authorization_message

decode_authorization_message(request: DecodeAuthorizationMessageInput | DecodeAuthorizationMessageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DecodeAuthorizationMessageInputDict]) -> DecodeAuthorizationMessageOutput

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.

Parameters:

Name Type Description Default
request DecodeAuthorizationMessageInput | DecodeAuthorizationMessageInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DecodeAuthorizationMessageInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DecodeAuthorizationMessageOutput

An instance of DecodeAuthorizationMessageOutput.

decode_authorization_message async

decode_authorization_message(request: DecodeAuthorizationMessageInput | DecodeAuthorizationMessageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DecodeAuthorizationMessageInputDict]) -> DecodeAuthorizationMessageOutput

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.

Parameters:

Name Type Description Default
request DecodeAuthorizationMessageInput | DecodeAuthorizationMessageInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DecodeAuthorizationMessageInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DecodeAuthorizationMessageOutput

An instance of DecodeAuthorizationMessageOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DecodeAuthorizationMessageInputDict

Bases: TypedDict

Dictionary form of DecodeAuthorizationMessageInput.

Attributes

encoded_message instance-attribute
encoded_message: Required[str]

The encoded message that was returned with the response.

DecodeAuthorizationMessageInput dataclass

Bases: _SerdeShape

Dataclass for DecodeAuthorizationMessageInput structure.

Attributes

encoded_message class-attribute instance-attribute
encoded_message: str | None = ...

The encoded message that was returned with the response.

Output

DecodeAuthorizationMessageOutput dataclass

Bases: _SerdeShape

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.

Attributes

decoded_message class-attribute instance-attribute
decoded_message: str | None = ...

The API returns a response with the decoded message.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.