Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. entityresolution
  5. getIdNamespace

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.3.0 published on Thursday, Oct 17, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.entityresolution.getIdNamespace

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.3.0 published on Thursday, Oct 17, 2024 by Pulumi
pulumi/pulumi-aws-native

    IdNamespace defined in AWS Entity Resolution service

    Using getIdNamespace

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIdNamespace(args: GetIdNamespaceArgs, opts?: InvokeOptions): Promise<GetIdNamespaceResult>
function getIdNamespaceOutput(args: GetIdNamespaceOutputArgs, opts?: InvokeOptions): Output<GetIdNamespaceResult>
    def get_id_namespace(id_namespace_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetIdNamespaceResult
def get_id_namespace_output(id_namespace_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetIdNamespaceResult]
    func LookupIdNamespace(ctx *Context, args *LookupIdNamespaceArgs, opts ...InvokeOption) (*LookupIdNamespaceResult, error)
func LookupIdNamespaceOutput(ctx *Context, args *LookupIdNamespaceOutputArgs, opts ...InvokeOption) LookupIdNamespaceResultOutput

    > Note: This function is named LookupIdNamespace in the Go SDK.

    public static class GetIdNamespace 
{
    public static Task<GetIdNamespaceResult> InvokeAsync(GetIdNamespaceArgs args, InvokeOptions? opts = null)
    public static Output<GetIdNamespaceResult> Invoke(GetIdNamespaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIdNamespaceResult> getIdNamespace(GetIdNamespaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:entityresolution:getIdNamespace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IdNamespaceName string
    The name of the ID namespace.
    IdNamespaceName string
    The name of the ID namespace.
    idNamespaceName String
    The name of the ID namespace.
    idNamespaceName string
    The name of the ID namespace.
    id_namespace_name str
    The name of the ID namespace.
    idNamespaceName String
    The name of the ID namespace.

    getIdNamespace Result

    The following output properties are available:

    CreatedAt string
    The date and time when the IdNamespace was created
    Description string
    The description of the ID namespace.
    IdMappingWorkflowProperties List<Pulumi.AwsNative.EntityResolution.Outputs.IdNamespaceIdMappingWorkflowProperties>
    Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
    IdNamespaceArn string
    The arn associated with the IdNamespace
    InputSourceConfig List<Pulumi.AwsNative.EntityResolution.Outputs.IdNamespaceInputSource>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags used to organize, track, or control access for this resource.
    Type Pulumi.AwsNative.EntityResolution.IdNamespaceType

    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 which all sourceIds will resolve to.

    UpdatedAt string
    The date and time when the IdNamespace was updated
    CreatedAt string
    The date and time when the IdNamespace was created
    Description string
    The description of the ID namespace.
    IdMappingWorkflowProperties []IdNamespaceIdMappingWorkflowProperties
    Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
    IdNamespaceArn string
    The arn associated with the IdNamespace
    InputSourceConfig []IdNamespaceInputSource
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
    Tags Tag
    The tags used to organize, track, or control access for this resource.
    Type IdNamespaceType

    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 which all sourceIds will resolve to.

    UpdatedAt string
    The date and time when the IdNamespace was updated
    createdAt String
    The date and time when the IdNamespace was created
    description String
    The description of the ID namespace.
    idMappingWorkflowProperties List<IdNamespaceIdMappingWorkflowProperties>
    Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
    idNamespaceArn String
    The arn associated with the IdNamespace
    inputSourceConfig List<IdNamespaceInputSource>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
    tags List<Tag>
    The tags used to organize, track, or control access for this resource.
    type IdNamespaceType

    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 which all sourceIds will resolve to.

    updatedAt String
    The date and time when the IdNamespace was updated
    createdAt string
    The date and time when the IdNamespace was created
    description string
    The description of the ID namespace.
    idMappingWorkflowProperties IdNamespaceIdMappingWorkflowProperties[]
    Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
    idNamespaceArn string
    The arn associated with the IdNamespace
    inputSourceConfig IdNamespaceInputSource[]
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
    tags Tag[]
    The tags used to organize, track, or control access for this resource.
    type IdNamespaceType

    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 which all sourceIds will resolve to.

    updatedAt string
    The date and time when the IdNamespace was updated
    created_at str
    The date and time when the IdNamespace was created
    description str
    The description of the ID namespace.
    id_mapping_workflow_properties Sequence[IdNamespaceIdMappingWorkflowProperties]
    Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
    id_namespace_arn str
    The arn associated with the IdNamespace
    input_source_config Sequence[IdNamespaceInputSource]
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
    tags Sequence[root_Tag]
    The tags used to organize, track, or control access for this resource.
    type IdNamespaceType

    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 which all sourceIds will resolve to.

    updated_at str
    The date and time when the IdNamespace was updated
    createdAt String
    The date and time when the IdNamespace was created
    description String
    The description of the ID namespace.
    idMappingWorkflowProperties List<Property Map>
    Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
    idNamespaceArn String
    The arn associated with the IdNamespace
    inputSourceConfig List<Property Map>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
    tags List<Property Map>
    The tags used to organize, track, or control access for this resource.
    type "SOURCE" | "TARGET"

    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 which all sourceIds will resolve to.

    updatedAt String
    The date and time when the IdNamespace was updated

    Supporting Types

    IdNamespaceIdMappingWorkflowProperties

    IdMappingType Pulumi.AwsNative.EntityResolution.IdNamespaceIdMappingWorkflowPropertiesIdMappingType
    The type of ID mapping.
    ProviderProperties Pulumi.AwsNative.EntityResolution.Inputs.IdNamespaceNamespaceProviderProperties
    An object which defines any additional configurations required by the provider service.
    RuleBasedProperties Pulumi.AwsNative.EntityResolution.Inputs.IdNamespaceNamespaceRuleBasedProperties
    An object which defines any additional configurations required by rule-based matching.
    IdMappingType IdNamespaceIdMappingWorkflowPropertiesIdMappingType
    The type of ID mapping.
    ProviderProperties IdNamespaceNamespaceProviderProperties
    An object which defines any additional configurations required by the provider service.
    RuleBasedProperties IdNamespaceNamespaceRuleBasedProperties
    An object which defines any additional configurations required by rule-based matching.
    idMappingType IdNamespaceIdMappingWorkflowPropertiesIdMappingType
    The type of ID mapping.
    providerProperties IdNamespaceNamespaceProviderProperties
    An object which defines any additional configurations required by the provider service.
    ruleBasedProperties IdNamespaceNamespaceRuleBasedProperties
    An object which defines any additional configurations required by rule-based matching.
    idMappingType IdNamespaceIdMappingWorkflowPropertiesIdMappingType
    The type of ID mapping.
    providerProperties IdNamespaceNamespaceProviderProperties
    An object which defines any additional configurations required by the provider service.
    ruleBasedProperties IdNamespaceNamespaceRuleBasedProperties
    An object which defines any additional configurations required by rule-based matching.
    id_mapping_type IdNamespaceIdMappingWorkflowPropertiesIdMappingType
    The type of ID mapping.
    provider_properties IdNamespaceNamespaceProviderProperties
    An object which defines any additional configurations required by the provider service.
    rule_based_properties IdNamespaceNamespaceRuleBasedProperties
    An object which defines any additional configurations required by rule-based matching.
    idMappingType "PROVIDER" | "RULE_BASED"
    The type of ID mapping.
    providerProperties Property Map
    An object which defines any additional configurations required by the provider service.
    ruleBasedProperties Property Map
    An object which defines any additional configurations required by rule-based matching.

    IdNamespaceIdMappingWorkflowPropertiesIdMappingType

    IdNamespaceInputSource

    InputSourceArn string
    An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
    SchemaName string
    The name of the schema.
    InputSourceArn string
    An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
    SchemaName string
    The name of the schema.
    inputSourceArn String
    An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
    schemaName String
    The name of the schema.
    inputSourceArn string
    An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
    schemaName string
    The name of the schema.
    input_source_arn str
    An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
    schema_name str
    The name of the schema.
    inputSourceArn String
    An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
    schemaName String
    The name of the schema.

    IdNamespaceNamespaceProviderProperties

    ProviderServiceArn string
    The Amazon Resource Name (ARN) of the provider service.
    ProviderConfiguration Dictionary<string, string>
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.
    ProviderServiceArn string
    The Amazon Resource Name (ARN) of the provider service.
    ProviderConfiguration map[string]string
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.
    providerServiceArn String
    The Amazon Resource Name (ARN) of the provider service.
    providerConfiguration Map<String,String>
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.
    providerServiceArn string
    The Amazon Resource Name (ARN) of the provider service.
    providerConfiguration {[key: string]: string}
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.
    provider_service_arn str
    The Amazon Resource Name (ARN) of the provider service.
    provider_configuration Mapping[str, str]
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.
    providerServiceArn String
    The Amazon Resource Name (ARN) of the provider service.
    providerConfiguration Map<String>
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.

    IdNamespaceNamespaceRuleBasedProperties

    AttributeMatchingModel Pulumi.AwsNative.EntityResolution.IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel

    The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

    If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

    If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

    RecordMatchingModels List<Pulumi.AwsNative.EntityResolution.IdNamespaceRecordMatchingModel>

    The type of matching record that is allowed to be used in an ID mapping workflow.

    If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target.

    If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

    RuleDefinitionTypes List<Pulumi.AwsNative.EntityResolution.IdNamespaceRuleDefinitionType>
    The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
    Rules List<Pulumi.AwsNative.EntityResolution.Inputs.IdNamespaceRule>
    The rules for the ID namespace.
    AttributeMatchingModel IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel

    The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

    If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

    If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

    RecordMatchingModels []IdNamespaceRecordMatchingModel

    The type of matching record that is allowed to be used in an ID mapping workflow.

    If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target.

    If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

    RuleDefinitionTypes []IdNamespaceRuleDefinitionType
    The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
    Rules []IdNamespaceRule
    The rules for the ID namespace.
    attributeMatchingModel IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel

    The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

    If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

    If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

    recordMatchingModels List<IdNamespaceRecordMatchingModel>

    The type of matching record that is allowed to be used in an ID mapping workflow.

    If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target.

    If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

    ruleDefinitionTypes List<IdNamespaceRuleDefinitionType>
    The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
    rules List<IdNamespaceRule>
    The rules for the ID namespace.
    attributeMatchingModel IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel

    The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

    If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

    If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

    recordMatchingModels IdNamespaceRecordMatchingModel[]

    The type of matching record that is allowed to be used in an ID mapping workflow.

    If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target.

    If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

    ruleDefinitionTypes IdNamespaceRuleDefinitionType[]
    The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
    rules IdNamespaceRule[]
    The rules for the ID namespace.
    attribute_matching_model IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel

    The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

    If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

    If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

    record_matching_models Sequence[IdNamespaceRecordMatchingModel]

    The type of matching record that is allowed to be used in an ID mapping workflow.

    If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target.

    If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

    rule_definition_types Sequence[IdNamespaceRuleDefinitionType]
    The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
    rules Sequence[IdNamespaceRule]
    The rules for the ID namespace.
    attributeMatchingModel "ONE_TO_ONE" | "MANY_TO_MANY"

    The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

    If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

    If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

    recordMatchingModels List<"ONE_SOURCE_TO_ONE_TARGET" | "MANY_SOURCE_TO_ONE_TARGET">

    The type of matching record that is allowed to be used in an ID mapping workflow.

    If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target.

    If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

    ruleDefinitionTypes List<"SOURCE" | "TARGET">
    The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
    rules List<Property Map>
    The rules for the ID namespace.

    IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel

    IdNamespaceRecordMatchingModel

    IdNamespaceRule

    MatchingKeys List<string>
    A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.
    RuleName string
    A name for the matching rule.
    MatchingKeys []string
    A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.
    RuleName string
    A name for the matching rule.
    matchingKeys List<String>
    A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.
    ruleName String
    A name for the matching rule.
    matchingKeys string[]
    A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.
    ruleName string
    A name for the matching rule.
    matching_keys Sequence[str]
    A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.
    rule_name str
    A name for the matching rule.
    matchingKeys List<String>
    A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.
    ruleName String
    A name for the matching rule.

    IdNamespaceRuleDefinitionType

    IdNamespaceType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.3.0 published on Thursday, Oct 17, 2024 by Pulumi
    pulumi/pulumi-aws-native