Network.AWS.OpsWorks.DescribeInstances

Requests a description of a set of instances.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Creating a Request

describeInstances :: DescribeInstances

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

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

• diInstanceIds
• diStackId
• diLayerId

data DescribeInstances

See: describeInstances smart constructor.

Instances

Eq DescribeInstances

Methods

(==) :: DescribeInstances -> DescribeInstances -> Bool

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

Data DescribeInstances

Methods

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

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

toConstr :: DescribeInstances -> Constr

dataTypeOf :: DescribeInstances -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeInstances

Methods

readsPrec :: Int -> ReadS DescribeInstances

readList :: ReadS [DescribeInstances]

readPrec :: ReadPrec DescribeInstances

readListPrec :: ReadPrec [DescribeInstances]

Show DescribeInstances

Methods

showsPrec :: Int -> DescribeInstances -> ShowS

show :: DescribeInstances -> String

showList :: [DescribeInstances] -> ShowS

Generic DescribeInstances

Associated Types

type Rep DescribeInstances :: * -> *

Methods

from :: DescribeInstances -> Rep DescribeInstances x

to :: Rep DescribeInstances x -> DescribeInstances

ToJSON DescribeInstances

Methods

toJSON :: DescribeInstances -> Value

toEncoding :: DescribeInstances -> Encoding

Hashable DescribeInstances

Methods

hashWithSalt :: Int -> DescribeInstances -> Int

hash :: DescribeInstances -> Int

NFData DescribeInstances

Methods

rnf :: DescribeInstances -> ()

AWSRequest DescribeInstances

Associated Types

type Rs DescribeInstances :: *

Methods

request :: DescribeInstances -> Request DescribeInstances

response :: MonadResource m => Logger -> Service -> Proxy * DescribeInstances -> ClientResponse -> m (Response DescribeInstances)

ToPath DescribeInstances

Methods

toPath :: DescribeInstances -> ByteString

ToHeaders DescribeInstances

Methods

toHeaders :: DescribeInstances -> [Header]

ToQuery DescribeInstances

Methods

toQuery :: DescribeInstances -> QueryString

type Rep DescribeInstances

type Rep DescribeInstances = D1 (MetaData "DescribeInstances" "Network.AWS.OpsWorks.DescribeInstances" "amazonka-opsworks-1.4.2-H1NWw2Q6WTvKlcJsv19jGW" False) (C1 (MetaCons "DescribeInstances'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_diInstanceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_diStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_diLayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs DescribeInstances

type Rs DescribeInstances = DescribeInstancesResponse

Request Lenses

diInstanceIds :: Lens' DescribeInstances [Text]

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

diStackId :: Lens' DescribeInstances (Maybe Text)

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

diLayerId :: Lens' DescribeInstances (Maybe Text)

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

Destructuring the Response

describeInstancesResponse

Arguments

:: Int

dirsResponseStatus

-> DescribeInstancesResponse

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

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

• dirsInstances
• dirsResponseStatus

data DescribeInstancesResponse

Contains the response to a DescribeInstances request.

See: describeInstancesResponse smart constructor.

Instances

Eq DescribeInstancesResponse

Methods

(==) :: DescribeInstancesResponse -> DescribeInstancesResponse -> Bool

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

Data DescribeInstancesResponse

Methods

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

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

toConstr :: DescribeInstancesResponse -> Constr

dataTypeOf :: DescribeInstancesResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeInstancesResponse

Methods

readsPrec :: Int -> ReadS DescribeInstancesResponse

readList :: ReadS [DescribeInstancesResponse]

readPrec :: ReadPrec DescribeInstancesResponse

readListPrec :: ReadPrec [DescribeInstancesResponse]

Show DescribeInstancesResponse

Methods

showsPrec :: Int -> DescribeInstancesResponse -> ShowS

show :: DescribeInstancesResponse -> String

showList :: [DescribeInstancesResponse] -> ShowS

Generic DescribeInstancesResponse

Associated Types

type Rep DescribeInstancesResponse :: * -> *

Methods

from :: DescribeInstancesResponse -> Rep DescribeInstancesResponse x

to :: Rep DescribeInstancesResponse x -> DescribeInstancesResponse

NFData DescribeInstancesResponse

Methods

rnf :: DescribeInstancesResponse -> ()

type Rep DescribeInstancesResponse

type Rep DescribeInstancesResponse = D1 (MetaData "DescribeInstancesResponse" "Network.AWS.OpsWorks.DescribeInstances" "amazonka-opsworks-1.4.2-H1NWw2Q6WTvKlcJsv19jGW" False) (C1 (MetaCons "DescribeInstancesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dirsInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Instance]))) (S1 (MetaSel (Just Symbol "_dirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dirsInstances :: Lens' DescribeInstancesResponse [Instance]

An array of Instance objects that describe the instances.

dirsResponseStatus :: Lens' DescribeInstancesResponse Int

The response status code.