ApplyPendingMaintenanceAction - Amazon DocumentDB
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ApplyPendingMaintenanceAction

Type d'action de maintenance en attente à appliquer à la ressource.

Syntaxe de la demande

POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

applyAction

L'action de maintenance en attente à appliquer à la ressource.

Les actions valides sont :

  • ENGINE_UPDATE

  • ENGINE_UPGRADE

  • SECURITY_UPDATE

  • OS_UPDATE

  • MASTER_USER_PASSWORD_UPDATE

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.

Obligatoire : oui

optInType

Valeur qui spécifie le type de demande de confirmation de l'acceptation ou annule cette dernière. Un type demande de confirmation de l'acceptation de type IMMEDIATE ne peut pas être annulée.

Type : String

Valeurs valides : IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN

Obligatoire : oui

resourceArn

Nom de ressource Amazon DocumentDB (ARN) Amazon DocumentDB de la ressource à laquelle s'applique l'action de maintenance en attente.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.

Obligatoire : oui

applyOn

Une date précise pour appliquer l'action de maintenance en attente. Obligatoire si opt-in-type a pour valeur APPLY_ON. Format : yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

resourcePendingMaintenanceAction

Résultat de l'action de maintenance en attente appliquée.

Type : objet ResourcePendingMaintenanceAction

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.

Code d’état HTTP : 403

ConflictException

Il y a eu un conflit d'accès.

Code d’état HTTP : 409

InternalServerException

Une erreur interne s'est produite au niveau du serveur.

Code d’état HTTP : 500

ResourceNotFoundException

La ressource spécifiée n'a pas pu être localisée.

Code d’état HTTP : 404

ThrottlingException

ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.

Code d’état HTTP : 429

ValidationException

Structure définissant une exception de validation.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :