ExportJournalToS3 - Banco de dados Amazon Quantum Ledger (AmazonQLDB)
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á.

ExportJournalToS3

Exporta o conteúdo do diário em um intervalo de data e hora de um ledger para um bucket do Amazon Simple Storage Service (Amazon S3). Um trabalho de exportação de diário pode gravar os objetos de dados no texto ou na representação binária do formato Amazon Ion ou no formato de texto JSON Lines.

Se o livro com o dado Name não existir, então lança ResourceNotFoundException.

Se o livro com o dado Name estiver no status CREATING, então lança ResourcePreconditionNotMetException.

Você pode iniciar até duas solicitações simultâneas de exportação de diário para cada ledger. Além desse limite, as solicitações de exportação de diário lançam LimitExceededException.

Sintaxe da Solicitação

POST /ledgers/name/journal-s3-exports HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "OutputFormat": "string",
   "RoleArn": "string",
   "S3ExportConfiguration": { 
      "Bucket": "string",
      "EncryptionConfiguration": { 
         "KmsKeyArn": "string",
         "ObjectEncryptionType": "string"
      },
      "Prefix": "string"
   }
}

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

name

O nome do ledger.

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 32.

Padrão: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Exigido: Sim

Corpo da Solicitação

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

ExclusiveEndTime

A data e hora de término exclusivas da variedade de conteúdos do periódico a serem exportados.

O ExclusiveEndTime deve estar no formato de data e hora ISO 8601 e em UTC (Tempo Universal Coordenado). Por exemplo: 2019-06-13T21:36:34Z.

O ExclusiveEndTime deve ser menor ou igual à data e hora UTC atuais.

Tipo: carimbo de data/hora

Obrigatório: Sim

InclusiveStartTime

A data e hora de início exclusivas da variedade de conteúdos do periódico a serem exportados.

O InclusiveStartTime deve estar no formato de data e hora ISO 8601 e em UTC (Tempo Universal Coordenado). Por exemplo: 2019-06-13T21:36:34Z.

O InclusiveStartTime deve ser antes de ExclusiveEndTime.

Se você fornecer uma InclusiveStartTime anterior à CreationDateTime do ledger, o Amazon QLDB efetivamente usará como padrão a CreationDateTime do ledger.

Tipo: carimbo de data/hora

Obrigatório: Sim

OutputFormat

O formato de saída dos dados exportados do diário. Um trabalho de exportação de diário pode gravar os objetos de dados no texto ou na representação binária do formato Amazon Ion ou no formato de texto JSON Lines.

Padrão: ION_TEXT

No formato JSON Lines, cada bloco de diário em um objeto de dados exportado é um objeto JSON válido delimitado por uma nova linha. Você pode usar esse formato para integrar diretamente as exportações JSON com ferramentas de análise, como o Amazon Athena e AWS Glue porque esses serviços podem analisar automaticamente o JSON delimitado por novas linhas.

Tipo: sequências

Valores Válidos: ION_BINARY | ION_TEXT | JSON

Obrigatório: não

RoleArn

O Nome do recurso da Amazon (ARN) do perfil do IAM que concede ao QLDB permissões para um trabalho de exportação de diário fazer o seguinte:

  • Gravar objetos em um bucket do Amazon S3.

  • (Opcional) Use sua chave gerenciada pelo cliente em AWS Key Management Service (AWS KMS) para criptografia do lado do servidor dos dados exportados.

Para transmitir uma função ao QLDB ao solicitar uma exportação de diário, você deve ter permissões para realizar a ação iam:PassRole no recurso do perfil do IAM. Isso é necessário para todas as solicitações de exportação de diário.

Tipo: sequência

Restrições de tamanho: tamanho mínimo 20. Comprimento máximo de 1.600.

Obrigatório: Sim

S3ExportConfiguration

As configurações do destino do bucket do Amazon S3 para a solicitação de exportação.

Tipo: objeto S3ExportConfiguration

Exigido: Sim

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "ExportId": "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.

ExportId

O UUID (representado em texto codificado em Base62) que o QLDB atribui a cada trabalho de exportação de diário.

Para descrever sua solicitação de exportação e verificar o status do trabalho, você pode usar ExportId para chamar DescribeJournalS3Export.

Tipo: sequência

Restrições de comprimento: comprimento fixo de 22.

Padrão: ^[A-Za-z-0-9]+$

Erros

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

ResourceNotFoundException

O recurso especificado não existe.

Código de Status HTTP: 404

ResourcePreconditionNotMetException

A operação falhou porque uma condição não foi satisfeita com antecedência.

Código de status HTTP: 412

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: