Create Id Namespace

entityresolution_create_id_namespace

R Documentation

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it¶

Description¶

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 update_id_namespace API.

Usage¶

entityresolution_create_id_namespace(description,
  idMappingWorkflowProperties, idNamespaceName, inputSourceConfig,
  roleArn, tags, type)

Arguments¶

description

The description of the ID namespace.

idMappingWorkflowProperties

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

idNamespaceName

[required] The name of the ID namespace.

inputSourceConfig

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

roleArn

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 the workflow run.

tags

The tags used to organize, track, or control access for this resource.

type

[required] The type of ID namespace. There are two types: SOURCE and TARGET.

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

Value¶

A list with the following syntax:

list(
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  description = "string",
  idMappingWorkflowProperties = list(
    list(
      idMappingType = "PROVIDER"|"RULE_BASED",
      providerProperties = list(
        providerConfiguration = list(),
        providerServiceArn = "string"
      ),
      ruleBasedProperties = list(
        attributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
        recordMatchingModels = list(
          "ONE_SOURCE_TO_ONE_TARGET"|"MANY_SOURCE_TO_ONE_TARGET"
        ),
        ruleDefinitionTypes = list(
          "SOURCE"|"TARGET"
        ),
        rules = list(
          list(
            matchingKeys = list(
              "string"
            ),
            ruleName = "string"
          )
        )
      )
    )
  ),
  idNamespaceArn = "string",
  idNamespaceName = "string",
  inputSourceConfig = list(
    list(
      inputSourceARN = "string",
      schemaName = "string"
    )
  ),
  roleArn = "string",
  tags = list(
    "string"
  ),
  type = "SOURCE"|"TARGET",
  updatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$create_id_namespace(
  description = "string",
  idMappingWorkflowProperties = list(
    list(
      idMappingType = "PROVIDER"|"RULE_BASED",
      providerProperties = list(
        providerConfiguration = list(),
        providerServiceArn = "string"
      ),
      ruleBasedProperties = list(
        attributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
        recordMatchingModels = list(
          "ONE_SOURCE_TO_ONE_TARGET"|"MANY_SOURCE_TO_ONE_TARGET"
        ),
        ruleDefinitionTypes = list(
          "SOURCE"|"TARGET"
        ),
        rules = list(
          list(
            matchingKeys = list(
              "string"
            ),
            ruleName = "string"
          )
        )
      )
    )
  ),
  idNamespaceName = "string",
  inputSourceConfig = list(
    list(
      inputSourceARN = "string",
      schemaName = "string"
    )
  ),
  roleArn = "string",
  tags = list(
    "string"
  ),
  type = "SOURCE"|"TARGET"
)