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