Interface ListChildrenRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListChildrenRequest.Builder,ListChildrenRequest>, OrganizationsRequest.Builder, SdkBuilder<ListChildrenRequest.Builder,ListChildrenRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListChildrenRequest
@Mutable @NotThreadSafe public static interface ListChildrenRequest.Builder extends OrganizationsRequest.Builder, SdkPojo, CopyableBuilder<ListChildrenRequest.Builder,ListChildrenRequest>

  • Method Details

    • parentId

      ListChildrenRequest.Builder parentId(String parentId)

      The unique identifier (ID) for the parent root or OU whose children you want to list.

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

      • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or 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.

      Parameters:
      parentId - The unique identifier (ID) for the parent root or OU whose children you want to list.

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

      • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or 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:
      Returns a reference to this object so that method calls can be chained together.

    • childType

      ListChildrenRequest.Builder childType(String childType)

      Filters the output to include only the specified child type.

      Parameters:
      childType - Filters the output to include only the specified child type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • childType

      ListChildrenRequest.Builder childType(ChildType childType)

      Filters the output to include only the specified child type.

      Parameters:
      childType - Filters the output to include only the specified child type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      ListChildrenRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListChildrenRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListChildrenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListChildrenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.