Package software.amazon.awssdk.services.iam.model

Class GetContextKeysForPrincipalPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iam.model.IamRequest

software.amazon.awssdk.services.iam.model.GetContextKeysForPrincipalPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetContextKeysForPrincipalPolicyRequest.Builder,GetContextKeysForPrincipalPolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetContextKeysForPrincipalPolicyRequest
extends IamRequest
implements ToCopyableBuilder<GetContextKeysForPrincipalPolicyRequest.Builder,GetContextKeysForPrincipalPolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetContextKeysForPrincipalPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetContextKeysForPrincipalPolicyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolicyInputList()	For responses, this returns true if the service returned a value for the PolicyInputList property.
List<String>	policyInputList()	An optional list of additional policies for which you want the list of context keys that are referenced.
String	policySourceArn()	The ARN of a user, group, or role whose policies contain the context keys that you want listed.
List<SdkField<?>>	sdkFields()
static Class<? extends GetContextKeysForPrincipalPolicyRequest.Builder>	serializableBuilderClass()
GetContextKeysForPrincipalPolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

policySourceArn

public final String policySourceArn()

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Returns:

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

hasPolicyInputList

public final boolean hasPolicyInputList()

For responses, this returns true if the service returned a value for the PolicyInputList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

policyInputList

public final List<String> policyInputList()

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

• Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPolicyInputList() method.

Returns:

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

• Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

toBuilder

public GetContextKeysForPrincipalPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetContextKeysForPrincipalPolicyRequest.Builder,GetContextKeysForPrincipalPolicyRequest>

Specified by:

toBuilder in class IamRequest

builder

public static GetContextKeysForPrincipalPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetContextKeysForPrincipalPolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo