aws-sdk-comprehend 1.39.0 → 1.44.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 +238 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-comprehend.rb +2 -2
- data/lib/aws-sdk-comprehend/client.rb +237 -4
- data/lib/aws-sdk-comprehend/client_api.rb +148 -3
- data/lib/aws-sdk-comprehend/errors.rb +1 -1
- data/lib/aws-sdk-comprehend/resource.rb +1 -1
- data/lib/aws-sdk-comprehend/types.rb +504 -23
- metadata +8 -5
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,13 +3,54 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
10
|
module Aws::Comprehend
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# An augmented manifest file that provides training data for your custom
|
14
|
+
# model. An augmented manifest file is a labeled dataset that is
|
15
|
+
# produced by Amazon SageMaker Ground Truth.
|
16
|
+
#
|
17
|
+
# @note When making an API call, you may pass AugmentedManifestsListItem
|
18
|
+
# data as a hash:
|
19
|
+
#
|
20
|
+
# {
|
21
|
+
# s3_uri: "S3Uri", # required
|
22
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
23
|
+
# }
|
24
|
+
#
|
25
|
+
# @!attribute [rw] s3_uri
|
26
|
+
# The Amazon S3 location of the augmented manifest file.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] attribute_names
|
30
|
+
# The JSON attribute that contains the annotations for your training
|
31
|
+
# documents. The number of attribute names that you specify depends on
|
32
|
+
# whether your augmented manifest file is the output of a single
|
33
|
+
# labeling job or a chained labeling job.
|
34
|
+
#
|
35
|
+
# If your file is the output of a single labeling job, specify the
|
36
|
+
# LabelAttributeName key that was used when the job was created in
|
37
|
+
# Ground Truth.
|
38
|
+
#
|
39
|
+
# If your file is the output of a chained labeling job, specify the
|
40
|
+
# LabelAttributeName key for one or more jobs in the chain. Each
|
41
|
+
# LabelAttributeName key provides the annotations from an individual
|
42
|
+
# job.
|
43
|
+
# @return [Array<String>]
|
44
|
+
#
|
45
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/AugmentedManifestsListItem AWS API Documentation
|
46
|
+
#
|
47
|
+
class AugmentedManifestsListItem < Struct.new(
|
48
|
+
:s3_uri,
|
49
|
+
:attribute_names)
|
50
|
+
SENSITIVE = []
|
51
|
+
include Aws::Structure
|
52
|
+
end
|
53
|
+
|
13
54
|
# The result of calling the operation. The operation returns one object
|
14
55
|
# for each document that is successfully processed by the operation.
|
15
56
|
#
|
@@ -562,7 +603,7 @@ module Aws::Comprehend
|
|
562
603
|
# @!attribute [rw] labels
|
563
604
|
# The labels used the document being analyzed. These are used for
|
564
605
|
# multi-label trained models. Individual labels represent different
|
565
|
-
# categories that are related in some manner and are not
|
606
|
+
# categories that are related in some manner and are not mutually
|
566
607
|
# exclusive. For example, a movie can be just an action movie, or it
|
567
608
|
# can be an action movie, a science fiction movie, and a comedy, all
|
568
609
|
# at the same time.
|
@@ -604,8 +645,15 @@ module Aws::Comprehend
|
|
604
645
|
# },
|
605
646
|
# ],
|
606
647
|
# input_data_config: { # required
|
607
|
-
#
|
648
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
649
|
+
# s3_uri: "S3Uri",
|
608
650
|
# label_delimiter: "LabelDelimiter",
|
651
|
+
# augmented_manifests: [
|
652
|
+
# {
|
653
|
+
# s3_uri: "S3Uri", # required
|
654
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
655
|
+
# },
|
656
|
+
# ],
|
609
657
|
# },
|
610
658
|
# output_data_config: {
|
611
659
|
# s3_uri: "S3Uri",
|
@@ -810,12 +858,13 @@ module Aws::Comprehend
|
|
810
858
|
# },
|
811
859
|
# ],
|
812
860
|
# input_data_config: { # required
|
861
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
813
862
|
# entity_types: [ # required
|
814
863
|
# {
|
815
864
|
# type: "EntityTypeName", # required
|
816
865
|
# },
|
817
866
|
# ],
|
818
|
-
# documents: {
|
867
|
+
# documents: {
|
819
868
|
# s3_uri: "S3Uri", # required
|
820
869
|
# },
|
821
870
|
# annotations: {
|
@@ -824,6 +873,12 @@ module Aws::Comprehend
|
|
824
873
|
# entity_list: {
|
825
874
|
# s3_uri: "S3Uri", # required
|
826
875
|
# },
|
876
|
+
# augmented_manifests: [
|
877
|
+
# {
|
878
|
+
# s3_uri: "S3Uri", # required
|
879
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
880
|
+
# },
|
881
|
+
# ],
|
827
882
|
# },
|
828
883
|
# client_request_token: "ClientRequestTokenString",
|
829
884
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
@@ -1192,6 +1247,38 @@ module Aws::Comprehend
|
|
1192
1247
|
include Aws::Structure
|
1193
1248
|
end
|
1194
1249
|
|
1250
|
+
# @note When making an API call, you may pass DescribeEventsDetectionJobRequest
|
1251
|
+
# data as a hash:
|
1252
|
+
#
|
1253
|
+
# {
|
1254
|
+
# job_id: "JobId", # required
|
1255
|
+
# }
|
1256
|
+
#
|
1257
|
+
# @!attribute [rw] job_id
|
1258
|
+
# The identifier of the events detection job.
|
1259
|
+
# @return [String]
|
1260
|
+
#
|
1261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobRequest AWS API Documentation
|
1262
|
+
#
|
1263
|
+
class DescribeEventsDetectionJobRequest < Struct.new(
|
1264
|
+
:job_id)
|
1265
|
+
SENSITIVE = []
|
1266
|
+
include Aws::Structure
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# @!attribute [rw] events_detection_job_properties
|
1270
|
+
# An object that contains the properties associated with an event
|
1271
|
+
# detection job.
|
1272
|
+
# @return [Types::EventsDetectionJobProperties]
|
1273
|
+
#
|
1274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobResponse AWS API Documentation
|
1275
|
+
#
|
1276
|
+
class DescribeEventsDetectionJobResponse < Struct.new(
|
1277
|
+
:events_detection_job_properties)
|
1278
|
+
SENSITIVE = []
|
1279
|
+
include Aws::Structure
|
1280
|
+
end
|
1281
|
+
|
1195
1282
|
# @note When making an API call, you may pass DescribeKeyPhrasesDetectionJobRequest
|
1196
1283
|
# data as a hash:
|
1197
1284
|
#
|
@@ -1813,10 +1900,37 @@ module Aws::Comprehend
|
|
1813
1900
|
# data as a hash:
|
1814
1901
|
#
|
1815
1902
|
# {
|
1816
|
-
#
|
1903
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
1904
|
+
# s3_uri: "S3Uri",
|
1817
1905
|
# label_delimiter: "LabelDelimiter",
|
1906
|
+
# augmented_manifests: [
|
1907
|
+
# {
|
1908
|
+
# s3_uri: "S3Uri", # required
|
1909
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
1910
|
+
# },
|
1911
|
+
# ],
|
1818
1912
|
# }
|
1819
1913
|
#
|
1914
|
+
# @!attribute [rw] data_format
|
1915
|
+
# The format of your training data:
|
1916
|
+
#
|
1917
|
+
# * `COMPREHEND_CSV`\: A two-column CSV file, where labels are
|
1918
|
+
# provided in the first column, and documents are provided in the
|
1919
|
+
# second. If you use this value, you must provide the `S3Uri`
|
1920
|
+
# parameter in your request.
|
1921
|
+
#
|
1922
|
+
# * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
|
1923
|
+
# Amazon SageMaker Ground Truth. This file is in JSON lines format.
|
1924
|
+
# Each line is a complete JSON object that contains a training
|
1925
|
+
# document and its associated labels.
|
1926
|
+
#
|
1927
|
+
# If you use this value, you must provide the `AugmentedManifests`
|
1928
|
+
# parameter in your request.
|
1929
|
+
#
|
1930
|
+
# If you don't specify a value, Amazon Comprehend uses
|
1931
|
+
# `COMPREHEND_CSV` as the default.
|
1932
|
+
# @return [String]
|
1933
|
+
#
|
1820
1934
|
# @!attribute [rw] s3_uri
|
1821
1935
|
# The Amazon S3 URI for the input data. The S3 bucket must be in the
|
1822
1936
|
# same region as the API endpoint that you are calling. The URI can
|
@@ -1827,6 +1941,9 @@ module Aws::Comprehend
|
|
1827
1941
|
# prefix is a single file, Amazon Comprehend uses that file as input.
|
1828
1942
|
# If more than one file begins with the prefix, Amazon Comprehend uses
|
1829
1943
|
# all of them as input.
|
1944
|
+
#
|
1945
|
+
# This parameter is required if you set `DataFormat` to
|
1946
|
+
# `COMPREHEND_CSV`.
|
1830
1947
|
# @return [String]
|
1831
1948
|
#
|
1832
1949
|
# @!attribute [rw] label_delimiter
|
@@ -1839,11 +1956,22 @@ module Aws::Comprehend
|
|
1839
1956
|
# be combined to make a single unique label, such as LABELLABELLABEL.
|
1840
1957
|
# @return [String]
|
1841
1958
|
#
|
1959
|
+
# @!attribute [rw] augmented_manifests
|
1960
|
+
# A list of augmented manifest files that provide training data for
|
1961
|
+
# your custom model. An augmented manifest file is a labeled dataset
|
1962
|
+
# that is produced by Amazon SageMaker Ground Truth.
|
1963
|
+
#
|
1964
|
+
# This parameter is required if you set `DataFormat` to
|
1965
|
+
# `AUGMENTED_MANIFEST`.
|
1966
|
+
# @return [Array<Types::AugmentedManifestsListItem>]
|
1967
|
+
#
|
1842
1968
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
|
1843
1969
|
#
|
1844
1970
|
class DocumentClassifierInputDataConfig < Struct.new(
|
1971
|
+
:data_format,
|
1845
1972
|
:s3_uri,
|
1846
|
-
:label_delimiter
|
1973
|
+
:label_delimiter,
|
1974
|
+
:augmented_manifests)
|
1847
1975
|
SENSITIVE = []
|
1848
1976
|
include Aws::Structure
|
1849
1977
|
end
|
@@ -2194,7 +2322,7 @@ module Aws::Comprehend
|
|
2194
2322
|
include Aws::Structure
|
2195
2323
|
end
|
2196
2324
|
|
2197
|
-
# The filter used to determine which endpoints are
|
2325
|
+
# The filter used to determine which endpoints are returned. You can
|
2198
2326
|
# filter jobs on their name, model, status, or the date and time that
|
2199
2327
|
# they were created. You can only set one filter at a time.
|
2200
2328
|
#
|
@@ -2626,12 +2754,13 @@ module Aws::Comprehend
|
|
2626
2754
|
# data as a hash:
|
2627
2755
|
#
|
2628
2756
|
# {
|
2757
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
2629
2758
|
# entity_types: [ # required
|
2630
2759
|
# {
|
2631
2760
|
# type: "EntityTypeName", # required
|
2632
2761
|
# },
|
2633
2762
|
# ],
|
2634
|
-
# documents: {
|
2763
|
+
# documents: {
|
2635
2764
|
# s3_uri: "S3Uri", # required
|
2636
2765
|
# },
|
2637
2766
|
# annotations: {
|
@@ -2640,33 +2769,89 @@ module Aws::Comprehend
|
|
2640
2769
|
# entity_list: {
|
2641
2770
|
# s3_uri: "S3Uri", # required
|
2642
2771
|
# },
|
2772
|
+
# augmented_manifests: [
|
2773
|
+
# {
|
2774
|
+
# s3_uri: "S3Uri", # required
|
2775
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
2776
|
+
# },
|
2777
|
+
# ],
|
2643
2778
|
# }
|
2644
2779
|
#
|
2780
|
+
# @!attribute [rw] data_format
|
2781
|
+
# The format of your training data:
|
2782
|
+
#
|
2783
|
+
# * `COMPREHEND_CSV`\: A CSV file that supplements your training
|
2784
|
+
# documents. The CSV file contains information about the custom
|
2785
|
+
# entities that your trained model will detect. The required format
|
2786
|
+
# of the file depends on whether you are providing annotations or an
|
2787
|
+
# entity list.
|
2788
|
+
#
|
2789
|
+
# If you use this value, you must provide your CSV file by using
|
2790
|
+
# either the `Annotations` or `EntityList` parameters. You must
|
2791
|
+
# provide your training documents by using the `Documents`
|
2792
|
+
# parameter.
|
2793
|
+
#
|
2794
|
+
# * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
|
2795
|
+
# Amazon SageMaker Ground Truth. This file is in JSON lines format.
|
2796
|
+
# Each line is a complete JSON object that contains a training
|
2797
|
+
# document and its labels. Each label annotates a named entity in
|
2798
|
+
# the training document.
|
2799
|
+
#
|
2800
|
+
# If you use this value, you must provide the `AugmentedManifests`
|
2801
|
+
# parameter in your request.
|
2802
|
+
#
|
2803
|
+
# If you don't specify a value, Amazon Comprehend uses
|
2804
|
+
# `COMPREHEND_CSV` as the default.
|
2805
|
+
# @return [String]
|
2806
|
+
#
|
2645
2807
|
# @!attribute [rw] entity_types
|
2646
|
-
# The entity types in the
|
2647
|
-
#
|
2648
|
-
#
|
2808
|
+
# The entity types in the labeled training data that Amazon Comprehend
|
2809
|
+
# uses to train the custom entity recognizer. Any entity types that
|
2810
|
+
# you don't specify are ignored.
|
2811
|
+
#
|
2812
|
+
# A maximum of 25 entity types can be used at one time to train an
|
2813
|
+
# entity recognizer. Entity types must not contain the following
|
2814
|
+
# invalid characters: \\n (line break), \\\\n (escaped line break),
|
2815
|
+
# \\r (carriage return), \\\\r (escaped carriage return), \\t (tab),
|
2816
|
+
# \\\\t (escaped tab), space, and , (comma).
|
2649
2817
|
# @return [Array<Types::EntityTypesListItem>]
|
2650
2818
|
#
|
2651
2819
|
# @!attribute [rw] documents
|
2652
|
-
# S3 location of the
|
2820
|
+
# The S3 location of the folder that contains the training documents
|
2821
|
+
# for your custom entity recognizer.
|
2822
|
+
#
|
2823
|
+
# This parameter is required if you set `DataFormat` to
|
2824
|
+
# `COMPREHEND_CSV`.
|
2653
2825
|
# @return [Types::EntityRecognizerDocuments]
|
2654
2826
|
#
|
2655
2827
|
# @!attribute [rw] annotations
|
2656
|
-
# S3 location of the
|
2828
|
+
# The S3 location of the CSV file that annotates your training
|
2829
|
+
# documents.
|
2657
2830
|
# @return [Types::EntityRecognizerAnnotations]
|
2658
2831
|
#
|
2659
2832
|
# @!attribute [rw] entity_list
|
2660
|
-
# S3 location of the entity list for
|
2833
|
+
# The S3 location of the CSV file that has the entity list for your
|
2834
|
+
# custom entity recognizer.
|
2661
2835
|
# @return [Types::EntityRecognizerEntityList]
|
2662
2836
|
#
|
2837
|
+
# @!attribute [rw] augmented_manifests
|
2838
|
+
# A list of augmented manifest files that provide training data for
|
2839
|
+
# your custom model. An augmented manifest file is a labeled dataset
|
2840
|
+
# that is produced by Amazon SageMaker Ground Truth.
|
2841
|
+
#
|
2842
|
+
# This parameter is required if you set `DataFormat` to
|
2843
|
+
# `AUGMENTED_MANIFEST`.
|
2844
|
+
# @return [Array<Types::AugmentedManifestsListItem>]
|
2845
|
+
#
|
2663
2846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerInputDataConfig AWS API Documentation
|
2664
2847
|
#
|
2665
2848
|
class EntityRecognizerInputDataConfig < Struct.new(
|
2849
|
+
:data_format,
|
2666
2850
|
:entity_types,
|
2667
2851
|
:documents,
|
2668
2852
|
:annotations,
|
2669
|
-
:entity_list
|
2853
|
+
:entity_list,
|
2854
|
+
:augmented_manifests)
|
2670
2855
|
SENSITIVE = []
|
2671
2856
|
include Aws::Structure
|
2672
2857
|
end
|
@@ -2841,11 +3026,10 @@ module Aws::Comprehend
|
|
2841
3026
|
# @return [Float]
|
2842
3027
|
#
|
2843
3028
|
# @!attribute [rw] f1_score
|
2844
|
-
# A measure of how accurate the recognizer results are for
|
2845
|
-
#
|
2846
|
-
# `
|
2847
|
-
#
|
2848
|
-
# score is 0.
|
3029
|
+
# A measure of how accurate the recognizer results are for a specific
|
3030
|
+
# entity type in the test data. It is derived from the `Precision` and
|
3031
|
+
# `Recall` values. The `F1Score` is the harmonic average of the two
|
3032
|
+
# scores. The highest score is 1, and the worst score is 0.
|
2849
3033
|
# @return [Float]
|
2850
3034
|
#
|
2851
3035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesEvaluationMetrics AWS API Documentation
|
@@ -2858,7 +3042,8 @@ module Aws::Comprehend
|
|
2858
3042
|
include Aws::Structure
|
2859
3043
|
end
|
2860
3044
|
|
2861
|
-
#
|
3045
|
+
# An entity type within a labeled training dataset that Amazon
|
3046
|
+
# Comprehend uses to train a custom entity recognizer.
|
2862
3047
|
#
|
2863
3048
|
# @note When making an API call, you may pass EntityTypesListItem
|
2864
3049
|
# data as a hash:
|
@@ -2868,7 +3053,13 @@ module Aws::Comprehend
|
|
2868
3053
|
# }
|
2869
3054
|
#
|
2870
3055
|
# @!attribute [rw] type
|
2871
|
-
#
|
3056
|
+
# An entity type within a labeled training dataset that Amazon
|
3057
|
+
# Comprehend uses to train a custom entity recognizer.
|
3058
|
+
#
|
3059
|
+
# Entity types must not contain the following invalid characters: \\n
|
3060
|
+
# (line break), \\\\n (escaped line break, \\r (carriage return),
|
3061
|
+
# \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),
|
3062
|
+
# space, and , (comma).
|
2872
3063
|
# @return [String]
|
2873
3064
|
#
|
2874
3065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesListItem AWS API Documentation
|
@@ -2879,6 +3070,120 @@ module Aws::Comprehend
|
|
2879
3070
|
include Aws::Structure
|
2880
3071
|
end
|
2881
3072
|
|
3073
|
+
# Provides information for filtering a list of event detection jobs.
|
3074
|
+
#
|
3075
|
+
# @note When making an API call, you may pass EventsDetectionJobFilter
|
3076
|
+
# data as a hash:
|
3077
|
+
#
|
3078
|
+
# {
|
3079
|
+
# job_name: "JobName",
|
3080
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3081
|
+
# submit_time_before: Time.now,
|
3082
|
+
# submit_time_after: Time.now,
|
3083
|
+
# }
|
3084
|
+
#
|
3085
|
+
# @!attribute [rw] job_name
|
3086
|
+
# Filters on the name of the events detection job.
|
3087
|
+
# @return [String]
|
3088
|
+
#
|
3089
|
+
# @!attribute [rw] job_status
|
3090
|
+
# Filters the list of jobs based on job status. Returns only jobs with
|
3091
|
+
# the specified status.
|
3092
|
+
# @return [String]
|
3093
|
+
#
|
3094
|
+
# @!attribute [rw] submit_time_before
|
3095
|
+
# Filters the list of jobs based on the time that the job was
|
3096
|
+
# submitted for processing. Returns only jobs submitted before the
|
3097
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
3098
|
+
# newest.
|
3099
|
+
# @return [Time]
|
3100
|
+
#
|
3101
|
+
# @!attribute [rw] submit_time_after
|
3102
|
+
# Filters the list of jobs based on the time that the job was
|
3103
|
+
# submitted for processing. Returns only jobs submitted after the
|
3104
|
+
# specified time. Jobs are returned in descending order, newest to
|
3105
|
+
# oldest.
|
3106
|
+
# @return [Time]
|
3107
|
+
#
|
3108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobFilter AWS API Documentation
|
3109
|
+
#
|
3110
|
+
class EventsDetectionJobFilter < Struct.new(
|
3111
|
+
:job_name,
|
3112
|
+
:job_status,
|
3113
|
+
:submit_time_before,
|
3114
|
+
:submit_time_after)
|
3115
|
+
SENSITIVE = []
|
3116
|
+
include Aws::Structure
|
3117
|
+
end
|
3118
|
+
|
3119
|
+
# Provides information about an events detection job.
|
3120
|
+
#
|
3121
|
+
# @!attribute [rw] job_id
|
3122
|
+
# The identifier assigned to the events detection job.
|
3123
|
+
# @return [String]
|
3124
|
+
#
|
3125
|
+
# @!attribute [rw] job_name
|
3126
|
+
# The name you assigned the events detection job.
|
3127
|
+
# @return [String]
|
3128
|
+
#
|
3129
|
+
# @!attribute [rw] job_status
|
3130
|
+
# The current status of the events detection job.
|
3131
|
+
# @return [String]
|
3132
|
+
#
|
3133
|
+
# @!attribute [rw] message
|
3134
|
+
# A description of the status of the events detection job.
|
3135
|
+
# @return [String]
|
3136
|
+
#
|
3137
|
+
# @!attribute [rw] submit_time
|
3138
|
+
# The time that the events detection job was submitted for processing.
|
3139
|
+
# @return [Time]
|
3140
|
+
#
|
3141
|
+
# @!attribute [rw] end_time
|
3142
|
+
# The time that the events detection job completed.
|
3143
|
+
# @return [Time]
|
3144
|
+
#
|
3145
|
+
# @!attribute [rw] input_data_config
|
3146
|
+
# The input data configuration that you supplied when you created the
|
3147
|
+
# events detection job.
|
3148
|
+
# @return [Types::InputDataConfig]
|
3149
|
+
#
|
3150
|
+
# @!attribute [rw] output_data_config
|
3151
|
+
# The output data configuration that you supplied when you created the
|
3152
|
+
# events detection job.
|
3153
|
+
# @return [Types::OutputDataConfig]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] language_code
|
3156
|
+
# The language code of the input documents.
|
3157
|
+
# @return [String]
|
3158
|
+
#
|
3159
|
+
# @!attribute [rw] data_access_role_arn
|
3160
|
+
# The Amazon Resource Name (ARN) of the AWS Identify and Access
|
3161
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
3162
|
+
# your input data.
|
3163
|
+
# @return [String]
|
3164
|
+
#
|
3165
|
+
# @!attribute [rw] target_event_types
|
3166
|
+
# The types of events that are detected by the job.
|
3167
|
+
# @return [Array<String>]
|
3168
|
+
#
|
3169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobProperties AWS API Documentation
|
3170
|
+
#
|
3171
|
+
class EventsDetectionJobProperties < Struct.new(
|
3172
|
+
:job_id,
|
3173
|
+
:job_name,
|
3174
|
+
:job_status,
|
3175
|
+
:message,
|
3176
|
+
:submit_time,
|
3177
|
+
:end_time,
|
3178
|
+
:input_data_config,
|
3179
|
+
:output_data_config,
|
3180
|
+
:language_code,
|
3181
|
+
:data_access_role_arn,
|
3182
|
+
:target_event_types)
|
3183
|
+
SENSITIVE = []
|
3184
|
+
include Aws::Structure
|
3185
|
+
end
|
3186
|
+
|
2882
3187
|
# The input properties for a topic detection job.
|
2883
3188
|
#
|
2884
3189
|
# @note When making an API call, you may pass InputDataConfig
|
@@ -3498,6 +3803,61 @@ module Aws::Comprehend
|
|
3498
3803
|
include Aws::Structure
|
3499
3804
|
end
|
3500
3805
|
|
3806
|
+
# @note When making an API call, you may pass ListEventsDetectionJobsRequest
|
3807
|
+
# data as a hash:
|
3808
|
+
#
|
3809
|
+
# {
|
3810
|
+
# filter: {
|
3811
|
+
# job_name: "JobName",
|
3812
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3813
|
+
# submit_time_before: Time.now,
|
3814
|
+
# submit_time_after: Time.now,
|
3815
|
+
# },
|
3816
|
+
# next_token: "String",
|
3817
|
+
# max_results: 1,
|
3818
|
+
# }
|
3819
|
+
#
|
3820
|
+
# @!attribute [rw] filter
|
3821
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
3822
|
+
# name, status, or the date and time that they were submitted. You can
|
3823
|
+
# only set one filter at a time.
|
3824
|
+
# @return [Types::EventsDetectionJobFilter]
|
3825
|
+
#
|
3826
|
+
# @!attribute [rw] next_token
|
3827
|
+
# Identifies the next page of results to return.
|
3828
|
+
# @return [String]
|
3829
|
+
#
|
3830
|
+
# @!attribute [rw] max_results
|
3831
|
+
# The maximum number of results to return in each page.
|
3832
|
+
# @return [Integer]
|
3833
|
+
#
|
3834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsRequest AWS API Documentation
|
3835
|
+
#
|
3836
|
+
class ListEventsDetectionJobsRequest < Struct.new(
|
3837
|
+
:filter,
|
3838
|
+
:next_token,
|
3839
|
+
:max_results)
|
3840
|
+
SENSITIVE = []
|
3841
|
+
include Aws::Structure
|
3842
|
+
end
|
3843
|
+
|
3844
|
+
# @!attribute [rw] events_detection_job_properties_list
|
3845
|
+
# A list containing the properties of each job that is returned.
|
3846
|
+
# @return [Array<Types::EventsDetectionJobProperties>]
|
3847
|
+
#
|
3848
|
+
# @!attribute [rw] next_token
|
3849
|
+
# Identifies the next page of results to return.
|
3850
|
+
# @return [String]
|
3851
|
+
#
|
3852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsResponse AWS API Documentation
|
3853
|
+
#
|
3854
|
+
class ListEventsDetectionJobsResponse < Struct.new(
|
3855
|
+
:events_detection_job_properties_list,
|
3856
|
+
:next_token)
|
3857
|
+
SENSITIVE = []
|
3858
|
+
include Aws::Structure
|
3859
|
+
end
|
3860
|
+
|
3501
3861
|
# @note When making an API call, you may pass ListKeyPhrasesDetectionJobsRequest
|
3502
3862
|
# data as a hash:
|
3503
3863
|
#
|
@@ -4664,6 +5024,91 @@ module Aws::Comprehend
|
|
4664
5024
|
include Aws::Structure
|
4665
5025
|
end
|
4666
5026
|
|
5027
|
+
# @note When making an API call, you may pass StartEventsDetectionJobRequest
|
5028
|
+
# data as a hash:
|
5029
|
+
#
|
5030
|
+
# {
|
5031
|
+
# input_data_config: { # required
|
5032
|
+
# s3_uri: "S3Uri", # required
|
5033
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5034
|
+
# },
|
5035
|
+
# output_data_config: { # required
|
5036
|
+
# s3_uri: "S3Uri", # required
|
5037
|
+
# kms_key_id: "KmsKeyId",
|
5038
|
+
# },
|
5039
|
+
# data_access_role_arn: "IamRoleArn", # required
|
5040
|
+
# job_name: "JobName",
|
5041
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5042
|
+
# client_request_token: "ClientRequestTokenString",
|
5043
|
+
# target_event_types: ["EventTypeString"], # required
|
5044
|
+
# }
|
5045
|
+
#
|
5046
|
+
# @!attribute [rw] input_data_config
|
5047
|
+
# Specifies the format and location of the input data for the job.
|
5048
|
+
# @return [Types::InputDataConfig]
|
5049
|
+
#
|
5050
|
+
# @!attribute [rw] output_data_config
|
5051
|
+
# Specifies where to send the output files.
|
5052
|
+
# @return [Types::OutputDataConfig]
|
5053
|
+
#
|
5054
|
+
# @!attribute [rw] data_access_role_arn
|
5055
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
5056
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
5057
|
+
# your input data.
|
5058
|
+
# @return [String]
|
5059
|
+
#
|
5060
|
+
# @!attribute [rw] job_name
|
5061
|
+
# The identifier of the events detection job.
|
5062
|
+
# @return [String]
|
5063
|
+
#
|
5064
|
+
# @!attribute [rw] language_code
|
5065
|
+
# The language code of the input documents.
|
5066
|
+
# @return [String]
|
5067
|
+
#
|
5068
|
+
# @!attribute [rw] client_request_token
|
5069
|
+
# An unique identifier for the request. If you don't set the client
|
5070
|
+
# request token, Amazon Comprehend generates one.
|
5071
|
+
#
|
5072
|
+
# **A suitable default value is auto-generated.** You should normally
|
5073
|
+
# not need to pass this option.
|
5074
|
+
# @return [String]
|
5075
|
+
#
|
5076
|
+
# @!attribute [rw] target_event_types
|
5077
|
+
# The types of events to detect in the input documents.
|
5078
|
+
# @return [Array<String>]
|
5079
|
+
#
|
5080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobRequest AWS API Documentation
|
5081
|
+
#
|
5082
|
+
class StartEventsDetectionJobRequest < Struct.new(
|
5083
|
+
:input_data_config,
|
5084
|
+
:output_data_config,
|
5085
|
+
:data_access_role_arn,
|
5086
|
+
:job_name,
|
5087
|
+
:language_code,
|
5088
|
+
:client_request_token,
|
5089
|
+
:target_event_types)
|
5090
|
+
SENSITIVE = []
|
5091
|
+
include Aws::Structure
|
5092
|
+
end
|
5093
|
+
|
5094
|
+
# @!attribute [rw] job_id
|
5095
|
+
# An unique identifier for the request. If you don't set the client
|
5096
|
+
# request token, Amazon Comprehend generates one.
|
5097
|
+
# @return [String]
|
5098
|
+
#
|
5099
|
+
# @!attribute [rw] job_status
|
5100
|
+
# The status of the events detection job.
|
5101
|
+
# @return [String]
|
5102
|
+
#
|
5103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobResponse AWS API Documentation
|
5104
|
+
#
|
5105
|
+
class StartEventsDetectionJobResponse < Struct.new(
|
5106
|
+
:job_id,
|
5107
|
+
:job_status)
|
5108
|
+
SENSITIVE = []
|
5109
|
+
include Aws::Structure
|
5110
|
+
end
|
5111
|
+
|
4667
5112
|
# @note When making an API call, you may pass StartKeyPhrasesDetectionJobRequest
|
4668
5113
|
# data as a hash:
|
4669
5114
|
#
|
@@ -5219,6 +5664,42 @@ module Aws::Comprehend
|
|
5219
5664
|
include Aws::Structure
|
5220
5665
|
end
|
5221
5666
|
|
5667
|
+
# @note When making an API call, you may pass StopEventsDetectionJobRequest
|
5668
|
+
# data as a hash:
|
5669
|
+
#
|
5670
|
+
# {
|
5671
|
+
# job_id: "JobId", # required
|
5672
|
+
# }
|
5673
|
+
#
|
5674
|
+
# @!attribute [rw] job_id
|
5675
|
+
# The identifier of the events detection job to stop.
|
5676
|
+
# @return [String]
|
5677
|
+
#
|
5678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobRequest AWS API Documentation
|
5679
|
+
#
|
5680
|
+
class StopEventsDetectionJobRequest < Struct.new(
|
5681
|
+
:job_id)
|
5682
|
+
SENSITIVE = []
|
5683
|
+
include Aws::Structure
|
5684
|
+
end
|
5685
|
+
|
5686
|
+
# @!attribute [rw] job_id
|
5687
|
+
# The identifier of the events detection job to stop.
|
5688
|
+
# @return [String]
|
5689
|
+
#
|
5690
|
+
# @!attribute [rw] job_status
|
5691
|
+
# The status of the events detection job.
|
5692
|
+
# @return [String]
|
5693
|
+
#
|
5694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobResponse AWS API Documentation
|
5695
|
+
#
|
5696
|
+
class StopEventsDetectionJobResponse < Struct.new(
|
5697
|
+
:job_id,
|
5698
|
+
:job_status)
|
5699
|
+
SENSITIVE = []
|
5700
|
+
include Aws::Structure
|
5701
|
+
end
|
5702
|
+
|
5222
5703
|
# @note When making an API call, you may pass StopKeyPhrasesDetectionJobRequest
|
5223
5704
|
# data as a hash:
|
5224
5705
|
#
|
@@ -5769,7 +6250,7 @@ module Aws::Comprehend
|
|
5769
6250
|
class UpdateEndpointResponse < Aws::EmptyStructure; end
|
5770
6251
|
|
5771
6252
|
# Configuration parameters for an optional private Virtual Private Cloud
|
5772
|
-
# (VPC) containing the resources you are using for the job. For
|
6253
|
+
# (VPC) containing the resources you are using for the job. For more
|
5773
6254
|
# information, see [Amazon VPC][1].
|
5774
6255
|
#
|
5775
6256
|
#
|