| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::CommandFilter; | ||
| 3 | use Moose; | ||
| 4 | has Key => (is => 'ro', isa => 'Str', request_name => 'key', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Value => (is => 'ro', isa => 'Str', request_name => 'value', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::SSM::CommandFilter | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::SSM::CommandFilter object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Key => $value, ..., Value => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::CommandFilter object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Key | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Describes a command filter. | ||
| 38 | |||
| 39 | An instance ID can't be specified when a command status is C<Pending> | ||
| 40 | because the command hasn't run on the instance yet. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> Key => Str | ||
| 46 | |||
| 47 | The name of the filter. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> Value => Str | ||
| 51 | |||
| 52 | The filter value. Valid values for each filter key are as follows: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | B<InvokedAfter>: Specify a timestamp to limit your results. For | ||
| 59 | example, specify C<2018-07-07T00:00:00Z> to see a list of command | ||
| 60 | executions occurring July 7, 2018, and later. | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | B<InvokedBefore>: Specify a timestamp to limit your results. For | ||
| 65 | example, specify C<2018-07-07T00:00:00Z> to see a list of command | ||
| 66 | executions from before July 7, 2018. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | B<Status>: Specify a valid command status to see a list of all command | ||
| 71 | executions with that status. Status values you can specify include: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<Pending> | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<InProgress> | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<Success> | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<Cancelled> | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<Failed> | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<TimedOut> | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<Cancelling> | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | B<DocumentName>: Specify name of the SSM document for which you want to | ||
| 108 | see command execution results. For example, specify | ||
| 109 | C<AWS-RunPatchBaseline> to see command executions that used this SSM | ||
| 110 | document to perform security patching operations on instances. | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | B<ExecutionStage>: Specify one of the following values: | ||
| 115 | |||
| 116 | =over | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<Executing>: Returns a list of command executions that are currently | ||
| 121 | still running. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<Complete>: Returns a list of command executions that have already | ||
| 126 | completed. | ||
| 127 | |||
| 128 | =back | ||
| 129 | |||
| 130 | =back | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |