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.DocumentDB.DescribeDBInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

This operation returns paginated results.

Synopsis

data DescribeDBInstances = DescribeDBInstances' {
- dbInstanceIdentifier :: Maybe Text
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeDBInstances :: DescribeDBInstances
describeDBInstances_dbInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text)
describeDBInstances_filters :: Lens' DescribeDBInstances (Maybe [Filter])
describeDBInstances_marker :: Lens' DescribeDBInstances (Maybe Text)
describeDBInstances_maxRecords :: Lens' DescribeDBInstances (Maybe Int)
data DescribeDBInstancesResponse = DescribeDBInstancesResponse' {
- dbInstances :: Maybe [DBInstance]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeDBInstancesResponse :: Int -> DescribeDBInstancesResponse
describeDBInstancesResponse_dbInstances :: Lens' DescribeDBInstancesResponse (Maybe [DBInstance])
describeDBInstancesResponse_marker :: Lens' DescribeDBInstancesResponse (Maybe Text)
describeDBInstancesResponse_httpStatus :: Lens' DescribeDBInstancesResponse Int

Creating a Request

data DescribeDBInstances Source #

Represents the input to DescribeDBInstances.

See: newDescribeDBInstances smart constructor.

Constructors

DescribeDBInstances'

Fields

dbInstanceIdentifier :: Maybe Text
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
Constraints:
- If provided, must match the identifier of an existing DBInstance.
filters :: Maybe [Filter]
A filter that specifies one or more instances to describe.
Supported filters:
- db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
- db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
marker :: Maybe Text
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.

Instances

Instances details

ToHeaders DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods toHeaders :: DescribeDBInstances -> [Header] #
ToPath DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods toPath :: DescribeDBInstances -> ByteString #
ToQuery DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods toQuery :: DescribeDBInstances -> QueryString #
AWSPager DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods page :: DescribeDBInstances -> AWSResponse DescribeDBInstances -> Maybe DescribeDBInstances #
AWSRequest DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Associated Types type AWSResponse DescribeDBInstances # Methods request :: (Service -> Service) -> DescribeDBInstances -> Request DescribeDBInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBInstances))) #
Generic DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Associated Types type Rep DescribeDBInstances :: Type -> Type # Methods from :: DescribeDBInstances -> Rep DescribeDBInstances x # to :: Rep DescribeDBInstances x -> DescribeDBInstances #
Read DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods readsPrec :: Int -> ReadS DescribeDBInstances # readList :: ReadS [DescribeDBInstances] # readPrec :: ReadPrec DescribeDBInstances # readListPrec :: ReadPrec [DescribeDBInstances] #
Show DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods showsPrec :: Int -> DescribeDBInstances -> ShowS # show :: DescribeDBInstances -> String # showList :: [DescribeDBInstances] -> ShowS #
NFData DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods rnf :: DescribeDBInstances -> () #
Eq DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods (==) :: DescribeDBInstances -> DescribeDBInstances -> Bool # (/=) :: DescribeDBInstances -> DescribeDBInstances -> Bool #
Hashable DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances Methods hashWithSalt :: Int -> DescribeDBInstances -> Int # hash :: DescribeDBInstances -> Int #
type AWSResponse DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances type AWSResponse DescribeDBInstances = DescribeDBInstancesResponse
type Rep DescribeDBInstances Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBInstances type Rep DescribeDBInstances = D1 ('MetaData "DescribeDBInstances" "Amazonka.DocumentDB.DescribeDBInstances" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeDBInstances :: DescribeDBInstances Source #

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

DescribeDBInstances, describeDBInstances_dbInstanceIdentifier - The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

If provided, must match the identifier of an existing DBInstance.

$sel:filters:DescribeDBInstances', describeDBInstances_filters - A filter that specifies one or more instances to describe.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

DescribeDBInstances, describeDBInstances_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeDBInstances', describeDBInstances_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeDBInstances_dbInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text) Source #

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

If provided, must match the identifier of an existing DBInstance.

describeDBInstances_filters :: Lens' DescribeDBInstances (Maybe [Filter]) Source #

A filter that specifies one or more instances to describe.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

describeDBInstances_marker :: Lens' DescribeDBInstances (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBInstances_maxRecords :: Lens' DescribeDBInstances (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeDBInstancesResponse Source #

Represents the output of DescribeDBInstances.

See: newDescribeDBInstancesResponse smart constructor.

Constructors

DescribeDBInstancesResponse'
Fields dbInstances :: Maybe [DBInstance] Detailed information about one or more instances. marker :: Maybe Text An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeDBInstancesResponse Source #

Arguments

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

Create a value of DescribeDBInstancesResponse 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:dbInstances:DescribeDBInstancesResponse', describeDBInstancesResponse_dbInstances - Detailed information about one or more instances.

DescribeDBInstances, describeDBInstancesResponse_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:httpStatus:DescribeDBInstancesResponse', describeDBInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeDBInstancesResponse_dbInstances :: Lens' DescribeDBInstancesResponse (Maybe [DBInstance]) Source #

Detailed information about one or more instances.

describeDBInstancesResponse_marker :: Lens' DescribeDBInstancesResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBInstancesResponse_httpStatus :: Lens' DescribeDBInstancesResponse Int Source #

The response's http status code.