GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::EC2::DescribeInstanceStatus(3) User Contributed Perl Documentation Paws::EC2::DescribeInstanceStatus(3)

Paws::EC2::DescribeInstanceStatus - Arguments for method DescribeInstanceStatus on Paws::EC2

This class represents the parameters used for calling the method DescribeInstanceStatus on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method DescribeInstanceStatus.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstanceStatus.

    my $ec2 = Paws->service('EC2');
    # To describe the status of an instance
    # This example describes the current status of the specified instance.
    my $DescribeInstanceStatusResult =
      $ec2->DescribeInstanceStatus( 'InstanceIds' => ['i-1234567890abcdef0'] );
    # Results:
    my $InstanceStatuses = $DescribeInstanceStatusResult->InstanceStatuses;
    # Returns a L<Paws::EC2::DescribeInstanceStatusResult> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeInstanceStatus>

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation".

The filters.

  • "availability-zone" - The Availability Zone of the instance.
  • "event.code" - The code for the scheduled event ("instance-reboot" | "system-reboot" | "system-maintenance" | "instance-retirement" | "instance-stop").
  • "event.description" - A description of the event.
  • "event.instance-event-id" - The ID of the event whose date and time you are modifying.
  • "event.not-after" - The latest end time for the scheduled event (for example, "2014-09-15T17:15:20.000Z").
  • "event.not-before" - The earliest start time for the scheduled event (for example, "2014-09-15T17:15:20.000Z").
  • "event.not-before-deadline" - The deadline for starting the event (for example, "2014-09-15T17:15:20.000Z").
  • "instance-state-code" - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
  • "instance-state-name" - The state of the instance ("pending" | "running" | "shutting-down" | "terminated" | "stopping" | "stopped").
  • "instance-status.reachability" - Filters on instance status where the name is "reachability" ("passed" | "failed" | "initializing" | "insufficient-data").
  • "instance-status.status" - The status of the instance ("ok" | "impaired" | "initializing" | "insufficient-data" | "not-applicable").
  • "system-status.reachability" - Filters on system status where the name is "reachability" ("passed" | "failed" | "initializing" | "insufficient-data").
  • "system-status.status" - The system status of the instance ("ok" | "impaired" | "initializing" | "insufficient-data" | "not-applicable").

When "true", includes the health status for all instances. When "false", includes the health status for running instances only.

Default: "false"

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned "NextToken" value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

The token to retrieve the next page of results.

This class forms part of Paws, documenting arguments for method DescribeInstanceStatus in Paws::EC2

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.