create_id_namespace
async
¶
create_id_namespace(
id_namespace_name: EntityName,
type: IdNamespaceType,
*,
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,
tags: Optional[TagMap] = None,
) -> CreateIdNamespaceOutput
Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.
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
InputSourceobjects, which have the fieldsInputSourceARNandSchemaName. -
id_mapping_workflow_properties(Optional[IdNamespaceIdMappingWorkflowPropertiesList], default:None) –Determines the properties of
IdMappingWorflowwhere thisIdNamespacecan be used as aSourceor aTarget. -
type(IdNamespaceType) –The type of ID namespace. There are two types:
SOURCEandTARGET.The
SOURCEcontains configurations forsourceIddata that will be processed in an ID mapping workflow.The
TARGETcontains a configuration oftargetIdto which allsourceIdswill resolve to. -
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
IdNamespaceon your behalf as part of the workflow run. -
tags(Optional[TagMap], default:None) –The tags used to organize, track, or control access for this resource.
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.
-
ExceedsLimitException–The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
-
InternalServerException–This exception occurs when there is an internal failure in the Entity Resolution service.
-
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
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 | |