« blib/lib/Paws/Honeycode/SourceDataColumnProperties.pm
↑ Summary
blib/lib/Paws/Honeycode/StartTableDataImportJobResult.pm »
| 1 | |||
| 2 | package Paws::Honeycode::StartTableDataImportJob; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken', required => 1); | ||
| 5 | has DataFormat => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dataFormat', required => 1); | ||
| 6 | has DataSource => (is => 'ro', isa => 'Paws::Honeycode::ImportDataSource', traits => ['NameInRequest'], request_name => 'dataSource', required => 1); | ||
| 7 | has DestinationTableId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'tableId', required => 1); | ||
| 8 | has ImportOptions => (is => 'ro', isa => 'Paws::Honeycode::ImportOptions', traits => ['NameInRequest'], request_name => 'importOptions', required => 1); | ||
| 9 | has WorkbookId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'workbookId', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartTableDataImportJob'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/workbooks/{workbookId}/tables/{tableId}/import'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Honeycode::StartTableDataImportJobResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Honeycode::StartTableDataImportJob - Arguments for method StartTableDataImportJob on L<Paws::Honeycode> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method StartTableDataImportJob on the | ||
| 28 | L<Amazon Honeycode|Paws::Honeycode> service. Use the attributes of this class | ||
| 29 | as arguments to method StartTableDataImportJob. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartTableDataImportJob. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $honeycode = Paws->service('Honeycode'); | ||
| 36 | my $StartTableDataImportJobResult = $honeycode->StartTableDataImportJob( | ||
| 37 | ClientRequestToken => 'MyClientRequestToken', | ||
| 38 | DataFormat => 'DELIMITED_TEXT', | ||
| 39 | DataSource => { | ||
| 40 | DataSourceConfig => { | ||
| 41 | DataSourceUrl => 'MySecureURL', # min: 1, max: 8000; OPTIONAL | ||
| 42 | }, | ||
| 43 | |||
| 44 | }, | ||
| 45 | DestinationTableId => 'MyResourceId', | ||
| 46 | ImportOptions => { | ||
| 47 | DelimitedTextOptions => { | ||
| 48 | Delimiter => 'MyDelimitedTextDelimiter', # min: 1, max: 1 | ||
| 49 | DataCharacterEncoding => 'UTF-8' | ||
| 50 | , # values: UTF-8, US-ASCII, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-16; OPTIONAL | ||
| 51 | HasHeaderRow => 1, # OPTIONAL | ||
| 52 | IgnoreEmptyRows => 1, # OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | DestinationOptions => { | ||
| 55 | ColumnMap => { | ||
| 56 | 'MyResourceId' => { | ||
| 57 | ColumnIndex => 1, # min: 1; OPTIONAL | ||
| 58 | }, # key: min: 36, max: 36 | ||
| 59 | }, # max: 100; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | }, | ||
| 62 | WorkbookId => 'MyResourceId', | ||
| 63 | |||
| 64 | ); | ||
| 65 | |||
| 66 | # Results: | ||
| 67 | my $JobId = $StartTableDataImportJobResult->JobId; | ||
| 68 | my $JobStatus = $StartTableDataImportJobResult->JobStatus; | ||
| 69 | |||
| 70 | # Returns a L<Paws::Honeycode::StartTableDataImportJobResult> object. | ||
| 71 | |||
| 72 | 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. | ||
| 73 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/honeycode/StartTableDataImportJob> | ||
| 74 | |||
| 75 | =head1 ATTRIBUTES | ||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 79 | |||
| 80 | The request token for performing the update action. Request tokens help | ||
| 81 | to identify duplicate requests. If a call times out or fails due to a | ||
| 82 | transient error like a failed network connection, you can retry the | ||
| 83 | call with the same request token. The service ensures that if the first | ||
| 84 | call using that request token is successfully performed, the second | ||
| 85 | call will not perform the action again. | ||
| 86 | |||
| 87 | Note that request tokens are valid only for a few minutes. You cannot | ||
| 88 | use request tokens to dedupe requests spanning hours or days. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> DataFormat => Str | ||
| 93 | |||
| 94 | The format of the data that is being imported. Currently the only | ||
| 95 | option supported is "DELIMITED_TEXT". | ||
| 96 | |||
| 97 | Valid values are: C<"DELIMITED_TEXT"> | ||
| 98 | |||
| 99 | =head2 B<REQUIRED> DataSource => L<Paws::Honeycode::ImportDataSource> | ||
| 100 | |||
| 101 | The source of the data that is being imported. The size of source must | ||
| 102 | be no larger than 100 MB. Source must have no more than 100,000 cells | ||
| 103 | and no more than 1,000 rows. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> DestinationTableId => Str | ||
| 108 | |||
| 109 | The ID of the table where the rows are being imported. | ||
| 110 | |||
| 111 | If a table with the specified id could not be found, this API throws | ||
| 112 | ResourceNotFoundException. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> ImportOptions => L<Paws::Honeycode::ImportOptions> | ||
| 117 | |||
| 118 | The options for customizing this import request. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> WorkbookId => Str | ||
| 123 | |||
| 124 | The ID of the workbook where the rows are being imported. | ||
| 125 | |||
| 126 | If a workbook with the specified id could not be found, this API throws | ||
| 127 | ResourceNotFoundException. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, documenting arguments for method StartTableDataImportJob in L<Paws::Honeycode> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |