StartSearchJob - AWS Backup
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte Também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

StartSearchJob

Essa operação cria um trabalho de pesquisa que retorna pontos de recuperação filtrados por SearchScope e itens filtrados por. ItemFilters

Opcionalmente, você pode incluir ClientToken EncryptionKeyArn, Nome e/ou Tags.

Sintaxe da Solicitação

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 da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

ClientToken

Inclua esse parâmetro para permitir várias chamadas idênticas de idempotência.

Um token de cliente é válido por 8 horas após a conclusão da primeira solicitação que o usa. Após esse período, qualquer solicitação com o mesmo token será tratada como uma nova solicitação.

Tipo: String

Obrigatório: Não

EncryptionKeyArn

A chave de criptografia para o trabalho de pesquisa especificado.

Tipo: String

Obrigatório: Não

ItemFilters

Os filtros de itens representam todas as propriedades do item de entrada especificadas quando a pesquisa foi criada.

Contém EBSItem filtros ou S3 ItemFilters

Tipo: objeto ItemFilters

Obrigatório: não

Name

Inclua caracteres alfanuméricos para criar um nome para esse trabalho de pesquisa.

Tipo: string

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 500.

Obrigatório: não

SearchScope

Esse objeto pode conter BackupResourceTypes,, BackupResourceArns BackupResourceCreationTime BackupResourceTags, e SourceResourceArns filtrar os pontos de recuperação retornados pelo trabalho de pesquisa.

Tipo: objeto SearchScope

Obrigatório: sim

Tags

Lista de tags retornadas pela operação.

Tipo: mapa de strings para string

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "SearchJobArn": "string",
   "SearchJobIdentifier": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

CreationTime

A data e a hora em que um trabalho foi criado, no formato Unix e no Tempo Universal Coordenado (UTC). O valor de CompletionTime tem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.

Tipo: carimbo de data/hora

SearchJobArn

A sequência de caracteres exclusiva que identifica o Amazon Resource Name (ARN) do trabalho de pesquisa especificado.

Tipo: string

SearchJobIdentifier

A sequência de caracteres exclusiva que especifica o trabalho de pesquisa.

Tipo: string

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulte Erros comuns.

AccessDeniedException

Você não tem acesso suficiente para executar esta ação.

Código de status HTTP: 403

ConflictException

Essa exceção ocorre quando um conflito com uma operação anterior bem-sucedida é detectado. Isso geralmente ocorre quando a operação anterior não teve tempo de se propagar para o host que atende à solicitação atual.

Uma nova tentativa (com a lógica de recuo apropriada) é a resposta recomendada para essa exceção.

Código de Status HTTP: 409

InternalServerException

Ocorreu um erro interno do servidor. Tente sua solicitação novamente.

Código de status HTTP: 500

ServiceQuotaExceededException

A solicitação foi negada por exceder os limites de cota permitidos.

Código de status HTTP: 402

ThrottlingException

A solicitação foi negada devido ao controle de limitação.

Código de status HTTP: 429

ValidationException

A entrada não satisfaz as restrições especificadas por um serviço.

Código de Status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: