Lambda / Paginator / ListFunctionUrlConfigs

ListFunctionUrlConfigs

class Lambda.Paginator.ListFunctionUrlConfigs

paginator = client.get_paginator('list_function_url_configs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Lambda.Client.list_function_url_configs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FunctionName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• FunctionName (string) –

  [REQUIRED]

  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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'FunctionUrlConfigs': [
        {
            'FunctionUrl': 'string',
            'FunctionArn': 'string',
            'CreationTime': 'string',
            'LastModifiedTime': 'string',
            'Cors': {
                'AllowCredentials': True|False,
                'AllowHeaders': [
                    'string',
                ],
                'AllowMethods': [
                    'string',
                ],
                'AllowOrigins': [
                    'string',
                ],
                'ExposeHeaders': [
                    'string',
                ],
                'MaxAge': 123
            },
            'AuthType': 'NONE'|'AWS_IAM',
            'InvokeMode': 'BUFFERED'|'RESPONSE_STREAM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • FunctionUrlConfigs (list) –

    A list of function URL configurations.

    • (dict) –

      Details about a Lambda function URL.

      • FunctionUrl (string) –

        The HTTP URL endpoint for your function.

      • FunctionArn (string) –

        The Amazon Resource Name (ARN) of your function.

      • CreationTime (string) –

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

      • LastModifiedTime (string) –

        When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

      • Cors (dict) –

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

        • AllowCredentials (boolean) –

          Whether to allow cookies or other credentials in requests to your function URL. The default is false.

        • AllowHeaders (list) –

          The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

          • (string) –

        • AllowMethods (list) –

          The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character ( *).

          • (string) –

        • AllowOrigins (list) –

          The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.

          Alternatively, you can grant access to all origins using the wildcard character ( *).

          • (string) –

        • ExposeHeaders (list) –

          The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.

          • (string) –

        • MaxAge (integer) –

          The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn’t cache results.

      • AuthType (string) –

        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 Security and auth model for Lambda function URLs.

      • InvokeMode (string) –

        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 20 MB, however, you can request a quota increase.

  • NextToken (string) –

    A token to resume pagination.