Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

Creating a Request

data ApplyPendingMaintenanceAction

Represents the input to ApplyPendingMaintenanceAction.

See: newApplyPendingMaintenanceAction smart constructor.

Constructors

ApplyPendingMaintenanceAction'

Fields

• resourceIdentifier :: Text

  The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

• applyAction :: Text

  The pending maintenance action to apply to this resource.

  Valid values: system-update, db-upgrade

• optInType :: Text

  A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

  Valid values:

  • immediate - Apply the maintenance action immediately.
  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Instances

ToHeaders ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

toHeaders :: ApplyPendingMaintenanceAction -> [Header]

ToPath ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

toPath :: ApplyPendingMaintenanceAction -> ByteString

ToQuery ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

toQuery :: ApplyPendingMaintenanceAction -> QueryString

AWSRequest ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Associated Types

type AWSResponse ApplyPendingMaintenanceAction

Methods

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

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

Generic ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Associated Types

type Rep ApplyPendingMaintenanceAction :: Type -> Type

Methods

from :: ApplyPendingMaintenanceAction -> Rep ApplyPendingMaintenanceAction x

to :: Rep ApplyPendingMaintenanceAction x -> ApplyPendingMaintenanceAction

Read ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

readsPrec :: Int -> ReadS ApplyPendingMaintenanceAction

readList :: ReadS [ApplyPendingMaintenanceAction]

readPrec :: ReadPrec ApplyPendingMaintenanceAction

readListPrec :: ReadPrec [ApplyPendingMaintenanceAction]

Show ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

showsPrec :: Int -> ApplyPendingMaintenanceAction -> ShowS

show :: ApplyPendingMaintenanceAction -> String

showList :: [ApplyPendingMaintenanceAction] -> ShowS

NFData ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

rnf :: ApplyPendingMaintenanceAction -> ()

Eq ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

(==) :: ApplyPendingMaintenanceAction -> ApplyPendingMaintenanceAction -> Bool

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

Hashable ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

hashWithSalt :: Int -> ApplyPendingMaintenanceAction -> Int

hash :: ApplyPendingMaintenanceAction -> Int

type AWSResponse ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type AWSResponse ApplyPendingMaintenanceAction = ApplyPendingMaintenanceActionResponse

type Rep ApplyPendingMaintenanceAction

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type Rep ApplyPendingMaintenanceAction = D1 ('MetaData "ApplyPendingMaintenanceAction" "Amazonka.DocumentDB.ApplyPendingMaintenanceAction" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ApplyPendingMaintenanceAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "applyAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "optInType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newApplyPendingMaintenanceAction

Arguments

:: Text

ApplyPendingMaintenanceAction

-> Text

$sel:applyAction:ApplyPendingMaintenanceAction'

-> Text

$sel:optInType:ApplyPendingMaintenanceAction'

-> ApplyPendingMaintenanceAction

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

ApplyPendingMaintenanceAction, applyPendingMaintenanceAction_resourceIdentifier - The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

$sel:applyAction:ApplyPendingMaintenanceAction', applyPendingMaintenanceAction_applyAction - The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

$sel:optInType:ApplyPendingMaintenanceAction', applyPendingMaintenanceAction_optInType - A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

• immediate - Apply the maintenance action immediately.
• next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
• undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Request Lenses

applyPendingMaintenanceAction_resourceIdentifier :: Lens' ApplyPendingMaintenanceAction Text

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

applyPendingMaintenanceAction_applyAction :: Lens' ApplyPendingMaintenanceAction Text

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

applyPendingMaintenanceAction_optInType :: Lens' ApplyPendingMaintenanceAction Text

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

• immediate - Apply the maintenance action immediately.
• next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
• undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Destructuring the Response

data ApplyPendingMaintenanceActionResponse

See: newApplyPendingMaintenanceActionResponse smart constructor.

Constructors

ApplyPendingMaintenanceActionResponse'

Fields

• resourcePendingMaintenanceActions :: Maybe ResourcePendingMaintenanceActions
• httpStatus :: Int

  The response's http status code.

Instances

Generic ApplyPendingMaintenanceActionResponse

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Associated Types

type Rep ApplyPendingMaintenanceActionResponse :: Type -> Type

Methods

from :: ApplyPendingMaintenanceActionResponse -> Rep ApplyPendingMaintenanceActionResponse x

to :: Rep ApplyPendingMaintenanceActionResponse x -> ApplyPendingMaintenanceActionResponse

Read ApplyPendingMaintenanceActionResponse

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

readsPrec :: Int -> ReadS ApplyPendingMaintenanceActionResponse

readList :: ReadS [ApplyPendingMaintenanceActionResponse]

readPrec :: ReadPrec ApplyPendingMaintenanceActionResponse

readListPrec :: ReadPrec [ApplyPendingMaintenanceActionResponse]

Show ApplyPendingMaintenanceActionResponse

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

showsPrec :: Int -> ApplyPendingMaintenanceActionResponse -> ShowS

show :: ApplyPendingMaintenanceActionResponse -> String

showList :: [ApplyPendingMaintenanceActionResponse] -> ShowS

NFData ApplyPendingMaintenanceActionResponse

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

rnf :: ApplyPendingMaintenanceActionResponse -> ()

Eq ApplyPendingMaintenanceActionResponse

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Methods

(==) :: ApplyPendingMaintenanceActionResponse -> ApplyPendingMaintenanceActionResponse -> Bool

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

type Rep ApplyPendingMaintenanceActionResponse

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type Rep ApplyPendingMaintenanceActionResponse = D1 ('MetaData "ApplyPendingMaintenanceActionResponse" "Amazonka.DocumentDB.ApplyPendingMaintenanceAction" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ApplyPendingMaintenanceActionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourcePendingMaintenanceActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcePendingMaintenanceActions)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newApplyPendingMaintenanceActionResponse

Arguments

:: Int

$sel:httpStatus:ApplyPendingMaintenanceActionResponse'

-> ApplyPendingMaintenanceActionResponse

Create a value of ApplyPendingMaintenanceActionResponse 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:resourcePendingMaintenanceActions:ApplyPendingMaintenanceActionResponse', applyPendingMaintenanceActionResponse_resourcePendingMaintenanceActions - Undocumented member.

$sel:httpStatus:ApplyPendingMaintenanceActionResponse', applyPendingMaintenanceActionResponse_httpStatus - The response's http status code.

Response Lenses

applyPendingMaintenanceActionResponse_resourcePendingMaintenanceActions :: Lens' ApplyPendingMaintenanceActionResponse (Maybe ResourcePendingMaintenanceActions)

Undocumented member.

applyPendingMaintenanceActionResponse_httpStatus :: Lens' ApplyPendingMaintenanceActionResponse Int

The response's http status code.