« blib/lib/Paws/SSMIncidents/ListTagsForResourceResponse.pm
↑ Summary
blib/lib/Paws/SSMIncidents/ListTimelineEventsOutput.pm »
| 1 | |||
| 2 | package Paws::SSMIncidents::ListTimelineEvents; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::SSMIncidents::Filter]', traits => ['NameInRequest'], request_name => 'filters'); | ||
| 5 | has IncidentRecordArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'incidentRecordArn', required => 1); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 8 | has SortBy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sortBy'); | ||
| 9 | has SortOrder => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sortOrder'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTimelineEvents'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/listTimelineEvents'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMIncidents::ListTimelineEventsOutput'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SSMIncidents::ListTimelineEvents - Arguments for method ListTimelineEvents on L<Paws::SSMIncidents> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListTimelineEvents on the | ||
| 28 | L<AWS Systems Manager Incident Manager|Paws::SSMIncidents> service. Use the attributes of this class | ||
| 29 | as arguments to method ListTimelineEvents. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTimelineEvents. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ssm-incidents = Paws->service('SSMIncidents'); | ||
| 36 | my $ListTimelineEventsOutput = $ssm -incidents->ListTimelineEvents( | ||
| 37 | IncidentRecordArn => 'MyArn', | ||
| 38 | Filters => [ | ||
| 39 | { | ||
| 40 | Condition => { | ||
| 41 | After => '1970-01-01T01:00:00', # OPTIONAL | ||
| 42 | Before => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | Equals => { | ||
| 44 | IntegerValues => [ 1, ... ], # max: 100; OPTIONAL | ||
| 45 | StringValues => [ | ||
| 46 | 'MyStringListMemberString', ... # max: 1000 | ||
| 47 | ], # max: 100; OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | }, | ||
| 50 | Key => 'MyFilterKeyString', # max: 50 | ||
| 51 | |||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # OPTIONAL | ||
| 55 | MaxResults => 1, # OPTIONAL | ||
| 56 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 57 | SortBy => 'EVENT_TIME', # OPTIONAL | ||
| 58 | SortOrder => 'ASCENDING', # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $EventSummaries = $ListTimelineEventsOutput->EventSummaries; | ||
| 63 | my $NextToken = $ListTimelineEventsOutput->NextToken; | ||
| 64 | |||
| 65 | # Returns a L<Paws::SSMIncidents::ListTimelineEventsOutput> object. | ||
| 66 | |||
| 67 | 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. | ||
| 68 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents/ListTimelineEvents> | ||
| 69 | |||
| 70 | =head1 ATTRIBUTES | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Filters => ArrayRef[L<Paws::SSMIncidents::Filter>] | ||
| 74 | |||
| 75 | Filters the timeline events based on the provided conditional values. | ||
| 76 | You can filter timeline events using the following keys: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<eventTime> | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<eventType> | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> IncidentRecordArn => Str | ||
| 94 | |||
| 95 | The Amazon Resource Name (ARN) of the incident that the event is part | ||
| 96 | of. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 MaxResults => Int | ||
| 101 | |||
| 102 | The maximum number of results per page. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 NextToken => Str | ||
| 107 | |||
| 108 | The pagination token to continue to the next page of results. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 SortBy => Str | ||
| 113 | |||
| 114 | Sort by the specified key value pair. | ||
| 115 | |||
| 116 | Valid values are: C<"EVENT_TIME"> | ||
| 117 | |||
| 118 | =head2 SortOrder => Str | ||
| 119 | |||
| 120 | Sorts the order of timeline events by the value specified in the | ||
| 121 | C<sortBy> field. | ||
| 122 | |||
| 123 | Valid values are: C<"ASCENDING">, C<"DESCENDING"> | ||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, documenting arguments for method ListTimelineEvents in L<Paws::SSMIncidents> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |