1. Packages
  2. AWS Native
  3. API Docs
  4. entityresolution
  5. getIdMappingWorkflow

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.entityresolution.getIdMappingWorkflow

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    IdMappingWorkflow defined in AWS Entity Resolution service

    Using getIdMappingWorkflow

    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 getIdMappingWorkflow(args: GetIdMappingWorkflowArgs, opts?: InvokeOptions): Promise<GetIdMappingWorkflowResult>
    function getIdMappingWorkflowOutput(args: GetIdMappingWorkflowOutputArgs, opts?: InvokeOptions): Output<GetIdMappingWorkflowResult>
    def get_id_mapping_workflow(workflow_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetIdMappingWorkflowResult
    def get_id_mapping_workflow_output(workflow_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetIdMappingWorkflowResult]
    func LookupIdMappingWorkflow(ctx *Context, args *LookupIdMappingWorkflowArgs, opts ...InvokeOption) (*LookupIdMappingWorkflowResult, error)
    func LookupIdMappingWorkflowOutput(ctx *Context, args *LookupIdMappingWorkflowOutputArgs, opts ...InvokeOption) LookupIdMappingWorkflowResultOutput

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

    public static class GetIdMappingWorkflow 
    {
        public static Task<GetIdMappingWorkflowResult> InvokeAsync(GetIdMappingWorkflowArgs args, InvokeOptions? opts = null)
        public static Output<GetIdMappingWorkflowResult> Invoke(GetIdMappingWorkflowInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIdMappingWorkflowResult> getIdMappingWorkflow(GetIdMappingWorkflowArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:entityresolution:getIdMappingWorkflow
      arguments:
        # arguments dictionary

    The following arguments are supported:

    WorkflowName string
    The name of the IdMappingWorkflow
    WorkflowName string
    The name of the IdMappingWorkflow
    workflowName String
    The name of the IdMappingWorkflow
    workflowName string
    The name of the IdMappingWorkflow
    workflow_name str
    The name of the IdMappingWorkflow
    workflowName String
    The name of the IdMappingWorkflow

    getIdMappingWorkflow Result

    The following output properties are available:

    CreatedAt string
    Description string
    The description of the IdMappingWorkflow
    IdMappingTechniques Pulumi.AwsNative.EntityResolution.Outputs.IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    InputSourceConfig List<Pulumi.AwsNative.EntityResolution.Outputs.IdMappingWorkflowInputSource>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    OutputSourceConfig List<Pulumi.AwsNative.EntityResolution.Outputs.IdMappingWorkflowOutputSource>
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags used to organize, track, or control access for this resource.
    UpdatedAt string
    WorkflowArn string
    CreatedAt string
    Description string
    The description of the IdMappingWorkflow
    IdMappingTechniques IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    InputSourceConfig []IdMappingWorkflowInputSource
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    OutputSourceConfig []IdMappingWorkflowOutputSource
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
    Tags Tag
    The tags used to organize, track, or control access for this resource.
    UpdatedAt string
    WorkflowArn string
    createdAt String
    description String
    The description of the IdMappingWorkflow
    idMappingTechniques IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    inputSourceConfig List<IdMappingWorkflowInputSource>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    outputSourceConfig List<IdMappingWorkflowOutputSource>
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
    tags List<Tag>
    The tags used to organize, track, or control access for this resource.
    updatedAt String
    workflowArn String
    createdAt string
    description string
    The description of the IdMappingWorkflow
    idMappingTechniques IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    inputSourceConfig IdMappingWorkflowInputSource[]
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    outputSourceConfig IdMappingWorkflowOutputSource[]
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
    tags Tag[]
    The tags used to organize, track, or control access for this resource.
    updatedAt string
    workflowArn string
    created_at str
    description str
    The description of the IdMappingWorkflow
    id_mapping_techniques IdMappingWorkflowIdMappingTechniques
    An object which defines the idMappingType and the providerProperties .
    input_source_config Sequence[IdMappingWorkflowInputSource]
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    output_source_config Sequence[IdMappingWorkflowOutputSource]
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
    tags Sequence[root_Tag]
    The tags used to organize, track, or control access for this resource.
    updated_at str
    workflow_arn str
    createdAt String
    description String
    The description of the IdMappingWorkflow
    idMappingTechniques Property Map
    An object which defines the idMappingType and the providerProperties .
    inputSourceConfig List<Property Map>
    A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
    outputSourceConfig List<Property Map>
    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
    tags List<Property Map>
    The tags used to organize, track, or control access for this resource.
    updatedAt String
    workflowArn String

    Supporting Types

    IdMappingWorkflowIdMappingRuleBasedProperties

    IdMappingWorkflowIdMappingRuleBasedPropertiesAttributeMatchingModel

    IdMappingWorkflowIdMappingRuleBasedPropertiesRecordMatchingModel

    IdMappingWorkflowIdMappingRuleBasedPropertiesRuleDefinitionType

    IdMappingWorkflowIdMappingTechniques

    idMappingType "PROVIDER" | "RULE_BASED"
    The type of ID mapping.
    normalizationVersion String
    providerProperties Property Map
    An object which defines any additional configurations required by the provider service.
    ruleBasedProperties Property Map

    IdMappingWorkflowIdMappingTechniquesIdMappingType

    IdMappingWorkflowInputSource

    InputSourceArn string
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    SchemaArn string
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    Type Pulumi.AwsNative.EntityResolution.IdMappingWorkflowInputSourceType

    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.

    InputSourceArn string
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    SchemaArn string
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    Type IdMappingWorkflowInputSourceType

    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.

    inputSourceArn String
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schemaArn String
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    type IdMappingWorkflowInputSourceType

    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.

    inputSourceArn string
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schemaArn string
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    type IdMappingWorkflowInputSourceType

    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.

    input_source_arn str
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schema_arn str
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    type IdMappingWorkflowInputSourceType

    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.

    inputSourceArn String
    An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN
    schemaArn String
    The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .
    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 to which all sourceIds will resolve to.

    IdMappingWorkflowInputSourceType

    IdMappingWorkflowIntermediateSourceConfiguration

    IntermediateS3Path string
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    IntermediateS3Path string
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediateS3Path String
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediateS3Path string
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediate_s3_path str
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.
    intermediateS3Path String
    The s3 path that would be used to stage the intermediate data being generated during workflow execution.

    IdMappingWorkflowOutputSource

    OutputS3Path string
    The S3 path to which Entity Resolution will write the output table
    KmsArn string
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    OutputS3Path string
    The S3 path to which Entity Resolution will write the output table
    KmsArn string
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    outputS3Path String
    The S3 path to which Entity Resolution will write the output table
    kmsArn String
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    outputS3Path string
    The S3 path to which Entity Resolution will write the output table
    kmsArn string
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    output_s3_path str
    The S3 path to which Entity Resolution will write the output table
    kms_arn str
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
    outputS3Path String
    The S3 path to which Entity Resolution will write the output table
    kmsArn String
    Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.

    IdMappingWorkflowProviderProperties

    ProviderServiceArn string
    Arn of the Provider Service being used.
    IntermediateSourceConfiguration Pulumi.AwsNative.EntityResolution.Inputs.IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    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
    Arn of the Provider Service being used.
    IntermediateSourceConfiguration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    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
    Arn of the Provider Service being used.
    intermediateSourceConfiguration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    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
    Arn of the Provider Service being used.
    intermediateSourceConfiguration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    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
    Arn of the Provider Service being used.
    intermediate_source_configuration IdMappingWorkflowIntermediateSourceConfiguration
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    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
    Arn of the Provider Service being used.
    intermediateSourceConfiguration Property Map
    The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
    providerConfiguration Map<String>
    Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format

    IdMappingWorkflowRule

    MatchingKeys List<string>
    RuleName string
    MatchingKeys []string
    RuleName string
    matchingKeys List<String>
    ruleName String
    matchingKeys string[]
    ruleName string
    matching_keys Sequence[str]
    rule_name str
    matchingKeys List<String>
    ruleName String

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi