blib/lib/Paws/Pinpoint/ImportJobResource.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::ImportJobResource;
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::ImportJobResource
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::ImportJobResource 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::ImportJobResource object:
37  
38 $result = $service_obj->Method(...);
39 $result->Att1->DefineSegment
40  
41 =head1 DESCRIPTION
42  
43 Provides information about the resource settings for a job that imports
44 endpoint definitions from one or more files. The files can be stored in
45 an Amazon Simple Storage Service (Amazon S3) bucket or uploaded
46 directly from a computer by using the Amazon Pinpoint console.
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 DefineSegment => Bool
52  
53 Specifies whether the import job creates a segment that contains the
54 endpoints, when the endpoint definitions are imported.
55  
56  
57 =head2 ExternalId => Str
58  
59 (Deprecated) Your AWS account ID, which you assigned to an external ID
60 key in an IAM trust policy. Amazon Pinpoint previously used this value
61 to assume an IAM role when importing endpoint definitions, but we
62 removed this requirement. We don't recommend use of external IDs for
63 IAM roles that are assumed by Amazon Pinpoint.
64  
65  
66 =head2 B<REQUIRED> Format => Str
67  
68 The format of the files that contain the endpoint definitions to
69 import. Valid values are: CSV, for comma-separated values format; and,
70 JSON, for newline-delimited JSON format.
71  
72 If the files are stored in an Amazon S3 location and that location
73 contains multiple files that use different formats, Amazon Pinpoint
74 imports data only from the files that use the specified format.
75  
76  
77 =head2 RegisterEndpoints => Bool
78  
79 Specifies whether the import job registers the endpoints with Amazon
80 Pinpoint, when the endpoint definitions are imported.
81  
82  
83 =head2 B<REQUIRED> RoleArn => Str
84  
85 The Amazon Resource Name (ARN) of the AWS Identity and Access
86 Management (IAM) role that authorizes Amazon Pinpoint to access the
87 Amazon S3 location to import endpoint definitions from.
88  
89  
90 =head2 B<REQUIRED> S3Url => Str
91  
92 The URL of the Amazon Simple Storage Service (Amazon S3) bucket that
93 contains the endpoint definitions to import. This location can be a
94 folder or a single file. If the location is a folder, Amazon Pinpoint
95 imports endpoint definitions from the files in this location, including
96 any subfolders that the folder contains.
97  
98 The URL should be in the following format:
99 s3://bucket-name/folder-name/file-name. The location can end with the
100 key for an individual object or a prefix that qualifies multiple
101 objects.
102  
103  
104 =head2 SegmentId => Str
105  
106 The identifier for the segment that the import job updates or adds
107 endpoint definitions to, if the import job updates an existing segment.
108  
109  
110 =head2 SegmentName => Str
111  
112 The custom name for the segment that's created by the import job, if
113 the value of the DefineSegment property is true.
114  
115  
116  
117 =head1 SEE ALSO
118  
119 This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
120  
121 =head1 BUGS and CONTRIBUTIONS
122  
123 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
124  
125 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
126  
127 =cut
128