Class: Aws::Organizations::Types::ListHandshakesForOrganizationRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-organizations/types.rb

Overview

Note:

When making an API call, you may pass ListHandshakesForOrganizationRequest data as a hash:

{
  filter: {
    action_type: "INVITE", # accepts INVITE, ENABLE_ALL_FEATURES, APPROVE_ALL_FEATURES, ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE
    parent_handshake_id: "HandshakeId",
  },
  next_token: "NextToken",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::HandshakeFilter

A filter of the handshakes that you want included in the response. The default is all types. Use the ‘ActionType` element to limit the output to only a specified type, such as `INVITE`, `ENABLE-ALL-FEATURES`, or `APPROVE-ALL-FEATURES`. Alternatively, for the `ENABLE-ALL-FEATURES` handshake that generates a separate child handshake for each member account, you can specify the `ParentHandshakeId` to see only the handshakes that were generated by that parent request.

Returns:



1852
1853
1854
1855
1856
1857
 
# File 'lib/aws-sdk-organizations/types.rb', line 1852

class ListHandshakesForOrganizationRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_results ⇒ Integer

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

  • (Integer) 


1852
1853
1854
1855
1856
1857
 
# File 'lib/aws-sdk-organizations/types.rb', line 1852

class ListHandshakesForOrganizationRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_token ⇒ String

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:

  • (String) 


1852
1853
1854
1855
1856
1857
 
# File 'lib/aws-sdk-organizations/types.rb', line 1852

class ListHandshakesForOrganizationRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end