amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeInstanceStatus

Description

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeInstanceStatus Source #

See: newDescribeInstanceStatus smart constructor.

Constructors

DescribeInstanceStatus' 

Fields

  • dryRun :: Maybe Bool

    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.

  • filters :: Maybe [Filter]

    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).
  • includeAllInstances :: Maybe Bool

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

    Default: false

  • instanceIds :: Maybe [Text]

    The instance IDs.

    Default: Describes all your instances.

    Constraints: Maximum 100 explicitly specified instance IDs.

  • maxResults :: Maybe Int

    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.

  • nextToken :: Maybe Text

    The token to retrieve the next page of results.

Instances

Instances details
ToHeaders DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

toHeaders :: DescribeInstanceStatus -> [Header] #

ToPath DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

toPath :: DescribeInstanceStatus -> ByteString #

ToQuery DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

toQuery :: DescribeInstanceStatus -> QueryString #

AWSPager DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

page :: DescribeInstanceStatus -> AWSResponse DescribeInstanceStatus -> Maybe DescribeInstanceStatus #

AWSRequest DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Associated Types

type AWSResponse DescribeInstanceStatus #

Methods

request :: (Service -> Service) -> DescribeInstanceStatus -> Request DescribeInstanceStatus #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeInstanceStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInstanceStatus))) #

Generic DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Associated Types

type Rep DescribeInstanceStatus :: Type -> Type #

Methods

from :: DescribeInstanceStatus -> Rep DescribeInstanceStatus x #

to :: Rep DescribeInstanceStatus x -> DescribeInstanceStatus #

Read DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

readsPrec :: Int -> ReadS DescribeInstanceStatus #

readList :: ReadS [DescribeInstanceStatus] #

readPrec :: ReadPrec DescribeInstanceStatus #

readListPrec :: ReadPrec [DescribeInstanceStatus] #

Show DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

showsPrec :: Int -> DescribeInstanceStatus -> ShowS #

show :: DescribeInstanceStatus -> String #

showList :: [DescribeInstanceStatus] -> ShowS #

NFData DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

rnf :: DescribeInstanceStatus -> () #

Eq DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

(==) :: DescribeInstanceStatus -> DescribeInstanceStatus -> Bool #

(/=) :: DescribeInstanceStatus -> DescribeInstanceStatus -> Bool #

Hashable DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

hashWithSalt :: Int -> DescribeInstanceStatus -> Int #

hash :: DescribeInstanceStatus -> Int #

type AWSResponse DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

type AWSResponse DescribeInstanceStatus = DescribeInstanceStatusResponse
type Rep DescribeInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

type Rep DescribeInstanceStatus = D1 ('MetaData "DescribeInstanceStatus" "Amazonka.EC2.DescribeInstanceStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeInstanceStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "includeAllInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeInstanceStatus :: DescribeInstanceStatus Source #

Create a value of DescribeInstanceStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeInstanceStatus', describeInstanceStatus_dryRun - 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.

$sel:filters:DescribeInstanceStatus', describeInstanceStatus_filters - 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).

$sel:includeAllInstances:DescribeInstanceStatus', describeInstanceStatus_includeAllInstances - When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

DescribeInstanceStatus, describeInstanceStatus_instanceIds - The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

$sel:maxResults:DescribeInstanceStatus', describeInstanceStatus_maxResults - 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.

DescribeInstanceStatus, describeInstanceStatus_nextToken - The token to retrieve the next page of results.

Request Lenses

describeInstanceStatus_dryRun :: Lens' DescribeInstanceStatus (Maybe Bool) Source #

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.

describeInstanceStatus_filters :: Lens' DescribeInstanceStatus (Maybe [Filter]) Source #

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).

describeInstanceStatus_includeAllInstances :: Lens' DescribeInstanceStatus (Maybe Bool) Source #

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

Default: false

describeInstanceStatus_instanceIds :: Lens' DescribeInstanceStatus (Maybe [Text]) Source #

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

describeInstanceStatus_maxResults :: Lens' DescribeInstanceStatus (Maybe Int) Source #

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.

describeInstanceStatus_nextToken :: Lens' DescribeInstanceStatus (Maybe Text) Source #

The token to retrieve the next page of results.

Destructuring the Response

data DescribeInstanceStatusResponse Source #

See: newDescribeInstanceStatusResponse smart constructor.

Constructors

DescribeInstanceStatusResponse' 

Fields

Instances

Instances details
Generic DescribeInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Associated Types

type Rep DescribeInstanceStatusResponse :: Type -> Type #

Methods

from :: DescribeInstanceStatusResponse -> Rep DescribeInstanceStatusResponse x #

to :: Rep DescribeInstanceStatusResponse x -> DescribeInstanceStatusResponse #

Read DescribeInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

readsPrec :: Int -> ReadS DescribeInstanceStatusResponse #

readList :: ReadS [DescribeInstanceStatusResponse] #

readPrec :: ReadPrec DescribeInstanceStatusResponse #

readListPrec :: ReadPrec [DescribeInstanceStatusResponse] #

Show DescribeInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

showsPrec :: Int -> DescribeInstanceStatusResponse -> ShowS #

show :: DescribeInstanceStatusResponse -> String #

showList :: [DescribeInstanceStatusResponse] -> ShowS #

NFData DescribeInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

rnf :: DescribeInstanceStatusResponse -> () #

Eq DescribeInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

Methods

(==) :: DescribeInstanceStatusResponse -> DescribeInstanceStatusResponse -> Bool #

(/=) :: DescribeInstanceStatusResponse -> DescribeInstanceStatusResponse -> Bool #

type Rep DescribeInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceStatus

type Rep DescribeInstanceStatusResponse = D1 ('MetaData "DescribeInstanceStatusResponse" "Amazonka.EC2.DescribeInstanceStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeInstanceStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceStatus])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeInstanceStatusResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeInstanceStatusResponse'

-> DescribeInstanceStatusResponse 

Create a value of DescribeInstanceStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:instanceStatuses:DescribeInstanceStatusResponse', describeInstanceStatusResponse_instanceStatuses - Information about the status of the instances.

DescribeInstanceStatus, describeInstanceStatusResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeInstanceStatusResponse', describeInstanceStatusResponse_httpStatus - The response's http status code.

Response Lenses

describeInstanceStatusResponse_instanceStatuses :: Lens' DescribeInstanceStatusResponse (Maybe [InstanceStatus]) Source #

Information about the status of the instances.

describeInstanceStatusResponse_nextToken :: Lens' DescribeInstanceStatusResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeInstanceStatusResponse_httpStatus :: Lens' DescribeInstanceStatusResponse Int Source #

The response's http status code.