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

Inherits:

Struct

• Object
• Struct
• Aws::Organizations::Types::ListHandshakesForOrganizationRequest

Defined in:

gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filter ⇒ Types::HandshakeFilter

  A filter of the handshakes that you want included in the response.

• #max_results ⇒ 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.

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:

• (Types::HandshakeFilter)

# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 3099

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

#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)

# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 3099

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

#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)

# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 3099

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