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
@@ -40,6 +40,103 @@ module Aws::EntityResolution
|
|
40
40
|
include Aws::Structure
|
41
41
|
end
|
42
42
|
|
43
|
+
# @!attribute [rw] description
|
44
|
+
# A description of the workflow.
|
45
|
+
# @return [String]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] id_mapping_techniques
|
48
|
+
# An object which defines the `idMappingType` and the
|
49
|
+
# `providerProperties`.
|
50
|
+
# @return [Types::IdMappingTechniques]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] input_source_config
|
53
|
+
# A list of `InputSource` objects, which have the fields
|
54
|
+
# `InputSourceARN` and `SchemaName`.
|
55
|
+
# @return [Array<Types::IdMappingWorkflowInputSource>]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] output_source_config
|
58
|
+
# A list of `IdMappingWorkflowOutputSource` objects, each of which
|
59
|
+
# contains fields `OutputS3Path` and `Output`.
|
60
|
+
# @return [Array<Types::IdMappingWorkflowOutputSource>]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] role_arn
|
63
|
+
# The Amazon Resource Name (ARN) of the IAM role. Entity Resolution
|
64
|
+
# assumes this role to create resources on your behalf as part of
|
65
|
+
# workflow execution.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] tags
|
69
|
+
# The tags used to organize, track, or control access for this
|
70
|
+
# resource.
|
71
|
+
# @return [Hash<String,String>]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] workflow_name
|
74
|
+
# The name of the workflow. There can't be multiple
|
75
|
+
# `IdMappingWorkflows` with the same name.
|
76
|
+
# @return [String]
|
77
|
+
#
|
78
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateIdMappingWorkflowInput AWS API Documentation
|
79
|
+
#
|
80
|
+
class CreateIdMappingWorkflowInput < Struct.new(
|
81
|
+
:description,
|
82
|
+
:id_mapping_techniques,
|
83
|
+
:input_source_config,
|
84
|
+
:output_source_config,
|
85
|
+
:role_arn,
|
86
|
+
:tags,
|
87
|
+
:workflow_name)
|
88
|
+
SENSITIVE = []
|
89
|
+
include Aws::Structure
|
90
|
+
end
|
91
|
+
|
92
|
+
# @!attribute [rw] description
|
93
|
+
# A description of the workflow.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] id_mapping_techniques
|
97
|
+
# An object which defines the `idMappingType` and the
|
98
|
+
# `providerProperties`.
|
99
|
+
# @return [Types::IdMappingTechniques]
|
100
|
+
#
|
101
|
+
# @!attribute [rw] input_source_config
|
102
|
+
# A list of `InputSource` objects, which have the fields
|
103
|
+
# `InputSourceARN` and `SchemaName`.
|
104
|
+
# @return [Array<Types::IdMappingWorkflowInputSource>]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] output_source_config
|
107
|
+
# A list of `IdMappingWorkflowOutputSource` objects, each of which
|
108
|
+
# contains fields `OutputS3Path` and `Output`.
|
109
|
+
# @return [Array<Types::IdMappingWorkflowOutputSource>]
|
110
|
+
#
|
111
|
+
# @!attribute [rw] role_arn
|
112
|
+
# The Amazon Resource Name (ARN) of the IAM role. Entity Resolution
|
113
|
+
# assumes this role to create resources on your behalf as part of
|
114
|
+
# workflow execution.
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] workflow_arn
|
118
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
119
|
+
# the `IDMappingWorkflow`.
|
120
|
+
# @return [String]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] workflow_name
|
123
|
+
# The name of the workflow.
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateIdMappingWorkflowOutput AWS API Documentation
|
127
|
+
#
|
128
|
+
class CreateIdMappingWorkflowOutput < Struct.new(
|
129
|
+
:description,
|
130
|
+
:id_mapping_techniques,
|
131
|
+
:input_source_config,
|
132
|
+
:output_source_config,
|
133
|
+
:role_arn,
|
134
|
+
:workflow_arn,
|
135
|
+
:workflow_name)
|
136
|
+
SENSITIVE = []
|
137
|
+
include Aws::Structure
|
138
|
+
end
|
139
|
+
|
43
140
|
# @!attribute [rw] description
|
44
141
|
# A description of the workflow.
|
45
142
|
# @return [String]
|
@@ -76,8 +173,8 @@ module Aws::EntityResolution
|
|
76
173
|
# @return [Hash<String,String>]
|
77
174
|
#
|
78
175
|
# @!attribute [rw] workflow_name
|
79
|
-
# The name of the workflow. There
|
80
|
-
# `
|
176
|
+
# The name of the workflow. There can't be multiple
|
177
|
+
# `MatchingWorkflows` with the same name.
|
81
178
|
# @return [String]
|
82
179
|
#
|
83
180
|
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateMatchingWorkflowInput AWS API Documentation
|
@@ -160,7 +257,7 @@ module Aws::EntityResolution
|
|
160
257
|
# @return [Array<Types::SchemaInputAttribute>]
|
161
258
|
#
|
162
259
|
# @!attribute [rw] schema_name
|
163
|
-
# The name of the schema. There
|
260
|
+
# The name of the schema. There can't be multiple `SchemaMappings`
|
164
261
|
# with the same name.
|
165
262
|
# @return [String]
|
166
263
|
#
|
@@ -210,6 +307,30 @@ module Aws::EntityResolution
|
|
210
307
|
include Aws::Structure
|
211
308
|
end
|
212
309
|
|
310
|
+
# @!attribute [rw] workflow_name
|
311
|
+
# The name of the workflow to be deleted.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteIdMappingWorkflowInput AWS API Documentation
|
315
|
+
#
|
316
|
+
class DeleteIdMappingWorkflowInput < Struct.new(
|
317
|
+
:workflow_name)
|
318
|
+
SENSITIVE = []
|
319
|
+
include Aws::Structure
|
320
|
+
end
|
321
|
+
|
322
|
+
# @!attribute [rw] message
|
323
|
+
# A successful operation message.
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteIdMappingWorkflowOutput AWS API Documentation
|
327
|
+
#
|
328
|
+
class DeleteIdMappingWorkflowOutput < Struct.new(
|
329
|
+
:message)
|
330
|
+
SENSITIVE = []
|
331
|
+
include Aws::Structure
|
332
|
+
end
|
333
|
+
|
213
334
|
# @!attribute [rw] workflow_name
|
214
335
|
# The name of the workflow to be retrieved.
|
215
336
|
# @return [String]
|
@@ -297,6 +418,136 @@ module Aws::EntityResolution
|
|
297
418
|
include Aws::Structure
|
298
419
|
end
|
299
420
|
|
421
|
+
# @!attribute [rw] job_id
|
422
|
+
# The ID of the job.
|
423
|
+
# @return [String]
|
424
|
+
#
|
425
|
+
# @!attribute [rw] workflow_name
|
426
|
+
# The name of the workflow.
|
427
|
+
# @return [String]
|
428
|
+
#
|
429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetIdMappingJobInput AWS API Documentation
|
430
|
+
#
|
431
|
+
class GetIdMappingJobInput < Struct.new(
|
432
|
+
:job_id,
|
433
|
+
:workflow_name)
|
434
|
+
SENSITIVE = []
|
435
|
+
include Aws::Structure
|
436
|
+
end
|
437
|
+
|
438
|
+
# @!attribute [rw] end_time
|
439
|
+
# The time at which the job has finished.
|
440
|
+
# @return [Time]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] error_details
|
443
|
+
# An object containing an error message, if there was an error.
|
444
|
+
# @return [Types::ErrorDetails]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] job_id
|
447
|
+
# The ID of the job.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] metrics
|
451
|
+
# Metrics associated with the execution, specifically total records
|
452
|
+
# processed, unique IDs generated, and records the execution skipped.
|
453
|
+
# @return [Types::IdMappingJobMetrics]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] start_time
|
456
|
+
# The time at which the job was started.
|
457
|
+
# @return [Time]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] status
|
460
|
+
# The current status of the job.
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetIdMappingJobOutput AWS API Documentation
|
464
|
+
#
|
465
|
+
class GetIdMappingJobOutput < Struct.new(
|
466
|
+
:end_time,
|
467
|
+
:error_details,
|
468
|
+
:job_id,
|
469
|
+
:metrics,
|
470
|
+
:start_time,
|
471
|
+
:status)
|
472
|
+
SENSITIVE = []
|
473
|
+
include Aws::Structure
|
474
|
+
end
|
475
|
+
|
476
|
+
# @!attribute [rw] workflow_name
|
477
|
+
# The name of the workflow.
|
478
|
+
# @return [String]
|
479
|
+
#
|
480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetIdMappingWorkflowInput AWS API Documentation
|
481
|
+
#
|
482
|
+
class GetIdMappingWorkflowInput < Struct.new(
|
483
|
+
:workflow_name)
|
484
|
+
SENSITIVE = []
|
485
|
+
include Aws::Structure
|
486
|
+
end
|
487
|
+
|
488
|
+
# @!attribute [rw] created_at
|
489
|
+
# The timestamp of when the workflow was created.
|
490
|
+
# @return [Time]
|
491
|
+
#
|
492
|
+
# @!attribute [rw] description
|
493
|
+
# A description of the workflow.
|
494
|
+
# @return [String]
|
495
|
+
#
|
496
|
+
# @!attribute [rw] id_mapping_techniques
|
497
|
+
# An object which defines the `idMappingType` and the
|
498
|
+
# `providerProperties`.
|
499
|
+
# @return [Types::IdMappingTechniques]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] input_source_config
|
502
|
+
# A list of `InputSource` objects, which have the fields
|
503
|
+
# `InputSourceARN` and `SchemaName`.
|
504
|
+
# @return [Array<Types::IdMappingWorkflowInputSource>]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] output_source_config
|
507
|
+
# A list of `OutputSource` objects, each of which contains fields
|
508
|
+
# `OutputS3Path` and `KMSArn`.
|
509
|
+
# @return [Array<Types::IdMappingWorkflowOutputSource>]
|
510
|
+
#
|
511
|
+
# @!attribute [rw] role_arn
|
512
|
+
# The Amazon Resource Name (ARN) of the IAM role. Entity Resolution
|
513
|
+
# assumes this role to access resources on your behalf.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @!attribute [rw] tags
|
517
|
+
# The tags used to organize, track, or control access for this
|
518
|
+
# resource.
|
519
|
+
# @return [Hash<String,String>]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] updated_at
|
522
|
+
# The timestamp of when the workflow was last updated.
|
523
|
+
# @return [Time]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] workflow_arn
|
526
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
527
|
+
# the `IdMappingWorkflow` .
|
528
|
+
# @return [String]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] workflow_name
|
531
|
+
# The name of the workflow.
|
532
|
+
# @return [String]
|
533
|
+
#
|
534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetIdMappingWorkflowOutput AWS API Documentation
|
535
|
+
#
|
536
|
+
class GetIdMappingWorkflowOutput < Struct.new(
|
537
|
+
:created_at,
|
538
|
+
:description,
|
539
|
+
:id_mapping_techniques,
|
540
|
+
:input_source_config,
|
541
|
+
:output_source_config,
|
542
|
+
:role_arn,
|
543
|
+
:tags,
|
544
|
+
:updated_at,
|
545
|
+
:workflow_arn,
|
546
|
+
:workflow_name)
|
547
|
+
SENSITIVE = []
|
548
|
+
include Aws::Structure
|
549
|
+
end
|
550
|
+
|
300
551
|
# @!attribute [rw] record
|
301
552
|
# The record to fetch the Match ID for.
|
302
553
|
# @return [Hash<String,String>]
|
@@ -462,6 +713,89 @@ module Aws::EntityResolution
|
|
462
713
|
include Aws::Structure
|
463
714
|
end
|
464
715
|
|
716
|
+
# @!attribute [rw] provider_name
|
717
|
+
# The name of the provider. This name is typically the company name.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] provider_service_name
|
721
|
+
# The ARN (Amazon Resource Name) of the product that the provider
|
722
|
+
# service provides.
|
723
|
+
# @return [String]
|
724
|
+
#
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetProviderServiceInput AWS API Documentation
|
726
|
+
#
|
727
|
+
class GetProviderServiceInput < Struct.new(
|
728
|
+
:provider_name,
|
729
|
+
:provider_service_name)
|
730
|
+
SENSITIVE = []
|
731
|
+
include Aws::Structure
|
732
|
+
end
|
733
|
+
|
734
|
+
# @!attribute [rw] anonymized_output
|
735
|
+
# Specifies whether output data from the provider is anonymized. A
|
736
|
+
# value of `TRUE` means the output will be anonymized and you can't
|
737
|
+
# relate the data that comes back from the provider to the identifying
|
738
|
+
# input. A value of `FALSE` means the output won't be anonymized and
|
739
|
+
# you can relate the data that comes back from the provider to your
|
740
|
+
# source data.
|
741
|
+
# @return [Boolean]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] provider_configuration_definition
|
744
|
+
# The definition of the provider configuration.
|
745
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] provider_endpoint_configuration
|
748
|
+
# The required configuration fields to use with the provider service.
|
749
|
+
# @return [Types::ProviderEndpointConfiguration]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] provider_entity_output_definition
|
752
|
+
# The definition of the provider entity output.
|
753
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] provider_intermediate_data_access_configuration
|
756
|
+
# The Amazon Web Services accounts and the S3 permissions that are
|
757
|
+
# required by some providers to create an S3 bucket for intermediate
|
758
|
+
# data storage.
|
759
|
+
# @return [Types::ProviderIntermediateDataAccessConfiguration]
|
760
|
+
#
|
761
|
+
# @!attribute [rw] provider_name
|
762
|
+
# The name of the provider. This name is typically the company name.
|
763
|
+
# @return [String]
|
764
|
+
#
|
765
|
+
# @!attribute [rw] provider_service_arn
|
766
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
767
|
+
# the provider service.
|
768
|
+
# @return [String]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] provider_service_display_name
|
771
|
+
# The display name of the provider service.
|
772
|
+
# @return [String]
|
773
|
+
#
|
774
|
+
# @!attribute [rw] provider_service_name
|
775
|
+
# The name of the product that the provider service provides.
|
776
|
+
# @return [String]
|
777
|
+
#
|
778
|
+
# @!attribute [rw] provider_service_type
|
779
|
+
# The type of provider service.
|
780
|
+
# @return [String]
|
781
|
+
#
|
782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetProviderServiceOutput AWS API Documentation
|
783
|
+
#
|
784
|
+
class GetProviderServiceOutput < Struct.new(
|
785
|
+
:anonymized_output,
|
786
|
+
:provider_configuration_definition,
|
787
|
+
:provider_endpoint_configuration,
|
788
|
+
:provider_entity_output_definition,
|
789
|
+
:provider_intermediate_data_access_configuration,
|
790
|
+
:provider_name,
|
791
|
+
:provider_service_arn,
|
792
|
+
:provider_service_display_name,
|
793
|
+
:provider_service_name,
|
794
|
+
:provider_service_type)
|
795
|
+
SENSITIVE = []
|
796
|
+
include Aws::Structure
|
797
|
+
end
|
798
|
+
|
465
799
|
# @!attribute [rw] schema_name
|
466
800
|
# The name of the schema to be retrieved.
|
467
801
|
# @return [String]
|
@@ -482,6 +816,10 @@ module Aws::EntityResolution
|
|
482
816
|
# A description of the schema.
|
483
817
|
# @return [String]
|
484
818
|
#
|
819
|
+
# @!attribute [rw] has_workflows
|
820
|
+
# Specifies whether the schema mapping has been applied to a workflow.
|
821
|
+
# @return [Boolean]
|
822
|
+
#
|
485
823
|
# @!attribute [rw] mapped_input_fields
|
486
824
|
# A list of `MappedInputFields`. Each `MappedInputField` corresponds
|
487
825
|
# to a column the source data table, and contains column name plus
|
@@ -511,6 +849,7 @@ module Aws::EntityResolution
|
|
511
849
|
class GetSchemaMappingOutput < Struct.new(
|
512
850
|
:created_at,
|
513
851
|
:description,
|
852
|
+
:has_workflows,
|
514
853
|
:mapped_input_fields,
|
515
854
|
:schema_arn,
|
516
855
|
:schema_name,
|
@@ -520,6 +859,123 @@ module Aws::EntityResolution
|
|
520
859
|
include Aws::Structure
|
521
860
|
end
|
522
861
|
|
862
|
+
# An object containing `InputRecords`, `TotalRecordsProcessed`,
|
863
|
+
# `MatchIDs`, and `RecordsNotProcessed`.
|
864
|
+
#
|
865
|
+
# @!attribute [rw] input_records
|
866
|
+
# The total number of input records.
|
867
|
+
# @return [Integer]
|
868
|
+
#
|
869
|
+
# @!attribute [rw] records_not_processed
|
870
|
+
# The total number of records that did not get processed.
|
871
|
+
# @return [Integer]
|
872
|
+
#
|
873
|
+
# @!attribute [rw] total_records_processed
|
874
|
+
# The total number of records processed.
|
875
|
+
# @return [Integer]
|
876
|
+
#
|
877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/IdMappingJobMetrics AWS API Documentation
|
878
|
+
#
|
879
|
+
class IdMappingJobMetrics < Struct.new(
|
880
|
+
:input_records,
|
881
|
+
:records_not_processed,
|
882
|
+
:total_records_processed)
|
883
|
+
SENSITIVE = []
|
884
|
+
include Aws::Structure
|
885
|
+
end
|
886
|
+
|
887
|
+
# An object which defines the ID mapping techniques and provider
|
888
|
+
# configurations.
|
889
|
+
#
|
890
|
+
# @!attribute [rw] id_mapping_type
|
891
|
+
# The type of ID mapping.
|
892
|
+
# @return [String]
|
893
|
+
#
|
894
|
+
# @!attribute [rw] provider_properties
|
895
|
+
# An object which defines any additional configurations required by
|
896
|
+
# the provider service.
|
897
|
+
# @return [Types::ProviderProperties]
|
898
|
+
#
|
899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/IdMappingTechniques AWS API Documentation
|
900
|
+
#
|
901
|
+
class IdMappingTechniques < Struct.new(
|
902
|
+
:id_mapping_type,
|
903
|
+
:provider_properties)
|
904
|
+
SENSITIVE = []
|
905
|
+
include Aws::Structure
|
906
|
+
end
|
907
|
+
|
908
|
+
# An object containing `InputSourceARN` and `SchemaName`.
|
909
|
+
#
|
910
|
+
# @!attribute [rw] input_source_arn
|
911
|
+
# An Gluetable ARN for the input source table.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] schema_name
|
915
|
+
# The name of the schema to be retrieved.
|
916
|
+
# @return [String]
|
917
|
+
#
|
918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/IdMappingWorkflowInputSource AWS API Documentation
|
919
|
+
#
|
920
|
+
class IdMappingWorkflowInputSource < Struct.new(
|
921
|
+
:input_source_arn,
|
922
|
+
:schema_name)
|
923
|
+
SENSITIVE = []
|
924
|
+
include Aws::Structure
|
925
|
+
end
|
926
|
+
|
927
|
+
# The output source for the ID mapping workflow.
|
928
|
+
#
|
929
|
+
# @!attribute [rw] kms_arn
|
930
|
+
# Customer KMS ARN for encryption at rest. If not provided, system
|
931
|
+
# will use an Entity Resolution managed KMS key.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] output_s3_path
|
935
|
+
# The S3 path to which Entity Resolution will write the output table.
|
936
|
+
# @return [String]
|
937
|
+
#
|
938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/IdMappingWorkflowOutputSource AWS API Documentation
|
939
|
+
#
|
940
|
+
class IdMappingWorkflowOutputSource < Struct.new(
|
941
|
+
:kms_arn,
|
942
|
+
:output_s3_path)
|
943
|
+
SENSITIVE = []
|
944
|
+
include Aws::Structure
|
945
|
+
end
|
946
|
+
|
947
|
+
# A list of `IdMappingWorkflowSummary` objects, each of which contain
|
948
|
+
# the fields `WorkflowName`, `WorkflowArn`, `CreatedAt`, and
|
949
|
+
# `UpdatedAt`.
|
950
|
+
#
|
951
|
+
# @!attribute [rw] created_at
|
952
|
+
# The timestamp of when the workflow was created.
|
953
|
+
# @return [Time]
|
954
|
+
#
|
955
|
+
# @!attribute [rw] updated_at
|
956
|
+
# The timestamp of when the workflow was last updated.
|
957
|
+
# @return [Time]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] workflow_arn
|
960
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
961
|
+
# the `IdMappingWorkflow`.
|
962
|
+
# @return [String]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] workflow_name
|
965
|
+
# The name of the workflow.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/IdMappingWorkflowSummary AWS API Documentation
|
969
|
+
#
|
970
|
+
class IdMappingWorkflowSummary < Struct.new(
|
971
|
+
:created_at,
|
972
|
+
:updated_at,
|
973
|
+
:workflow_arn,
|
974
|
+
:workflow_name)
|
975
|
+
SENSITIVE = []
|
976
|
+
include Aws::Structure
|
977
|
+
end
|
978
|
+
|
523
979
|
# An object which defines an incremental run type and has only
|
524
980
|
# `incrementalRunType` as a field.
|
525
981
|
#
|
@@ -564,6 +1020,22 @@ module Aws::EntityResolution
|
|
564
1020
|
include Aws::Structure
|
565
1021
|
end
|
566
1022
|
|
1023
|
+
# The Amazon S3 location that temporarily stores your data while it
|
1024
|
+
# processes. Your information won't be saved permanently.
|
1025
|
+
#
|
1026
|
+
# @!attribute [rw] intermediate_s3_path
|
1027
|
+
# The Amazon S3 location (bucket and prefix). For example:
|
1028
|
+
# `s3://provider_bucket/DOC-EXAMPLE-BUCKET`
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1031
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/IntermediateSourceConfiguration AWS API Documentation
|
1032
|
+
#
|
1033
|
+
class IntermediateSourceConfiguration < Struct.new(
|
1034
|
+
:intermediate_s3_path)
|
1035
|
+
SENSITIVE = []
|
1036
|
+
include Aws::Structure
|
1037
|
+
end
|
1038
|
+
|
567
1039
|
# This exception occurs when there is an internal failure in the Entity
|
568
1040
|
# Resolution service. `HTTP Status Code: 500`
|
569
1041
|
#
|
@@ -608,32 +1080,105 @@ module Aws::EntityResolution
|
|
608
1080
|
include Aws::Structure
|
609
1081
|
end
|
610
1082
|
|
611
|
-
# An object containing the `JobId`, `Status`, `StartTime`, and `EndTime`
|
612
|
-
# of a job.
|
613
|
-
#
|
614
|
-
# @!attribute [rw] end_time
|
615
|
-
# The time at which the job has finished.
|
616
|
-
# @return [Time]
|
617
|
-
#
|
618
|
-
# @!attribute [rw] job_id
|
619
|
-
# The ID of the job.
|
1083
|
+
# An object containing the `JobId`, `Status`, `StartTime`, and `EndTime`
|
1084
|
+
# of a job.
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] end_time
|
1087
|
+
# The time at which the job has finished.
|
1088
|
+
# @return [Time]
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] job_id
|
1091
|
+
# The ID of the job.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] start_time
|
1095
|
+
# The time at which the job was started.
|
1096
|
+
# @return [Time]
|
1097
|
+
#
|
1098
|
+
# @!attribute [rw] status
|
1099
|
+
# The current status of the job.
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/JobSummary AWS API Documentation
|
1103
|
+
#
|
1104
|
+
class JobSummary < Struct.new(
|
1105
|
+
:end_time,
|
1106
|
+
:job_id,
|
1107
|
+
:start_time,
|
1108
|
+
:status)
|
1109
|
+
SENSITIVE = []
|
1110
|
+
include Aws::Structure
|
1111
|
+
end
|
1112
|
+
|
1113
|
+
# @!attribute [rw] max_results
|
1114
|
+
# The maximum number of objects returned per page.
|
1115
|
+
# @return [Integer]
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] next_token
|
1118
|
+
# The pagination token from the previous API call.
|
1119
|
+
# @return [String]
|
1120
|
+
#
|
1121
|
+
# @!attribute [rw] workflow_name
|
1122
|
+
# The name of the workflow to be retrieved.
|
1123
|
+
# @return [String]
|
1124
|
+
#
|
1125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListIdMappingJobsInput AWS API Documentation
|
1126
|
+
#
|
1127
|
+
class ListIdMappingJobsInput < Struct.new(
|
1128
|
+
:max_results,
|
1129
|
+
:next_token,
|
1130
|
+
:workflow_name)
|
1131
|
+
SENSITIVE = []
|
1132
|
+
include Aws::Structure
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
# @!attribute [rw] jobs
|
1136
|
+
# A list of `JobSummary` objects.
|
1137
|
+
# @return [Array<Types::JobSummary>]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] next_token
|
1140
|
+
# The pagination token from the previous API call.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListIdMappingJobsOutput AWS API Documentation
|
1144
|
+
#
|
1145
|
+
class ListIdMappingJobsOutput < Struct.new(
|
1146
|
+
:jobs,
|
1147
|
+
:next_token)
|
1148
|
+
SENSITIVE = []
|
1149
|
+
include Aws::Structure
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
# @!attribute [rw] max_results
|
1153
|
+
# The maximum number of objects returned per page.
|
1154
|
+
# @return [Integer]
|
1155
|
+
#
|
1156
|
+
# @!attribute [rw] next_token
|
1157
|
+
# The pagination token from the previous API call.
|
1158
|
+
# @return [String]
|
1159
|
+
#
|
1160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListIdMappingWorkflowsInput AWS API Documentation
|
1161
|
+
#
|
1162
|
+
class ListIdMappingWorkflowsInput < Struct.new(
|
1163
|
+
:max_results,
|
1164
|
+
:next_token)
|
1165
|
+
SENSITIVE = []
|
1166
|
+
include Aws::Structure
|
1167
|
+
end
|
1168
|
+
|
1169
|
+
# @!attribute [rw] next_token
|
1170
|
+
# The pagination token from the previous API call.
|
620
1171
|
# @return [String]
|
621
1172
|
#
|
622
|
-
# @!attribute [rw]
|
623
|
-
#
|
624
|
-
# @return [
|
625
|
-
#
|
626
|
-
# @!attribute [rw] status
|
627
|
-
# The current status of the job.
|
628
|
-
# @return [String]
|
1173
|
+
# @!attribute [rw] workflow_summaries
|
1174
|
+
# A list of `IdMappingWorkflowSummary` objects.
|
1175
|
+
# @return [Array<Types::IdMappingWorkflowSummary>]
|
629
1176
|
#
|
630
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/
|
1177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListIdMappingWorkflowsOutput AWS API Documentation
|
631
1178
|
#
|
632
|
-
class
|
633
|
-
:
|
634
|
-
:
|
635
|
-
:start_time,
|
636
|
-
:status)
|
1179
|
+
class ListIdMappingWorkflowsOutput < Struct.new(
|
1180
|
+
:next_token,
|
1181
|
+
:workflow_summaries)
|
637
1182
|
SENSITIVE = []
|
638
1183
|
include Aws::Structure
|
639
1184
|
end
|
@@ -643,8 +1188,7 @@ module Aws::EntityResolution
|
|
643
1188
|
# @return [Integer]
|
644
1189
|
#
|
645
1190
|
# @!attribute [rw] next_token
|
646
|
-
# The pagination token from the previous
|
647
|
-
# call.
|
1191
|
+
# The pagination token from the previous API call.
|
648
1192
|
# @return [String]
|
649
1193
|
#
|
650
1194
|
# @!attribute [rw] workflow_name
|
@@ -667,8 +1211,7 @@ module Aws::EntityResolution
|
|
667
1211
|
# @return [Array<Types::JobSummary>]
|
668
1212
|
#
|
669
1213
|
# @!attribute [rw] next_token
|
670
|
-
# The pagination token from the previous
|
671
|
-
# call.
|
1214
|
+
# The pagination token from the previous API call.
|
672
1215
|
# @return [String]
|
673
1216
|
#
|
674
1217
|
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingJobsOutput AWS API Documentation
|
@@ -685,8 +1228,7 @@ module Aws::EntityResolution
|
|
685
1228
|
# @return [Integer]
|
686
1229
|
#
|
687
1230
|
# @!attribute [rw] next_token
|
688
|
-
# The pagination token from the previous
|
689
|
-
# call.
|
1231
|
+
# The pagination token from the previous API call.
|
690
1232
|
# @return [String]
|
691
1233
|
#
|
692
1234
|
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingWorkflowsInput AWS API Documentation
|
@@ -699,8 +1241,7 @@ module Aws::EntityResolution
|
|
699
1241
|
end
|
700
1242
|
|
701
1243
|
# @!attribute [rw] next_token
|
702
|
-
# The pagination token from the previous
|
703
|
-
# call.
|
1244
|
+
# The pagination token from the previous API call.
|
704
1245
|
# @return [String]
|
705
1246
|
#
|
706
1247
|
# @!attribute [rw] workflow_summaries
|
@@ -723,8 +1264,46 @@ module Aws::EntityResolution
|
|
723
1264
|
# @return [Integer]
|
724
1265
|
#
|
725
1266
|
# @!attribute [rw] next_token
|
726
|
-
# The pagination token from the previous
|
727
|
-
#
|
1267
|
+
# The pagination token from the previous API call.
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] provider_name
|
1271
|
+
# The name of the provider. This name is typically the company name.
|
1272
|
+
# @return [String]
|
1273
|
+
#
|
1274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListProviderServicesInput AWS API Documentation
|
1275
|
+
#
|
1276
|
+
class ListProviderServicesInput < Struct.new(
|
1277
|
+
:max_results,
|
1278
|
+
:next_token,
|
1279
|
+
:provider_name)
|
1280
|
+
SENSITIVE = []
|
1281
|
+
include Aws::Structure
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# @!attribute [rw] next_token
|
1285
|
+
# The pagination token from the previous API call.
|
1286
|
+
# @return [String]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] provider_service_summaries
|
1289
|
+
# A list of `ProviderServices` objects.
|
1290
|
+
# @return [Array<Types::ProviderServiceSummary>]
|
1291
|
+
#
|
1292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListProviderServicesOutput AWS API Documentation
|
1293
|
+
#
|
1294
|
+
class ListProviderServicesOutput < Struct.new(
|
1295
|
+
:next_token,
|
1296
|
+
:provider_service_summaries)
|
1297
|
+
SENSITIVE = []
|
1298
|
+
include Aws::Structure
|
1299
|
+
end
|
1300
|
+
|
1301
|
+
# @!attribute [rw] max_results
|
1302
|
+
# The maximum number of objects returned per page.
|
1303
|
+
# @return [Integer]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] next_token
|
1306
|
+
# The pagination token from the previous API call.
|
728
1307
|
# @return [String]
|
729
1308
|
#
|
730
1309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListSchemaMappingsInput AWS API Documentation
|
@@ -737,7 +1316,7 @@ module Aws::EntityResolution
|
|
737
1316
|
end
|
738
1317
|
|
739
1318
|
# @!attribute [rw] next_token
|
740
|
-
# The pagination token from the previous
|
1319
|
+
# The pagination token from the previous API call.
|
741
1320
|
# @return [String]
|
742
1321
|
#
|
743
1322
|
# @!attribute [rw] schema_list
|
@@ -786,6 +1365,12 @@ module Aws::EntityResolution
|
|
786
1365
|
# The timestamp of when the workflow was created.
|
787
1366
|
# @return [Time]
|
788
1367
|
#
|
1368
|
+
# @!attribute [rw] resolution_type
|
1369
|
+
# The method that has been specified for data matching, either using
|
1370
|
+
# matching provided by Entity Resolution or through a provider
|
1371
|
+
# service.
|
1372
|
+
# @return [String]
|
1373
|
+
#
|
789
1374
|
# @!attribute [rw] updated_at
|
790
1375
|
# The timestamp of when the workflow was last updated.
|
791
1376
|
# @return [Time]
|
@@ -803,6 +1388,7 @@ module Aws::EntityResolution
|
|
803
1388
|
#
|
804
1389
|
class MatchingWorkflowSummary < Struct.new(
|
805
1390
|
:created_at,
|
1391
|
+
:resolution_type,
|
806
1392
|
:updated_at,
|
807
1393
|
:workflow_arn,
|
808
1394
|
:workflow_name)
|
@@ -873,9 +1459,147 @@ module Aws::EntityResolution
|
|
873
1459
|
include Aws::Structure
|
874
1460
|
end
|
875
1461
|
|
1462
|
+
# The required configuration fields to use with the provider service.
|
1463
|
+
#
|
1464
|
+
# @note ProviderEndpointConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProviderEndpointConfiguration corresponding to the set member.
|
1465
|
+
#
|
1466
|
+
# @!attribute [rw] marketplace_configuration
|
1467
|
+
# The identifiers of the provider service, from Data Exchange.
|
1468
|
+
# @return [Types::ProviderMarketplaceConfiguration]
|
1469
|
+
#
|
1470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ProviderEndpointConfiguration AWS API Documentation
|
1471
|
+
#
|
1472
|
+
class ProviderEndpointConfiguration < Struct.new(
|
1473
|
+
:marketplace_configuration,
|
1474
|
+
:unknown)
|
1475
|
+
SENSITIVE = []
|
1476
|
+
include Aws::Structure
|
1477
|
+
include Aws::Structure::Union
|
1478
|
+
|
1479
|
+
class MarketplaceConfiguration < ProviderEndpointConfiguration; end
|
1480
|
+
class Unknown < ProviderEndpointConfiguration; end
|
1481
|
+
end
|
1482
|
+
|
1483
|
+
# The required configuration fields to give intermediate access to a
|
1484
|
+
# provider service.
|
1485
|
+
#
|
1486
|
+
# @!attribute [rw] aws_account_ids
|
1487
|
+
# The Amazon Web Services account that provider can use to read or
|
1488
|
+
# write data into the customer's intermediate S3 bucket.
|
1489
|
+
# @return [Array<String>]
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] required_bucket_actions
|
1492
|
+
# The S3 bucket actions that the provider requires permission for.
|
1493
|
+
# @return [Array<String>]
|
1494
|
+
#
|
1495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ProviderIntermediateDataAccessConfiguration AWS API Documentation
|
1496
|
+
#
|
1497
|
+
class ProviderIntermediateDataAccessConfiguration < Struct.new(
|
1498
|
+
:aws_account_ids,
|
1499
|
+
:required_bucket_actions)
|
1500
|
+
SENSITIVE = []
|
1501
|
+
include Aws::Structure
|
1502
|
+
end
|
1503
|
+
|
1504
|
+
# The identifiers of the provider service, from Data Exchange.
|
1505
|
+
#
|
1506
|
+
# @!attribute [rw] asset_id
|
1507
|
+
# The asset ID on Data Exchange.
|
1508
|
+
# @return [String]
|
1509
|
+
#
|
1510
|
+
# @!attribute [rw] data_set_id
|
1511
|
+
# The dataset ID on Data Exchange.
|
1512
|
+
# @return [String]
|
1513
|
+
#
|
1514
|
+
# @!attribute [rw] listing_id
|
1515
|
+
# The listing ID on Data Exchange.
|
1516
|
+
# @return [String]
|
1517
|
+
#
|
1518
|
+
# @!attribute [rw] revision_id
|
1519
|
+
# The revision ID on Data Exchange.
|
1520
|
+
# @return [String]
|
1521
|
+
#
|
1522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ProviderMarketplaceConfiguration AWS API Documentation
|
1523
|
+
#
|
1524
|
+
class ProviderMarketplaceConfiguration < Struct.new(
|
1525
|
+
:asset_id,
|
1526
|
+
:data_set_id,
|
1527
|
+
:listing_id,
|
1528
|
+
:revision_id)
|
1529
|
+
SENSITIVE = []
|
1530
|
+
include Aws::Structure
|
1531
|
+
end
|
1532
|
+
|
1533
|
+
# An object containing the `providerServiceARN`,
|
1534
|
+
# `intermediateSourceConfiguration`, and `providerConfiguration`.
|
1535
|
+
#
|
1536
|
+
# @!attribute [rw] intermediate_source_configuration
|
1537
|
+
# The Amazon S3 location that temporarily stores your data while it
|
1538
|
+
# processes. Your information won't be saved permanently.
|
1539
|
+
# @return [Types::IntermediateSourceConfiguration]
|
1540
|
+
#
|
1541
|
+
# @!attribute [rw] provider_configuration
|
1542
|
+
# The required configuration fields to use with the provider service.
|
1543
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
1544
|
+
#
|
1545
|
+
# @!attribute [rw] provider_service_arn
|
1546
|
+
# The ARN of the provider service.
|
1547
|
+
# @return [String]
|
1548
|
+
#
|
1549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ProviderProperties AWS API Documentation
|
1550
|
+
#
|
1551
|
+
class ProviderProperties < Struct.new(
|
1552
|
+
:intermediate_source_configuration,
|
1553
|
+
:provider_configuration,
|
1554
|
+
:provider_service_arn)
|
1555
|
+
SENSITIVE = []
|
1556
|
+
include Aws::Structure
|
1557
|
+
end
|
1558
|
+
|
1559
|
+
# A list of `ProviderService` objects, each of which contain the fields
|
1560
|
+
# `providerName`, `providerServiceArn`, `providerServiceName`, and
|
1561
|
+
# `providerServiceType`.
|
1562
|
+
#
|
1563
|
+
# @!attribute [rw] provider_name
|
1564
|
+
# The name of the provider. This name is typically the company name.
|
1565
|
+
# @return [String]
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] provider_service_arn
|
1568
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
1569
|
+
# the `providerService`.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] provider_service_display_name
|
1573
|
+
# The display name of the provider service.
|
1574
|
+
# @return [String]
|
1575
|
+
#
|
1576
|
+
# @!attribute [rw] provider_service_name
|
1577
|
+
# The name of the product that the provider service provides.
|
1578
|
+
# @return [String]
|
1579
|
+
#
|
1580
|
+
# @!attribute [rw] provider_service_type
|
1581
|
+
# The type of provider service.
|
1582
|
+
# @return [String]
|
1583
|
+
#
|
1584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ProviderServiceSummary AWS API Documentation
|
1585
|
+
#
|
1586
|
+
class ProviderServiceSummary < Struct.new(
|
1587
|
+
:provider_name,
|
1588
|
+
:provider_service_arn,
|
1589
|
+
:provider_service_display_name,
|
1590
|
+
:provider_service_name,
|
1591
|
+
:provider_service_type)
|
1592
|
+
SENSITIVE = []
|
1593
|
+
include Aws::Structure
|
1594
|
+
end
|
1595
|
+
|
876
1596
|
# An object which defines the `resolutionType` and the
|
877
1597
|
# `ruleBasedProperties`.
|
878
1598
|
#
|
1599
|
+
# @!attribute [rw] provider_properties
|
1600
|
+
# The properties of the provider service.
|
1601
|
+
# @return [Types::ProviderProperties]
|
1602
|
+
#
|
879
1603
|
# @!attribute [rw] resolution_type
|
880
1604
|
# The type of matching. There are two types of matching:
|
881
1605
|
# `RULE_MATCHING` and `ML_MATCHING`.
|
@@ -889,6 +1613,7 @@ module Aws::EntityResolution
|
|
889
1613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ResolutionTechniques AWS API Documentation
|
890
1614
|
#
|
891
1615
|
class ResolutionTechniques < Struct.new(
|
1616
|
+
:provider_properties,
|
892
1617
|
:resolution_type,
|
893
1618
|
:rule_based_properties)
|
894
1619
|
SENSITIVE = []
|
@@ -959,8 +1684,7 @@ module Aws::EntityResolution
|
|
959
1684
|
include Aws::Structure
|
960
1685
|
end
|
961
1686
|
|
962
|
-
# An object containing `
|
963
|
-
# `MatchKey`.
|
1687
|
+
# An object containing `FieldName`, `Type`, `GroupName`, and `MatchKey`.
|
964
1688
|
#
|
965
1689
|
# @!attribute [rw] field_name
|
966
1690
|
# A string containing the field name.
|
@@ -978,11 +1702,16 @@ module Aws::EntityResolution
|
|
978
1702
|
# A key that allows grouping of multiple input attributes into a
|
979
1703
|
# unified matching group. For example, let's consider a scenario
|
980
1704
|
# where the source table contains various addresses, such as
|
981
|
-
#
|
982
|
-
# *Address* to both attributes, Entity Resolution will
|
983
|
-
# across these fields to create a consolidated matching
|
984
|
-
# `MatchKey` is specified for a column, it won't be
|
985
|
-
# matching purposes but will still be included in the
|
1705
|
+
# `business_address` and `shipping_address`. By assigning the
|
1706
|
+
# `MatchKey` *Address* to both attributes, Entity Resolution will
|
1707
|
+
# match records across these fields to create a consolidated matching
|
1708
|
+
# group. If no `MatchKey` is specified for a column, it won't be
|
1709
|
+
# utilized for matching purposes but will still be included in the
|
1710
|
+
# output table.
|
1711
|
+
# @return [String]
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] sub_type
|
1714
|
+
# The subtype of the attribute, selected from a list of values.
|
986
1715
|
# @return [String]
|
987
1716
|
#
|
988
1717
|
# @!attribute [rw] type
|
@@ -995,6 +1724,7 @@ module Aws::EntityResolution
|
|
995
1724
|
:field_name,
|
996
1725
|
:group_name,
|
997
1726
|
:match_key,
|
1727
|
+
:sub_type,
|
998
1728
|
:type)
|
999
1729
|
SENSITIVE = []
|
1000
1730
|
include Aws::Structure
|
@@ -1007,6 +1737,10 @@ module Aws::EntityResolution
|
|
1007
1737
|
# The timestamp of when the `SchemaMapping` was created.
|
1008
1738
|
# @return [Time]
|
1009
1739
|
#
|
1740
|
+
# @!attribute [rw] has_workflows
|
1741
|
+
# Specifies whether the schema mapping has been applied to a workflow.
|
1742
|
+
# @return [Boolean]
|
1743
|
+
#
|
1010
1744
|
# @!attribute [rw] schema_arn
|
1011
1745
|
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
1012
1746
|
# the `SchemaMapping`.
|
@@ -1024,6 +1758,7 @@ module Aws::EntityResolution
|
|
1024
1758
|
#
|
1025
1759
|
class SchemaMappingSummary < Struct.new(
|
1026
1760
|
:created_at,
|
1761
|
+
:has_workflows,
|
1027
1762
|
:schema_arn,
|
1028
1763
|
:schema_name,
|
1029
1764
|
:updated_at)
|
@@ -1031,6 +1766,30 @@ module Aws::EntityResolution
|
|
1031
1766
|
include Aws::Structure
|
1032
1767
|
end
|
1033
1768
|
|
1769
|
+
# @!attribute [rw] workflow_name
|
1770
|
+
# The name of the ID mapping job to be retrieved.
|
1771
|
+
# @return [String]
|
1772
|
+
#
|
1773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/StartIdMappingJobInput AWS API Documentation
|
1774
|
+
#
|
1775
|
+
class StartIdMappingJobInput < Struct.new(
|
1776
|
+
:workflow_name)
|
1777
|
+
SENSITIVE = []
|
1778
|
+
include Aws::Structure
|
1779
|
+
end
|
1780
|
+
|
1781
|
+
# @!attribute [rw] job_id
|
1782
|
+
# The ID of the job.
|
1783
|
+
# @return [String]
|
1784
|
+
#
|
1785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/StartIdMappingJobOutput AWS API Documentation
|
1786
|
+
#
|
1787
|
+
class StartIdMappingJobOutput < Struct.new(
|
1788
|
+
:job_id)
|
1789
|
+
SENSITIVE = []
|
1790
|
+
include Aws::Structure
|
1791
|
+
end
|
1792
|
+
|
1034
1793
|
# @!attribute [rw] workflow_name
|
1035
1794
|
# The name of the matching job to be retrieved.
|
1036
1795
|
# @return [String]
|
@@ -1112,6 +1871,94 @@ module Aws::EntityResolution
|
|
1112
1871
|
#
|
1113
1872
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
1114
1873
|
|
1874
|
+
# @!attribute [rw] description
|
1875
|
+
# A description of the workflow.
|
1876
|
+
# @return [String]
|
1877
|
+
#
|
1878
|
+
# @!attribute [rw] id_mapping_techniques
|
1879
|
+
# An object which defines the `idMappingType` and the
|
1880
|
+
# `providerProperties`.
|
1881
|
+
# @return [Types::IdMappingTechniques]
|
1882
|
+
#
|
1883
|
+
# @!attribute [rw] input_source_config
|
1884
|
+
# A list of `InputSource` objects, which have the fields
|
1885
|
+
# `InputSourceARN` and `SchemaName`.
|
1886
|
+
# @return [Array<Types::IdMappingWorkflowInputSource>]
|
1887
|
+
#
|
1888
|
+
# @!attribute [rw] output_source_config
|
1889
|
+
# A list of `OutputSource` objects, each of which contains fields
|
1890
|
+
# `OutputS3Path` and `KMSArn`.
|
1891
|
+
# @return [Array<Types::IdMappingWorkflowOutputSource>]
|
1892
|
+
#
|
1893
|
+
# @!attribute [rw] role_arn
|
1894
|
+
# The Amazon Resource Name (ARN) of the IAM role. Entity Resolution
|
1895
|
+
# assumes this role to access resources on your behalf.
|
1896
|
+
# @return [String]
|
1897
|
+
#
|
1898
|
+
# @!attribute [rw] workflow_name
|
1899
|
+
# The name of the workflow.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateIdMappingWorkflowInput AWS API Documentation
|
1903
|
+
#
|
1904
|
+
class UpdateIdMappingWorkflowInput < Struct.new(
|
1905
|
+
:description,
|
1906
|
+
:id_mapping_techniques,
|
1907
|
+
:input_source_config,
|
1908
|
+
:output_source_config,
|
1909
|
+
:role_arn,
|
1910
|
+
:workflow_name)
|
1911
|
+
SENSITIVE = []
|
1912
|
+
include Aws::Structure
|
1913
|
+
end
|
1914
|
+
|
1915
|
+
# @!attribute [rw] description
|
1916
|
+
# A description of the workflow.
|
1917
|
+
# @return [String]
|
1918
|
+
#
|
1919
|
+
# @!attribute [rw] id_mapping_techniques
|
1920
|
+
# An object which defines the `idMappingType` and the
|
1921
|
+
# `providerProperties`.
|
1922
|
+
# @return [Types::IdMappingTechniques]
|
1923
|
+
#
|
1924
|
+
# @!attribute [rw] input_source_config
|
1925
|
+
# A list of `InputSource` objects, which have the fields
|
1926
|
+
# `InputSourceARN` and `SchemaName`.
|
1927
|
+
# @return [Array<Types::IdMappingWorkflowInputSource>]
|
1928
|
+
#
|
1929
|
+
# @!attribute [rw] output_source_config
|
1930
|
+
# A list of `OutputSource` objects, each of which contains fields
|
1931
|
+
# `OutputS3Path` and `KMSArn`.
|
1932
|
+
# @return [Array<Types::IdMappingWorkflowOutputSource>]
|
1933
|
+
#
|
1934
|
+
# @!attribute [rw] role_arn
|
1935
|
+
# The Amazon Resource Name (ARN) of the IAM role. Entity Resolution
|
1936
|
+
# assumes this role to access resources on your behalf.
|
1937
|
+
# @return [String]
|
1938
|
+
#
|
1939
|
+
# @!attribute [rw] workflow_arn
|
1940
|
+
# The Amazon Resource Name (ARN) of the workflow role. Entity
|
1941
|
+
# Resolution assumes this role to access resources on your behalf.
|
1942
|
+
# @return [String]
|
1943
|
+
#
|
1944
|
+
# @!attribute [rw] workflow_name
|
1945
|
+
# The name of the workflow.
|
1946
|
+
# @return [String]
|
1947
|
+
#
|
1948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateIdMappingWorkflowOutput AWS API Documentation
|
1949
|
+
#
|
1950
|
+
class UpdateIdMappingWorkflowOutput < Struct.new(
|
1951
|
+
:description,
|
1952
|
+
:id_mapping_techniques,
|
1953
|
+
:input_source_config,
|
1954
|
+
:output_source_config,
|
1955
|
+
:role_arn,
|
1956
|
+
:workflow_arn,
|
1957
|
+
:workflow_name)
|
1958
|
+
SENSITIVE = []
|
1959
|
+
include Aws::Structure
|
1960
|
+
end
|
1961
|
+
|
1115
1962
|
# @!attribute [rw] description
|
1116
1963
|
# A description of the workflow.
|
1117
1964
|
# @return [String]
|
@@ -1208,6 +2055,61 @@ module Aws::EntityResolution
|
|
1208
2055
|
include Aws::Structure
|
1209
2056
|
end
|
1210
2057
|
|
2058
|
+
# @!attribute [rw] description
|
2059
|
+
# A description of the schema.
|
2060
|
+
# @return [String]
|
2061
|
+
#
|
2062
|
+
# @!attribute [rw] mapped_input_fields
|
2063
|
+
# A list of `MappedInputFields`. Each `MappedInputField` corresponds
|
2064
|
+
# to a column the source data table, and contains column name plus
|
2065
|
+
# additional information that Entity Resolution uses for matching.
|
2066
|
+
# @return [Array<Types::SchemaInputAttribute>]
|
2067
|
+
#
|
2068
|
+
# @!attribute [rw] schema_name
|
2069
|
+
# The name of the schema. There can't be multiple `SchemaMappings`
|
2070
|
+
# with the same name.
|
2071
|
+
# @return [String]
|
2072
|
+
#
|
2073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateSchemaMappingInput AWS API Documentation
|
2074
|
+
#
|
2075
|
+
class UpdateSchemaMappingInput < Struct.new(
|
2076
|
+
:description,
|
2077
|
+
:mapped_input_fields,
|
2078
|
+
:schema_name)
|
2079
|
+
SENSITIVE = []
|
2080
|
+
include Aws::Structure
|
2081
|
+
end
|
2082
|
+
|
2083
|
+
# @!attribute [rw] description
|
2084
|
+
# A description of the schema.
|
2085
|
+
# @return [String]
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] mapped_input_fields
|
2088
|
+
# A list of `MappedInputFields`. Each `MappedInputField` corresponds
|
2089
|
+
# to a column the source data table, and contains column name plus
|
2090
|
+
# additional information that Entity Resolution uses for matching.
|
2091
|
+
# @return [Array<Types::SchemaInputAttribute>]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] schema_arn
|
2094
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
2095
|
+
# the `SchemaMapping`.
|
2096
|
+
# @return [String]
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] schema_name
|
2099
|
+
# The name of the schema.
|
2100
|
+
# @return [String]
|
2101
|
+
#
|
2102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateSchemaMappingOutput AWS API Documentation
|
2103
|
+
#
|
2104
|
+
class UpdateSchemaMappingOutput < Struct.new(
|
2105
|
+
:description,
|
2106
|
+
:mapped_input_fields,
|
2107
|
+
:schema_arn,
|
2108
|
+
:schema_name)
|
2109
|
+
SENSITIVE = []
|
2110
|
+
include Aws::Structure
|
2111
|
+
end
|
2112
|
+
|
1211
2113
|
# The input fails to satisfy the constraints specified by Entity
|
1212
2114
|
# Resolution. `HTTP Status Code: 400`
|
1213
2115
|
#
|