Skip to content

update_data_table_metadata async

update_data_table_metadata(
    instance_id: InstanceId,
    data_table_id: DataTableId,
    name: DataTableName,
    value_lock_level: DataTableLockLevel,
    time_zone: TimeZone,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    description: Optional[DataTableDescription] = None,
) -> UpdateDataTableMetadataResponse

Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.

Parameters:

  • instance_id (InstanceId) –

    The unique identifier for the Amazon Connect instance.

  • data_table_id (DataTableId) –

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails with an error.

  • name (DataTableName) –

    The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.

  • description (Optional[DataTableDescription], default: None ) –

    The updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.

  • value_lock_level (DataTableLockLevel) –

    The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE.

  • time_zone (TimeZone) –

    The updated IANA timezone identifier to use when resolving time based dynamic values.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def update_data_table_metadata(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    data_table_id: "capo_connect.types.data_table_id.DataTableId",
    name: "capo_connect.types.data_table_name.DataTableName",
    value_lock_level: "capo_connect.types.data_table_lock_level.DataTableLockLevel",
    time_zone: "capo_connect.types.time_zone.TimeZone",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    description: Optional[
        "capo_connect.types.data_table_description.DataTableDescription"
    ] = None,
) -> "capo_connect.types.update_data_table_metadata_response.UpdateDataTableMetadataResponse":
    """<p>Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.</p>

    Args:
        instance_id: <p>The unique identifier for the Amazon Connect instance.</p>
        data_table_id: <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails with an error.</p>
        name: <p>The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.</p>
        description: <p>The updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.</p>
        value_lock_level: <p>The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE.</p>
        time_zone: <p>The updated IANA timezone identifier to use when resolving time based dynamic values.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.conflict_exception.ConflictException: <p>Operation cannot be performed at this time as there is a conflict with another operation or contact state.</p>
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.update_data_table_metadata_request.UpdateDataTableMetadataRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.update_data_table_metadata_response.UpdateDataTableMetadataResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.update_data_table_metadata

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.update_data_table_metadata.async_update_data_table_metadata(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDataTableMetadata")
    )
    input_: capo_connect.types.update_data_table_metadata_request.UpdateDataTableMetadataRequest = {
        "instance_id": instance_id,
        "data_table_id": data_table_id,
        "name": name,
        "value_lock_level": value_lock_level,
        "time_zone": time_zone,
    }
    if description is not None:
        input_["description"] = description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output