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