amazonka-opsworks-2.0: Amazon OpsWorks 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.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.

  • 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

ToHeaders DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

ToPath DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

ToQuery DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

AWSRequest DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Associated Types

type AWSResponse DescribeInstances #

Generic DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Associated Types

type Rep DescribeInstances :: Type -> Type #

Read DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Show DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

NFData DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Methods

rnf :: DescribeInstances -> () #

Eq DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Hashable DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

type AWSResponse DescribeInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

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

Instances details
Generic DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Associated Types

type Rep DescribeInstancesResponse :: Type -> Type #

Read DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Show DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

NFData DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

Eq DescribeInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeInstances

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 #

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.