libZSservicesZSamazonka-opsworksZSamazonka-opsworks
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpsWorks.DescribeInstances

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.

Synopsis

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.

  • stackId :: Maybe Text

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

  • layerId :: Maybe Text

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

Instances

Instances details
Eq DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Methods

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

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

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 #

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 #

NFData DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Methods

rnf :: DescribeInstances -> () #

Hashable DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Methods

hashWithSalt :: Int -> DescribeInstances -> Int #

hash :: DescribeInstances -> Int #

ToJSON DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Methods

toJSON :: DescribeInstances -> Value #

toEncoding :: DescribeInstances -> Encoding #

toJSONList :: [DescribeInstances] -> Value #

toEncodingList :: [DescribeInstances] -> Encoding #

AWSRequest DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Associated Types

type AWSResponse DescribeInstances #

Methods

request :: DescribeInstances -> Request DescribeInstances #

response :: MonadResource m => Logger -> Service -> Proxy DescribeInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInstances))) #

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 #

type Rep DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

type Rep DescribeInstances = D1 ('MetaData "DescribeInstances" "Amazonka.OpsWorks.DescribeInstances" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "DescribeInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "layerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

type AWSResponse DescribeInstances = DescribeInstancesResponse

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:

$sel:instanceIds: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.

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

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

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

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.

Destructuring the Response

data DescribeInstancesResponse Source #

Contains the response to a DescribeInstances request.

See: newDescribeInstancesResponse smart constructor.

Constructors

DescribeInstancesResponse' 

Fields

Instances

Instances details
Eq DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Methods

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

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

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 #

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 #

NFData DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Methods

rnf :: DescribeInstancesResponse -> () #

type Rep DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

type Rep DescribeInstancesResponse = D1 ('MetaData "DescribeInstancesResponse" "Amazonka.OpsWorks.DescribeInstances" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" '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.