Skip to content

delete_schema_mapping async

delete_schema_mapping(
    schema_name: EntityName,
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
) -> DeleteSchemaMappingOutput

Deletes the SchemaMapping with a given name. This operation returns a ResourceNotFoundException if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.

Parameters:

  • schema_name (EntityName) –

    The name of the schema to delete.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • ConflictException –

    The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

  • InternalServerException –

    This exception occurs when there is an internal failure in the Entity Resolution service.

  • ResourceNotFoundException –

    The resource couldn't be found.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The input fails to satisfy the constraints specified by Entity Resolution.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_entityresolution/_services/async_entity_resolution.py
async def delete_schema_mapping(
    self,
    schema_name: "capo_entityresolution.types.entity_name.EntityName",
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
) -> "capo_entityresolution.types.delete_schema_mapping_output.DeleteSchemaMappingOutput":
    """<p>Deletes the <code>SchemaMapping</code> with a given name. This operation returns a <code>ResourceNotFoundException</code> if a schema with the given name does not exist. This operation will fail if there is a <code>MatchingWorkflow</code> object that references the <code>SchemaMapping</code> in the workflow's <code>InputSourceConfig</code>.</p>

    Args:
        schema_name: <p>The name of the schema to delete.</p>

    Raises:
        capo_entityresolution.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. </p>
        capo_entityresolution.errors.conflict_exception.ConflictException: <p>The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. </p>
        capo_entityresolution.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
        capo_entityresolution.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource couldn't be found. </p>
        capo_entityresolution.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. </p>
        capo_entityresolution.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
        capo_entityresolution.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_entityresolution.types.delete_schema_mapping_input.DeleteSchemaMappingInput]",
    ) -> AsyncOperationResponse[
        "capo_entityresolution.types.delete_schema_mapping_output.DeleteSchemaMappingOutput"
    ]:
        import capo_entityresolution._operations.aws_venice_service.delete_schema_mapping

        (
            output,
            http_response,
        ) = await capo_entityresolution._operations.aws_venice_service.delete_schema_mapping.async_delete_schema_mapping(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSchemaMapping")
    )
    input_: capo_entityresolution.types.delete_schema_mapping_input.DeleteSchemaMappingInput = {
        "schema_name": schema_name
    }

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