« blib/lib/Paws/SSM/CommandInvocation.pm
↑ Summary
blib/lib/Paws/SSM/ComplianceExecutionSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::CommandPlugin; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str'); | ||
| 5 | has Output => (is => 'ro', isa => 'Str'); | ||
| 6 | has OutputS3BucketName => (is => 'ro', isa => 'Str'); | ||
| 7 | has OutputS3KeyPrefix => (is => 'ro', isa => 'Str'); | ||
| 8 | has OutputS3Region => (is => 'ro', isa => 'Str'); | ||
| 9 | has ResponseCode => (is => 'ro', isa => 'Int'); | ||
| 10 | has ResponseFinishDateTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has ResponseStartDateTime => (is => 'ro', isa => 'Str'); | ||
| 12 | has StandardErrorUrl => (is => 'ro', isa => 'Str'); | ||
| 13 | has StandardOutputUrl => (is => 'ro', isa => 'Str'); | ||
| 14 | has Status => (is => 'ro', isa => 'Str'); | ||
| 15 | has StatusDetails => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SSM::CommandPlugin | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::SSM::CommandPlugin object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { Name => $value, ..., StatusDetails => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::CommandPlugin object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->Name | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Describes plugin details. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Name => Str | ||
| 53 | |||
| 54 | The name of the plugin. Must be one of the following: aws:updateAgent, | ||
| 55 | aws:domainjoin, aws:applications, aws:runPowerShellScript, | ||
| 56 | aws:psmodule, aws:cloudWatch, aws:runShellScript, or | ||
| 57 | aws:updateSSMAgent. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Output => Str | ||
| 61 | |||
| 62 | Output of the plugin execution. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 OutputS3BucketName => Str | ||
| 66 | |||
| 67 | The S3 bucket where the responses to the command executions should be | ||
| 68 | stored. This was requested when issuing the command. For example, in | ||
| 69 | the following response: | ||
| 70 | |||
| 71 | doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript | ||
| 72 | |||
| 73 | doc-example-bucket is the name of the S3 bucket; | ||
| 74 | |||
| 75 | ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; | ||
| 76 | |||
| 77 | i-02573cafcfEXAMPLE is the instance ID; | ||
| 78 | |||
| 79 | awsrunShellScript is the name of the plugin. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 OutputS3KeyPrefix => Str | ||
| 83 | |||
| 84 | The S3 directory path inside the bucket where the responses to the | ||
| 85 | command executions should be stored. This was requested when issuing | ||
| 86 | the command. For example, in the following response: | ||
| 87 | |||
| 88 | doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript | ||
| 89 | |||
| 90 | doc-example-bucket is the name of the S3 bucket; | ||
| 91 | |||
| 92 | ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; | ||
| 93 | |||
| 94 | i-02573cafcfEXAMPLE is the instance ID; | ||
| 95 | |||
| 96 | awsrunShellScript is the name of the plugin. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 OutputS3Region => Str | ||
| 100 | |||
| 101 | (Deprecated) You can no longer specify this parameter. The system | ||
| 102 | ignores it. Instead, Systems Manager automatically determines the S3 | ||
| 103 | bucket region. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ResponseCode => Int | ||
| 107 | |||
| 108 | A numeric response code generated after running the plugin. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 ResponseFinishDateTime => Str | ||
| 112 | |||
| 113 | The time the plugin stopped running. Could stop prematurely if, for | ||
| 114 | example, a cancel command was sent. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 ResponseStartDateTime => Str | ||
| 118 | |||
| 119 | The time the plugin started running. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 StandardErrorUrl => Str | ||
| 123 | |||
| 124 | The URL for the complete text written by the plugin to stderr. If | ||
| 125 | execution is not yet complete, then this string is empty. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 StandardOutputUrl => Str | ||
| 129 | |||
| 130 | The URL for the complete text written by the plugin to stdout in Amazon | ||
| 131 | S3. If the S3 bucket for the command was not specified, then this | ||
| 132 | string is empty. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 Status => Str | ||
| 136 | |||
| 137 | The status of this plugin. You can run a document with multiple | ||
| 138 | plugins. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 StatusDetails => Str | ||
| 142 | |||
| 143 | A detailed status of the plugin execution. StatusDetails includes more | ||
| 144 | information than Status because it includes states resulting from error | ||
| 145 | and concurrency control parameters. StatusDetails can show different | ||
| 146 | results than Status. For more information about these statuses, see | ||
| 147 | Understanding command statuses | ||
| 148 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) | ||
| 149 | in the I<AWS Systems Manager User Guide>. StatusDetails can be one of | ||
| 150 | the following values: | ||
| 151 | |||
| 152 | =over | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | Pending: The command has not been sent to the instance. | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | In Progress: The command has been sent to the instance but has not | ||
| 161 | reached a terminal state. | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | Success: The execution of the command or plugin was successfully | ||
| 166 | completed. This is a terminal state. | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | Delivery Timed Out: The command was not delivered to the instance | ||
| 171 | before the delivery timeout expired. Delivery timeouts do not count | ||
| 172 | against the parent command's MaxErrors limit, but they do contribute to | ||
| 173 | whether the parent command status is Success or Incomplete. This is a | ||
| 174 | terminal state. | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | Execution Timed Out: Command execution started on the instance, but the | ||
| 179 | execution was not complete before the execution timeout expired. | ||
| 180 | Execution timeouts count against the MaxErrors limit of the parent | ||
| 181 | command. This is a terminal state. | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | Failed: The command was not successful on the instance. For a plugin, | ||
| 186 | this indicates that the result code was not zero. For a command | ||
| 187 | invocation, this indicates that the result code for one or more plugins | ||
| 188 | was not zero. Invocation failures count against the MaxErrors limit of | ||
| 189 | the parent command. This is a terminal state. | ||
| 190 | |||
| 191 | =item * | ||
| 192 | |||
| 193 | Canceled: The command was terminated before it was completed. This is a | ||
| 194 | terminal state. | ||
| 195 | |||
| 196 | =item * | ||
| 197 | |||
| 198 | Undeliverable: The command can't be delivered to the instance. The | ||
| 199 | instance might not exist, or it might not be responding. Undeliverable | ||
| 200 | invocations don't count against the parent command's MaxErrors limit, | ||
| 201 | and they don't contribute to whether the parent command status is | ||
| 202 | Success or Incomplete. This is a terminal state. | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | Terminated: The parent command exceeded its MaxErrors limit and | ||
| 207 | subsequent command invocations were canceled by the system. This is a | ||
| 208 | terminal state. | ||
| 209 | |||
| 210 | =back | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | |||
| 215 | =head1 SEE ALSO | ||
| 216 | |||
| 217 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 218 | |||
| 219 | =head1 BUGS and CONTRIBUTIONS | ||
| 220 | |||
| 221 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 222 | |||
| 223 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 224 | |||
| 225 | =cut | ||
| 226 |