StartSearchJob - AWS Backup

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.

StartSearchJob

Esta operación crea un trabajo de búsqueda que devuelve los puntos de recuperación filtrados por SearchScope y los elementos filtrados por ItemFilters.

Si lo desea, puede incluir ClientToken, EncryptionKeyArn, Name o Tags.

Sintaxis de la solicitud

PUT /search-jobs HTTP/1.1 Content-type: application/json { "ClientToken": "string", "EncryptionKeyArn": "string", "ItemFilters": { "EBSItemFilters": [ { "CreationTimes": [ { "Operator": "string", "Value": number } ], "FilePaths": [ { "Operator": "string", "Value": "string" } ], "LastModificationTimes": [ { "Operator": "string", "Value": number } ], "Sizes": [ { "Operator": "string", "Value": number } ] } ], "S3ItemFilters": [ { "CreationTimes": [ { "Operator": "string", "Value": number } ], "ETags": [ { "Operator": "string", "Value": "string" } ], "ObjectKeys": [ { "Operator": "string", "Value": "string" } ], "Sizes": [ { "Operator": "string", "Value": number } ], "VersionIds": [ { "Operator": "string", "Value": "string" } ] } ] }, "Name": "string", "SearchScope": { "BackupResourceArns": [ "string" ], "BackupResourceCreationTime": { "CreatedAfter": number, "CreatedBefore": number }, "BackupResourceTags": { "string" : "string" }, "BackupResourceTypes": [ "string" ], "SourceResourceArns": [ "string" ] }, "Tags": { "string" : "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.

ClientToken

Incluya este parámetro para permitir múltiples llamadas idénticas de idempotencia.

Un token de cliente es válido durante ocho horas desde el momento en que finaliza la primera solicitud que lo utiliza. Pasado ese tiempo, cualquier solicitud con el mismo token se considera una solicitud nueva.

Tipo: cadena

Requerido: no

EncryptionKeyArn

Es la clave de cifrado del trabajo de búsqueda especificado.

Tipo: cadena

Requerido: no

ItemFilters

Son los filtros de elementos que representan todas las propiedades de los elementos de entrada especificados al crear la búsqueda.

Contiene EBSItemFilters o S3ItemFilters.

Tipo: objeto ItemFilters

Obligatorio: no

Name

Incluye caracteres alfanuméricos para crear un nombre para este trabajo de búsqueda.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 500 caracteres.

Obligatorio: no

SearchScope

Este objeto puede contener BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags y SourceResourceArns para filtrar los puntos de recuperación devueltos por el trabajo de búsqueda.

Tipo: objeto SearchScope

Obligatorio: sí

Tags

Es la lista de etiquetas que devuelve la operación.

Tipo: mapa de cadena a cadena

Obligatorio: no

Sintaxis de la respuesta

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "SearchJobArn": "string", "SearchJobIdentifier": "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.

CreationTime

Fecha y hora en que se creó el trabajo, expresadas en formato Unix y en horario universal coordinado (UTC). El valor de CompletionTime tiene una precisión de milisegundos. Por ejemplo, el valor 1516925490.087 representa el viernes 26 de enero de 2018 a las 12:11:30.087 h.

Tipo: marca temporal

SearchJobArn

Cadena única que identifica el nombre de recurso de Amazon (ARN) del trabajo de búsqueda especificado.

Tipo: cadena

SearchJobIdentifier

Cadena unívoca que especifica el trabajo de búsqueda.

Tipo: cadena

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

AccessDeniedException

No tiene acceso suficiente para realizar esta acción.

message

El usuario no tiene acceso suficiente para realizar esta acción.

Código de estado HTTP: 403

ConflictException

Esta excepción se produce cuando se detecta un conflicto con una operación anterior completada correctamente. Esto suele ocurrir cuando la operación anterior no ha podido propagarse al host que atiende la solicitud actual.

La respuesta recomendada a esta excepción es intentarlo de nuevo (con la lógica de retroceso adecuada).

message

Actualizar o eliminar un recurso puede generar un estado incoherente.

resourceId

Es el identificador del recurso afectado.

resourceType

Es el tipo de recurso afectado.

Código de estado HTTP: 409

InternalServerException

Se ha producido un error interno del servidor. Vuelva a enviar la solicitud.

message

Error inesperado durante el procesamiento de la solicitud.

retryAfterSeconds

Vuelva a intentar la llamada pasados varios segundos.

Código de estado HTTP: 500

ResourceNotFoundException

No se ha encontrado el recurso para esta solicitud.

Confirme que la información del recurso, como el ARN o el tipo, es correcta y existe y, a continuación, vuelva a intentar la solicitud.

message

La solicitud hace referencia a un recurso que no existe.

resourceId

Identificador hipotético del recurso afectado.

resourceType

Tipo hipotético del recurso afectado.

Código de estado HTTP: 404

ServiceQuotaExceededException

La solicitud se ha denegado debido a que se han superado los límites de cuota permitidos.

message

Esta solicitud no se ha realizado correctamente debido a que la cuota de servicio ha superado los límites.

quotaCode

Este es el código específico del tipo de cuota.

resourceId

Es el identificador del recurso.

resourceType

Tipo de recurso.

serviceCode

Este es el código unívoco del servicio de origen con la cuota.

Código de estado HTTP: 402

ThrottlingException

La solicitud fue denegada debido a una limitación de la solicitud.

message

La solicitud ha dado error debido a la limitación de la solicitud.

quotaCode

Este es el código unívoco del servicio de origen con la cuota.

retryAfterSeconds

Vuelva a intentar la llamada pasados varios segundos.

serviceCode

Este es el código unívoco del servicio de origen.

Código de estado HTTP: 429

ValidationException

La entrada no satisface las limitaciones que especifica un servicio.

message

La entrada no satisface las limitaciones que especifica un servicio de Amazon.

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: