Skip to content

update_id_namespace async

update_id_namespace(
    id_namespace_name: EntityName,
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
    description: Optional[Description] = None,
    input_source_config: Optional[IdNamespaceInputSourceConfig] = None,
    id_mapping_workflow_properties: Optional[
        IdNamespaceIdMappingWorkflowPropertiesList
    ] = None,
    role_arn: Optional[RoleArn] = None,
) -> UpdateIdNamespaceOutput

Updates an existing ID namespace.

Parameters:

  • id_namespace_name (EntityName) –

    The name of the ID namespace.

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

    The description of the ID namespace.

  • input_source_config (Optional[IdNamespaceInputSourceConfig], default: None ) –

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • id_mapping_workflow_properties (Optional[IdNamespaceIdMappingWorkflowPropertiesList], default: None ) –

    Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

  • role_arn (Optional[RoleArn], default: None ) –

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.

Raises:

Source code in docs_src/capo_entityresolution/_services/async_entity_resolution.py
async def update_id_namespace(
    self,
    id_namespace_name: "capo_entityresolution.types.entity_name.EntityName",
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
    description: Optional[
        "capo_entityresolution.types.description.Description"
    ] = None,
    input_source_config: Optional[
        "capo_entityresolution.types.id_namespace_input_source_config.IdNamespaceInputSourceConfig"
    ] = None,
    id_mapping_workflow_properties: Optional[
        "capo_entityresolution.types.id_namespace_id_mapping_workflow_properties_list.IdNamespaceIdMappingWorkflowPropertiesList"
    ] = None,
    role_arn: Optional["capo_entityresolution.types.role_arn.RoleArn"] = None,
) -> (
    "capo_entityresolution.types.update_id_namespace_output.UpdateIdNamespaceOutput"
):
    """<p>Updates an existing ID namespace.</p>

    Args:
        id_namespace_name: <p>The name of the ID namespace.</p>
        description: <p>The description of the ID namespace.</p>
        input_source_config: <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>
        id_mapping_workflow_properties: <p>Determines the properties of <code>IdMappingWorkflow</code> where this <code>IdNamespace</code> can be used as a <code>Source</code> or a <code>Target</code>.</p>
        role_arn: <p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this <code>IdNamespace</code> on your behalf as part of a workflow run.</p>

    Raises:
        capo_entityresolution.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. </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.update_id_namespace_input.UpdateIdNamespaceInput]",
    ) -> AsyncOperationResponse[
        "capo_entityresolution.types.update_id_namespace_output.UpdateIdNamespaceOutput"
    ]:
        import capo_entityresolution._operations.aws_venice_service.update_id_namespace

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateIdNamespace")
    )
    input_: capo_entityresolution.types.update_id_namespace_input.UpdateIdNamespaceInput = {
        "id_namespace_name": id_namespace_name
    }
    if description is not None:
        input_["description"] = description
    if input_source_config is not None:
        input_["input_source_config"] = input_source_config
    if id_mapping_workflow_properties is not None:
        input_["id_mapping_workflow_properties"] = id_mapping_workflow_properties
    if role_arn is not None:
        input_["role_arn"] = role_arn

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