Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.DescribePendingMaintenanceActions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePendingMaintenanceActions Source #

Represents the input to DescribePendingMaintenanceActions.

See: newDescribePendingMaintenanceActions smart constructor.

Constructors

DescribePendingMaintenanceActions'

Fields

filters :: Maybe [Filter]
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
- db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
- db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances 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.
resourceIdentifier :: Maybe Text
The ARN of a resource to return pending maintenance actions for.

Instances

Instances details

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

newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions Source #

Create a value of DescribePendingMaintenanceActions 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:filters:DescribePendingMaintenanceActions', describePendingMaintenanceActions_filters - A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

$sel:marker:DescribePendingMaintenanceActions', describePendingMaintenanceActions_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:DescribePendingMaintenanceActions', describePendingMaintenanceActions_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.

$sel:resourceIdentifier:DescribePendingMaintenanceActions', describePendingMaintenanceActions_resourceIdentifier - The ARN of a resource to return pending maintenance actions for.

Request Lenses

describePendingMaintenanceActions_filters :: Lens' DescribePendingMaintenanceActions (Maybe [Filter]) Source #

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

describePendingMaintenanceActions_marker :: Lens' DescribePendingMaintenanceActions (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.

describePendingMaintenanceActions_maxRecords :: Lens' DescribePendingMaintenanceActions (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.

describePendingMaintenanceActions_resourceIdentifier :: Lens' DescribePendingMaintenanceActions (Maybe Text) Source #

The ARN of a resource to return pending maintenance actions for.

Destructuring the Response

data DescribePendingMaintenanceActionsResponse Source #

Represents the output of DescribePendingMaintenanceActions.

See: newDescribePendingMaintenanceActionsResponse smart constructor.

Constructors

DescribePendingMaintenanceActionsResponse'
Fields pendingMaintenanceActions :: Maybe [ResourcePendingMaintenanceActions] The maintenance actions to be applied. 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

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

newDescribePendingMaintenanceActionsResponse Source #

Arguments

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

Create a value of DescribePendingMaintenanceActionsResponse 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:pendingMaintenanceActions:DescribePendingMaintenanceActionsResponse', describePendingMaintenanceActionsResponse_pendingMaintenanceActions - The maintenance actions to be applied.

$sel:marker:DescribePendingMaintenanceActions', describePendingMaintenanceActionsResponse_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:DescribePendingMaintenanceActionsResponse', describePendingMaintenanceActionsResponse_httpStatus - The response's http status code.

Response Lenses

describePendingMaintenanceActionsResponse_pendingMaintenanceActions :: Lens' DescribePendingMaintenanceActionsResponse (Maybe [ResourcePendingMaintenanceActions]) Source #

The maintenance actions to be applied.

describePendingMaintenanceActionsResponse_marker :: Lens' DescribePendingMaintenanceActionsResponse (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.

describePendingMaintenanceActionsResponse_httpStatus :: Lens' DescribePendingMaintenanceActionsResponse Int Source #

The response's http status code.