ApplyPendingMaintenanceAction
El tipo de acción de mantenimiento pendiente que se aplica a este recurso.
Sintaxis de la solicitud
POST /pending-action HTTP/1.1
Content-type: application/json
{
"applyAction": "string",
"applyOn": "string",
"optInType": "string",
"resourceArn": "string"
}Parámetros de solicitud del URI
La solicitud no utiliza ningún parámetro de URI.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- applyAction
-
La acción de mantenimiento pendiente que se aplica a este recurso.
Las acciones válidas son:
-
ENGINE_UPDATE -
ENGINE_UPGRADE -
SECURITY_UPDATE -
OS_UPDATE -
MASTER_USER_PASSWORD_UPDATE
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Obligatorio: sí
-
- optInType
-
Un valor que indica el tipo de solicitud de alta o deshace una solicitud de alta. Una solicitud de alta de tipo
IMMEDIATEno se puede deshacer.Tipo: cadena
Valores válidos:
IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_INObligatorio: sí
- resourceArn
-
El Nombre de recurso de Amazon (ARN) Amazon DocumentDB del recurso al que se aplica la acción de mantenimiento pendiente.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Obligatorio: sí
- applyOn
-
Una fecha específica para aplicar la acción de mantenimiento pendiente. Obligatorio si el tipo de suscripción es
APPLY_ON. Formato:yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mmTipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"resourcePendingMaintenanceAction": {
"pendingMaintenanceActionDetails": [
{
"action": "string",
"autoAppliedAfterDate": "string",
"currentApplyDate": "string",
"description": "string",
"forcedApplyDate": "string",
"optInStatus": "string"
}
],
"resourceArn": "string"
}
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- resourcePendingMaintenanceAction
-
El resultado de la acción de mantenimiento pendiente que se aplica.
Tipo: objeto ResourcePendingMaintenanceAction
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AccessDeniedException
-
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.
- message
-
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403
- ConflictException
-
Se ha producido un conflicto de acceso.
- resourceId
-
El identificador del recurso en el que se produjo un conflicto de acceso.
- resourceType
-
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409
- InternalServerException
-
Se ha producido un error en el servidor interno.
Código de estado HTTP: 500
- ResourceNotFoundException
-
No se pudo encontrar el recurso especificado.
- message
-
Un mensaje de error que describe el error.
- resourceId
-
El identificador del recurso que no se pudo encontrar.
- resourceType
-
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404
- ThrottlingException
-
Se lanzará ThrottlingException cuando se deniegue la solicitud debido a la limitación de la solicitud.
- retryAfterSeconds
-
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429
- ValidationException
-
Estructura que define una excepción de validación.
- fieldList
-
Una lista de los campos en los que se produjo la excepción de validación.
- message
-
Un mensaje de error que describe la excepción de validación.
- reason
-
El motivo por el que se produjo la excepción de validación (uno de los siguientes:
unknownOperation,cannotParse,fieldValidationFailedoother).
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
