« blib/lib/Paws/Personalize/CreateDataset.pm
↑ Summary
blib/lib/Paws/Personalize/CreateDatasetExportJobResponse.pm »
| 1 | |||
| 2 | package Paws::Personalize::CreateDatasetExportJob; | ||
| 3 | use Moose; | ||
| 4 | has DatasetArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'datasetArn' , required => 1); | ||
| 5 | has IngestionMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'ingestionMode' ); | ||
| 6 | has JobName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobName' , required => 1); | ||
| 7 | has JobOutput => (is => 'ro', isa => 'Paws::Personalize::DatasetExportJobOutput', traits => ['NameInRequest'], request_name => 'jobOutput' , required => 1); | ||
| 8 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn' , required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDatasetExportJob'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Personalize::CreateDatasetExportJobResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Personalize::CreateDatasetExportJob - Arguments for method CreateDatasetExportJob on L<Paws::Personalize> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateDatasetExportJob on the | ||
| 26 | L<Amazon Personalize|Paws::Personalize> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateDatasetExportJob. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDatasetExportJob. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $personalize = Paws->service('Personalize'); | ||
| 34 | my $CreateDatasetExportJobResponse = $personalize->CreateDatasetExportJob( | ||
| 35 | DatasetArn => 'MyArn', | ||
| 36 | JobName => 'MyName', | ||
| 37 | JobOutput => { | ||
| 38 | S3DataDestination => { | ||
| 39 | Path => 'MyS3Location', # max: 256 | ||
| 40 | KmsKeyArn => 'MyKmsKeyArn', # OPTIONAL | ||
| 41 | }, | ||
| 42 | |||
| 43 | }, | ||
| 44 | RoleArn => 'MyRoleArn', | ||
| 45 | IngestionMode => 'BULK', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $DatasetExportJobArn = | ||
| 50 | $CreateDatasetExportJobResponse->DatasetExportJobArn; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Personalize::CreateDatasetExportJobResponse> 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/personalize/CreateDatasetExportJob> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> DatasetArn => Str | ||
| 61 | |||
| 62 | The Amazon Resource Name (ARN) of the dataset that contains the data to | ||
| 63 | export. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 IngestionMode => Str | ||
| 68 | |||
| 69 | The data to export, based on how you imported the data. You can choose | ||
| 70 | to export only C<BULK> data that you imported using a dataset import | ||
| 71 | job, only C<PUT> data that you imported incrementally (using the | ||
| 72 | console, PutEvents, PutUsers and PutItems operations), or C<ALL> for | ||
| 73 | both types. The default value is C<PUT>. | ||
| 74 | |||
| 75 | Valid values are: C<"BULK">, C<"PUT">, C<"ALL"> | ||
| 76 | |||
| 77 | =head2 B<REQUIRED> JobName => Str | ||
| 78 | |||
| 79 | The name for the dataset export job. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> JobOutput => L<Paws::Personalize::DatasetExportJobOutput> | ||
| 84 | |||
| 85 | The path to the Amazon S3 bucket where the job's output is stored. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> RoleArn => Str | ||
| 90 | |||
| 91 | The Amazon Resource Name (ARN) of the AWS Identity and Access | ||
| 92 | Management service role that has permissions to add data to your output | ||
| 93 | Amazon S3 bucket. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method CreateDatasetExportJob in L<Paws::Personalize> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |