File Coverage

blib/lib/Paws/MarketplaceCommerceAnalytics.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::MarketplaceCommerceAnalytics;
2 1     1   4398 use Moose;
  1         4  
  1         8  
3             sub service { 'marketplacecommerceanalytics' }
4             sub version { '2015-07-01' }
5             sub target_prefix { 'MarketplaceCommerceAnalytics20150701' }
6             sub json_version { "1.1" }
7             has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8             has retry => (is => 'ro', isa => 'HashRef', default => sub {
9             { base => 'rand', type => 'exponential', growth_factor => 2 }
10             });
11             has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12             ] });
13              
14             with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller', 'Paws::Net::JsonResponse';
15              
16            
17             sub GenerateDataSet {
18             my $self = shift;
19             my $call_object = $self->new_with_coercions('Paws::MarketplaceCommerceAnalytics::GenerateDataSet', @_);
20             return $self->caller->do_call($self, $call_object);
21             }
22             sub StartSupportDataExport {
23             my $self = shift;
24             my $call_object = $self->new_with_coercions('Paws::MarketplaceCommerceAnalytics::StartSupportDataExport', @_);
25             return $self->caller->do_call($self, $call_object);
26             }
27            
28              
29              
30             sub operations { qw/GenerateDataSet StartSupportDataExport / }
31              
32             1;
33              
34             ### main pod documentation begin ###
35              
36             =head1 NAME
37              
38             Paws::MarketplaceCommerceAnalytics - Perl Interface to AWS AWS Marketplace Commerce Analytics
39              
40             =head1 SYNOPSIS
41              
42             use Paws;
43              
44             my $obj = Paws->service('MarketplaceCommerceAnalytics');
45             my $res = $obj->Method(
46             Arg1 => $val1,
47             Arg2 => [ 'V1', 'V2' ],
48             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
49             # of the arguments type
50             Arg3 => { Att1 => 'Val1' },
51             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
52             # the constructor of the arguments type
53             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
54             );
55              
56             =head1 DESCRIPTION
57              
58             Provides AWS Marketplace business intelligence data on-demand.
59              
60             =head1 METHODS
61              
62             =head2 GenerateDataSet(DataSetPublicationDate => Str, DataSetType => Str, DestinationS3BucketName => Str, RoleNameArn => Str, SnsTopicArn => Str, [CustomerDefinedValues => L<Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues>, DestinationS3Prefix => Str])
63              
64             Each argument is described in detail in: L<Paws::MarketplaceCommerceAnalytics::GenerateDataSet>
65              
66             Returns: a L<Paws::MarketplaceCommerceAnalytics::GenerateDataSetResult> instance
67              
68             Given a data set type and data set publication date, asynchronously
69             publishes the requested data set to the specified S3 bucket and
70             notifies the specified SNS topic once the data is available. Returns a
71             unique request identifier that can be used to correlate requests with
72             notifications from the SNS topic. Data sets will be published in
73             comma-separated values (CSV) format with the file name
74             {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already
75             exists (e.g. if the same data set is requested twice), the original
76             file will be overwritten by the new file. Requires a Role with an
77             attached permissions policy providing Allow permissions for the
78             following actions: s3:PutObject, s3:GetBucketLocation,
79             sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
80              
81              
82             =head2 StartSupportDataExport(DataSetType => Str, DestinationS3BucketName => Str, FromDate => Str, RoleNameArn => Str, SnsTopicArn => Str, [CustomerDefinedValues => L<Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues>, DestinationS3Prefix => Str])
83              
84             Each argument is described in detail in: L<Paws::MarketplaceCommerceAnalytics::StartSupportDataExport>
85              
86             Returns: a L<Paws::MarketplaceCommerceAnalytics::StartSupportDataExportResult> instance
87              
88             Given a data set type and a from date, asynchronously publishes the
89             requested customer support data to the specified S3 bucket and notifies
90             the specified SNS topic once the data is available. Returns a unique
91             request identifier that can be used to correlate requests with
92             notifications from the SNS topic. Data sets will be published in
93             comma-separated values (CSV) format with the file name
94             {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same
95             name already exists (e.g. if the same data set is requested twice), the
96             original file will be overwritten by the new file. Requires a Role with
97             an attached permissions policy providing Allow permissions for the
98             following actions: s3:PutObject, s3:GetBucketLocation,
99             sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
100              
101              
102              
103              
104             =head1 PAGINATORS
105              
106             Paginator methods are helpers that repetively call methods that return partial results
107              
108              
109              
110              
111             =head1 SEE ALSO
112              
113             This service class forms part of L<Paws>
114              
115             =head1 BUGS and CONTRIBUTIONS
116              
117             The source code is located here: https://github.com/pplu/aws-sdk-perl
118              
119             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120              
121             =cut
122