sts_decode_authorization_message: Decodes additional information about the authorization status...

Description Usage Arguments Details Request syntax Examples

View source: R/sts_operations.R

Description

Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.

Usage

1

Arguments

EncodedMessage

[required] The encoded message that was returned with the response.

Details

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.

Only certain AWS 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 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:

Request syntax

1
2
3
svc$decode_authorization_message(
  EncodedMessage = "string"
)

Examples

1
2
3
4
# 
svc$decode_authorization_message(
  EncodedMessage = "<encoded-message>"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.