« blib/lib/Paws/Honeycode/ListTableColumnsResult.pm
↑ Summary
blib/lib/Paws/Honeycode/ListTableRowsResult.pm »
| 1 | |||
| 2 | package Paws::Honeycode::ListTableRows; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 6 | has RowIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'rowIds'); | ||
| 7 | has TableId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'tableId', required => 1); | ||
| 8 | has WorkbookId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'workbookId', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTableRows'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/workbooks/{workbookId}/tables/{tableId}/rows/list'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Honeycode::ListTableRowsResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Honeycode::ListTableRows - Arguments for method ListTableRows on L<Paws::Honeycode> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListTableRows on the | ||
| 27 | L<Amazon Honeycode|Paws::Honeycode> service. Use the attributes of this class | ||
| 28 | as arguments to method ListTableRows. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTableRows. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $honeycode = Paws->service('Honeycode'); | ||
| 35 | my $ListTableRowsResult = $honeycode->ListTableRows( | ||
| 36 | TableId => 'MyResourceId', | ||
| 37 | WorkbookId => 'MyResourceId', | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 40 | RowIds => [ | ||
| 41 | 'MyRowId', ... # min: 77, max: 77 | ||
| 42 | ], # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $ColumnIds = $ListTableRowsResult->ColumnIds; | ||
| 47 | my $NextToken = $ListTableRowsResult->NextToken; | ||
| 48 | my $RowIdsNotFound = $ListTableRowsResult->RowIdsNotFound; | ||
| 49 | my $Rows = $ListTableRowsResult->Rows; | ||
| 50 | my $WorkbookCursor = $ListTableRowsResult->WorkbookCursor; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Honeycode::ListTableRowsResult> object. | ||
| 53 | |||
| 54 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/honeycode/ListTableRows> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 MaxResults => Int | ||
| 61 | |||
| 62 | The maximum number of rows to return in each page of the results. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 NextToken => Str | ||
| 67 | |||
| 68 | This parameter is optional. If a nextToken is not specified, the API | ||
| 69 | returns the first page of data. | ||
| 70 | |||
| 71 | Pagination tokens expire after 1 hour. If you use a token that was | ||
| 72 | returned more than an hour back, the API will throw | ||
| 73 | ValidationException. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 RowIds => ArrayRef[Str|Undef] | ||
| 78 | |||
| 79 | This parameter is optional. If one or more row ids are specified in | ||
| 80 | this list, then only the specified row ids are returned in the result. | ||
| 81 | If no row ids are specified here, then all the rows in the table are | ||
| 82 | returned. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> TableId => Str | ||
| 87 | |||
| 88 | The ID of the table whose rows are being retrieved. | ||
| 89 | |||
| 90 | If a table with the specified id could not be found, this API throws | ||
| 91 | ResourceNotFoundException. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> WorkbookId => Str | ||
| 96 | |||
| 97 | The ID of the workbook that contains the table whose rows are being | ||
| 98 | retrieved. | ||
| 99 | |||
| 100 | If a workbook with the specified id could not be found, this API throws | ||
| 101 | ResourceNotFoundException. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, documenting arguments for method ListTableRows in L<Paws::Honeycode> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |