Network.AWS.EC2.DescribeInstanceStatus

Describes the status of one or more 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 Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide .

This operation returns paginated results.

Creating a Request

describeInstanceStatus :: DescribeInstanceStatus

Creates a value of DescribeInstanceStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• disIncludeAllInstances - When true , includes the health status for all instances. When false , includes the health status for running instances only. Default: false
• disFilters - One or more 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.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 ). * instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value 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 ).
• disNextToken - The token to retrieve the next page of results.
• disInstanceIds - One or more instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.
• disDryRun - 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 .
• disMaxResults - 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.

data DescribeInstanceStatus

Contains the parameters for DescribeInstanceStatus.

See: describeInstanceStatus smart constructor.

Instances

Eq DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

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

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

Data DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeInstanceStatus -> c DescribeInstanceStatus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeInstanceStatus

toConstr :: DescribeInstanceStatus -> Constr

dataTypeOf :: DescribeInstanceStatus -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeInstanceStatus)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeInstanceStatus)

gmapT :: (forall b. Data b => b -> b) -> DescribeInstanceStatus -> DescribeInstanceStatus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstanceStatus -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstanceStatus -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeInstanceStatus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeInstanceStatus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeInstanceStatus -> m DescribeInstanceStatus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstanceStatus -> m DescribeInstanceStatus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstanceStatus -> m DescribeInstanceStatus

Read DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

readsPrec :: Int -> ReadS DescribeInstanceStatus

readList :: ReadS [DescribeInstanceStatus]

readPrec :: ReadPrec DescribeInstanceStatus

readListPrec :: ReadPrec [DescribeInstanceStatus]

Show DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

showsPrec :: Int -> DescribeInstanceStatus -> ShowS

show :: DescribeInstanceStatus -> String

showList :: [DescribeInstanceStatus] -> ShowS

Generic DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Associated Types

type Rep DescribeInstanceStatus :: Type -> Type

Methods

from :: DescribeInstanceStatus -> Rep DescribeInstanceStatus x

to :: Rep DescribeInstanceStatus x -> DescribeInstanceStatus

Hashable DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

hashWithSalt :: Int -> DescribeInstanceStatus -> Int

hash :: DescribeInstanceStatus -> Int

AWSPager DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

page :: DescribeInstanceStatus -> Rs DescribeInstanceStatus -> Maybe DescribeInstanceStatus

AWSRequest DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Associated Types

type Rs DescribeInstanceStatus :: Type

Methods

request :: DescribeInstanceStatus -> Request DescribeInstanceStatus

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeInstanceStatus -> ClientResponse -> m (Response DescribeInstanceStatus)

ToHeaders DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

toHeaders :: DescribeInstanceStatus -> [Header]

ToPath DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

toPath :: DescribeInstanceStatus -> ByteString

ToQuery DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

toQuery :: DescribeInstanceStatus -> QueryString

NFData DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

rnf :: DescribeInstanceStatus -> ()

type Rep DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

type Rep DescribeInstanceStatus = D1 (MetaData "DescribeInstanceStatus" "Network.AWS.EC2.DescribeInstanceStatus" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "DescribeInstanceStatus'" PrefixI True) ((S1 (MetaSel (Just "_disIncludeAllInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_disFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 (MetaSel (Just "_disNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_disInstanceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_disDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_disMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))

type Rs DescribeInstanceStatus

Defined in Network.AWS.EC2.DescribeInstanceStatus

type Rs DescribeInstanceStatus = DescribeInstanceStatusResponse

Request Lenses

disIncludeAllInstances :: Lens' DescribeInstanceStatus (Maybe Bool)

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

disFilters :: Lens' DescribeInstanceStatus [Filter]

One or more 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.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 ). * instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value 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 ).

disNextToken :: Lens' DescribeInstanceStatus (Maybe Text)

The token to retrieve the next page of results.

disInstanceIds :: Lens' DescribeInstanceStatus [Text]

One or more instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.

disDryRun :: Lens' DescribeInstanceStatus (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 .

disMaxResults :: Lens' DescribeInstanceStatus (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.

Destructuring the Response

describeInstanceStatusResponse

Arguments

:: Int

disrsResponseStatus

-> DescribeInstanceStatusResponse

Creates a value of DescribeInstanceStatusResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• disrsInstanceStatuses - One or more instance status descriptions.
• disrsNextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.
• disrsResponseStatus - -- | The response status code.

data DescribeInstanceStatusResponse

Contains the output of DescribeInstanceStatus.

See: describeInstanceStatusResponse smart constructor.

Instances

Eq DescribeInstanceStatusResponse

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

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

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

Data DescribeInstanceStatusResponse

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeInstanceStatusResponse -> c DescribeInstanceStatusResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeInstanceStatusResponse

toConstr :: DescribeInstanceStatusResponse -> Constr

dataTypeOf :: DescribeInstanceStatusResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeInstanceStatusResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeInstanceStatusResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeInstanceStatusResponse -> DescribeInstanceStatusResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstanceStatusResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstanceStatusResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeInstanceStatusResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeInstanceStatusResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeInstanceStatusResponse -> m DescribeInstanceStatusResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstanceStatusResponse -> m DescribeInstanceStatusResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstanceStatusResponse -> m DescribeInstanceStatusResponse

Read DescribeInstanceStatusResponse

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

readsPrec :: Int -> ReadS DescribeInstanceStatusResponse

readList :: ReadS [DescribeInstanceStatusResponse]

readPrec :: ReadPrec DescribeInstanceStatusResponse

readListPrec :: ReadPrec [DescribeInstanceStatusResponse]

Show DescribeInstanceStatusResponse

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

showsPrec :: Int -> DescribeInstanceStatusResponse -> ShowS

show :: DescribeInstanceStatusResponse -> String

showList :: [DescribeInstanceStatusResponse] -> ShowS

Generic DescribeInstanceStatusResponse

Defined in Network.AWS.EC2.DescribeInstanceStatus

Associated Types

type Rep DescribeInstanceStatusResponse :: Type -> Type

Methods

from :: DescribeInstanceStatusResponse -> Rep DescribeInstanceStatusResponse x

to :: Rep DescribeInstanceStatusResponse x -> DescribeInstanceStatusResponse

NFData DescribeInstanceStatusResponse

Defined in Network.AWS.EC2.DescribeInstanceStatus

Methods

rnf :: DescribeInstanceStatusResponse -> ()

type Rep DescribeInstanceStatusResponse

Defined in Network.AWS.EC2.DescribeInstanceStatus

type Rep DescribeInstanceStatusResponse = D1 (MetaData "DescribeInstanceStatusResponse" "Network.AWS.EC2.DescribeInstanceStatus" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "DescribeInstanceStatusResponse'" PrefixI True) (S1 (MetaSel (Just "_disrsInstanceStatuses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [InstanceStatus])) :*: (S1 (MetaSel (Just "_disrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_disrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

disrsInstanceStatuses :: Lens' DescribeInstanceStatusResponse [InstanceStatus]

One or more instance status descriptions.

disrsNextToken :: Lens' DescribeInstanceStatusResponse (Maybe Text)

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

disrsResponseStatus :: Lens' DescribeInstanceStatusResponse Int

• - | The response status code.