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á.
StartReportJob
Inicia um trabalho de relatório sob demanda para o plano de relatório especificado.
Sintaxe da Solicitação
POST /audit/report-jobs/reportPlanName HTTP/1.1
Content-type: application/json
{
"IdempotencyToken": "string"
}Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- reportPlanName
-
O nome exclusivo de um plano de relatório.
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.
Padrão:
[a-zA-Z][_a-zA-Z0-9]*Obrigatório: Sim
Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
- IdempotencyToken
-
Uma string escolhida pelo cliente que você pode usar para distinguir entre chamadas idênticas para
StartReportJobInput. 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
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"ReportJobId": "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.
- ReportJobId
-
O identificador do trabalho de relatório. Uma string Unicode exclusiva, gerada aleatoriamente, codificada em UTF-8, com, no máximo, 1.024 bytes. Não é possível editar o ID do trabalho de relatório.
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.
Código de Status HTTP: 400
- MissingParameterValueException
-
Indica que um parâmetro necessário está ausente.
Código de Status HTTP: 400
- ResourceNotFoundException
-
Um recurso necessário para a ação não existe.
Código de Status HTTP: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
Código de Status HTTP: 500
Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
