Amazonka.DocumentDB.DescribePendingMaintenanceActions

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

This operation returns paginated results.

Creating a Request

data DescribePendingMaintenanceActions

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

ToHeaders DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

toHeaders :: DescribePendingMaintenanceActions -> [Header]

ToPath DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

toPath :: DescribePendingMaintenanceActions -> ByteString

ToQuery DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

toQuery :: DescribePendingMaintenanceActions -> QueryString

AWSPager DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

page :: DescribePendingMaintenanceActions -> AWSResponse DescribePendingMaintenanceActions -> Maybe DescribePendingMaintenanceActions

AWSRequest DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Associated Types

type AWSResponse DescribePendingMaintenanceActions

Methods

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

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

Generic DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Associated Types

type Rep DescribePendingMaintenanceActions :: Type -> Type

Methods

from :: DescribePendingMaintenanceActions -> Rep DescribePendingMaintenanceActions x

to :: Rep DescribePendingMaintenanceActions x -> DescribePendingMaintenanceActions

Read DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

readsPrec :: Int -> ReadS DescribePendingMaintenanceActions

readList :: ReadS [DescribePendingMaintenanceActions]

readPrec :: ReadPrec DescribePendingMaintenanceActions

readListPrec :: ReadPrec [DescribePendingMaintenanceActions]

Show DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

showsPrec :: Int -> DescribePendingMaintenanceActions -> ShowS

show :: DescribePendingMaintenanceActions -> String

showList :: [DescribePendingMaintenanceActions] -> ShowS

NFData DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

rnf :: DescribePendingMaintenanceActions -> ()

Eq DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

(==) :: DescribePendingMaintenanceActions -> DescribePendingMaintenanceActions -> Bool

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

Hashable DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

hashWithSalt :: Int -> DescribePendingMaintenanceActions -> Int

hash :: DescribePendingMaintenanceActions -> Int

type AWSResponse DescribePendingMaintenanceActions

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type AWSResponse DescribePendingMaintenanceActions = DescribePendingMaintenanceActionsResponse

type Rep DescribePendingMaintenanceActions

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

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])

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)

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)

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)

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

Destructuring the Response

data DescribePendingMaintenanceActionsResponse

Represents the output of DescribePendingMaintenanceActions.

See: newDescribePendingMaintenanceActionsResponse smart constructor.

Constructors

DescribePendingMaintenanceActionsResponse'

Fields

• 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.

• pendingMaintenanceActions :: Maybe [ResourcePendingMaintenanceActions]

  The maintenance actions to be applied.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribePendingMaintenanceActionsResponse

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Associated Types

type Rep DescribePendingMaintenanceActionsResponse :: Type -> Type

Methods

from :: DescribePendingMaintenanceActionsResponse -> Rep DescribePendingMaintenanceActionsResponse x

to :: Rep DescribePendingMaintenanceActionsResponse x -> DescribePendingMaintenanceActionsResponse

Read DescribePendingMaintenanceActionsResponse

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

readsPrec :: Int -> ReadS DescribePendingMaintenanceActionsResponse

readList :: ReadS [DescribePendingMaintenanceActionsResponse]

readPrec :: ReadPrec DescribePendingMaintenanceActionsResponse

readListPrec :: ReadPrec [DescribePendingMaintenanceActionsResponse]

Show DescribePendingMaintenanceActionsResponse

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

showsPrec :: Int -> DescribePendingMaintenanceActionsResponse -> ShowS

show :: DescribePendingMaintenanceActionsResponse -> String

showList :: [DescribePendingMaintenanceActionsResponse] -> ShowS

NFData DescribePendingMaintenanceActionsResponse

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

rnf :: DescribePendingMaintenanceActionsResponse -> ()

Eq DescribePendingMaintenanceActionsResponse

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Methods

(==) :: DescribePendingMaintenanceActionsResponse -> DescribePendingMaintenanceActionsResponse -> Bool

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

type Rep DescribePendingMaintenanceActionsResponse

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

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:

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)

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_pendingMaintenanceActions :: Lens' DescribePendingMaintenanceActionsResponse (Maybe [ResourcePendingMaintenanceActions])

The maintenance actions to be applied.

describePendingMaintenanceActionsResponse_httpStatus :: Lens' DescribePendingMaintenanceActionsResponse Int

The response's http status code.