com.amazonaws.services.securitytoken.model

Class DecodeAuthorizationMessageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageRequest

All Implemented Interfaces:

Serializable

public class DecodeAuthorizationMessageRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DecodeAuthorizationMessage operation.

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 action that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure.

NOTE: Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action 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 action should not see. To decode an authorization status message, a user must be granted permissions via an AWS 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 Using AWS IAM .
• 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:

AWSSecurityTokenService.decodeAuthorizationMessage(DecodeAuthorizationMessageRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DecodeAuthorizationMessageRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getEncodedMessage() The encoded message that was returned with the response.
int	hashCode()
void	setEncodedMessage(String encodedMessage) The encoded message that was returned with the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DecodeAuthorizationMessageRequest	withEncodedMessage(String encodedMessage) The encoded message that was returned with the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DecodeAuthorizationMessageRequest

public DecodeAuthorizationMessageRequest()

Method Detail

getEncodedMessage

public String getEncodedMessage()

The encoded message that was returned with the response.

Constraints:
Length: 1 - 10240

Returns:

The encoded message that was returned with the response.

setEncodedMessage

public void setEncodedMessage(String encodedMessage)

The encoded message that was returned with the response.

Constraints:
Length: 1 - 10240

Parameters:

encodedMessage - The encoded message that was returned with the response.

withEncodedMessage

public DecodeAuthorizationMessageRequest withEncodedMessage(String encodedMessage)

The encoded message that was returned with the response.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 10240

Parameters:

encodedMessage - The encoded message that was returned with the response.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object