Skip to main content
GET
Inspecionar mensagens de uma fila
Exige a ação IAM queue:PeekMessages. Veja QUEUE permissões para a lista completa, o escopo de cada ação e um exemplo de política.

Autorizações

Authorization
string
header
obrigatório

Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.

Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.

Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.

Parâmetros de caminho

queue_id
string<uuid>
obrigatório
Exemplo:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Parâmetros de consulta

crn
string

CRN exato da mensagem nesta fila. CRNs de outro escopo retornam uma página vazia antes da paginação; CRNs malformados retornam 400.

Exemplo:

"crn:queue:sa-saopaulo-1:acme:queue/orders/message/019400aa-bbbb-7ccc-8ddd-eeeeffff0000"

visibility
enum<string>

Restringe a inspeção: available pode ser recebida agora; in_flight está concedida; delayed ainda não foi entregue e seu atraso não terminou.

Opções disponíveis:
available,
in_flight,
delayed
Exemplo:

"available"

marker
string<uuid>

ID do último item da página anterior.

Exemplo:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

limit
integer
padrão:50

Número máximo de itens a devolver. Um valor maior é fixado ao máximo em vez de rejeitado, então page until meta.has_more é false.

Intervalo obrigatório: 1 <= x <= 200
Exemplo:

50

Resposta

Lista paginada de mensagens.

messages
object[]
obrigatório
meta
object