Class ListPoliciesForTargetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.organizations.model.OrganizationsRequest

software.amazon.awssdk.services.organizations.model.ListPoliciesForTargetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListPoliciesForTargetRequest.Builder,ListPoliciesForTargetRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListPoliciesForTargetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListPoliciesForTargetRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final PolicyType	filter()	The type of policy that you want to include in the returned list.
final String	filterAsString()	The type of policy that you want to include in the returned list.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final int	hashCode()
final Integer	maxResults()	The maximum number of items to return in the response.
final String	nextToken()	The parameter for receiving additional results if you receive a NextToken response in a previous request.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ListPoliciesForTargetRequest.Builder>	serializableBuilderClass()
final String	targetId()	ID for the root, organizational unit, or account whose policies you want to list.
ListPoliciesForTargetRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final 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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

targetId

public final String targetId()

ID for the root, organizational unit, or account whose policies you want to list.

The regex pattern for a target ID string requires one of the following:

• Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

• Account - A string that consists of exactly 12 digits.

• Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Returns:

ID for the root, organizational unit, or account whose policies you want to list.

The regex pattern for a target ID string requires one of the following:

• Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

• Account - A string that consists of exactly 12 digits.

• Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

filter

public final PolicyType filter()

The type of policy that you want to include in the returned list. You must specify one of the following values:

• SERVICE_CONTROL_POLICY

• RESOURCE_CONTROL_POLICY

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

• UPGRADE_ROLLOUT_POLICY

• INSPECTOR_POLICY

• BEDROCK_POLICY

• S3_POLICY

If the service returns an enum value that is not available in the current SDK version, filter will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterAsString().

Returns:

The type of policy that you want to include in the returned list. You must specify one of the following values:

• SERVICE_CONTROL_POLICY

• RESOURCE_CONTROL_POLICY

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

• UPGRADE_ROLLOUT_POLICY

• INSPECTOR_POLICY

• BEDROCK_POLICY

• S3_POLICY

See Also:

• PolicyType

filterAsString

public final String filterAsString()

The type of policy that you want to include in the returned list. You must specify one of the following values:

• SERVICE_CONTROL_POLICY

• RESOURCE_CONTROL_POLICY

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

• UPGRADE_ROLLOUT_POLICY

• INSPECTOR_POLICY

• BEDROCK_POLICY

• S3_POLICY

If the service returns an enum value that is not available in the current SDK version, filter will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterAsString().

Returns:

The type of policy that you want to include in the returned list. You must specify one of the following values:

• SERVICE_CONTROL_POLICY

• RESOURCE_CONTROL_POLICY

• DECLARATIVE_POLICY_EC2

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

• SECURITYHUB_POLICY

• UPGRADE_ROLLOUT_POLICY

• INSPECTOR_POLICY

• BEDROCK_POLICY

• S3_POLICY

See Also:

• PolicyType

nextToken

public final String nextToken()

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Returns:

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

maxResults

public final Integer maxResults()

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

Returns:

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

toBuilder

public ListPoliciesForTargetRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListPoliciesForTargetRequest.Builder,ListPoliciesForTargetRequest>

Specified by:

toBuilder in class OrganizationsRequest

Returns:

a builder for type T

builder

public static ListPoliciesForTargetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListPoliciesForTargetRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.