PutFunctionEventInvokeConfig
Configura opções para invocação assíncrona em uma função, uma versão ou um alias. Se já existe uma configuração para uma função, uma versão ou um alias, essa operação a substituirá. Se você excluir quaisquer configurações, elas serão removidas. Para definir uma opção sem afetar as configurações existentes de outras opções, use UpdateFunctionEventInvokeConfig.
Por padrão, o Lambda tentará novamente uma invocação assíncrona duas vezes se a função retornar um erro. Ele retém eventos em uma fila por até seis horas. Quando um evento falha em todas as tentativas de processamento ou permanece na fila de invocação assíncrona por muito tempo, o Lambda o descarta. Configure uma fila de mensagens mortas com UpdateFunctionConfiguration para reter eventos descartados.
Para enviar um registro de chamada para uma fila, um tópico, uma função ou um barramento de eventos, especifique um destino. Você pode configurar destinos separados para chamadas bem-sucedidas (on-success) e eventos que falharam em todas as tentativas de processamento (on-failure). Você pode configurar destinos além de uma fila de mensagens mortas ou no lugar dela.
Sintaxe da Solicitação
PUT /2019-09-25/functions/FunctionName
/event-invoke-config?Qualifier=Qualifier
HTTP/1.1
Content-type: application/json
{
"DestinationConfig": {
"OnFailure": {
"Destination": "string
"
},
"OnSuccess": {
"Destination": "string
"
}
},
"MaximumEventAgeInSeconds": number
,
"MaximumRetryAttempts": number
}
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- FunctionName
-
O nome da função, versão ou alias do Lambda.
Formatos de nome
-
Function name -
my-function
(somente nome),my-function:v1
(com alias). -
ARN da função -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
ARN parcial:
123456789012:function:my-function
.
Você pode anexar um número de versão ou alias a qualquer um dos formatos. A restrição de comprimento se aplica apenas ao ARN completo. Se você especificar apenas o nome da função, ele será limitado a 64 caracteres.
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 140.
Padrão:
(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
Exigido: Sim
-
- Qualifier
-
Um número de versão ou nome de alias.
Restrições de Tamanho: Tamanho mínimo 1. Comprimento máximo de 128.
Padrão:
(|[a-zA-Z0-9$_-]+)
Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
- DestinationConfig
-
Um destino para eventos depois que eles foram enviados a uma função para processamento.
Destinos
-
Function (Função) – o nome de recurso da Amazon (ARN) da função do Lambda.
-
Fila: o ARN de uma fila padrão do SQS.
-
Tópico: o ARN de um tópico padrão do SNS.
-
Event Bus (Barramento de eventos) – o ARN de um barramento de eventos do Amazon EventBridge.
Tipo: objeto DestinationConfig
Obrigatório: não
-
- MaximumEventAgeInSeconds
-
A idade máxima de uma solicitação que o Lambda envia a uma função para processamento.
Tipo: inteiro
Intervalo válido: valor mínimo de 60. Valor máximo de 21600.
Obrigatório: não
- MaximumRetryAttempts
-
O número máximo de vezes para tentar novamente quando a função retorna um erro.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 2.
Obrigatório: não
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"DestinationConfig": {
"OnFailure": {
"Destination": "string"
},
"OnSuccess": {
"Destination": "string"
}
},
"FunctionArn": "string",
"LastModified": number,
"MaximumEventAgeInSeconds": number,
"MaximumRetryAttempts": number
}
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.
- DestinationConfig
-
Um destino para eventos depois que eles foram enviados a uma função para processamento.
Destinos
-
Function (Função) – o nome de recurso da Amazon (ARN) da função do Lambda.
-
Fila: o ARN de uma fila padrão do SQS.
-
Tópico: o ARN de um tópico padrão do SNS.
-
Event Bus (Barramento de eventos) – o ARN de um barramento de eventos do Amazon EventBridge.
Tipo: objeto DestinationConfig
-
- FunctionArn
-
O nome de recurso da Amazon (ARN) da função.
Tipo: string
Padrão:
arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
- LastModified
-
A data e a hora em que a configuração foi atualizada pela última vez, em segundos no tempo do Unix.
Tipo: Carimbo de data/hora
- MaximumEventAgeInSeconds
-
A idade máxima de uma solicitação que o Lambda envia a uma função para processamento.
Tipo: inteiro
Intervalo válido: valor mínimo de 60. Valor máximo de 21600.
- MaximumRetryAttempts
-
O número máximo de vezes para tentar novamente quando a função retorna um erro.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 2.
Erros
Para obter informações sobre os erros que todas as ações retornam, consulte Erros comuns.
- InvalidParameterValueException
-
Um dos parâmetros da solicitação não é válido.
Código de Status HTTP: 400
- ResourceConflictException
-
O recurso já existe ou outra operação está em andamento.
Código de status HTTP: 409
- ResourceNotFoundException
-
O recurso especificado na solicitação não existe.
Código de Status HTTP: 404
- ServiceException
-
O serviço AWS Lambda encontrou um erro interno.
Código de Status HTTP: 500
- TooManyRequestsException
-
O limite de throughput da solicitação foi excedido. Para obter mais informações, consulte Cotas do Lambda.
Código de status HTTP: 429
Ver também
Para mais informações sobre como usar essa API em um dos AWS SDKs de idiomas específicos, consulte o seguinte: