aws-sdk-entityresolution 1.2.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-entityresolution/client.rb +646 -18
- data/lib/aws-sdk-entityresolution/client_api.rb +411 -0
- data/lib/aws-sdk-entityresolution/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-entityresolution/endpoints.rb +154 -0
- data/lib/aws-sdk-entityresolution/plugins/endpoints.rb +22 -0
- data/lib/aws-sdk-entityresolution/types.rb +945 -43
- data/lib/aws-sdk-entityresolution.rb +2 -2
- metadata +5 -5
@@ -388,6 +388,107 @@ module Aws::EntityResolution
|
|
388
388
|
|
389
389
|
# @!group API Operations
|
390
390
|
|
391
|
+
# Creates an `IdMappingWorkflow` object which stores the configuration
|
392
|
+
# of the data processing job to be run. Each `IdMappingWorkflow` must
|
393
|
+
# have a unique workflow name. To modify an existing workflow, use the
|
394
|
+
# `UpdateIdMappingWorkflow` API.
|
395
|
+
#
|
396
|
+
# @option params [String] :description
|
397
|
+
# A description of the workflow.
|
398
|
+
#
|
399
|
+
# @option params [required, Types::IdMappingTechniques] :id_mapping_techniques
|
400
|
+
# An object which defines the `idMappingType` and the
|
401
|
+
# `providerProperties`.
|
402
|
+
#
|
403
|
+
# @option params [required, Array<Types::IdMappingWorkflowInputSource>] :input_source_config
|
404
|
+
# A list of `InputSource` objects, which have the fields
|
405
|
+
# `InputSourceARN` and `SchemaName`.
|
406
|
+
#
|
407
|
+
# @option params [required, Array<Types::IdMappingWorkflowOutputSource>] :output_source_config
|
408
|
+
# A list of `IdMappingWorkflowOutputSource` objects, each of which
|
409
|
+
# contains fields `OutputS3Path` and `Output`.
|
410
|
+
#
|
411
|
+
# @option params [required, String] :role_arn
|
412
|
+
# The Amazon Resource Name (ARN) of the IAM role. Entity Resolution
|
413
|
+
# assumes this role to create resources on your behalf as part of
|
414
|
+
# workflow execution.
|
415
|
+
#
|
416
|
+
# @option params [Hash<String,String>] :tags
|
417
|
+
# The tags used to organize, track, or control access for this resource.
|
418
|
+
#
|
419
|
+
# @option params [required, String] :workflow_name
|
420
|
+
# The name of the workflow. There can't be multiple
|
421
|
+
# `IdMappingWorkflows` with the same name.
|
422
|
+
#
|
423
|
+
# @return [Types::CreateIdMappingWorkflowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
424
|
+
#
|
425
|
+
# * {Types::CreateIdMappingWorkflowOutput#description #description} => String
|
426
|
+
# * {Types::CreateIdMappingWorkflowOutput#id_mapping_techniques #id_mapping_techniques} => Types::IdMappingTechniques
|
427
|
+
# * {Types::CreateIdMappingWorkflowOutput#input_source_config #input_source_config} => Array<Types::IdMappingWorkflowInputSource>
|
428
|
+
# * {Types::CreateIdMappingWorkflowOutput#output_source_config #output_source_config} => Array<Types::IdMappingWorkflowOutputSource>
|
429
|
+
# * {Types::CreateIdMappingWorkflowOutput#role_arn #role_arn} => String
|
430
|
+
# * {Types::CreateIdMappingWorkflowOutput#workflow_arn #workflow_arn} => String
|
431
|
+
# * {Types::CreateIdMappingWorkflowOutput#workflow_name #workflow_name} => String
|
432
|
+
#
|
433
|
+
# @example Request syntax with placeholder values
|
434
|
+
#
|
435
|
+
# resp = client.create_id_mapping_workflow({
|
436
|
+
# description: "Description",
|
437
|
+
# id_mapping_techniques: { # required
|
438
|
+
# id_mapping_type: "PROVIDER", # required, accepts PROVIDER
|
439
|
+
# provider_properties: { # required
|
440
|
+
# intermediate_source_configuration: {
|
441
|
+
# intermediate_s3_path: "S3Path", # required
|
442
|
+
# },
|
443
|
+
# provider_configuration: {
|
444
|
+
# },
|
445
|
+
# provider_service_arn: "ProviderServiceArn", # required
|
446
|
+
# },
|
447
|
+
# },
|
448
|
+
# input_source_config: [ # required
|
449
|
+
# {
|
450
|
+
# input_source_arn: "IdMappingWorkflowInputSourceInputSourceARNString", # required
|
451
|
+
# schema_name: "EntityName", # required
|
452
|
+
# },
|
453
|
+
# ],
|
454
|
+
# output_source_config: [ # required
|
455
|
+
# {
|
456
|
+
# kms_arn: "KMSArn",
|
457
|
+
# output_s3_path: "S3Path", # required
|
458
|
+
# },
|
459
|
+
# ],
|
460
|
+
# role_arn: "RoleArn", # required
|
461
|
+
# tags: {
|
462
|
+
# "TagKey" => "TagValue",
|
463
|
+
# },
|
464
|
+
# workflow_name: "EntityName", # required
|
465
|
+
# })
|
466
|
+
#
|
467
|
+
# @example Response structure
|
468
|
+
#
|
469
|
+
# resp.description #=> String
|
470
|
+
# resp.id_mapping_techniques.id_mapping_type #=> String, one of "PROVIDER"
|
471
|
+
# resp.id_mapping_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
|
472
|
+
# resp.id_mapping_techniques.provider_properties.provider_service_arn #=> String
|
473
|
+
# resp.input_source_config #=> Array
|
474
|
+
# resp.input_source_config[0].input_source_arn #=> String
|
475
|
+
# resp.input_source_config[0].schema_name #=> String
|
476
|
+
# resp.output_source_config #=> Array
|
477
|
+
# resp.output_source_config[0].kms_arn #=> String
|
478
|
+
# resp.output_source_config[0].output_s3_path #=> String
|
479
|
+
# resp.role_arn #=> String
|
480
|
+
# resp.workflow_arn #=> String
|
481
|
+
# resp.workflow_name #=> String
|
482
|
+
#
|
483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateIdMappingWorkflow AWS API Documentation
|
484
|
+
#
|
485
|
+
# @overload create_id_mapping_workflow(params = {})
|
486
|
+
# @param [Hash] params ({})
|
487
|
+
def create_id_mapping_workflow(params = {}, options = {})
|
488
|
+
req = build_request(:create_id_mapping_workflow, params)
|
489
|
+
req.send_request(options)
|
490
|
+
end
|
491
|
+
|
391
492
|
# Creates a `MatchingWorkflow` object which stores the configuration of
|
392
493
|
# the data processing job to be run. It is important to note that there
|
393
494
|
# should not be a pre-existing `MatchingWorkflow` with the same name. To
|
@@ -421,8 +522,8 @@ module Aws::EntityResolution
|
|
421
522
|
# The tags used to organize, track, or control access for this resource.
|
422
523
|
#
|
423
524
|
# @option params [required, String] :workflow_name
|
424
|
-
# The name of the workflow. There
|
425
|
-
#
|
525
|
+
# The name of the workflow. There can't be multiple `MatchingWorkflows`
|
526
|
+
# with the same name.
|
426
527
|
#
|
427
528
|
# @return [Types::CreateMatchingWorkflowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
529
|
#
|
@@ -463,7 +564,15 @@ module Aws::EntityResolution
|
|
463
564
|
# },
|
464
565
|
# ],
|
465
566
|
# resolution_techniques: { # required
|
466
|
-
#
|
567
|
+
# provider_properties: {
|
568
|
+
# intermediate_source_configuration: {
|
569
|
+
# intermediate_s3_path: "S3Path", # required
|
570
|
+
# },
|
571
|
+
# provider_configuration: {
|
572
|
+
# },
|
573
|
+
# provider_service_arn: "ProviderServiceArn", # required
|
574
|
+
# },
|
575
|
+
# resolution_type: "RULE_MATCHING", # required, accepts RULE_MATCHING, ML_MATCHING, PROVIDER
|
467
576
|
# rule_based_properties: {
|
468
577
|
# attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
|
469
578
|
# rules: [ # required
|
@@ -496,7 +605,9 @@ module Aws::EntityResolution
|
|
496
605
|
# resp.output_source_config[0].output[0].hashed #=> Boolean
|
497
606
|
# resp.output_source_config[0].output[0].name #=> String
|
498
607
|
# resp.output_source_config[0].output_s3_path #=> String
|
499
|
-
# resp.resolution_techniques.
|
608
|
+
# resp.resolution_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
|
609
|
+
# resp.resolution_techniques.provider_properties.provider_service_arn #=> String
|
610
|
+
# resp.resolution_techniques.resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
|
500
611
|
# resp.resolution_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
|
501
612
|
# resp.resolution_techniques.rule_based_properties.rules #=> Array
|
502
613
|
# resp.resolution_techniques.rule_based_properties.rules[0].matching_keys #=> Array
|
@@ -529,7 +640,7 @@ module Aws::EntityResolution
|
|
529
640
|
# additional information that Entity Resolution uses for matching.
|
530
641
|
#
|
531
642
|
# @option params [required, String] :schema_name
|
532
|
-
# The name of the schema. There
|
643
|
+
# The name of the schema. There can't be multiple `SchemaMappings` with
|
533
644
|
# the same name.
|
534
645
|
#
|
535
646
|
# @option params [Hash<String,String>] :tags
|
@@ -551,7 +662,8 @@ module Aws::EntityResolution
|
|
551
662
|
# field_name: "AttributeName", # required
|
552
663
|
# group_name: "AttributeName",
|
553
664
|
# match_key: "AttributeName",
|
554
|
-
#
|
665
|
+
# sub_type: "AttributeName",
|
666
|
+
# type: "NAME", # required, accepts NAME, NAME_FIRST, NAME_MIDDLE, NAME_LAST, ADDRESS, ADDRESS_STREET1, ADDRESS_STREET2, ADDRESS_STREET3, ADDRESS_CITY, ADDRESS_STATE, ADDRESS_COUNTRY, ADDRESS_POSTALCODE, PHONE, PHONE_NUMBER, PHONE_COUNTRYCODE, EMAIL_ADDRESS, UNIQUE_ID, DATE, STRING, PROVIDER_ID
|
555
667
|
# },
|
556
668
|
# ],
|
557
669
|
# schema_name: "EntityName", # required
|
@@ -567,7 +679,8 @@ module Aws::EntityResolution
|
|
567
679
|
# resp.mapped_input_fields[0].field_name #=> String
|
568
680
|
# resp.mapped_input_fields[0].group_name #=> String
|
569
681
|
# resp.mapped_input_fields[0].match_key #=> String
|
570
|
-
# resp.mapped_input_fields[0].
|
682
|
+
# resp.mapped_input_fields[0].sub_type #=> String
|
683
|
+
# resp.mapped_input_fields[0].type #=> String, one of "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID"
|
571
684
|
# resp.schema_arn #=> String
|
572
685
|
# resp.schema_name #=> String
|
573
686
|
#
|
@@ -580,6 +693,35 @@ module Aws::EntityResolution
|
|
580
693
|
req.send_request(options)
|
581
694
|
end
|
582
695
|
|
696
|
+
# Deletes the `IdMappingWorkflow` with a given name. This operation will
|
697
|
+
# succeed even if a workflow with the given name does not exist.
|
698
|
+
#
|
699
|
+
# @option params [required, String] :workflow_name
|
700
|
+
# The name of the workflow to be deleted.
|
701
|
+
#
|
702
|
+
# @return [Types::DeleteIdMappingWorkflowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
703
|
+
#
|
704
|
+
# * {Types::DeleteIdMappingWorkflowOutput#message #message} => String
|
705
|
+
#
|
706
|
+
# @example Request syntax with placeholder values
|
707
|
+
#
|
708
|
+
# resp = client.delete_id_mapping_workflow({
|
709
|
+
# workflow_name: "EntityName", # required
|
710
|
+
# })
|
711
|
+
#
|
712
|
+
# @example Response structure
|
713
|
+
#
|
714
|
+
# resp.message #=> String
|
715
|
+
#
|
716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteIdMappingWorkflow AWS API Documentation
|
717
|
+
#
|
718
|
+
# @overload delete_id_mapping_workflow(params = {})
|
719
|
+
# @param [Hash] params ({})
|
720
|
+
def delete_id_mapping_workflow(params = {}, options = {})
|
721
|
+
req = build_request(:delete_id_mapping_workflow, params)
|
722
|
+
req.send_request(options)
|
723
|
+
end
|
724
|
+
|
583
725
|
# Deletes the `MatchingWorkflow` with a given name. This operation will
|
584
726
|
# succeed even if a workflow with the given name does not exist.
|
585
727
|
#
|
@@ -611,9 +753,8 @@ module Aws::EntityResolution
|
|
611
753
|
|
612
754
|
# Deletes the `SchemaMapping` with a given name. This operation will
|
613
755
|
# succeed even if a schema with the given name does not exist. This
|
614
|
-
# operation will fail if there is a `
|
615
|
-
#
|
616
|
-
# `InputSourceConfig`.
|
756
|
+
# operation will fail if there is a `MatchingWorkflow` object that
|
757
|
+
# references the `SchemaMapping` in the workflow's `InputSourceConfig`.
|
617
758
|
#
|
618
759
|
# @option params [required, String] :schema_name
|
619
760
|
# The name of the schema to delete.
|
@@ -641,6 +782,104 @@ module Aws::EntityResolution
|
|
641
782
|
req.send_request(options)
|
642
783
|
end
|
643
784
|
|
785
|
+
# Gets the status, metrics, and errors (if there are any) that are
|
786
|
+
# associated with a job.
|
787
|
+
#
|
788
|
+
# @option params [required, String] :job_id
|
789
|
+
# The ID of the job.
|
790
|
+
#
|
791
|
+
# @option params [required, String] :workflow_name
|
792
|
+
# The name of the workflow.
|
793
|
+
#
|
794
|
+
# @return [Types::GetIdMappingJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
795
|
+
#
|
796
|
+
# * {Types::GetIdMappingJobOutput#end_time #end_time} => Time
|
797
|
+
# * {Types::GetIdMappingJobOutput#error_details #error_details} => Types::ErrorDetails
|
798
|
+
# * {Types::GetIdMappingJobOutput#job_id #job_id} => String
|
799
|
+
# * {Types::GetIdMappingJobOutput#metrics #metrics} => Types::IdMappingJobMetrics
|
800
|
+
# * {Types::GetIdMappingJobOutput#start_time #start_time} => Time
|
801
|
+
# * {Types::GetIdMappingJobOutput#status #status} => String
|
802
|
+
#
|
803
|
+
# @example Request syntax with placeholder values
|
804
|
+
#
|
805
|
+
# resp = client.get_id_mapping_job({
|
806
|
+
# job_id: "JobId", # required
|
807
|
+
# workflow_name: "EntityName", # required
|
808
|
+
# })
|
809
|
+
#
|
810
|
+
# @example Response structure
|
811
|
+
#
|
812
|
+
# resp.end_time #=> Time
|
813
|
+
# resp.error_details.error_message #=> String
|
814
|
+
# resp.job_id #=> String
|
815
|
+
# resp.metrics.input_records #=> Integer
|
816
|
+
# resp.metrics.records_not_processed #=> Integer
|
817
|
+
# resp.metrics.total_records_processed #=> Integer
|
818
|
+
# resp.start_time #=> Time
|
819
|
+
# resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "QUEUED"
|
820
|
+
#
|
821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetIdMappingJob AWS API Documentation
|
822
|
+
#
|
823
|
+
# @overload get_id_mapping_job(params = {})
|
824
|
+
# @param [Hash] params ({})
|
825
|
+
def get_id_mapping_job(params = {}, options = {})
|
826
|
+
req = build_request(:get_id_mapping_job, params)
|
827
|
+
req.send_request(options)
|
828
|
+
end
|
829
|
+
|
830
|
+
# Returns the `IdMappingWorkflow` with a given name, if it exists.
|
831
|
+
#
|
832
|
+
# @option params [required, String] :workflow_name
|
833
|
+
# The name of the workflow.
|
834
|
+
#
|
835
|
+
# @return [Types::GetIdMappingWorkflowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
836
|
+
#
|
837
|
+
# * {Types::GetIdMappingWorkflowOutput#created_at #created_at} => Time
|
838
|
+
# * {Types::GetIdMappingWorkflowOutput#description #description} => String
|
839
|
+
# * {Types::GetIdMappingWorkflowOutput#id_mapping_techniques #id_mapping_techniques} => Types::IdMappingTechniques
|
840
|
+
# * {Types::GetIdMappingWorkflowOutput#input_source_config #input_source_config} => Array<Types::IdMappingWorkflowInputSource>
|
841
|
+
# * {Types::GetIdMappingWorkflowOutput#output_source_config #output_source_config} => Array<Types::IdMappingWorkflowOutputSource>
|
842
|
+
# * {Types::GetIdMappingWorkflowOutput#role_arn #role_arn} => String
|
843
|
+
# * {Types::GetIdMappingWorkflowOutput#tags #tags} => Hash<String,String>
|
844
|
+
# * {Types::GetIdMappingWorkflowOutput#updated_at #updated_at} => Time
|
845
|
+
# * {Types::GetIdMappingWorkflowOutput#workflow_arn #workflow_arn} => String
|
846
|
+
# * {Types::GetIdMappingWorkflowOutput#workflow_name #workflow_name} => String
|
847
|
+
#
|
848
|
+
# @example Request syntax with placeholder values
|
849
|
+
#
|
850
|
+
# resp = client.get_id_mapping_workflow({
|
851
|
+
# workflow_name: "EntityName", # required
|
852
|
+
# })
|
853
|
+
#
|
854
|
+
# @example Response structure
|
855
|
+
#
|
856
|
+
# resp.created_at #=> Time
|
857
|
+
# resp.description #=> String
|
858
|
+
# resp.id_mapping_techniques.id_mapping_type #=> String, one of "PROVIDER"
|
859
|
+
# resp.id_mapping_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
|
860
|
+
# resp.id_mapping_techniques.provider_properties.provider_service_arn #=> String
|
861
|
+
# resp.input_source_config #=> Array
|
862
|
+
# resp.input_source_config[0].input_source_arn #=> String
|
863
|
+
# resp.input_source_config[0].schema_name #=> String
|
864
|
+
# resp.output_source_config #=> Array
|
865
|
+
# resp.output_source_config[0].kms_arn #=> String
|
866
|
+
# resp.output_source_config[0].output_s3_path #=> String
|
867
|
+
# resp.role_arn #=> String
|
868
|
+
# resp.tags #=> Hash
|
869
|
+
# resp.tags["TagKey"] #=> String
|
870
|
+
# resp.updated_at #=> Time
|
871
|
+
# resp.workflow_arn #=> String
|
872
|
+
# resp.workflow_name #=> String
|
873
|
+
#
|
874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetIdMappingWorkflow AWS API Documentation
|
875
|
+
#
|
876
|
+
# @overload get_id_mapping_workflow(params = {})
|
877
|
+
# @param [Hash] params ({})
|
878
|
+
def get_id_mapping_workflow(params = {}, options = {})
|
879
|
+
req = build_request(:get_id_mapping_workflow, params)
|
880
|
+
req.send_request(options)
|
881
|
+
end
|
882
|
+
|
644
883
|
# Returns the corresponding Match ID of a customer record if the record
|
645
884
|
# has been processed.
|
646
885
|
#
|
@@ -763,7 +1002,9 @@ module Aws::EntityResolution
|
|
763
1002
|
# resp.output_source_config[0].output[0].hashed #=> Boolean
|
764
1003
|
# resp.output_source_config[0].output[0].name #=> String
|
765
1004
|
# resp.output_source_config[0].output_s3_path #=> String
|
766
|
-
# resp.resolution_techniques.
|
1005
|
+
# resp.resolution_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
|
1006
|
+
# resp.resolution_techniques.provider_properties.provider_service_arn #=> String
|
1007
|
+
# resp.resolution_techniques.resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
|
767
1008
|
# resp.resolution_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
|
768
1009
|
# resp.resolution_techniques.rule_based_properties.rules #=> Array
|
769
1010
|
# resp.resolution_techniques.rule_based_properties.rules[0].matching_keys #=> Array
|
@@ -785,6 +1026,61 @@ module Aws::EntityResolution
|
|
785
1026
|
req.send_request(options)
|
786
1027
|
end
|
787
1028
|
|
1029
|
+
# Returns the `ProviderService` of a given name.
|
1030
|
+
#
|
1031
|
+
# @option params [required, String] :provider_name
|
1032
|
+
# The name of the provider. This name is typically the company name.
|
1033
|
+
#
|
1034
|
+
# @option params [required, String] :provider_service_name
|
1035
|
+
# The ARN (Amazon Resource Name) of the product that the provider
|
1036
|
+
# service provides.
|
1037
|
+
#
|
1038
|
+
# @return [Types::GetProviderServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1039
|
+
#
|
1040
|
+
# * {Types::GetProviderServiceOutput#anonymized_output #anonymized_output} => Boolean
|
1041
|
+
# * {Types::GetProviderServiceOutput#provider_configuration_definition #provider_configuration_definition} => Hash,Array,String,Numeric,Boolean
|
1042
|
+
# * {Types::GetProviderServiceOutput#provider_endpoint_configuration #provider_endpoint_configuration} => Types::ProviderEndpointConfiguration
|
1043
|
+
# * {Types::GetProviderServiceOutput#provider_entity_output_definition #provider_entity_output_definition} => Hash,Array,String,Numeric,Boolean
|
1044
|
+
# * {Types::GetProviderServiceOutput#provider_intermediate_data_access_configuration #provider_intermediate_data_access_configuration} => Types::ProviderIntermediateDataAccessConfiguration
|
1045
|
+
# * {Types::GetProviderServiceOutput#provider_name #provider_name} => String
|
1046
|
+
# * {Types::GetProviderServiceOutput#provider_service_arn #provider_service_arn} => String
|
1047
|
+
# * {Types::GetProviderServiceOutput#provider_service_display_name #provider_service_display_name} => String
|
1048
|
+
# * {Types::GetProviderServiceOutput#provider_service_name #provider_service_name} => String
|
1049
|
+
# * {Types::GetProviderServiceOutput#provider_service_type #provider_service_type} => String
|
1050
|
+
#
|
1051
|
+
# @example Request syntax with placeholder values
|
1052
|
+
#
|
1053
|
+
# resp = client.get_provider_service({
|
1054
|
+
# provider_name: "EntityName", # required
|
1055
|
+
# provider_service_name: "ProviderServiceArn", # required
|
1056
|
+
# })
|
1057
|
+
#
|
1058
|
+
# @example Response structure
|
1059
|
+
#
|
1060
|
+
# resp.anonymized_output #=> Boolean
|
1061
|
+
# resp.provider_endpoint_configuration.marketplace_configuration.asset_id #=> String
|
1062
|
+
# resp.provider_endpoint_configuration.marketplace_configuration.data_set_id #=> String
|
1063
|
+
# resp.provider_endpoint_configuration.marketplace_configuration.listing_id #=> String
|
1064
|
+
# resp.provider_endpoint_configuration.marketplace_configuration.revision_id #=> String
|
1065
|
+
# resp.provider_intermediate_data_access_configuration.aws_account_ids #=> Array
|
1066
|
+
# resp.provider_intermediate_data_access_configuration.aws_account_ids[0] #=> String
|
1067
|
+
# resp.provider_intermediate_data_access_configuration.required_bucket_actions #=> Array
|
1068
|
+
# resp.provider_intermediate_data_access_configuration.required_bucket_actions[0] #=> String
|
1069
|
+
# resp.provider_name #=> String
|
1070
|
+
# resp.provider_service_arn #=> String
|
1071
|
+
# resp.provider_service_display_name #=> String
|
1072
|
+
# resp.provider_service_name #=> String
|
1073
|
+
# resp.provider_service_type #=> String, one of "ASSIGNMENT", "ID_MAPPING"
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetProviderService AWS API Documentation
|
1076
|
+
#
|
1077
|
+
# @overload get_provider_service(params = {})
|
1078
|
+
# @param [Hash] params ({})
|
1079
|
+
def get_provider_service(params = {}, options = {})
|
1080
|
+
req = build_request(:get_provider_service, params)
|
1081
|
+
req.send_request(options)
|
1082
|
+
end
|
1083
|
+
|
788
1084
|
# Returns the SchemaMapping of a given name.
|
789
1085
|
#
|
790
1086
|
# @option params [required, String] :schema_name
|
@@ -794,6 +1090,7 @@ module Aws::EntityResolution
|
|
794
1090
|
#
|
795
1091
|
# * {Types::GetSchemaMappingOutput#created_at #created_at} => Time
|
796
1092
|
# * {Types::GetSchemaMappingOutput#description #description} => String
|
1093
|
+
# * {Types::GetSchemaMappingOutput#has_workflows #has_workflows} => Boolean
|
797
1094
|
# * {Types::GetSchemaMappingOutput#mapped_input_fields #mapped_input_fields} => Array<Types::SchemaInputAttribute>
|
798
1095
|
# * {Types::GetSchemaMappingOutput#schema_arn #schema_arn} => String
|
799
1096
|
# * {Types::GetSchemaMappingOutput#schema_name #schema_name} => String
|
@@ -810,11 +1107,13 @@ module Aws::EntityResolution
|
|
810
1107
|
#
|
811
1108
|
# resp.created_at #=> Time
|
812
1109
|
# resp.description #=> String
|
1110
|
+
# resp.has_workflows #=> Boolean
|
813
1111
|
# resp.mapped_input_fields #=> Array
|
814
1112
|
# resp.mapped_input_fields[0].field_name #=> String
|
815
1113
|
# resp.mapped_input_fields[0].group_name #=> String
|
816
1114
|
# resp.mapped_input_fields[0].match_key #=> String
|
817
|
-
# resp.mapped_input_fields[0].
|
1115
|
+
# resp.mapped_input_fields[0].sub_type #=> String
|
1116
|
+
# resp.mapped_input_fields[0].type #=> String, one of "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID"
|
818
1117
|
# resp.schema_arn #=> String
|
819
1118
|
# resp.schema_name #=> String
|
820
1119
|
# resp.tags #=> Hash
|
@@ -830,13 +1129,98 @@ module Aws::EntityResolution
|
|
830
1129
|
req.send_request(options)
|
831
1130
|
end
|
832
1131
|
|
1132
|
+
# Lists all ID mapping jobs for a given workflow.
|
1133
|
+
#
|
1134
|
+
# @option params [Integer] :max_results
|
1135
|
+
# The maximum number of objects returned per page.
|
1136
|
+
#
|
1137
|
+
# @option params [String] :next_token
|
1138
|
+
# The pagination token from the previous API call.
|
1139
|
+
#
|
1140
|
+
# @option params [required, String] :workflow_name
|
1141
|
+
# The name of the workflow to be retrieved.
|
1142
|
+
#
|
1143
|
+
# @return [Types::ListIdMappingJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1144
|
+
#
|
1145
|
+
# * {Types::ListIdMappingJobsOutput#jobs #jobs} => Array<Types::JobSummary>
|
1146
|
+
# * {Types::ListIdMappingJobsOutput#next_token #next_token} => String
|
1147
|
+
#
|
1148
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1149
|
+
#
|
1150
|
+
# @example Request syntax with placeholder values
|
1151
|
+
#
|
1152
|
+
# resp = client.list_id_mapping_jobs({
|
1153
|
+
# max_results: 1,
|
1154
|
+
# next_token: "NextToken",
|
1155
|
+
# workflow_name: "EntityName", # required
|
1156
|
+
# })
|
1157
|
+
#
|
1158
|
+
# @example Response structure
|
1159
|
+
#
|
1160
|
+
# resp.jobs #=> Array
|
1161
|
+
# resp.jobs[0].end_time #=> Time
|
1162
|
+
# resp.jobs[0].job_id #=> String
|
1163
|
+
# resp.jobs[0].start_time #=> Time
|
1164
|
+
# resp.jobs[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "QUEUED"
|
1165
|
+
# resp.next_token #=> String
|
1166
|
+
#
|
1167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListIdMappingJobs AWS API Documentation
|
1168
|
+
#
|
1169
|
+
# @overload list_id_mapping_jobs(params = {})
|
1170
|
+
# @param [Hash] params ({})
|
1171
|
+
def list_id_mapping_jobs(params = {}, options = {})
|
1172
|
+
req = build_request(:list_id_mapping_jobs, params)
|
1173
|
+
req.send_request(options)
|
1174
|
+
end
|
1175
|
+
|
1176
|
+
# Returns a list of all the `IdMappingWorkflows` that have been created
|
1177
|
+
# for an Amazon Web Services account.
|
1178
|
+
#
|
1179
|
+
# @option params [Integer] :max_results
|
1180
|
+
# The maximum number of objects returned per page.
|
1181
|
+
#
|
1182
|
+
# @option params [String] :next_token
|
1183
|
+
# The pagination token from the previous API call.
|
1184
|
+
#
|
1185
|
+
# @return [Types::ListIdMappingWorkflowsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1186
|
+
#
|
1187
|
+
# * {Types::ListIdMappingWorkflowsOutput#next_token #next_token} => String
|
1188
|
+
# * {Types::ListIdMappingWorkflowsOutput#workflow_summaries #workflow_summaries} => Array<Types::IdMappingWorkflowSummary>
|
1189
|
+
#
|
1190
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1191
|
+
#
|
1192
|
+
# @example Request syntax with placeholder values
|
1193
|
+
#
|
1194
|
+
# resp = client.list_id_mapping_workflows({
|
1195
|
+
# max_results: 1,
|
1196
|
+
# next_token: "NextToken",
|
1197
|
+
# })
|
1198
|
+
#
|
1199
|
+
# @example Response structure
|
1200
|
+
#
|
1201
|
+
# resp.next_token #=> String
|
1202
|
+
# resp.workflow_summaries #=> Array
|
1203
|
+
# resp.workflow_summaries[0].created_at #=> Time
|
1204
|
+
# resp.workflow_summaries[0].updated_at #=> Time
|
1205
|
+
# resp.workflow_summaries[0].workflow_arn #=> String
|
1206
|
+
# resp.workflow_summaries[0].workflow_name #=> String
|
1207
|
+
#
|
1208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListIdMappingWorkflows AWS API Documentation
|
1209
|
+
#
|
1210
|
+
# @overload list_id_mapping_workflows(params = {})
|
1211
|
+
# @param [Hash] params ({})
|
1212
|
+
def list_id_mapping_workflows(params = {}, options = {})
|
1213
|
+
req = build_request(:list_id_mapping_workflows, params)
|
1214
|
+
req.send_request(options)
|
1215
|
+
end
|
1216
|
+
|
833
1217
|
# Lists all jobs for a given workflow.
|
834
1218
|
#
|
835
1219
|
# @option params [Integer] :max_results
|
836
1220
|
# The maximum number of objects returned per page.
|
837
1221
|
#
|
838
1222
|
# @option params [String] :next_token
|
839
|
-
# The pagination token from the previous
|
1223
|
+
# The pagination token from the previous API call.
|
840
1224
|
#
|
841
1225
|
# @option params [required, String] :workflow_name
|
842
1226
|
# The name of the workflow to be retrieved.
|
@@ -881,7 +1265,7 @@ module Aws::EntityResolution
|
|
881
1265
|
# The maximum number of objects returned per page.
|
882
1266
|
#
|
883
1267
|
# @option params [String] :next_token
|
884
|
-
# The pagination token from the previous
|
1268
|
+
# The pagination token from the previous API call.
|
885
1269
|
#
|
886
1270
|
# @return [Types::ListMatchingWorkflowsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
887
1271
|
#
|
@@ -902,6 +1286,7 @@ module Aws::EntityResolution
|
|
902
1286
|
# resp.next_token #=> String
|
903
1287
|
# resp.workflow_summaries #=> Array
|
904
1288
|
# resp.workflow_summaries[0].created_at #=> Time
|
1289
|
+
# resp.workflow_summaries[0].resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
|
905
1290
|
# resp.workflow_summaries[0].updated_at #=> Time
|
906
1291
|
# resp.workflow_summaries[0].workflow_arn #=> String
|
907
1292
|
# resp.workflow_summaries[0].workflow_name #=> String
|
@@ -915,6 +1300,52 @@ module Aws::EntityResolution
|
|
915
1300
|
req.send_request(options)
|
916
1301
|
end
|
917
1302
|
|
1303
|
+
# Returns a list of all the `ProviderServices` that are available in
|
1304
|
+
# this Amazon Web Services Region.
|
1305
|
+
#
|
1306
|
+
# @option params [Integer] :max_results
|
1307
|
+
# The maximum number of objects returned per page.
|
1308
|
+
#
|
1309
|
+
# @option params [String] :next_token
|
1310
|
+
# The pagination token from the previous API call.
|
1311
|
+
#
|
1312
|
+
# @option params [String] :provider_name
|
1313
|
+
# The name of the provider. This name is typically the company name.
|
1314
|
+
#
|
1315
|
+
# @return [Types::ListProviderServicesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1316
|
+
#
|
1317
|
+
# * {Types::ListProviderServicesOutput#next_token #next_token} => String
|
1318
|
+
# * {Types::ListProviderServicesOutput#provider_service_summaries #provider_service_summaries} => Array<Types::ProviderServiceSummary>
|
1319
|
+
#
|
1320
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1321
|
+
#
|
1322
|
+
# @example Request syntax with placeholder values
|
1323
|
+
#
|
1324
|
+
# resp = client.list_provider_services({
|
1325
|
+
# max_results: 1,
|
1326
|
+
# next_token: "NextToken",
|
1327
|
+
# provider_name: "EntityName",
|
1328
|
+
# })
|
1329
|
+
#
|
1330
|
+
# @example Response structure
|
1331
|
+
#
|
1332
|
+
# resp.next_token #=> String
|
1333
|
+
# resp.provider_service_summaries #=> Array
|
1334
|
+
# resp.provider_service_summaries[0].provider_name #=> String
|
1335
|
+
# resp.provider_service_summaries[0].provider_service_arn #=> String
|
1336
|
+
# resp.provider_service_summaries[0].provider_service_display_name #=> String
|
1337
|
+
# resp.provider_service_summaries[0].provider_service_name #=> String
|
1338
|
+
# resp.provider_service_summaries[0].provider_service_type #=> String, one of "ASSIGNMENT", "ID_MAPPING"
|
1339
|
+
#
|
1340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListProviderServices AWS API Documentation
|
1341
|
+
#
|
1342
|
+
# @overload list_provider_services(params = {})
|
1343
|
+
# @param [Hash] params ({})
|
1344
|
+
def list_provider_services(params = {}, options = {})
|
1345
|
+
req = build_request(:list_provider_services, params)
|
1346
|
+
req.send_request(options)
|
1347
|
+
end
|
1348
|
+
|
918
1349
|
# Returns a list of all the `SchemaMappings` that have been created for
|
919
1350
|
# an Amazon Web Services account.
|
920
1351
|
#
|
@@ -922,7 +1353,7 @@ module Aws::EntityResolution
|
|
922
1353
|
# The maximum number of objects returned per page.
|
923
1354
|
#
|
924
1355
|
# @option params [String] :next_token
|
925
|
-
# The pagination token from the previous
|
1356
|
+
# The pagination token from the previous API call.
|
926
1357
|
#
|
927
1358
|
# @return [Types::ListSchemaMappingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
928
1359
|
#
|
@@ -943,6 +1374,7 @@ module Aws::EntityResolution
|
|
943
1374
|
# resp.next_token #=> String
|
944
1375
|
# resp.schema_list #=> Array
|
945
1376
|
# resp.schema_list[0].created_at #=> Time
|
1377
|
+
# resp.schema_list[0].has_workflows #=> Boolean
|
946
1378
|
# resp.schema_list[0].schema_arn #=> String
|
947
1379
|
# resp.schema_list[0].schema_name #=> String
|
948
1380
|
# resp.schema_list[0].updated_at #=> Time
|
@@ -987,6 +1419,35 @@ module Aws::EntityResolution
|
|
987
1419
|
req.send_request(options)
|
988
1420
|
end
|
989
1421
|
|
1422
|
+
# Starts the `IdMappingJob` of a workflow. The workflow must have
|
1423
|
+
# previously been created using the `CreateIdMappingWorkflow` endpoint.
|
1424
|
+
#
|
1425
|
+
# @option params [required, String] :workflow_name
|
1426
|
+
# The name of the ID mapping job to be retrieved.
|
1427
|
+
#
|
1428
|
+
# @return [Types::StartIdMappingJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1429
|
+
#
|
1430
|
+
# * {Types::StartIdMappingJobOutput#job_id #job_id} => String
|
1431
|
+
#
|
1432
|
+
# @example Request syntax with placeholder values
|
1433
|
+
#
|
1434
|
+
# resp = client.start_id_mapping_job({
|
1435
|
+
# workflow_name: "EntityName", # required
|
1436
|
+
# })
|
1437
|
+
#
|
1438
|
+
# @example Response structure
|
1439
|
+
#
|
1440
|
+
# resp.job_id #=> String
|
1441
|
+
#
|
1442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/StartIdMappingJob AWS API Documentation
|
1443
|
+
#
|
1444
|
+
# @overload start_id_mapping_job(params = {})
|
1445
|
+
# @param [Hash] params ({})
|
1446
|
+
def start_id_mapping_job(params = {}, options = {})
|
1447
|
+
req = build_request(:start_id_mapping_job, params)
|
1448
|
+
req.send_request(options)
|
1449
|
+
end
|
1450
|
+
|
990
1451
|
# Starts the `MatchingJob` of a workflow. The workflow must have
|
991
1452
|
# previously been created using the `CreateMatchingWorkflow` endpoint.
|
992
1453
|
#
|
@@ -1083,6 +1544,99 @@ module Aws::EntityResolution
|
|
1083
1544
|
req.send_request(options)
|
1084
1545
|
end
|
1085
1546
|
|
1547
|
+
# Updates an existing `IdMappingWorkflow`. This method is identical to
|
1548
|
+
# `CreateIdMappingWorkflow`, except it uses an HTTP `PUT` request
|
1549
|
+
# instead of a `POST` request, and the `IdMappingWorkflow` must already
|
1550
|
+
# exist for the method to succeed.
|
1551
|
+
#
|
1552
|
+
# @option params [String] :description
|
1553
|
+
# A description of the workflow.
|
1554
|
+
#
|
1555
|
+
# @option params [required, Types::IdMappingTechniques] :id_mapping_techniques
|
1556
|
+
# An object which defines the `idMappingType` and the
|
1557
|
+
# `providerProperties`.
|
1558
|
+
#
|
1559
|
+
# @option params [required, Array<Types::IdMappingWorkflowInputSource>] :input_source_config
|
1560
|
+
# A list of `InputSource` objects, which have the fields
|
1561
|
+
# `InputSourceARN` and `SchemaName`.
|
1562
|
+
#
|
1563
|
+
# @option params [required, Array<Types::IdMappingWorkflowOutputSource>] :output_source_config
|
1564
|
+
# A list of `OutputSource` objects, each of which contains fields
|
1565
|
+
# `OutputS3Path` and `KMSArn`.
|
1566
|
+
#
|
1567
|
+
# @option params [required, String] :role_arn
|
1568
|
+
# The Amazon Resource Name (ARN) of the IAM role. Entity Resolution
|
1569
|
+
# assumes this role to access resources on your behalf.
|
1570
|
+
#
|
1571
|
+
# @option params [required, String] :workflow_name
|
1572
|
+
# The name of the workflow.
|
1573
|
+
#
|
1574
|
+
# @return [Types::UpdateIdMappingWorkflowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1575
|
+
#
|
1576
|
+
# * {Types::UpdateIdMappingWorkflowOutput#description #description} => String
|
1577
|
+
# * {Types::UpdateIdMappingWorkflowOutput#id_mapping_techniques #id_mapping_techniques} => Types::IdMappingTechniques
|
1578
|
+
# * {Types::UpdateIdMappingWorkflowOutput#input_source_config #input_source_config} => Array<Types::IdMappingWorkflowInputSource>
|
1579
|
+
# * {Types::UpdateIdMappingWorkflowOutput#output_source_config #output_source_config} => Array<Types::IdMappingWorkflowOutputSource>
|
1580
|
+
# * {Types::UpdateIdMappingWorkflowOutput#role_arn #role_arn} => String
|
1581
|
+
# * {Types::UpdateIdMappingWorkflowOutput#workflow_arn #workflow_arn} => String
|
1582
|
+
# * {Types::UpdateIdMappingWorkflowOutput#workflow_name #workflow_name} => String
|
1583
|
+
#
|
1584
|
+
# @example Request syntax with placeholder values
|
1585
|
+
#
|
1586
|
+
# resp = client.update_id_mapping_workflow({
|
1587
|
+
# description: "Description",
|
1588
|
+
# id_mapping_techniques: { # required
|
1589
|
+
# id_mapping_type: "PROVIDER", # required, accepts PROVIDER
|
1590
|
+
# provider_properties: { # required
|
1591
|
+
# intermediate_source_configuration: {
|
1592
|
+
# intermediate_s3_path: "S3Path", # required
|
1593
|
+
# },
|
1594
|
+
# provider_configuration: {
|
1595
|
+
# },
|
1596
|
+
# provider_service_arn: "ProviderServiceArn", # required
|
1597
|
+
# },
|
1598
|
+
# },
|
1599
|
+
# input_source_config: [ # required
|
1600
|
+
# {
|
1601
|
+
# input_source_arn: "IdMappingWorkflowInputSourceInputSourceARNString", # required
|
1602
|
+
# schema_name: "EntityName", # required
|
1603
|
+
# },
|
1604
|
+
# ],
|
1605
|
+
# output_source_config: [ # required
|
1606
|
+
# {
|
1607
|
+
# kms_arn: "KMSArn",
|
1608
|
+
# output_s3_path: "S3Path", # required
|
1609
|
+
# },
|
1610
|
+
# ],
|
1611
|
+
# role_arn: "RoleArn", # required
|
1612
|
+
# workflow_name: "EntityName", # required
|
1613
|
+
# })
|
1614
|
+
#
|
1615
|
+
# @example Response structure
|
1616
|
+
#
|
1617
|
+
# resp.description #=> String
|
1618
|
+
# resp.id_mapping_techniques.id_mapping_type #=> String, one of "PROVIDER"
|
1619
|
+
# resp.id_mapping_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
|
1620
|
+
# resp.id_mapping_techniques.provider_properties.provider_service_arn #=> String
|
1621
|
+
# resp.input_source_config #=> Array
|
1622
|
+
# resp.input_source_config[0].input_source_arn #=> String
|
1623
|
+
# resp.input_source_config[0].schema_name #=> String
|
1624
|
+
# resp.output_source_config #=> Array
|
1625
|
+
# resp.output_source_config[0].kms_arn #=> String
|
1626
|
+
# resp.output_source_config[0].output_s3_path #=> String
|
1627
|
+
# resp.role_arn #=> String
|
1628
|
+
# resp.workflow_arn #=> String
|
1629
|
+
# resp.workflow_name #=> String
|
1630
|
+
#
|
1631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateIdMappingWorkflow AWS API Documentation
|
1632
|
+
#
|
1633
|
+
# @overload update_id_mapping_workflow(params = {})
|
1634
|
+
# @param [Hash] params ({})
|
1635
|
+
def update_id_mapping_workflow(params = {}, options = {})
|
1636
|
+
req = build_request(:update_id_mapping_workflow, params)
|
1637
|
+
req.send_request(options)
|
1638
|
+
end
|
1639
|
+
|
1086
1640
|
# Updates an existing `MatchingWorkflow`. This method is identical to
|
1087
1641
|
# `CreateMatchingWorkflow`, except it uses an HTTP `PUT` request instead
|
1088
1642
|
# of a `POST` request, and the `MatchingWorkflow` must already exist for
|
@@ -1153,7 +1707,15 @@ module Aws::EntityResolution
|
|
1153
1707
|
# },
|
1154
1708
|
# ],
|
1155
1709
|
# resolution_techniques: { # required
|
1156
|
-
#
|
1710
|
+
# provider_properties: {
|
1711
|
+
# intermediate_source_configuration: {
|
1712
|
+
# intermediate_s3_path: "S3Path", # required
|
1713
|
+
# },
|
1714
|
+
# provider_configuration: {
|
1715
|
+
# },
|
1716
|
+
# provider_service_arn: "ProviderServiceArn", # required
|
1717
|
+
# },
|
1718
|
+
# resolution_type: "RULE_MATCHING", # required, accepts RULE_MATCHING, ML_MATCHING, PROVIDER
|
1157
1719
|
# rule_based_properties: {
|
1158
1720
|
# attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
|
1159
1721
|
# rules: [ # required
|
@@ -1183,7 +1745,9 @@ module Aws::EntityResolution
|
|
1183
1745
|
# resp.output_source_config[0].output[0].hashed #=> Boolean
|
1184
1746
|
# resp.output_source_config[0].output[0].name #=> String
|
1185
1747
|
# resp.output_source_config[0].output_s3_path #=> String
|
1186
|
-
# resp.resolution_techniques.
|
1748
|
+
# resp.resolution_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
|
1749
|
+
# resp.resolution_techniques.provider_properties.provider_service_arn #=> String
|
1750
|
+
# resp.resolution_techniques.resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
|
1187
1751
|
# resp.resolution_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
|
1188
1752
|
# resp.resolution_techniques.rule_based_properties.rules #=> Array
|
1189
1753
|
# resp.resolution_techniques.rule_based_properties.rules[0].matching_keys #=> Array
|
@@ -1201,6 +1765,70 @@ module Aws::EntityResolution
|
|
1201
1765
|
req.send_request(options)
|
1202
1766
|
end
|
1203
1767
|
|
1768
|
+
# Updates a schema mapping.
|
1769
|
+
#
|
1770
|
+
# <note markdown="1"> A schema is immutable if it is being used by a workflow. Therefore,
|
1771
|
+
# you can't update a schema mapping if it's associated with a
|
1772
|
+
# workflow.
|
1773
|
+
#
|
1774
|
+
# </note>
|
1775
|
+
#
|
1776
|
+
# @option params [String] :description
|
1777
|
+
# A description of the schema.
|
1778
|
+
#
|
1779
|
+
# @option params [required, Array<Types::SchemaInputAttribute>] :mapped_input_fields
|
1780
|
+
# A list of `MappedInputFields`. Each `MappedInputField` corresponds to
|
1781
|
+
# a column the source data table, and contains column name plus
|
1782
|
+
# additional information that Entity Resolution uses for matching.
|
1783
|
+
#
|
1784
|
+
# @option params [required, String] :schema_name
|
1785
|
+
# The name of the schema. There can't be multiple `SchemaMappings` with
|
1786
|
+
# the same name.
|
1787
|
+
#
|
1788
|
+
# @return [Types::UpdateSchemaMappingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1789
|
+
#
|
1790
|
+
# * {Types::UpdateSchemaMappingOutput#description #description} => String
|
1791
|
+
# * {Types::UpdateSchemaMappingOutput#mapped_input_fields #mapped_input_fields} => Array<Types::SchemaInputAttribute>
|
1792
|
+
# * {Types::UpdateSchemaMappingOutput#schema_arn #schema_arn} => String
|
1793
|
+
# * {Types::UpdateSchemaMappingOutput#schema_name #schema_name} => String
|
1794
|
+
#
|
1795
|
+
# @example Request syntax with placeholder values
|
1796
|
+
#
|
1797
|
+
# resp = client.update_schema_mapping({
|
1798
|
+
# description: "Description",
|
1799
|
+
# mapped_input_fields: [ # required
|
1800
|
+
# {
|
1801
|
+
# field_name: "AttributeName", # required
|
1802
|
+
# group_name: "AttributeName",
|
1803
|
+
# match_key: "AttributeName",
|
1804
|
+
# sub_type: "AttributeName",
|
1805
|
+
# type: "NAME", # required, accepts NAME, NAME_FIRST, NAME_MIDDLE, NAME_LAST, ADDRESS, ADDRESS_STREET1, ADDRESS_STREET2, ADDRESS_STREET3, ADDRESS_CITY, ADDRESS_STATE, ADDRESS_COUNTRY, ADDRESS_POSTALCODE, PHONE, PHONE_NUMBER, PHONE_COUNTRYCODE, EMAIL_ADDRESS, UNIQUE_ID, DATE, STRING, PROVIDER_ID
|
1806
|
+
# },
|
1807
|
+
# ],
|
1808
|
+
# schema_name: "EntityName", # required
|
1809
|
+
# })
|
1810
|
+
#
|
1811
|
+
# @example Response structure
|
1812
|
+
#
|
1813
|
+
# resp.description #=> String
|
1814
|
+
# resp.mapped_input_fields #=> Array
|
1815
|
+
# resp.mapped_input_fields[0].field_name #=> String
|
1816
|
+
# resp.mapped_input_fields[0].group_name #=> String
|
1817
|
+
# resp.mapped_input_fields[0].match_key #=> String
|
1818
|
+
# resp.mapped_input_fields[0].sub_type #=> String
|
1819
|
+
# resp.mapped_input_fields[0].type #=> String, one of "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID"
|
1820
|
+
# resp.schema_arn #=> String
|
1821
|
+
# resp.schema_name #=> String
|
1822
|
+
#
|
1823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateSchemaMapping AWS API Documentation
|
1824
|
+
#
|
1825
|
+
# @overload update_schema_mapping(params = {})
|
1826
|
+
# @param [Hash] params ({})
|
1827
|
+
def update_schema_mapping(params = {}, options = {})
|
1828
|
+
req = build_request(:update_schema_mapping, params)
|
1829
|
+
req.send_request(options)
|
1830
|
+
end
|
1831
|
+
|
1204
1832
|
# @!endgroup
|
1205
1833
|
|
1206
1834
|
# @param params ({})
|
@@ -1214,7 +1842,7 @@ module Aws::EntityResolution
|
|
1214
1842
|
params: params,
|
1215
1843
|
config: config)
|
1216
1844
|
context[:gem_name] = 'aws-sdk-entityresolution'
|
1217
|
-
context[:gem_version] = '1.
|
1845
|
+
context[:gem_version] = '1.4.0'
|
1218
1846
|
Seahorse::Client::Request.new(handlers, context)
|
1219
1847
|
end
|
1220
1848
|
|