| 1 | |||
| 2 | package Paws::RDS::DownloadDBLogFilePortion; | ||
| 3 | use Moose; | ||
| 4 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has LogFileName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 7 | has NumberOfLines => (is => 'ro', isa => 'Int'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DownloadDBLogFilePortion'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DownloadDBLogFilePortionDetails'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DownloadDBLogFilePortionResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RDS::DownloadDBLogFilePortion - Arguments for method DownloadDBLogFilePortion on L<Paws::RDS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DownloadDBLogFilePortion on the | ||
| 25 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 26 | as arguments to method DownloadDBLogFilePortion. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DownloadDBLogFilePortion. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('RDS'); | ||
| 33 | # To list information about DB log files | ||
| 34 | # This example lists information for the specified log file for the specified DB | ||
| 35 | # instance. | ||
| 36 | my $DownloadDBLogFilePortionDetails = $rds->DownloadDBLogFilePortion( | ||
| 37 | 'DBInstanceIdentifier' => 'mymysqlinstance', | ||
| 38 | 'LogFileName' => 'mysqlUpgrade' | ||
| 39 | ); | ||
| 40 | |||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DownloadDBLogFilePortion> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> DBInstanceIdentifier => Str | ||
| 49 | |||
| 50 | The customer-assigned name of the DB instance that contains the log | ||
| 51 | files you want to list. | ||
| 52 | |||
| 53 | Constraints: | ||
| 54 | |||
| 55 | =over | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | Must match the identifier of an existing DBInstance. | ||
| 60 | |||
| 61 | =back | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> LogFileName => Str | ||
| 67 | |||
| 68 | The name of the log file to be downloaded. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 Marker => Str | ||
| 73 | |||
| 74 | The pagination token provided in the previous request or "0". If the | ||
| 75 | Marker parameter is specified the response includes only records beyond | ||
| 76 | the marker until the end of the file or up to NumberOfLines. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 NumberOfLines => Int | ||
| 81 | |||
| 82 | The number of lines to download. If the number of lines specified | ||
| 83 | results in a file over 1 MB in size, the file is truncated at 1 MB in | ||
| 84 | size. | ||
| 85 | |||
| 86 | If the NumberOfLines parameter is specified, then the block of lines | ||
| 87 | returned can be from the beginning or the end of the log file, | ||
| 88 | depending on the value of the Marker parameter. | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | If neither Marker or NumberOfLines are specified, the entire log file | ||
| 95 | is returned up to a maximum of 10000 lines, starting with the most | ||
| 96 | recent log entries first. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | If NumberOfLines is specified and Marker isn't specified, then the most | ||
| 101 | recent lines from the end of the log file are returned. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | If Marker is specified as "0", then the specified number of lines from | ||
| 106 | the beginning of the log file are returned. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | You can download the log file in blocks of lines by specifying the size | ||
| 111 | of the block using the NumberOfLines parameter, and by specifying a | ||
| 112 | value of "0" for the Marker parameter in your first request. Include | ||
| 113 | the Marker value returned in the response as the Marker value for the | ||
| 114 | next request, continuing until the AdditionalDataPending response | ||
| 115 | element returns false. | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method DownloadDBLogFilePortion in L<Paws::RDS> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |