« blib/lib/Paws/AlexaForBusiness/CreateAddressBookResponse.pm
↑ Summary
blib/lib/Paws/AlexaForBusiness/CreateBusinessReportScheduleResponse.pm »
| 1 | |||
| 2 | package Paws::AlexaForBusiness::CreateBusinessReportSchedule; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has ContentRange => (is => 'ro', isa => 'Paws::AlexaForBusiness::BusinessReportContentRange', required => 1); | ||
| 6 | has Format => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Recurrence => (is => 'ro', isa => 'Paws::AlexaForBusiness::BusinessReportRecurrence'); | ||
| 8 | has S3BucketName => (is => 'ro', isa => 'Str'); | ||
| 9 | has S3KeyPrefix => (is => 'ro', isa => 'Str'); | ||
| 10 | has ScheduleName => (is => 'ro', isa => 'Str'); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::AlexaForBusiness::Tag]'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBusinessReportSchedule'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AlexaForBusiness::CreateBusinessReportScheduleResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::AlexaForBusiness::CreateBusinessReportSchedule - Arguments for method CreateBusinessReportSchedule on L<Paws::AlexaForBusiness> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateBusinessReportSchedule on the | ||
| 29 | L<Alexa For Business|Paws::AlexaForBusiness> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateBusinessReportSchedule. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBusinessReportSchedule. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $a4b = Paws->service('AlexaForBusiness'); | ||
| 37 | my $CreateBusinessReportScheduleResponse = | ||
| 38 | $a4b->CreateBusinessReportSchedule( | ||
| 39 | ContentRange => { | ||
| 40 | Interval => 'ONE_DAY', # values: ONE_DAY, ONE_WEEK, THIRTY_DAYS | ||
| 41 | |||
| 42 | }, | ||
| 43 | Format => 'CSV', | ||
| 44 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 45 | Recurrence => { | ||
| 46 | StartDate => 'MyDate', # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | S3BucketName => 'MyCustomerS3BucketName', # OPTIONAL | ||
| 49 | S3KeyPrefix => 'MyS3KeyPrefix', # OPTIONAL | ||
| 50 | ScheduleName => 'MyBusinessReportScheduleName', # OPTIONAL | ||
| 51 | Tags => [ | ||
| 52 | { | ||
| 53 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 54 | Value => 'MyTagValue', # max: 256 | ||
| 55 | |||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $ScheduleArn = $CreateBusinessReportScheduleResponse->ScheduleArn; | ||
| 63 | |||
| 64 | # Returns a L<Paws::AlexaForBusiness::CreateBusinessReportScheduleResponse> object. | ||
| 65 | |||
| 66 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/a4b/CreateBusinessReportSchedule> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 ClientRequestToken => Str | ||
| 73 | |||
| 74 | The client request token. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> ContentRange => L<Paws::AlexaForBusiness::BusinessReportContentRange> | ||
| 79 | |||
| 80 | The content range of the reports. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> Format => Str | ||
| 85 | |||
| 86 | The format of the generated report (individual CSV files or zipped | ||
| 87 | files of individual files). | ||
| 88 | |||
| 89 | Valid values are: C<"CSV">, C<"CSV_ZIP"> | ||
| 90 | |||
| 91 | =head2 Recurrence => L<Paws::AlexaForBusiness::BusinessReportRecurrence> | ||
| 92 | |||
| 93 | The recurrence of the reports. If this isn't specified, the report will | ||
| 94 | only be delivered one time when the API is called. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 S3BucketName => Str | ||
| 99 | |||
| 100 | The S3 bucket name of the output reports. If this isn't specified, the | ||
| 101 | report can be retrieved from a download link by calling | ||
| 102 | ListBusinessReportSchedule. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 S3KeyPrefix => Str | ||
| 107 | |||
| 108 | The S3 key where the report is delivered. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 ScheduleName => Str | ||
| 113 | |||
| 114 | The name identifier of the schedule. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 Tags => ArrayRef[L<Paws::AlexaForBusiness::Tag>] | ||
| 119 | |||
| 120 | The tags for the business report schedule. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, documenting arguments for method CreateBusinessReportSchedule in L<Paws::AlexaForBusiness> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |