File Coverage

blib/lib/Paws/Pinpoint/ImportJobResource.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Pinpoint::ImportJobResource;
2 1     1   542 use Moose;
  1         3  
  1         8  
3             has DefineSegment => (is => 'ro', isa => 'Bool');
4             has ExternalId => (is => 'ro', isa => 'Str');
5             has Format => (is => 'ro', isa => 'Str');
6             has RegisterEndpoints => (is => 'ro', isa => 'Bool');
7             has RoleArn => (is => 'ro', isa => 'Str');
8             has S3Url => (is => 'ro', isa => 'Str');
9             has SegmentId => (is => 'ro', isa => 'Str');
10             has SegmentName => (is => 'ro', isa => 'Str');
11             1;
12              
13             ### main pod documentation begin ###
14              
15             =head1 NAME
16              
17             Paws::Pinpoint::ImportJobResource
18              
19             =head1 USAGE
20              
21             This class represents one of two things:
22              
23             =head3 Arguments in a call to a service
24              
25             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26             Each attribute should be used as a named argument in the calls that expect this type of object.
27              
28             As an example, if Att1 is expected to be a Paws::Pinpoint::ImportJobResource object:
29              
30             $service_obj->Method(Att1 => { DefineSegment => $value, ..., SegmentName => $value });
31              
32             =head3 Results returned from an API call
33              
34             Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::ImportJobResource object:
35              
36             $result = $service_obj->Method(...);
37             $result->Att1->DefineSegment
38              
39             =head1 DESCRIPTION
40              
41             This class has no description
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 DefineSegment => Bool
47              
48             Sets whether the endpoints create a segment when they are imported.
49              
50              
51             =head2 ExternalId => Str
52              
53             A unique, custom ID assigned to the IAM role that restricts who can
54             assume the role.
55              
56              
57             =head2 Format => Str
58              
59             The format of the files that contain the endpoint definitions. Valid
60             values: CSV, JSON
61              
62              
63             =head2 RegisterEndpoints => Bool
64              
65             Sets whether the endpoints are registered with Amazon Pinpoint when
66             they are imported.
67              
68              
69             =head2 RoleArn => Str
70              
71             The Amazon Resource Name (ARN) of an IAM role that grants Amazon
72             Pinpoint access to the Amazon S3 location that contains the endpoints
73             to import.
74              
75              
76             =head2 S3Url => Str
77              
78             A URL that points to the location within an Amazon S3 bucket that
79             contains the endpoints to import. The location can be a folder or a
80             single file. The URL should follow this format:
81             s3://bucket-name/folder-name/file-name Amazon Pinpoint will import
82             endpoints from this location and any subfolders it contains.
83              
84              
85             =head2 SegmentId => Str
86              
87             The ID of the segment to update if the import job is meant to update an
88             existing segment.
89              
90              
91             =head2 SegmentName => Str
92              
93             A custom name for the segment created by the import job. Use if
94             DefineSegment is true.
95              
96              
97              
98             =head1 SEE ALSO
99              
100             This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
101              
102             =head1 BUGS and CONTRIBUTIONS
103              
104             The source code is located here: https://github.com/pplu/aws-sdk-perl
105              
106             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
107              
108             =cut
109