CreateLedger - Amazon Quantum Ledger Database (Amazon QLDB)
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á.

CreateLedger

Cria um novo livro contábil no seu Conta da AWS na região atual.

Sintaxe da Solicitação

POST /ledgers HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string",
   "Name": "string",
   "PermissionsMode": "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.

DeletionProtection

Especifica se o ledger está protegido contra exclusão por qualquer usuário. Se ele não for fornecido na criação do razão, esse recurso estará habilitado (true) por padrão.

Se a proteção contra exclusão estiver habilitada, você deverá desabilitá-la antes de excluir o razão. Você pode desabilitá-lo chamando a operação UpdateLedger para definir esse parâmetro como false.

Tipo: booliano

Obrigatório: não

KmsKey

A chave in AWS Key Management Service (AWS KMS) a ser usada para criptografia de dados em repouso no livro contábil. Para obter mais informações, consulte Criptografia em repouso, no Guia do desenvolvedor do Amazon QLDB.

Utilize uma das seguintes opções para especificar esse parâmetro:

  • AWS_OWNED_KMS_KEY: use uma AWS KMS chave que pertença e seja AWS gerenciada por você.

  • Indefinido: por padrão, use uma chave AWS KMS própria.

  • Uma chave simétrica do KMS válida e gerenciada pelo cliente: use a chave do KMS de criptografia simétrica, que você cria, detém e gerencia, especificada na sua conta.

    O Amazon QLDB não oferece suporte a chaves assimétricas. Para obter mais informações, consulte Como usar chaves simétricas e assimétricas no Guia do AWS Key Management Service desenvolvedor.

Para especificar uma chave do KMS gerenciada pelo cliente, use o ID da chave, o nome do recurso da Amazon (ARN), o nome do alias ou o ARN do alias. Ao usar um nome de alias, use "alias/" como prefixo. Para especificar uma chave em outra Conta da AWS, você deve usar o ARN da chave ou o alias ARN.

Por exemplo: .

  • ID da chave: 1234abcd-12ab-34cd-56ef-1234567890ab

  • ARN da chave: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Nome do alias: alias/ExampleAlias

  • ARN do alias: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

Para obter mais informações, consulte Identificadores de chave (KeyId) no Guia do AWS Key Management Service desenvolvedor.

Tipo: sequência

Restrições de tamanho: tamanho máximo de 1600.

Obrigatório: não

Name

O nome do livro contábil que você deseja criar. O nome deve ser exclusivo entre todos os livros contábeis da sua Conta da AWS região atual.

Restrições de nomenclatura para nomes de livros contábeis são definidas em Cotas no Amazon QLDB no Guia do desenvolvedor do Amazon QLDB.

Tipo: sequência

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

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

Exigido: Sim

PermissionsMode

O modo de permissões a ser atribuído ao livro contábil que você deseja criar. Esse parâmetro pode ter um dos valores a seguir:

  • ALLOW_ALL: um modo de permissões legado que permite o controle do acesso com granularidade em nível de API para razões.

    Esse modo permite aos usuários que tenham a permissão de API SendCommand para esse ledger executar todos os comandos PartiQL (portanto, ALLOW_ALL) em qualquer tabela no razão especificado. Esse modo desconsidera qualquer política de permissões do IAM em nível de tabela ou comando criada para o razão.

  • STANDARD: (Recomendado) Um modo de permissões que permite o controle do acesso com granularidade mais fina para razões, tabelas e comandos PartiQL.

    Por padrão, esse modo nega todas as solicitações do usuário para executar comandos do PartiQL em qualquer tabela nesse razão. Para permitir a execução de comandos PartiQL, é necessário criar políticas de permissões do IAM para recursos de tabela específicos e ações PartiQL, além da permissão da API SendCommand para o razão. Para saber mais, consulte Conceitos básicos sobre o modo de permissões padrão, no Guia do desenvolvedor do Amazon QLDB.

nota

Recomendamos o uso do modo de permissões STANDARD para maximizar a segurança dos dados do seu razão.

Tipo: sequências

Valores Válidos: ALLOW_ALL | STANDARD

Obrigatório: Sim

Tags

Os pares de chave-valor a serem adicionados como tags ao ledger que você deseja criar. Chaves de tag fazem distinção entre maiúsculas e minúsculas. Os valores de tag diferenciam maiúsculas de minúsculas e podem ser nulos.

Tipo: mapa de string para string

Entradas do mapa: número mínimo de 0 itens. Número máximo de 200 itens.

Restrições de Tamanho de Chave: Tamanho mínimo de 1. O tamanho máximo é 128.

Restrições de tamanho do valor: tamanho mínimo de 0. Tamanho máximo de 256.

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "KmsKeyArn": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "State": "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.

Arn

O nome do recurso da Amazon (ARN) para o ledger.

Tipo: sequência

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

CreationDateTime

A data e a hora, no formato epoch, quando o ledger foi criado. (O formato de hora epoch é o número de segundos decorridos desde as 0h de 1 de janeiro de 1970 em UTC.)

Tipo: carimbo de data/hora

DeletionProtection

Especifica se o ledger está protegido contra exclusão por qualquer usuário. Se ele não for fornecido na criação do razão, esse recurso estará habilitado (true) por padrão.

Se a proteção contra exclusão estiver habilitada, você deverá desabilitá-la antes de excluir o razão. Você pode desabilitá-lo chamando a operação UpdateLedger para definir esse parâmetro como false.

Tipo: booliano

KmsKeyArn

O ARN da chave KMS gerenciada pelo cliente que o ledger usa para criptografia em repouso. Se esse parâmetro for indefinido, o livro contábil usará uma chave AWS KMS própria para criptografia.

Tipo: sequência

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

Name

O nome do ledger.

Tipo: sequência

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

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

PermissionsMode

O modo de permissões a ser atribuído ao ledger que você deseja criar.

Tipo: sequências

Valores Válidos: ALLOW_ALL | STANDARD

State

O status atual do ledger.

Tipo: sequências

Valores Válidos: CREATING | ACTIVE | DELETING | DELETED

Erros

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

InvalidParameterException

Um ou mais parâmetros na solicitação não são válidos.

Código de Status HTTP: 400

LimitExceededException

Você atingiu a quantidade máxima permitida de recursos.

Código de Status HTTP: 400

ResourceAlreadyExistsException

O recurso especificado já existe.

Código de Status HTTP: 409

ResourceInUseException

O recurso especificado não pode ser modificado no momento.

Código de Status HTTP: 409

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: