amazonka-docdb-2.0: Amazon DocumentDB with MongoDB compatibility 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.DocumentDB.DescribePendingMaintenanceActions

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
ToHeaders DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

ToPath DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

ToQuery DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

AWSPager DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

AWSRequest DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Generic DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Associated Types

type Rep DescribePendingMaintenanceActions :: Type -> Type #

Read DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Show DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

NFData DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Eq DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Hashable DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type AWSResponse DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActions = D1 ('MetaData "DescribePendingMaintenanceActions" "Amazonka.DocumentDB.DescribePendingMaintenanceActions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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)))))

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.

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.

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

Instances

Instances details
Generic DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Read DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Show DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

NFData DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Eq DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActionsResponse = D1 ('MetaData "DescribePendingMaintenanceActionsResponse" "Amazonka.DocumentDB.DescribePendingMaintenanceActions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribePendingMaintenanceActionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pendingMaintenanceActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourcePendingMaintenanceActions])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePendingMaintenanceActionsResponse Source #

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:

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

$sel:httpStatus:DescribePendingMaintenanceActionsResponse', describePendingMaintenanceActionsResponse_httpStatus - The response's http status code.

Response Lenses

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.