Package software.amazon.awssdk.services.organizations.model

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()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PolicyType	filter()	The type of policy that you want to include in the returned list.
String	filterAsString()	The type of policy that you want to include in the returned list.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The total number of results that you want included on each page of the response.
String	nextToken()	The parameter for receiving additional results if you receive a NextToken response in a previous request.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPoliciesForTargetRequest.Builder>	serializableBuilderClass()
String	targetId()	The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.
ListPoliciesForTargetRequest.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

targetId

public final String targetId()

The unique identifier (ID) of 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:

The unique identifier (ID) of 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:

• AISERVICES_OPT_OUT_POLICY

• BACKUP_POLICY

• SERVICE_CONTROL_POLICY

• TAG_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:

• AISERVICES_OPT_OUT_POLICY

• BACKUP_POLICY

• SERVICE_CONTROL_POLICY

• TAG_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:

• AISERVICES_OPT_OUT_POLICY

• BACKUP_POLICY

• SERVICE_CONTROL_POLICY

• TAG_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:

• AISERVICES_OPT_OUT_POLICY

• BACKUP_POLICY

• SERVICE_CONTROL_POLICY

• TAG_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 total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

toBuilder

public ListPoliciesForTargetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPoliciesForTargetRequest.Builder,ListPoliciesForTargetRequest>

Specified by:

toBuilder in class OrganizationsRequest

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)

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