« blib/lib/Paws/Lightsail/GetContainerImagesResult.pm
↑ Summary
blib/lib/Paws/Lightsail/GetContainerLogResult.pm »
| 1 | |||
| 2 | package Paws::Lightsail::GetContainerLog; | ||
| 3 | use Moose; | ||
| 4 | has ContainerName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'containerName' , required => 1); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'endTime' ); | ||
| 6 | has FilterPattern => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterPattern' ); | ||
| 7 | has PageToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pageToken' ); | ||
| 8 | has ServiceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceName' , required => 1); | ||
| 9 | has StartTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'startTime' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetContainerLog'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::GetContainerLogResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Lightsail::GetContainerLog - Arguments for method GetContainerLog on L<Paws::Lightsail> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetContainerLog on the | ||
| 27 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 28 | as arguments to method GetContainerLog. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetContainerLog. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $lightsail = Paws->service('Lightsail'); | ||
| 35 | my $GetContainerLogResult = $lightsail->GetContainerLog( | ||
| 36 | ContainerName => 'Mystring', | ||
| 37 | ServiceName => 'MyContainerServiceName', | ||
| 38 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 39 | FilterPattern => 'Mystring', # OPTIONAL | ||
| 40 | PageToken => 'Mystring', # OPTIONAL | ||
| 41 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $LogEvents = $GetContainerLogResult->LogEvents; | ||
| 46 | my $NextPageToken = $GetContainerLogResult->NextPageToken; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Lightsail::GetContainerLogResult> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetContainerLog> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> ContainerName => Str | ||
| 57 | |||
| 58 | The name of the container that is either running or previously ran on | ||
| 59 | the container service for which to return a log. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 EndTime => Str | ||
| 64 | |||
| 65 | The end of the time interval for which to get log data. | ||
| 66 | |||
| 67 | Constraints: | ||
| 68 | |||
| 69 | =over | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | Specified in Coordinated Universal Time (UTC). | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | Specified in the Unix time format. | ||
| 78 | |||
| 79 | For example, if you wish to use an end time of October 1, 2018, at 9 PM | ||
| 80 | UTC, specify C<1538427600> as the end time. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | You can convert a human-friendly time to Unix time format using a | ||
| 85 | converter like Epoch converter (https://www.epochconverter.com/). | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 FilterPattern => Str | ||
| 90 | |||
| 91 | The pattern to use to filter the returned log events to a specific | ||
| 92 | term. | ||
| 93 | |||
| 94 | The following are a few examples of filter patterns that you can | ||
| 95 | specify: | ||
| 96 | |||
| 97 | =over | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | To return all log events, specify a filter pattern of C<"">. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | To exclude log events that contain the C<ERROR> term, and return all | ||
| 106 | other log events, specify a filter pattern of C<"-ERROR">. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | To return log events that contain the C<ERROR> term, specify a filter | ||
| 111 | pattern of C<"ERROR">. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | To return log events that contain both the C<ERROR> and C<Exception> | ||
| 116 | terms, specify a filter pattern of C<"ERROR Exception">. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | To return log events that contain the C<ERROR> I<or> the C<Exception> | ||
| 121 | term, specify a filter pattern of C<"?ERROR ?Exception">. | ||
| 122 | |||
| 123 | =back | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 PageToken => Str | ||
| 129 | |||
| 130 | The token to advance to the next page of results from your request. | ||
| 131 | |||
| 132 | To get a page token, perform an initial C<GetContainerLog> request. If | ||
| 133 | your results are paginated, the response will return a next page token | ||
| 134 | that you can specify as the page token in a subsequent request. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> ServiceName => Str | ||
| 139 | |||
| 140 | The name of the container service for which to get a container log. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 StartTime => Str | ||
| 145 | |||
| 146 | The start of the time interval for which to get log data. | ||
| 147 | |||
| 148 | Constraints: | ||
| 149 | |||
| 150 | =over | ||
| 151 | |||
| 152 | =item * | ||
| 153 | |||
| 154 | Specified in Coordinated Universal Time (UTC). | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | Specified in the Unix time format. | ||
| 159 | |||
| 160 | For example, if you wish to use a start time of October 1, 2018, at 8 | ||
| 161 | PM UTC, specify C<1538424000> as the start time. | ||
| 162 | |||
| 163 | =back | ||
| 164 | |||
| 165 | You can convert a human-friendly time to Unix time format using a | ||
| 166 | converter like Epoch converter (https://www.epochconverter.com/). | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head1 SEE ALSO | ||
| 172 | |||
| 173 | This class forms part of L<Paws>, documenting arguments for method GetContainerLog in L<Paws::Lightsail> | ||
| 174 | |||
| 175 | =head1 BUGS and CONTRIBUTIONS | ||
| 176 | |||
| 177 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 178 | |||
| 179 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 180 | |||
| 181 | =cut | ||
| 182 |