« blib/lib/Paws/CloudWatchLogs/CancelExportTask.pm
↑ Summary
blib/lib/Paws/CloudWatchLogs/CreateExportTaskResponse.pm »
| 1 | |||
| 2 | package Paws::CloudWatchLogs::CreateExportTask; | ||
| 3 | use Moose; | ||
| 4 | has Destination => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destination' , required => 1); | ||
| 5 | has DestinationPrefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destinationPrefix' ); | ||
| 6 | has From => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'from' , required => 1); | ||
| 7 | has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' , required => 1); | ||
| 8 | has LogStreamNamePrefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logStreamNamePrefix' ); | ||
| 9 | has TaskName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskName' ); | ||
| 10 | has To => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'to' , required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateExportTask'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchLogs::CreateExportTaskResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CloudWatchLogs::CreateExportTask - Arguments for method CreateExportTask on L<Paws::CloudWatchLogs> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateExportTask on the | ||
| 28 | L<Amazon CloudWatch Logs|Paws::CloudWatchLogs> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateExportTask. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateExportTask. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $logs = Paws->service('CloudWatchLogs'); | ||
| 36 | my $CreateExportTaskResponse = $logs->CreateExportTask( | ||
| 37 | Destination => 'MyExportDestinationBucket', | ||
| 38 | From => 1, | ||
| 39 | LogGroupName => 'MyLogGroupName', | ||
| 40 | To => 1, | ||
| 41 | DestinationPrefix => 'MyExportDestinationPrefix', # OPTIONAL | ||
| 42 | LogStreamNamePrefix => 'MyLogStreamName', # OPTIONAL | ||
| 43 | TaskName => 'MyExportTaskName', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $TaskId = $CreateExportTaskResponse->TaskId; | ||
| 48 | |||
| 49 | # Returns a L<Paws::CloudWatchLogs::CreateExportTaskResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/logs/CreateExportTask> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> Destination => Str | ||
| 58 | |||
| 59 | The name of S3 bucket for the exported log data. The bucket must be in | ||
| 60 | the same AWS region. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 DestinationPrefix => Str | ||
| 65 | |||
| 66 | The prefix used as the start of the key for every object exported. If | ||
| 67 | you don't specify a value, the default is C<exportedlogs>. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> From => Int | ||
| 72 | |||
| 73 | The start time of the range for the request, expressed as the number of | ||
| 74 | milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp | ||
| 75 | earlier than this time are not exported. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> LogGroupName => Str | ||
| 80 | |||
| 81 | The name of the log group. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 LogStreamNamePrefix => Str | ||
| 86 | |||
| 87 | Export only log streams that match the provided prefix. If you don't | ||
| 88 | specify a value, no prefix filter is applied. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 TaskName => Str | ||
| 93 | |||
| 94 | The name of the export task. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> To => Int | ||
| 99 | |||
| 100 | The end time of the range for the request, expreswatchlogsdocused as | ||
| 101 | the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with | ||
| 102 | a timestamp later than this time are not exported. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, documenting arguments for method CreateExportTask in L<Paws::CloudWatchLogs> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |