« blib/lib/Paws/Pinpoint/CreateExportJobResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/CreateImportJobResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::CreateImportJob; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has ImportJobRequest => (is => 'ro', isa => 'Paws::Pinpoint::ImportJobRequest', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | class_has _stream_param => (is => 'ro', default => 'ImportJobRequest'); | ||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateImportJob'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/jobs/import'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::CreateImportJobResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Pinpoint::CreateImportJob - Arguments for method CreateImportJob on L<Paws::Pinpoint> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateImportJob on the | ||
| 24 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateImportJob. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateImportJob. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 32 | my $CreateImportJobResponse = $pinpoint->CreateImportJob( | ||
| 33 | ApplicationId => 'My__string', | ||
| 34 | ImportJobRequest => { | ||
| 35 | Format => 'CSV', # values: CSV, JSON | ||
| 36 | RoleArn => 'My__string', | ||
| 37 | S3Url => 'My__string', | ||
| 38 | DefineSegment => 1, # OPTIONAL | ||
| 39 | ExternalId => 'My__string', | ||
| 40 | RegisterEndpoints => 1, # OPTIONAL | ||
| 41 | SegmentId => 'My__string', | ||
| 42 | SegmentName => 'My__string', | ||
| 43 | }, | ||
| 44 | |||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $ImportJobResponse = $CreateImportJobResponse->ImportJobResponse; | ||
| 49 | |||
| 50 | # Returns a L<Paws::Pinpoint::CreateImportJobResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/CreateImportJob> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 59 | |||
| 60 | The unique identifier for the application. This identifier is displayed | ||
| 61 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> ImportJobRequest => L<Paws::Pinpoint::ImportJobRequest> | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head1 SEE ALSO | ||
| 73 | |||
| 74 | This class forms part of L<Paws>, documenting arguments for method CreateImportJob in L<Paws::Pinpoint> | ||
| 75 | |||
| 76 | =head1 BUGS and CONTRIBUTIONS | ||
| 77 | |||
| 78 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 79 | |||
| 80 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 81 | |||
| 82 | =cut | ||
| 83 |