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

Class ListParentsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.organizations.model.ListParentsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListParentsRequest.Builder,ListParentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListParentsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ListParentsRequest.Builder	builder()
String	childId()	The unique identifier (ID) of the OU or account whose parent containers you want to list.
boolean	equals(Object obj)
int	hashCode()
Integer	maxResults()	(Optional) Use this to limit the number of results you want included in the response.
String	nextToken()	Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available.
static Class<? extends ListParentsRequest.Builder>	serializableBuilderClass()
ListParentsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

childId

public String childId()

The unique identifier (ID) of the OU or account whose parent containers you want to list. Do not specify a root.

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

• Account: a string that consists of exactly 12 digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Returns:

The unique identifier (ID) of the OU or account whose parent containers you want to list. Do not specify a root.

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

• Account: a string that consists of exactly 12 digits.

• Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

nextToken

public String nextToken()

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Returns:

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

maxResults

public Integer maxResults()

(Optional) Use this to limit the number of results you want included in 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:

(Optional) Use this to limit the number of results you want included in 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 ListParentsRequest.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<ListParentsRequest.Builder,ListParentsRequest>

Returns:

a builder for type T

builder

public static ListParentsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object