Skip to content

UpdateFunctionRequest

Source code in docs_src/capo_appsync/types/update_function_request.py
class UpdateFunctionRequest(TypedDict, closed=True):
    api_id: "capo_appsync.types.string.String"
    """<p>The GraphQL API ID.</p>"""
    name: "capo_appsync.types.resource_name.ResourceName"
    """<p>The <code>Function</code> name.</p>"""
    description: NotRequired["capo_appsync.types.string.String"]
    """<p>The <code>Function</code> description.</p>"""
    function_id: "capo_appsync.types.resource_name.ResourceName"
    """<p>The function ID.</p>"""
    data_source_name: "capo_appsync.types.resource_name.ResourceName"
    """<p>The <code>Function</code> <code>DataSource</code> name.</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> request mapping template.</p>"""
    function_version: NotRequired["capo_appsync.types.string.String"]
    """<p>The <code>version</code> of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the <code>functionVersion</code> is required.</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>"""

api_id instance-attribute

api_id: String

The GraphQL API ID.

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: ResourceName

The Function DataSource name.

description instance-attribute

description: NotRequired[String]

The Function description.

function_id instance-attribute

function_id: ResourceName

The function ID.

function_version instance-attribute

function_version: NotRequired[String]

The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.

max_batch_size instance-attribute

max_batch_size: MaxBatchSize

The maximum batching size for a resolver.

name instance-attribute

The Function name.

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 request mapping template.

runtime instance-attribute

runtime: NotRequired[AppSyncRuntime]

sync_config instance-attribute

sync_config: NotRequired[SyncConfig]