« blib/lib/Paws/LookoutEquipment/S3Object.pm
↑ Summary
blib/lib/Paws/LookoutEquipment/StartDataIngestionJobResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutEquipment::StartDataIngestionJob; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DatasetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has IngestionInputConfiguration => (is => 'ro', isa => 'Paws::LookoutEquipment::IngestionInputConfiguration', required => 1); | ||
| 7 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartDataIngestionJob'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutEquipment::StartDataIngestionJobResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::LookoutEquipment::StartDataIngestionJob - Arguments for method StartDataIngestionJob on L<Paws::LookoutEquipment> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method StartDataIngestionJob on the | ||
| 25 | L<Amazon Lookout for Equipment|Paws::LookoutEquipment> service. Use the attributes of this class | ||
| 26 | as arguments to method StartDataIngestionJob. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartDataIngestionJob. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $lookoutequipment = Paws->service('LookoutEquipment'); | ||
| 33 | my $StartDataIngestionJobResponse = | ||
| 34 | $lookoutequipment->StartDataIngestionJob( | ||
| 35 | ClientToken => 'MyIdempotenceToken', | ||
| 36 | DatasetName => 'MyDatasetIdentifier', | ||
| 37 | IngestionInputConfiguration => { | ||
| 38 | S3InputConfiguration => { | ||
| 39 | Bucket => 'MyS3Bucket', # min: 3, max: 63 | ||
| 40 | Prefix => 'MyS3Prefix', # max: 1024; OPTIONAL | ||
| 41 | }, | ||
| 42 | |||
| 43 | }, | ||
| 44 | RoleArn => 'MyIamRoleArn', | ||
| 45 | |||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $JobId = $StartDataIngestionJobResponse->JobId; | ||
| 50 | my $Status = $StartDataIngestionJobResponse->Status; | ||
| 51 | |||
| 52 | # Returns a L<Paws::LookoutEquipment::StartDataIngestionJobResponse> 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/lookoutequipment/StartDataIngestionJob> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> ClientToken => Str | ||
| 61 | |||
| 62 | A unique identifier for the request. If you do not set the client | ||
| 63 | request token, Amazon Lookout for Equipment generates one. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> DatasetName => Str | ||
| 68 | |||
| 69 | The name of the dataset being used by the data ingestion job. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> IngestionInputConfiguration => L<Paws::LookoutEquipment::IngestionInputConfiguration> | ||
| 74 | |||
| 75 | Specifies information for the input data for the data ingestion job, | ||
| 76 | including dataset S3 location. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> RoleArn => Str | ||
| 81 | |||
| 82 | The Amazon Resource Name (ARN) of a role with permission to access the | ||
| 83 | data source for the data ingestion job. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method StartDataIngestionJob in L<Paws::LookoutEquipment> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |