« blib/lib/Paws/Pinpoint/ExportJobRequest.pm
↑ Summary
blib/lib/Paws/Pinpoint/ExportJobResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::ExportJobResource; | ||
| 3 | use Moose; | ||
| 4 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has S3UrlPrefix => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has SegmentId => (is => 'ro', isa => 'Str'); | ||
| 7 | has SegmentVersion => (is => 'ro', isa => 'Int'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Pinpoint::ExportJobResource | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Pinpoint::ExportJobResource object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { RoleArn => $value, ..., SegmentVersion => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::ExportJobResource object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->RoleArn | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Provides information about the resource settings for a job that exports | ||
| 40 | endpoint definitions to a file. The file can be added directly to an | ||
| 41 | Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon | ||
| 42 | Pinpoint API or downloaded directly to a computer by using the Amazon | ||
| 43 | Pinpoint console. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> RoleArn => Str | ||
| 49 | |||
| 50 | The Amazon Resource Name (ARN) of the AWS Identity and Access | ||
| 51 | Management (IAM) role that authorized Amazon Pinpoint to access the | ||
| 52 | Amazon S3 location where the endpoint definitions were exported to. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> S3UrlPrefix => Str | ||
| 56 | |||
| 57 | The URL of the location in an Amazon Simple Storage Service (Amazon S3) | ||
| 58 | bucket where the endpoint definitions were exported to. This location | ||
| 59 | is typically a folder that contains multiple files. The URL should be | ||
| 60 | in the following format: s3://bucket-name/folder-name/. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 SegmentId => Str | ||
| 64 | |||
| 65 | The identifier for the segment that the endpoint definitions were | ||
| 66 | exported from. If this value isn't present, Amazon Pinpoint exported | ||
| 67 | definitions for all the endpoints that are associated with the | ||
| 68 | application. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 SegmentVersion => Int | ||
| 72 | |||
| 73 | The version of the segment that the endpoint definitions were exported | ||
| 74 | from. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |