You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Organizations::Types::ListParentsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListParentsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  child_id: "ChildId", # required
  next_token: "NextToken",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#child_id ⇒ String

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don\'t 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 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.

Returns:

  • (String) —

    The unique identifier (ID) of the OU or account whose parent containers you want to list.

#max_results ⇒ Integer

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:

  • (Integer) —

    The total number of results that you want included on each page of the response.

#next_token ⇒ String

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:

  • (String) —

    The parameter for receiving additional results if you receive a NextToken response in a previous request.