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á.
StreamJournalToKinesis
Cria um stream de diário para um ledger do Amazon QLDB. O stream captura todas as revisões de documentos confirmadas no diário do razão e entrega os dados a um recurso especificado do Amazon Kinesis Data Streams.
Sintaxe da Solicitação
POST /ledgers/name
/journal-kinesis-streams HTTP/1.1
Content-type: application/json
{
"ExclusiveEndTime": number
,
"InclusiveStartTime": number
,
"KinesisConfiguration": {
"AggregationEnabled": boolean
,
"StreamArn": "string
"
},
"RoleArn": "string
",
"StreamName": "string
",
"Tags": {
"string
" : "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 exclusivas que especificam quando o stream termina. Se você não definir esse parâmetro, o stream será executado indefinidamente até ser cancelado.
O
ExclusiveEndTime
deve estar no formato de data e horaISO 8601
e em UTC (Tempo Universal Coordenado). Por exemplo:2019-06-13T21:36:34Z
.Tipo: carimbo de data/hora
Obrigatório: não
- InclusiveStartTime
-
A data e hora de início inclusivas a partir das quais iniciar o streaming de dados do diário. Esse parâmetro 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
não pode ser no futuro e deve ser antes deExclusiveEndTime
.Se você fornecer uma
InclusiveStartTime
anterior àCreationDateTime
do razão, o QLDB efetivamente usará como padrão aCreationDateTime
do razão.Tipo: carimbo de data/hora
Obrigatório: Sim
- KinesisConfiguration
-
As configurações do destino do Kinesis Data Streams para a solicitação de stream.
Tipo: objeto KinesisConfiguration
Obrigatório: Sim
- RoleArn
-
O nome do recurso da Amazon (ARN) da perfil do IAM que concede ao QLDB permissões para um stream de diário gravar registros de dados em um recurso do Kinesis Data Streams.
Para transmitir uma função ao QLDB ao solicitar um fluxo 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 fluxos de diário.Tipo: sequência
Restrições de tamanho: tamanho mínimo 20. Comprimento máximo de 1.600.
Obrigatório: Sim
- StreamName
-
O nome que você deseja atribuir ao stream de diário do QLDB. Os nomes definidos pelo usuário podem ajudar a identificar e indicar a finalidade de um stream.
O nome do fluxo deve ser exclusivo entre outros fluxos ativos em um ledger. Os nomes de streams têm as mesmas restrições de nomenclatura que os nomes do razão, conforme definido 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
- Tags
-
Os pares de chave-valor a serem adicionados como tags ao stream 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
{
"StreamId": "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.
- StreamId
-
O UUID (representado em texto codificado em Base62) que o QLDB atribui a cada fluxo de diário do QLDB.
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 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
- 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: