Skip to content

create_function_url_config

Operation

create_function_url_config

create_function_url_config(request: CreateFunctionUrlConfigInput | CreateFunctionUrlConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFunctionUrlConfigInputDict]) -> CreateFunctionUrlConfigOutput

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

Parameters:

Name Type Description Default
request CreateFunctionUrlConfigInput | CreateFunctionUrlConfigInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateFunctionUrlConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateFunctionUrlConfigOutput

An instance of CreateFunctionUrlConfigOutput.

create_function_url_config async

create_function_url_config(request: CreateFunctionUrlConfigInput | CreateFunctionUrlConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFunctionUrlConfigInputDict]) -> CreateFunctionUrlConfigOutput

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

Parameters:

Name Type Description Default
request CreateFunctionUrlConfigInput | CreateFunctionUrlConfigInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateFunctionUrlConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateFunctionUrlConfigOutput

An instance of CreateFunctionUrlConfigOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateFunctionUrlConfigInputDict

Bases: TypedDict

Dictionary form of CreateFunctionUrlConfigInput.

Attributes

auth_type instance-attribute
auth_type: Required[str]

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

cors instance-attribute
cors: Cors | CorsDict | None

The cross-origin resource sharing (CORS) settings for your function URL.

function_name instance-attribute
function_name: Required[str]

The name or ARN of the Lambda function.

Name formats

  • Function name -- my-function.

  • Function ARN -- arn:aws:lambda:us-west-2:123456789012:function:my-function.

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

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

invoke_mode instance-attribute
invoke_mode: str | None

Use one of the following options:

  • BUFFERED -- This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM -- Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

qualifier instance-attribute
qualifier: str | None

The alias name.

CreateFunctionUrlConfigInput dataclass

Bases: _SerdeShape

Dataclass for CreateFunctionUrlConfigInput structure.

Attributes

auth_type class-attribute instance-attribute
auth_type: str | None = ...

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

cors class-attribute instance-attribute
cors: Cors | None = ...

The cross-origin resource sharing (CORS) settings for your function URL.

function_name class-attribute instance-attribute
function_name: str | None = ...

The name or ARN of the Lambda function.

Name formats

  • Function name -- my-function.

  • Function ARN -- arn:aws:lambda:us-west-2:123456789012:function:my-function.

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

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

invoke_mode class-attribute instance-attribute
invoke_mode: str | None = ...

Use one of the following options:

  • BUFFERED -- This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM -- Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

qualifier class-attribute instance-attribute
qualifier: str | None = ...

The alias name.

Output

CreateFunctionUrlConfigOutput dataclass

Bases: _SerdeShape

Dataclass for CreateFunctionUrlConfigOutput structure.

Attributes

auth_type instance-attribute
auth_type: str

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

cors class-attribute instance-attribute
cors: Cors | None = ...

The cross-origin resource sharing (CORS) settings for your function URL.

creation_time instance-attribute
creation_time: str

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh🇲🇲ss.sTZD).

function_arn instance-attribute
function_arn: str

The Amazon Resource Name (ARN) of your function.

function_url instance-attribute
function_url: str

The HTTP URL endpoint for your function.

invoke_mode class-attribute instance-attribute
invoke_mode: str | None = ...

Use one of the following options:

  • BUFFERED -- This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM -- Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.