Amazonka.OpsWorks.DescribeRdsDbInstances

Describes Amazon RDS instances.

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.

This call accepts only one resource-identifying parameter.

Creating a Request

data DescribeRdsDbInstances

See: newDescribeRdsDbInstances smart constructor.

Constructors

DescribeRdsDbInstances'

Fields

• rdsDbInstanceArns :: Maybe [Text]

  An array containing the ARNs of the instances to be described.

• stackId :: Text

  The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

Instances

ToJSON DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

toJSON :: DescribeRdsDbInstances -> Value

toEncoding :: DescribeRdsDbInstances -> Encoding

toJSONList :: [DescribeRdsDbInstances] -> Value

toEncodingList :: [DescribeRdsDbInstances] -> Encoding

ToHeaders DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

toHeaders :: DescribeRdsDbInstances -> [Header]

ToPath DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

toPath :: DescribeRdsDbInstances -> ByteString

ToQuery DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

toQuery :: DescribeRdsDbInstances -> QueryString

AWSRequest DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Associated Types

type AWSResponse DescribeRdsDbInstances

Methods

request :: (Service -> Service) -> DescribeRdsDbInstances -> Request DescribeRdsDbInstances

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRdsDbInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRdsDbInstances)))

Generic DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Associated Types

type Rep DescribeRdsDbInstances :: Type -> Type

Methods

from :: DescribeRdsDbInstances -> Rep DescribeRdsDbInstances x

to :: Rep DescribeRdsDbInstances x -> DescribeRdsDbInstances

Read DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

readsPrec :: Int -> ReadS DescribeRdsDbInstances

readList :: ReadS [DescribeRdsDbInstances]

readPrec :: ReadPrec DescribeRdsDbInstances

readListPrec :: ReadPrec [DescribeRdsDbInstances]

Show DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

showsPrec :: Int -> DescribeRdsDbInstances -> ShowS

show :: DescribeRdsDbInstances -> String

showList :: [DescribeRdsDbInstances] -> ShowS

NFData DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

rnf :: DescribeRdsDbInstances -> ()

Eq DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

(==) :: DescribeRdsDbInstances -> DescribeRdsDbInstances -> Bool

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

Hashable DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

hashWithSalt :: Int -> DescribeRdsDbInstances -> Int

hash :: DescribeRdsDbInstances -> Int

type AWSResponse DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

type AWSResponse DescribeRdsDbInstances = DescribeRdsDbInstancesResponse

type Rep DescribeRdsDbInstances

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

type Rep DescribeRdsDbInstances = D1 ('MetaData "DescribeRdsDbInstances" "Amazonka.OpsWorks.DescribeRdsDbInstances" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeRdsDbInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rdsDbInstanceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeRdsDbInstances

Arguments

:: Text

DescribeRdsDbInstances

-> DescribeRdsDbInstances

Create a value of DescribeRdsDbInstances 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:rdsDbInstanceArns:DescribeRdsDbInstances', describeRdsDbInstances_rdsDbInstanceArns - An array containing the ARNs of the instances to be described.

DescribeRdsDbInstances, describeRdsDbInstances_stackId - The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

Request Lenses

describeRdsDbInstances_rdsDbInstanceArns :: Lens' DescribeRdsDbInstances (Maybe [Text])

An array containing the ARNs of the instances to be described.

describeRdsDbInstances_stackId :: Lens' DescribeRdsDbInstances Text

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

Destructuring the Response

data DescribeRdsDbInstancesResponse

Contains the response to a DescribeRdsDbInstances request.

See: newDescribeRdsDbInstancesResponse smart constructor.

Constructors

DescribeRdsDbInstancesResponse'

Fields

• rdsDbInstances :: Maybe [RdsDbInstance]

  An a array of RdsDbInstance objects that describe the instances.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeRdsDbInstancesResponse

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Associated Types

type Rep DescribeRdsDbInstancesResponse :: Type -> Type

Methods

from :: DescribeRdsDbInstancesResponse -> Rep DescribeRdsDbInstancesResponse x

to :: Rep DescribeRdsDbInstancesResponse x -> DescribeRdsDbInstancesResponse

Read DescribeRdsDbInstancesResponse

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

readsPrec :: Int -> ReadS DescribeRdsDbInstancesResponse

readList :: ReadS [DescribeRdsDbInstancesResponse]

readPrec :: ReadPrec DescribeRdsDbInstancesResponse

readListPrec :: ReadPrec [DescribeRdsDbInstancesResponse]

Show DescribeRdsDbInstancesResponse

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

showsPrec :: Int -> DescribeRdsDbInstancesResponse -> ShowS

show :: DescribeRdsDbInstancesResponse -> String

showList :: [DescribeRdsDbInstancesResponse] -> ShowS

NFData DescribeRdsDbInstancesResponse

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

rnf :: DescribeRdsDbInstancesResponse -> ()

Eq DescribeRdsDbInstancesResponse

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

(==) :: DescribeRdsDbInstancesResponse -> DescribeRdsDbInstancesResponse -> Bool

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

type Rep DescribeRdsDbInstancesResponse

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

type Rep DescribeRdsDbInstancesResponse = D1 ('MetaData "DescribeRdsDbInstancesResponse" "Amazonka.OpsWorks.DescribeRdsDbInstances" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeRdsDbInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rdsDbInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RdsDbInstance])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeRdsDbInstancesResponse

Arguments

:: Int

$sel:httpStatus:DescribeRdsDbInstancesResponse'

-> DescribeRdsDbInstancesResponse

Create a value of DescribeRdsDbInstancesResponse 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:rdsDbInstances:DescribeRdsDbInstancesResponse', describeRdsDbInstancesResponse_rdsDbInstances - An a array of RdsDbInstance objects that describe the instances.

$sel:httpStatus:DescribeRdsDbInstancesResponse', describeRdsDbInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeRdsDbInstancesResponse_rdsDbInstances :: Lens' DescribeRdsDbInstancesResponse (Maybe [RdsDbInstance])

An a array of RdsDbInstance objects that describe the instances.

describeRdsDbInstancesResponse_httpStatus :: Lens' DescribeRdsDbInstancesResponse Int

The response's http status code.