« blib/lib/Paws/EC2/ReplaceTransitGatewayRouteResult.pm
↑ Summary
blib/lib/Paws/EC2/RequestLaunchTemplateData.pm »
| 1 | |||
| 2 | package Paws::EC2::ReportInstanceStatus; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 5 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | ||
| 6 | has EndTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'endTime' ); | ||
| 7 | has Instances => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'instanceId' , required => 1); | ||
| 8 | has ReasonCodes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'reasonCode' , required => 1); | ||
| 9 | has StartTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'startTime' ); | ||
| 10 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status' , required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ReportInstanceStatus'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::EC2::ReportInstanceStatus - Arguments for method ReportInstanceStatus on L<Paws::EC2> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ReportInstanceStatus on the | ||
| 28 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 29 | as arguments to method ReportInstanceStatus. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ReportInstanceStatus. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ec2 = Paws->service('EC2'); | ||
| 36 | $ec2->ReportInstanceStatus( | ||
| 37 | Instances => [ 'MyInstanceId', ... ], | ||
| 38 | ReasonCodes => [ | ||
| 39 | 'instance-stuck-in-state', | ||
| 40 | ... # values: instance-stuck-in-state, unresponsive, not-accepting-credentials, password-not-available, performance-network, performance-instance-store, performance-ebs-volume, performance-other, other | ||
| 41 | ], | ||
| 42 | Status => 'ok', | ||
| 43 | Description => 'MyString', # OPTIONAL | ||
| 44 | DryRun => 1, # OPTIONAL | ||
| 45 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 46 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ReportInstanceStatus> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Description => Str | ||
| 56 | |||
| 57 | Descriptive text about the health state of your instance. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 DryRun => Bool | ||
| 62 | |||
| 63 | Checks whether you have the required permissions for the action, | ||
| 64 | without actually making the request, and provides an error response. If | ||
| 65 | you have the required permissions, the error response is | ||
| 66 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 EndTime => Str | ||
| 71 | |||
| 72 | The time at which the reported instance health state ended. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Instances => ArrayRef[Str|Undef] | ||
| 77 | |||
| 78 | The instances. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> ReasonCodes => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | The reason codes that describe the health state of your instance. | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<instance-stuck-in-state>: My instance is stuck in a state. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<unresponsive>: My instance is unresponsive. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<not-accepting-credentials>: My instance is not accepting my | ||
| 99 | credentials. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<password-not-available>: A password is not available for my instance. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<performance-network>: My instance is experiencing performance | ||
| 108 | problems that I believe are network related. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<performance-instance-store>: My instance is experiencing performance | ||
| 113 | problems that I believe are related to the instance stores. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<performance-ebs-volume>: My instance is experiencing performance | ||
| 118 | problems that I believe are related to an EBS volume. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<performance-other>: My instance is experiencing performance problems. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<other>: [explain using the description parameter] | ||
| 127 | |||
| 128 | =back | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 StartTime => Str | ||
| 134 | |||
| 135 | The time at which the reported instance health state began. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 B<REQUIRED> Status => Str | ||
| 140 | |||
| 141 | The status of all instances listed. | ||
| 142 | |||
| 143 | Valid values are: C<"ok">, C<"impaired"> | ||
| 144 | |||
| 145 | |||
| 146 | =head1 SEE ALSO | ||
| 147 | |||
| 148 | This class forms part of L<Paws>, documenting arguments for method ReportInstanceStatus in L<Paws::EC2> | ||
| 149 | |||
| 150 | =head1 BUGS and CONTRIBUTIONS | ||
| 151 | |||
| 152 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 153 | |||
| 154 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 155 | |||
| 156 | =cut | ||
| 157 |