Class: Aws::Honeycode::Types::ListTableRowsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of rows to return in each page of the results.

Returns:

  • (Integer) 


1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1046

class ListTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :row_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Returns:

  • (String) 


1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1046

class ListTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :row_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#row_ids ⇒ Array<String>

This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

Returns:

  • (Array<String>) 


1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1046

class ListTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :row_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#table_id ⇒ String

The ID of the table whose rows are being retrieved.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Returns:

  • (String) 


1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1046

class ListTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :row_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#workbook_id ⇒ String

The ID of the workbook that contains the table whose rows are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Returns:

  • (String) 


1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1046

class ListTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :row_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end