Skip to content

FunctionConfiguration

Source code in docs_src/capo_appsync/types/function_configuration.py
class FunctionConfiguration(TypedDict, closed=True):
    function_id: NotRequired["capo_appsync.types.string.String"]
    """<p>A unique ID representing the <code>Function</code> object.</p>"""
    function_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the <code>Function</code> object.</p>"""
    name: NotRequired["capo_appsync.types.resource_name.ResourceName"]
    """<p>The name of the <code>Function</code> object.</p>"""
    description: NotRequired["capo_appsync.types.string.String"]
    """<p>The <code>Function</code> description.</p>"""
    data_source_name: NotRequired["capo_appsync.types.resource_name.ResourceName"]
    """<p>The name of the <code>DataSource</code>.</p>"""
    request_mapping_template: NotRequired[
        "capo_appsync.types.mapping_template.MappingTemplate"
    ]
    """<p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</p>"""
    response_mapping_template: NotRequired[
        "capo_appsync.types.mapping_template.MappingTemplate"
    ]
    """<p>The <code>Function</code> response mapping template.</p>"""
    function_version: NotRequired["capo_appsync.types.string.String"]
    """<p>The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.</p>"""
    sync_config: NotRequired["capo_appsync.types.sync_config.SyncConfig"]
    max_batch_size: "capo_appsync.types.max_batch_size.MaxBatchSize"
    """<p>The maximum batching size for a resolver.</p>"""
    runtime: NotRequired["capo_appsync.types.app_sync_runtime.AppSyncRuntime"]
    code: NotRequired["capo_appsync.types.code.Code"]
    """<p>The <code>function</code> code that contains the request and response functions. When code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>"""

code instance-attribute

code: NotRequired[Code]

The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

data_source_name instance-attribute

data_source_name: NotRequired[ResourceName]

The name of the DataSource.

description instance-attribute

description: NotRequired[String]

The Function description.

function_arn instance-attribute

function_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Function object.

function_id instance-attribute

function_id: NotRequired[String]

A unique ID representing the Function object.

function_version instance-attribute

function_version: NotRequired[String]

The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

max_batch_size instance-attribute

max_batch_size: MaxBatchSize

The maximum batching size for a resolver.

name instance-attribute

name: NotRequired[ResourceName]

The name of the Function object.

request_mapping_template instance-attribute

request_mapping_template: NotRequired[MappingTemplate]

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

response_mapping_template instance-attribute

response_mapping_template: NotRequired[MappingTemplate]

The Function response mapping template.

runtime instance-attribute

runtime: NotRequired[AppSyncRuntime]

sync_config instance-attribute

sync_config: NotRequired[SyncConfig]