« blib/lib/Paws/Honeycode/BatchDeleteTableRowsResult.pm
↑ Summary
blib/lib/Paws/Honeycode/BatchUpdateTableRowsResult.pm »
| 1 | |||
| 2 | package Paws::Honeycode::BatchUpdateTableRows; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken'); | ||
| 5 | has RowsToUpdate => (is => 'ro', isa => 'ArrayRef[Paws::Honeycode::UpdateRowData]', traits => ['NameInRequest'], request_name => 'rowsToUpdate', required => 1); | ||
| 6 | has TableId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'tableId', required => 1); | ||
| 7 | has WorkbookId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'workbookId', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchUpdateTableRows'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/workbooks/{workbookId}/tables/{tableId}/rows/batchupdate'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Honeycode::BatchUpdateTableRowsResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Honeycode::BatchUpdateTableRows - Arguments for method BatchUpdateTableRows on L<Paws::Honeycode> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method BatchUpdateTableRows on the | ||
| 26 | L<Amazon Honeycode|Paws::Honeycode> service. Use the attributes of this class | ||
| 27 | as arguments to method BatchUpdateTableRows. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchUpdateTableRows. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $honeycode = Paws->service('Honeycode'); | ||
| 34 | my $BatchUpdateTableRowsResult = $honeycode->BatchUpdateTableRows( | ||
| 35 | RowsToUpdate => [ | ||
| 36 | { | ||
| 37 | CellsToUpdate => { | ||
| 38 | 'MyResourceId' => { | ||
| 39 | Fact => 'MyFact', # max: 8192; OPTIONAL | ||
| 40 | }, # key: min: 36, max: 36 | ||
| 41 | }, # min: 1, max: 100 | ||
| 42 | RowId => 'MyRowId', # min: 77, max: 77 | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], | ||
| 47 | TableId => 'MyResourceId', | ||
| 48 | WorkbookId => 'MyResourceId', | ||
| 49 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $FailedBatchItems = $BatchUpdateTableRowsResult->FailedBatchItems; | ||
| 54 | my $WorkbookCursor = $BatchUpdateTableRowsResult->WorkbookCursor; | ||
| 55 | |||
| 56 | # Returns a L<Paws::Honeycode::BatchUpdateTableRowsResult> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/honeycode/BatchUpdateTableRows> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ClientRequestToken => Str | ||
| 65 | |||
| 66 | The request token for performing the update action. Request tokens help | ||
| 67 | to identify duplicate requests. If a call times out or fails due to a | ||
| 68 | transient error like a failed network connection, you can retry the | ||
| 69 | call with the same request token. The service ensures that if the first | ||
| 70 | call using that request token is successfully performed, the second | ||
| 71 | call will not perform the action again. | ||
| 72 | |||
| 73 | Note that request tokens are valid only for a few minutes. You cannot | ||
| 74 | use request tokens to dedupe requests spanning hours or days. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> RowsToUpdate => ArrayRef[L<Paws::Honeycode::UpdateRowData>] | ||
| 79 | |||
| 80 | The list of rows to update in the table. Each item in this list needs | ||
| 81 | to contain the row id to update along with the map of column id to cell | ||
| 82 | values for each column in that row that needs to be updated. You need | ||
| 83 | to specify at least one row in this list, and for each row, you need to | ||
| 84 | specify at least one column to update. | ||
| 85 | |||
| 86 | Note that if one of the row or column ids in the request does not exist | ||
| 87 | in the table, then the request fails and no updates are made to the | ||
| 88 | table. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> TableId => Str | ||
| 93 | |||
| 94 | The ID of the table where the rows are being updated. | ||
| 95 | |||
| 96 | If a table with the specified id could not be found, this API throws | ||
| 97 | ResourceNotFoundException. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> WorkbookId => Str | ||
| 102 | |||
| 103 | The ID of the workbook where the rows are being updated. | ||
| 104 | |||
| 105 | If a workbook with the specified id could not be found, this API throws | ||
| 106 | ResourceNotFoundException. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method BatchUpdateTableRows in L<Paws::Honeycode> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |