Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpsWorks.DescribeInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Requests a description of a set of instances.

This call accepts only one resource-identifying parameter.

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 about user permissions, see Managing User Permissions.

Creating a Request

data DescribeInstances Source #

See: newDescribeInstances smart constructor.

Constructors

DescribeInstances'

Fields

instanceIds :: Maybe [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.
layerId :: Maybe Text
A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.
stackId :: Maybe Text
A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

Instances

Instances details

ToJSON DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods toJSON :: DescribeInstances -> Value # toEncoding :: DescribeInstances -> Encoding # toJSONList :: [DescribeInstances] -> Value # toEncodingList :: [DescribeInstances] -> Encoding #
ToHeaders DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods toHeaders :: DescribeInstances -> [Header] #
ToPath DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods toPath :: DescribeInstances -> ByteString #
ToQuery DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods toQuery :: DescribeInstances -> QueryString #
AWSRequest DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Associated Types type AWSResponse DescribeInstances # Methods request :: (Service -> Service) -> DescribeInstances -> Request DescribeInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInstances))) #
Generic DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Associated Types type Rep DescribeInstances :: Type -> Type # Methods from :: DescribeInstances -> Rep DescribeInstances x # to :: Rep DescribeInstances x -> DescribeInstances #
Read DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods readsPrec :: Int -> ReadS DescribeInstances # readList :: ReadS [DescribeInstances] # readPrec :: ReadPrec DescribeInstances # readListPrec :: ReadPrec [DescribeInstances] #
Show DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods showsPrec :: Int -> DescribeInstances -> ShowS # show :: DescribeInstances -> String # showList :: [DescribeInstances] -> ShowS #
NFData DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods rnf :: DescribeInstances -> () #
Eq DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods (==) :: DescribeInstances -> DescribeInstances -> Bool # (/=) :: DescribeInstances -> DescribeInstances -> Bool #
Hashable DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods hashWithSalt :: Int -> DescribeInstances -> Int # hash :: DescribeInstances -> Int #
type AWSResponse DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances type AWSResponse DescribeInstances = DescribeInstancesResponse
type Rep DescribeInstances Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances type Rep DescribeInstances = D1 ('MetaData "DescribeInstances" "Amazonka.OpsWorks.DescribeInstances" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "layerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeInstances :: DescribeInstances Source #

Create a value of DescribeInstances 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:

DescribeInstances, describeInstances_instanceIds - 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.

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

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

Request Lenses

describeInstances_instanceIds :: Lens' DescribeInstances (Maybe [Text]) Source #

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.

describeInstances_layerId :: Lens' DescribeInstances (Maybe Text) Source #

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

describeInstances_stackId :: Lens' DescribeInstances (Maybe Text) Source #

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

Destructuring the Response

data DescribeInstancesResponse Source #

Contains the response to a DescribeInstances request.

See: newDescribeInstancesResponse smart constructor.

Constructors

DescribeInstancesResponse'
Fields instances :: Maybe [Instance] An array of `Instance` objects that describe the instances. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeInstancesResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Associated Types type Rep DescribeInstancesResponse :: Type -> Type # Methods from :: DescribeInstancesResponse -> Rep DescribeInstancesResponse x # to :: Rep DescribeInstancesResponse x -> DescribeInstancesResponse #
Read DescribeInstancesResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods readsPrec :: Int -> ReadS DescribeInstancesResponse # readList :: ReadS [DescribeInstancesResponse] # readPrec :: ReadPrec DescribeInstancesResponse # readListPrec :: ReadPrec [DescribeInstancesResponse] #
Show DescribeInstancesResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods showsPrec :: Int -> DescribeInstancesResponse -> ShowS # show :: DescribeInstancesResponse -> String # showList :: [DescribeInstancesResponse] -> ShowS #
NFData DescribeInstancesResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods rnf :: DescribeInstancesResponse -> () #
Eq DescribeInstancesResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances Methods (==) :: DescribeInstancesResponse -> DescribeInstancesResponse -> Bool # (/=) :: DescribeInstancesResponse -> DescribeInstancesResponse -> Bool #
type Rep DescribeInstancesResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeInstances type Rep DescribeInstancesResponse = D1 ('MetaData "DescribeInstancesResponse" "Amazonka.OpsWorks.DescribeInstances" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Instance])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeInstancesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeInstancesResponse'`
-> DescribeInstancesResponse

Create a value of DescribeInstancesResponse 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:instances:DescribeInstancesResponse', describeInstancesResponse_instances - An array of Instance objects that describe the instances.

$sel:httpStatus:DescribeInstancesResponse', describeInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeInstancesResponse_instances :: Lens' DescribeInstancesResponse (Maybe [Instance]) Source #

An array of Instance objects that describe the instances.

describeInstancesResponse_httpStatus :: Lens' DescribeInstancesResponse Int Source #

The response's http status code.