blib/lib/Paws/Pinpoint/ImportJobRequest.pm untested

filter: Statementstmt 0.0% 0 / 11 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 12 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Pinpoint::ImportJobRequest;
3 use Moose;
4 has DefineSegment => (is => 'ro', isa => 'Bool');
5 has ExternalId => (is => 'ro', isa => 'Str');
6 has Format => (is => 'ro', isa => 'Str', required => 1);
7 has RegisterEndpoints => (is => 'ro', isa => 'Bool');
8 has RoleArn => (is => 'ro', isa => 'Str', required => 1);
9 has S3Url => (is => 'ro', isa => 'Str', required => 1);
10 has SegmentId => (is => 'ro', isa => 'Str');
11 has SegmentName => (is => 'ro', isa => 'Str');
12  
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::Pinpoint::ImportJobRequest
20  
21 =head1 USAGE
22  
23 This class represents one of two things:
24  
25 =head3 Arguments in a call to a service
26  
27 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28 Each attribute should be used as a named argument in the calls that expect this type of object.
29  
30 As an example, if Att1 is expected to be a Paws::Pinpoint::ImportJobRequest object:
31  
32 $service_obj->Method(Att1 => { DefineSegment => $value, ..., SegmentName => $value });
33  
34 =head3 Results returned from an API call
35  
36 Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::ImportJobRequest object:
37  
38 $result = $service_obj->Method(...);
39 $result->Att1->DefineSegment
40  
41 =head1 DESCRIPTION
42  
43 Specifies the settings for a job that imports endpoint definitions from
44 an Amazon Simple Storage Service (Amazon S3) bucket.
45  
46 =head1 ATTRIBUTES
47  
48  
49 =head2 DefineSegment => Bool
50  
51 Specifies whether to create a segment that contains the endpoints, when
52 the endpoint definitions are imported.
53  
54  
55 =head2 ExternalId => Str
56  
57 (Deprecated) Your AWS account ID, which you assigned to an external ID
58 key in an IAM trust policy. Amazon Pinpoint previously used this value
59 to assume an IAM role when importing endpoint definitions, but we
60 removed this requirement. We don't recommend use of external IDs for
61 IAM roles that are assumed by Amazon Pinpoint.
62  
63  
64 =head2 B<REQUIRED> Format => Str
65  
66 The format of the files that contain the endpoint definitions to
67 import. Valid values are: CSV, for comma-separated values format; and,
68 JSON, for newline-delimited JSON format. If the Amazon S3 location
69 stores multiple files that use different formats, Amazon Pinpoint
70 imports data only from the files that use the specified format.
71  
72  
73 =head2 RegisterEndpoints => Bool
74  
75 Specifies whether to register the endpoints with Amazon Pinpoint, when
76 the endpoint definitions are imported.
77  
78  
79 =head2 B<REQUIRED> RoleArn => Str
80  
81 The Amazon Resource Name (ARN) of the AWS Identity and Access
82 Management (IAM) role that authorizes Amazon Pinpoint to access the
83 Amazon S3 location to import endpoint definitions from.
84  
85  
86 =head2 B<REQUIRED> S3Url => Str
87  
88 The URL of the Amazon Simple Storage Service (Amazon S3) bucket that
89 contains the endpoint definitions to import. This location can be a
90 folder or a single file. If the location is a folder, Amazon Pinpoint
91 imports endpoint definitions from the files in this location, including
92 any subfolders that the folder contains.
93  
94 The URL should be in the following format:
95 s3://bucket-name/folder-name/file-name. The location can end with the
96 key for an individual object or a prefix that qualifies multiple
97 objects.
98  
99  
100 =head2 SegmentId => Str
101  
102 The identifier for the segment to update or add the imported endpoint
103 definitions to, if the import job is meant to update an existing
104 segment.
105  
106  
107 =head2 SegmentName => Str
108  
109 A custom name for the segment that's created by the import job, if the
110 value of the DefineSegment property is true.
111  
112  
113  
114 =head1 SEE ALSO
115  
116 This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
117  
118 =head1 BUGS and CONTRIBUTIONS
119  
120 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
121  
122 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
123  
124 =cut
125