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á.
StartScanJob
Inicia trabalhos de varredura em busca de recursos específicos.
Sintaxe da Solicitação
PUT /scan/job HTTP/1.1
Content-type: application/json
{
"BackupVaultName": "string",
"IamRoleArn": "string",
"IdempotencyToken": "string",
"MalwareScanner": "string",
"RecoveryPointArn": "string",
"ScanBaseRecoveryPointArn": "string",
"ScanMode": "string",
"ScannerRoleArn": "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.
- BackupVaultName
-
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes exclusivos da conta usada para criá-los e da AWS região em que foram criados.
Padrão:
^[a-zA-Z0-9\-\_]{2,50}$Tipo: String
Obrigatório: Sim
- IamRoleArn
-
Especifica o ARN do perfil do IAM usado para criar o ponto de recuperação de destino. Por exemplo,
arn:aws:iam::123456789012:role/S3Access.Tipo: String
Obrigatório: Sim
- IdempotencyToken
-
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas a
StartScanJob. Tentar novamente uma solicitação com êxito com o mesmo token de idempotência resultará em uma mensagem de êxito sem nenhuma ação tomada.Tipo: string
Obrigatório: não
- MalwareScanner
-
Especifica o verificador de malware usado durante o trabalho de verificação. Atualmente, só suporta
GUARDDUTY.Tipo: string
Valores válidos:
GUARDDUTYObrigatório: sim
- RecoveryPointArn
-
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um ponto de recuperação. Este é o ponto de recuperação de destino para uma verificação completa. Se você estiver executando uma verificação incremental, esse será o ponto de recuperação criado após a seleção do ponto de recuperação básico.
Tipo: String
Obrigatório: Sim
- ScanBaseRecoveryPointArn
-
Um ARN que identifica de forma exclusiva o ponto de recuperação básico a ser usado para varredura incremental.
Tipo: string
Obrigatório: não
- ScanMode
-
Especifica o tipo de escaneamento usado para o trabalho de escaneamento.
Inclui:
-
FULL_SCANdigitalizará toda a linhagem de dados dentro do backup. -
INCREMENTAL_SCANexaminará a diferença de dados entre o ponto de recuperação de destino e o ARN do ponto de recuperação básico.
Tipo: string
Valores válidos:
FULL_SCAN | INCREMENTAL_SCANObrigatório: sim
-
- ScannerRoleArn
-
Especificou o ARN da função do scanner do IAM.
Tipo: String
Exigido: sim
Sintaxe da resposta
HTTP/1.1 201
Content-type: application/json
{
"CreationDate": number,
"ScanJobId": "string"
}Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.
Os dados a seguir são retornados no formato JSON pelo serviço.
- CreationDate
-
A data e hora em que o trabalho de backup foi criado, em formato de hora Unix e Tempo Universal Coordenado (UTC). O valor de
CreationDatetem 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
- ScanJobId
-
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Tipo: string
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- InvalidParameterValueException
-
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.
- Context
- Type
Código de status HTTP: 400
- InvalidRequestException
-
Indica que há algo errado com a entrada da solicitação. Por exemplo, um parâmetro é do tipo errado.
- Context
- Type
Código de status HTTP: 400
- LimitExceededException
-
Um limite na solicitação foi excedido; por exemplo, o número máximo de itens permitidos em uma solicitação.
- Context
- Type
Código de status HTTP: 400
- MissingParameterValueException
-
Indica que um parâmetro necessário está ausente.
- Context
- Type
Código de status HTTP: 400
- ResourceNotFoundException
-
Um recurso necessário para a ação não existe.
- Context
- Type
Código de status HTTP: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
- Context
- Type
Código de status HTTP: 500
Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
