CreateFunctionUrlConfig - AWS Lambda

CreateFunctionUrlConfig

Cria um URL de função do Lambda com os parâmetros de configuração especificados. Um URL de função é um endpoint HTTP(S) dedicado que você pode usar para invocar a função.

Sintaxe da Solicitação

POST /2021-10-31/functions/FunctionName/url?Qualifier=Qualifier HTTP/1.1 Content-type: application/json { "AuthType": "string", "Cors": { "AllowCredentials": boolean, "AllowHeaders": [ "string" ], "AllowMethods": [ "string" ], "AllowOrigins": [ "string" ], "ExposeHeaders": [ "string" ], "MaxAge": number }, "InvokeMode": "string" }

Parâmetros da Solicitação de URI

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

FunctionName

O nome da função do Lambda.

Formatos de nome
  • Nome da função: my-function.

  • ARN da função: arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • ARN parcial: 123456789012:function:my-function.

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

O nome do alias.

Restrições de Tamanho: Tamanho mínimo 1. Comprimento máximo de 128.

Padrão: (^\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+))

Corpo da Solicitação

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

AuthType

O tipo de autenticação que o URL de função usa. Defina como AWS_IAM se desejar restringir o acesso apenas a usuários autenticados. Defina como NONE se desejar ignorar a autenticação do IAM para criar um endpoint público. Para obter mais informações, consulte Security and auth model for Lambda function URLs (Modelo de segurança e autenticação para URLs de função do Lambda).

Tipo: string

Valores Válidos: NONE | AWS_IAM

Obrigatório: sim

Cors

As configurações de compartilhamento de recursos de origem cruzada (CORS) para o URL de função.

Tipo: objeto Cors

Obrigatório: não

InvokeMode

Use uma das seguintes opções:

  • BUFFERED: esta é a opção padrão. O Lambda invoca sua função usando a operação Invoke da API. Os resultados da invocação estarão disponíveis quando a carga estiver concluída. O tamanho máximo da carga é de 6 GB.

  • RESPONSE_STREAM: sua função faz o streaming dos resultados da carga à medida que eles se tornam disponíveis. O Lambda invoca sua função usando a operação InvokeWithResponseStream da API. O tamanho máximo da carga de resposta é de 20 MB, no entanto, é possível solicitar um aumento da cota.

Tipo: string

Valores Válidos: BUFFERED | RESPONSE_STREAM

Exigido: não

Sintaxe da Resposta

HTTP/1.1 201 Content-type: application/json { "AuthType": "string", "Cors": { "AllowCredentials": boolean, "AllowHeaders": [ "string" ], "AllowMethods": [ "string" ], "AllowOrigins": [ "string" ], "ExposeHeaders": [ "string" ], "MaxAge": number }, "CreationTime": "string", "FunctionArn": "string", "FunctionUrl": "string", "InvokeMode": "string" }

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.

Os dados a seguir são retornados no formato JSON pelo serviço.

AuthType

O tipo de autenticação que o URL de função usa. Defina como AWS_IAM se desejar restringir o acesso apenas a usuários autenticados. Defina como NONE se desejar ignorar a autenticação do IAM para criar um endpoint público. Para obter mais informações, consulte Security and auth model for Lambda function URLs (Modelo de segurança e autenticação para URLs de função do Lambda).

Tipo: string

Valores Válidos: NONE | AWS_IAM

Cors

As configurações de compartilhamento de recursos de origem cruzada (CORS) para o URL de função.

Tipo: objeto Cors

CreationTime

Quando o URL de função foi criado, no formato ISO-8601 (AAAA-MM-DDThh:mm:ss.sTZD).

Tipo: string

FunctionArn

O nome do 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-_]+))?

FunctionUrl

O endpoint de URL HTTP para a função.

Tipo: string

Restrições de comprimento: comprimento mínimo de 40. Comprimento máximo de 100.

InvokeMode

Use uma das seguintes opções:

  • BUFFERED: esta é a opção padrão. O Lambda invoca sua função usando a operação Invoke da API. Os resultados da invocação estarão disponíveis quando a carga estiver concluída. O tamanho máximo da carga é de 6 GB.

  • RESPONSE_STREAM: sua função faz o streaming dos resultados da carga à medida que eles se tornam disponíveis. O Lambda invoca sua função usando a operação InvokeWithResponseStream da API. O tamanho máximo da carga de resposta é de 20 MB, no entanto, é possível solicitar um aumento da cota.

Tipo: string

Valores Válidos: BUFFERED | RESPONSE_STREAM

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: