Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Otras API de Neptune
Acciones:
Estructuras:
AddTagsToResource (acción)
El nombre de la AWS CLI para esta API es: add-tags-to-resource.
Añade etiquetas de metadatos a un recurso de Amazon Neptune. Estas etiquetas también se pueden utilizar con los informes de asignación de costos para realizar un seguimiento de los costos asociados con los recursos de Amazon Neptune o se utilizan en una Declaración de condición en una política de IAM para Amazon Neptune.
Solicitud
-
ResourceName (en la CLI:
--resource-name): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El recurso de Amazon Neptune al que se añaden las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN). Para obtener más información acerca de cómo crear un ARN, consulte Creación de un nombre de recurso de Amazon (ARN).
-
Tags (en la CLI:
--tags) obligatorio: una matriz de objetos Tag.Las etiquetas que se van a asignar al recurso de Amazon Neptune.
Respuesta
Sin parámetros de respuesta.
ListTagsForResource (acción)
El nombre de la AWS CLI para esta API es: list-tags-for-resource.
Enumera todas las etiquetas en un recurso de Amazon Neptune.
Solicitud
-
Filters (en la CLI:
--filters): una matriz de objetos Filtro.Este parámetro es incompatible en estos momentos.
-
ResourceName (en la CLI:
--resource-name): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El recurso de Amazon Neptune con las etiquetas que se van a incluir en la lista. Este valor es un Nombre de recurso de Amazon (ARN). Para obtener más información acerca de cómo crear un ARN, consulte Creación de un nombre de recurso de Amazon (ARN).
Respuesta
-
TagList: matriz de objetos Tag.
Lista de etiquetas devueltas por la operación ListTagsForResource.
RemoveTagsFromResource (acción)
El nombre de la AWS CLI para esta API es: remove-tags-from-resource.
Elimina etiquetas de metadatos de un recurso de Amazon Neptune.
Solicitud
-
ResourceName (en la CLI:
--resource-name): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El recurso de Amazon Neptune del que se eliminan las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN). Para obtener más información acerca de cómo crear un ARN, consulte Creación de un nombre de recurso de Amazon (ARN).
-
TagKeys (en la CLI:
--tag-keys): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).La clave de la etiqueta (nombre) de la etiqueta que se va a eliminar.
Respuesta
Sin parámetros de respuesta.
ApplyPendingMaintenanceAction (acción)
El nombre de la AWS CLI para esta API es: apply-pending-maintenance-action.
Aplica una acción de mantenimiento pendiente a un recurso (por ejemplo, a una instancia de base de datos).
Solicitud
-
ApplyAction (en la CLI:
--apply-action): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).La acción de mantenimiento pendiente que se aplica a este recurso.
Valores válidos:
system-update,db-upgrade -
OptInType (en la CLI:
--opt-in-type): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).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.Valores válidos:
-
immediate: aplicar inmediatamente la acción de mantenimiento. -
next-maintenance: aplicar la acción de mantenimiento durante la siguiente ventana de mantenimiento del recurso. -
undo-opt-in: cancelar todas las solicitudes de altanext-maintenanceexistentes.
-
-
ResourceIdentifier (en la CLI:
--resource-identifier): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) del recurso al que se aplica la acción de mantenimiento pendiente. Para obtener más información acerca de cómo crear un ARN, consulte Creación de un nombre de recurso de Amazon (ARN).
Respuesta
Describe las acciones de mantenimiento pendientes para un recurso.
-
PendingMaintenanceActionDetails: matriz de objetos PendingMaintenanceAction.
Una lista que proporciona detalles sobre las acciones de mantenimiento pendientes para el recurso.
-
ResourceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del recurso que tiene acciones de mantenimiento pendientes.
Errores
DescribePendingMaintenanceActions (acción)
El nombre de la AWS CLI para esta API es: describe-pending-maintenance-actions.
Devuelve una lista de recursos (por ejemplo, instancias de base de datos) que tienen al menos una acción de mantenimiento pendiente.
Solicitud
-
Filters (en la CLI:
--filters): una matriz de objetos Filtro.Un filtro que especifica uno o más recursos para devolver acciones de mantenimiento pendientes.
Filtros compatibles:
-
db-cluster-id: acepta identificadores de clúster de base de datos y Nombres de recursos de Amazon (ARN). La lista de resultados solo incluirá las acciones de mantenimiento pendientes para los clústeres de base de datos identificados por estos ARN. -
db-instance-id: admite identificadores de instancia de base de datos y ARN de instancia de base de datos. La lista de resultados solo incluirá las acciones de mantenimiento pendientes para las instancias de base de datos identificadas por estos ARN.
-
-
Marker (en la CLI:
--marker): una cadena, del tipo:string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud
DescribePendingMaintenanceActionsanterior. Si se especifica este parámetro, la respuesta incluye solo los registros más allá del marcador, hasta un número de registros especificado porMaxRecords. -
MaxRecords (en la CLI:
--max-records): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El número máximo de registros que se debe incluir en la respuesta. Si el número de registros es superior al valor
MaxRecordsespecificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.Predeterminado: 100
Restricciones: Minimum 20, máximo 100.
-
ResourceIdentifier (en la CLI:
--resource-identifier): una cadena, del tipo:string(una cadena codificada con UTF-8).El ARN de un recuerdo para el que devolver acciones de mantenimiento pendientes.
Respuesta
-
Marker: una cadena, del tipo:
string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud
DescribePendingMaintenanceActionsanterior. Si se especifica este parámetro, la respuesta incluye solo los registros más allá del marcador, hasta un número de registros especificado porMaxRecords. -
PendingMaintenanceActions: matriz de objetos ResourcePendingMaintenanceActions.
La lista de acciones de mantenimiento pendientes para el recurso.
Errores
DescribeDBEngineVersions (acción)
El nombre de la AWS CLI para esta API es: describe-db-engine-versions.
Devuelve una lista con los motores de base de datos disponibles.
Solicitud
-
DBParameterGroupFamily (en la CLI:
--db-parameter-group-family): una cadena, del tipo:string(una cadena codificada con UTF-8).El nombre de una familia de grupos de parámetros de base de datos específicos para los que devolver detalles.
Restricciones:
-
Si se suministran, debe coincidir con una DBParameterGroupFamily existente.
-
-
DefaultOnly (en la CLI:
--default-only): un booleano, del tipo:boolean(un valor booleano [true o false]).Indica que solo se devuelve la versión predeterminada del motor especificado o motor y combinación de la versión principal.
-
Engine (en la CLI:
--engine): una cadena, del tipo:string(una cadena codificada con UTF-8).El motor de base de datos que se debe devolver.
-
EngineVersion (en la CLI:
--engine-version): una cadena, del tipo:string(una cadena codificada con UTF-8).La versión del motor de base de datos que se debe devolver.
Ejemplo:
5.1.49 -
Filters (en la CLI:
--filters): una matriz de objetos Filtro.No se admite actualmente.
-
ListSupportedCharacterSets (en la CLI:
--list-supported-character-sets): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Si se especifica este parámetro y el motor solicitado es compatible con el parámetro
CharacterSetNameparaCreateDBInstance, la respuesta incluye una lista de conjuntos de caracteres admitidos para cada versión del motor. -
ListSupportedTimezones (en la CLI:
--list-supported-timezones): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Si se especifica este parámetro y el motor solicitado es compatible con el parámetro
TimeZoneparaCreateDBInstance, la respuesta incluye una lista de zonas horarias admitidas para cada versión del motor. -
Marker (en la CLI:
--marker): una cadena, del tipo:string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords. -
MaxRecords (en la CLI:
--max-records): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El número máximo de registros que se debe incluir en la respuesta. Si hay más de un valor
MaxRecordsdisponible, se incluye un token de paginación que se conoce como marcador en la respuesta para poder recuperar los siguientes resultados.Predeterminado: 100
Restricciones: Minimum 20, máximo 100.
Respuesta
-
DBEngineVersions: matriz de objetos DBEngineVersion.
Una lista de elementos
DBEngineVersion -
Marker: una cadena, del tipo:
string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords.
Estructuras:
DBEngineVersion (estructura)
Este tipo de datos se utiliza como un elemento de respuesta en la acción DescribeDBEngineVersions (acción).
Campos
-
DBEngineDescription: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).La descripción del motor de base de datos.
-
DBEngineVersionDescription: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).La descripción de la versión del motor de base de datos.
-
DBParameterGroupFamily: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre de la familia de grupos de parámetros de base de datos para el motor de base de datos.
-
Engine: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre del motor de base de datos.
-
EngineVersion: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Número de versión del motor de base de datos.
-
ExportableLogTypes: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Los tipos de registros que el motor de base de datos tiene disponibles para la exportación a CloudWatch Logs.
-
SupportedTimezones: se trata de una matriz de objetos Zona horaria.
Una lista de las zonas horarias admitidas por este motor para el parámetro
Timezonede la acciónCreateDBInstance. -
SupportsGlobalDatabases: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Un valor que indica si puede utilizar las bases de datos globales de Aurora con una determinada versión de motor de base de datos.
-
SupportsLogExportsToCloudwatchLogs: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Un valor que indica si la versión del motor admite la exportación de tipos de registro especificados por ExportableLogTypes a CloudWatch Logs.
-
SupportsReadReplica: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si la versión del motor de base de datos admite réplicas de lectura.
-
ValidUpgradeTarget: se trata de una matriz de objetos UpgradeTarget.
Una lista de versiones de motor a la que esta versión del motor de base de datos se puede actualizar.
EngineDefaults (estructura)
Contiene el resultado de una invocación correcta de la acción DescribeEngineDefaultParameters (acción).
Campos
-
DBParameterGroupFamily: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el nombre de la familia del grupo de parámetros de base de datos a los que se aplican los parámetros predeterminados del motor.
-
Marker: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud EngineDefaults anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords. -
Parameters: se trata de una matriz de objetos Parámetro.
Contiene una lista de los parámetros predeterminados del motor.
EngineDefaults se utiliza como el elemento de respuesta para:
PendingMaintenanceAction (estructura)
Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.
Campos
-
Action: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El tipo de acción de mantenimiento pendiente disponible para el recurso.
-
AutoAppliedAfterDate: se trata de un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).La fecha del periodo de mantenimiento cuando se aplica la acción. La acción de mantenimiento se aplica al recurso durante su primer periodo de mantenimiento después de esta fecha. Si se especifica esta fecha, se omite cualquier solicitud de alta
next-maintenance. -
CurrentApplyDate: se trata de un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).La fecha de entrada en vigor en que se aplica la acción de mantenimiento pendiente al recurso. Esta fecha tiene en cuenta las solicitudes de alta recibidas de la API ApplyPendingMaintenanceAction (acción), la
AutoAppliedAfterDatey laForcedApplyDate. Este valor está en blanco si no se ha recibido una solicitud de alta y no se ha especificado nada comoAutoAppliedAfterDateoForcedApplyDate. -
Description: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Una descripción que proporciona información más detallada sobre la acción de mantenimiento.
-
ForcedApplyDate: se trata de un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).La fecha en que se aplica automáticamente la acción de mantenimiento. La acción de mantenimiento se aplica al recurso en esta fecha independientemente del periodo de mantenimiento para el recurso. Si se especifica esta fecha, se omite cualquier solicitud de alta
immediate. -
OptInStatus: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Indica el tipo de solicitud de alta que se ha recibido para el recurso.
ResourcePendingMaintenanceActions (estructura)
Describe las acciones de mantenimiento pendientes para un recurso.
Campos
-
PendingMaintenanceActionDetails: se trata de una matriz de objetos PendingMaintenanceAction.
Una lista que proporciona detalles sobre las acciones de mantenimiento pendientes para el recurso.
-
ResourceIdentifier: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del recurso que tiene acciones de mantenimiento pendientes.
ResourcePendingMaintenanceActions se utiliza como el elemento de respuesta para:
UpgradeTarget (estructura)
La versión del motor de base de datos a la que puede actualizarse una instancia de base de datos.
Campos
-
AutoUpgrade: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Un valor que indica si la versión de destino se aplica a cualquier instancia de base de datos de origen que tiene AutoMinorVersionUpgrade establecido en "true·.
-
Description: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).La versión del motor de base de datos a la que puede actualizarse una instancia de base de datos.
-
Engine: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre del motor de base de datos de destino de actualización.
-
EngineVersion: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El número de versión del motor de base de datos de destino de actualización.
-
IsMajorVersionUpgrade: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Un valor que indica si un motor de base de datos se actualiza a una versión principal.
-
SupportsGlobalDatabases: se trata de un BooleanOptional, del tipo:
boolean(un valor booleano [true o false]).Un valor que indica si puede utilizar las bases de datos globales de Neptune con una determinada versión de motor de destino.
Tag (estructura)
Metadatos asignados a un recurso de Amazon Neptune que consta de un par clave-valor.
Campos
-
Key: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).La clave es el nombre obligatorio de la etiqueta. El valor de la cadena puede tener una longitud de entre 1 y 128 caracteres Unicode y no puede llevar el prefijo
aws:nirds:. La cadena puede incluir únicamente el conjunto de letras de Unicode, dígitos y espacio en blanco, “_”, “.”, “/”, “=”, “+”, “-” (Java regex: “^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$”). -
Value: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El valor es la parte opcional de la etiqueta. El valor de la cadena puede tener una longitud de entre 1 y 256 caracteres Unicode y no puede llevar el prefijo
aws:nirds:. La cadena puede incluir únicamente el conjunto de letras de Unicode, dígitos y espacio en blanco, “_”, “.”, “/”, “=”, “+”, “-” (Java regex: “^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$”).
