aws-sdk-augmentedairuntime 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,223 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::AugmentedAIRuntime
9
+ # @api private
10
+ module ClientApi
11
+
12
+ include Seahorse::Model
13
+
14
+ Boolean = Shapes::BooleanShape.new(name: 'Boolean')
15
+ ContentClassifier = Shapes::StringShape.new(name: 'ContentClassifier')
16
+ ContentClassifiers = Shapes::ListShape.new(name: 'ContentClassifiers')
17
+ DeleteHumanLoopRequest = Shapes::StructureShape.new(name: 'DeleteHumanLoopRequest')
18
+ DeleteHumanLoopResponse = Shapes::StructureShape.new(name: 'DeleteHumanLoopResponse')
19
+ DescribeHumanLoopRequest = Shapes::StructureShape.new(name: 'DescribeHumanLoopRequest')
20
+ DescribeHumanLoopResponse = Shapes::StructureShape.new(name: 'DescribeHumanLoopResponse')
21
+ FailureReason = Shapes::StringShape.new(name: 'FailureReason')
22
+ FlowDefinitionArn = Shapes::StringShape.new(name: 'FlowDefinitionArn')
23
+ HumanLoopActivationReason = Shapes::StructureShape.new(name: 'HumanLoopActivationReason')
24
+ HumanLoopActivationResults = Shapes::StructureShape.new(name: 'HumanLoopActivationResults')
25
+ HumanLoopArn = Shapes::StringShape.new(name: 'HumanLoopArn')
26
+ HumanLoopInputContent = Shapes::StructureShape.new(name: 'HumanLoopInputContent')
27
+ HumanLoopName = Shapes::StringShape.new(name: 'HumanLoopName')
28
+ HumanLoopOutputContent = Shapes::StructureShape.new(name: 'HumanLoopOutputContent')
29
+ HumanLoopStatus = Shapes::StringShape.new(name: 'HumanLoopStatus')
30
+ HumanLoopSummaries = Shapes::ListShape.new(name: 'HumanLoopSummaries')
31
+ HumanLoopSummary = Shapes::StructureShape.new(name: 'HumanLoopSummary')
32
+ HumanReviewDataAttributes = Shapes::StructureShape.new(name: 'HumanReviewDataAttributes')
33
+ InputContent = Shapes::StringShape.new(name: 'InputContent')
34
+ InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
35
+ ListHumanLoopsRequest = Shapes::StructureShape.new(name: 'ListHumanLoopsRequest')
36
+ ListHumanLoopsResponse = Shapes::StructureShape.new(name: 'ListHumanLoopsResponse')
37
+ MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
38
+ NextToken = Shapes::StringShape.new(name: 'NextToken')
39
+ ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
40
+ ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
41
+ SortOrder = Shapes::StringShape.new(name: 'SortOrder')
42
+ StartHumanLoopRequest = Shapes::StructureShape.new(name: 'StartHumanLoopRequest')
43
+ StartHumanLoopResponse = Shapes::StructureShape.new(name: 'StartHumanLoopResponse')
44
+ StopHumanLoopRequest = Shapes::StructureShape.new(name: 'StopHumanLoopRequest')
45
+ StopHumanLoopResponse = Shapes::StructureShape.new(name: 'StopHumanLoopResponse')
46
+ String = Shapes::StringShape.new(name: 'String')
47
+ ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
48
+ Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
49
+ ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
50
+
51
+ ContentClassifiers.member = Shapes::ShapeRef.new(shape: ContentClassifier)
52
+
53
+ DeleteHumanLoopRequest.add_member(:human_loop_name, Shapes::ShapeRef.new(shape: HumanLoopName, required: true, location: "uri", location_name: "HumanLoopName"))
54
+ DeleteHumanLoopRequest.struct_class = Types::DeleteHumanLoopRequest
55
+
56
+ DeleteHumanLoopResponse.struct_class = Types::DeleteHumanLoopResponse
57
+
58
+ DescribeHumanLoopRequest.add_member(:human_loop_name, Shapes::ShapeRef.new(shape: HumanLoopName, required: true, location: "uri", location_name: "HumanLoopName"))
59
+ DescribeHumanLoopRequest.struct_class = Types::DescribeHumanLoopRequest
60
+
61
+ DescribeHumanLoopResponse.add_member(:creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreationTimestamp"))
62
+ DescribeHumanLoopResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: String, location_name: "FailureReason"))
63
+ DescribeHumanLoopResponse.add_member(:failure_code, Shapes::ShapeRef.new(shape: String, location_name: "FailureCode"))
64
+ DescribeHumanLoopResponse.add_member(:human_loop_status, Shapes::ShapeRef.new(shape: HumanLoopStatus, required: true, location_name: "HumanLoopStatus"))
65
+ DescribeHumanLoopResponse.add_member(:human_loop_name, Shapes::ShapeRef.new(shape: HumanLoopName, required: true, location_name: "HumanLoopName"))
66
+ DescribeHumanLoopResponse.add_member(:human_loop_arn, Shapes::ShapeRef.new(shape: HumanLoopArn, required: true, location_name: "HumanLoopArn"))
67
+ DescribeHumanLoopResponse.add_member(:flow_definition_arn, Shapes::ShapeRef.new(shape: FlowDefinitionArn, required: true, location_name: "FlowDefinitionArn"))
68
+ DescribeHumanLoopResponse.add_member(:human_loop_input, Shapes::ShapeRef.new(shape: HumanLoopInputContent, required: true, location_name: "HumanLoopInput"))
69
+ DescribeHumanLoopResponse.add_member(:human_loop_output, Shapes::ShapeRef.new(shape: HumanLoopOutputContent, location_name: "HumanLoopOutput"))
70
+ DescribeHumanLoopResponse.struct_class = Types::DescribeHumanLoopResponse
71
+
72
+ HumanLoopActivationReason.add_member(:conditions_matched, Shapes::ShapeRef.new(shape: Boolean, location_name: "ConditionsMatched"))
73
+ HumanLoopActivationReason.struct_class = Types::HumanLoopActivationReason
74
+
75
+ HumanLoopActivationResults.add_member(:human_loop_activation_reason, Shapes::ShapeRef.new(shape: HumanLoopActivationReason, location_name: "HumanLoopActivationReason"))
76
+ HumanLoopActivationResults.add_member(:human_loop_activation_conditions_evaluation_results, Shapes::ShapeRef.new(shape: String, location_name: "HumanLoopActivationConditionsEvaluationResults"))
77
+ HumanLoopActivationResults.struct_class = Types::HumanLoopActivationResults
78
+
79
+ HumanLoopInputContent.add_member(:input_content, Shapes::ShapeRef.new(shape: InputContent, required: true, location_name: "InputContent"))
80
+ HumanLoopInputContent.struct_class = Types::HumanLoopInputContent
81
+
82
+ HumanLoopOutputContent.add_member(:output_s3_uri, Shapes::ShapeRef.new(shape: String, required: true, location_name: "OutputS3Uri"))
83
+ HumanLoopOutputContent.struct_class = Types::HumanLoopOutputContent
84
+
85
+ HumanLoopSummaries.member = Shapes::ShapeRef.new(shape: HumanLoopSummary)
86
+
87
+ HumanLoopSummary.add_member(:human_loop_name, Shapes::ShapeRef.new(shape: HumanLoopName, location_name: "HumanLoopName"))
88
+ HumanLoopSummary.add_member(:human_loop_status, Shapes::ShapeRef.new(shape: HumanLoopStatus, location_name: "HumanLoopStatus"))
89
+ HumanLoopSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
90
+ HumanLoopSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
91
+ HumanLoopSummary.add_member(:flow_definition_arn, Shapes::ShapeRef.new(shape: FlowDefinitionArn, location_name: "FlowDefinitionArn"))
92
+ HumanLoopSummary.struct_class = Types::HumanLoopSummary
93
+
94
+ HumanReviewDataAttributes.add_member(:content_classifiers, Shapes::ShapeRef.new(shape: ContentClassifiers, required: true, location_name: "ContentClassifiers"))
95
+ HumanReviewDataAttributes.struct_class = Types::HumanReviewDataAttributes
96
+
97
+ InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: FailureReason, location_name: "Message"))
98
+ InternalServerException.struct_class = Types::InternalServerException
99
+
100
+ ListHumanLoopsRequest.add_member(:creation_time_after, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "CreationTimeAfter"))
101
+ ListHumanLoopsRequest.add_member(:creation_time_before, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "CreationTimeBefore"))
102
+ ListHumanLoopsRequest.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, location: "querystring", location_name: "SortOrder"))
103
+ ListHumanLoopsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "NextToken"))
104
+ ListHumanLoopsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "MaxResults", metadata: {"box"=>true}))
105
+ ListHumanLoopsRequest.struct_class = Types::ListHumanLoopsRequest
106
+
107
+ ListHumanLoopsResponse.add_member(:human_loop_summaries, Shapes::ShapeRef.new(shape: HumanLoopSummaries, required: true, location_name: "HumanLoopSummaries"))
108
+ ListHumanLoopsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
109
+ ListHumanLoopsResponse.struct_class = Types::ListHumanLoopsResponse
110
+
111
+ ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: FailureReason, location_name: "Message"))
112
+ ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
113
+
114
+ ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: FailureReason, location_name: "Message"))
115
+ ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
116
+
117
+ StartHumanLoopRequest.add_member(:human_loop_name, Shapes::ShapeRef.new(shape: HumanLoopName, required: true, location_name: "HumanLoopName"))
118
+ StartHumanLoopRequest.add_member(:flow_definition_arn, Shapes::ShapeRef.new(shape: FlowDefinitionArn, required: true, location_name: "FlowDefinitionArn"))
119
+ StartHumanLoopRequest.add_member(:human_loop_input, Shapes::ShapeRef.new(shape: HumanLoopInputContent, required: true, location_name: "HumanLoopInput"))
120
+ StartHumanLoopRequest.add_member(:data_attributes, Shapes::ShapeRef.new(shape: HumanReviewDataAttributes, location_name: "DataAttributes"))
121
+ StartHumanLoopRequest.struct_class = Types::StartHumanLoopRequest
122
+
123
+ StartHumanLoopResponse.add_member(:human_loop_arn, Shapes::ShapeRef.new(shape: HumanLoopArn, location_name: "HumanLoopArn"))
124
+ StartHumanLoopResponse.add_member(:human_loop_activation_results, Shapes::ShapeRef.new(shape: HumanLoopActivationResults, location_name: "HumanLoopActivationResults"))
125
+ StartHumanLoopResponse.struct_class = Types::StartHumanLoopResponse
126
+
127
+ StopHumanLoopRequest.add_member(:human_loop_name, Shapes::ShapeRef.new(shape: HumanLoopName, required: true, location_name: "HumanLoopName"))
128
+ StopHumanLoopRequest.struct_class = Types::StopHumanLoopRequest
129
+
130
+ StopHumanLoopResponse.struct_class = Types::StopHumanLoopResponse
131
+
132
+ ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: FailureReason, location_name: "Message"))
133
+ ThrottlingException.struct_class = Types::ThrottlingException
134
+
135
+ ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: FailureReason, location_name: "Message"))
136
+ ValidationException.struct_class = Types::ValidationException
137
+
138
+
139
+ # @api private
140
+ API = Seahorse::Model::Api.new.tap do |api|
141
+
142
+ api.version = "2019-11-07"
143
+
144
+ api.metadata = {
145
+ "apiVersion" => "2019-11-07",
146
+ "endpointPrefix" => "a2i-runtime.sagemaker",
147
+ "jsonVersion" => "1.1",
148
+ "protocol" => "rest-json",
149
+ "serviceFullName" => "Amazon Augmented AI Runtime",
150
+ "serviceId" => "SageMaker A2I Runtime",
151
+ "signatureVersion" => "v4",
152
+ "signingName" => "sagemaker",
153
+ "uid" => "sagemaker-a2i-runtime-2019-11-07",
154
+ }
155
+
156
+ api.add_operation(:delete_human_loop, Seahorse::Model::Operation.new.tap do |o|
157
+ o.name = "DeleteHumanLoop"
158
+ o.http_method = "DELETE"
159
+ o.http_request_uri = "/human-loops/{HumanLoopName}"
160
+ o.input = Shapes::ShapeRef.new(shape: DeleteHumanLoopRequest)
161
+ o.output = Shapes::ShapeRef.new(shape: DeleteHumanLoopResponse)
162
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
163
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
164
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
165
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
166
+ end)
167
+
168
+ api.add_operation(:describe_human_loop, Seahorse::Model::Operation.new.tap do |o|
169
+ o.name = "DescribeHumanLoop"
170
+ o.http_method = "GET"
171
+ o.http_request_uri = "/human-loops/{HumanLoopName}"
172
+ o.input = Shapes::ShapeRef.new(shape: DescribeHumanLoopRequest)
173
+ o.output = Shapes::ShapeRef.new(shape: DescribeHumanLoopResponse)
174
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
175
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
176
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
177
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
178
+ end)
179
+
180
+ api.add_operation(:list_human_loops, Seahorse::Model::Operation.new.tap do |o|
181
+ o.name = "ListHumanLoops"
182
+ o.http_method = "GET"
183
+ o.http_request_uri = "/human-loops"
184
+ o.input = Shapes::ShapeRef.new(shape: ListHumanLoopsRequest)
185
+ o.output = Shapes::ShapeRef.new(shape: ListHumanLoopsResponse)
186
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
187
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
188
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
189
+ o[:pager] = Aws::Pager.new(
190
+ limit_key: "max_results",
191
+ tokens: {
192
+ "next_token" => "next_token"
193
+ }
194
+ )
195
+ end)
196
+
197
+ api.add_operation(:start_human_loop, Seahorse::Model::Operation.new.tap do |o|
198
+ o.name = "StartHumanLoop"
199
+ o.http_method = "POST"
200
+ o.http_request_uri = "/human-loops"
201
+ o.input = Shapes::ShapeRef.new(shape: StartHumanLoopRequest)
202
+ o.output = Shapes::ShapeRef.new(shape: StartHumanLoopResponse)
203
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
204
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
205
+ o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
206
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
207
+ end)
208
+
209
+ api.add_operation(:stop_human_loop, Seahorse::Model::Operation.new.tap do |o|
210
+ o.name = "StopHumanLoop"
211
+ o.http_method = "POST"
212
+ o.http_request_uri = "/human-loops/stop"
213
+ o.input = Shapes::ShapeRef.new(shape: StopHumanLoopRequest)
214
+ o.output = Shapes::ShapeRef.new(shape: StopHumanLoopResponse)
215
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
216
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
217
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
218
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
219
+ end)
220
+ end
221
+
222
+ end
223
+ end
@@ -0,0 +1,94 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::AugmentedAIRuntime
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ class InternalServerException < ServiceError
14
+
15
+ # @param [Seahorse::Client::RequestContext] context
16
+ # @param [String] message
17
+ # @param [Aws::AugmentedAIRuntime::Types::InternalServerException] data
18
+ def initialize(context, message, data = Aws::EmptyStructure.new)
19
+ super(context, message, data)
20
+ end
21
+
22
+ # @return [String]
23
+ def message
24
+ @message || @data[:message]
25
+ end
26
+
27
+ end
28
+
29
+ class ResourceNotFoundException < ServiceError
30
+
31
+ # @param [Seahorse::Client::RequestContext] context
32
+ # @param [String] message
33
+ # @param [Aws::AugmentedAIRuntime::Types::ResourceNotFoundException] data
34
+ def initialize(context, message, data = Aws::EmptyStructure.new)
35
+ super(context, message, data)
36
+ end
37
+
38
+ # @return [String]
39
+ def message
40
+ @message || @data[:message]
41
+ end
42
+
43
+ end
44
+
45
+ class ServiceQuotaExceededException < ServiceError
46
+
47
+ # @param [Seahorse::Client::RequestContext] context
48
+ # @param [String] message
49
+ # @param [Aws::AugmentedAIRuntime::Types::ServiceQuotaExceededException] data
50
+ def initialize(context, message, data = Aws::EmptyStructure.new)
51
+ super(context, message, data)
52
+ end
53
+
54
+ # @return [String]
55
+ def message
56
+ @message || @data[:message]
57
+ end
58
+
59
+ end
60
+
61
+ class ThrottlingException < ServiceError
62
+
63
+ # @param [Seahorse::Client::RequestContext] context
64
+ # @param [String] message
65
+ # @param [Aws::AugmentedAIRuntime::Types::ThrottlingException] data
66
+ def initialize(context, message, data = Aws::EmptyStructure.new)
67
+ super(context, message, data)
68
+ end
69
+
70
+ # @return [String]
71
+ def message
72
+ @message || @data[:message]
73
+ end
74
+
75
+ end
76
+
77
+ class ValidationException < ServiceError
78
+
79
+ # @param [Seahorse::Client::RequestContext] context
80
+ # @param [String] message
81
+ # @param [Aws::AugmentedAIRuntime::Types::ValidationException] data
82
+ def initialize(context, message, data = Aws::EmptyStructure.new)
83
+ super(context, message, data)
84
+ end
85
+
86
+ # @return [String]
87
+ def message
88
+ @message || @data[:message]
89
+ end
90
+
91
+ end
92
+
93
+ end
94
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::AugmentedAIRuntime
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,441 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::AugmentedAIRuntime
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass DeleteHumanLoopRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # human_loop_name: "HumanLoopName", # required
16
+ # }
17
+ #
18
+ # @!attribute [rw] human_loop_name
19
+ # The name of the human loop you want to delete.
20
+ # @return [String]
21
+ #
22
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DeleteHumanLoopRequest AWS API Documentation
23
+ #
24
+ class DeleteHumanLoopRequest < Struct.new(
25
+ :human_loop_name)
26
+ include Aws::Structure
27
+ end
28
+
29
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DeleteHumanLoopResponse AWS API Documentation
30
+ #
31
+ class DeleteHumanLoopResponse < Aws::EmptyStructure; end
32
+
33
+ # @note When making an API call, you may pass DescribeHumanLoopRequest
34
+ # data as a hash:
35
+ #
36
+ # {
37
+ # human_loop_name: "HumanLoopName", # required
38
+ # }
39
+ #
40
+ # @!attribute [rw] human_loop_name
41
+ # The name of the human loop.
42
+ # @return [String]
43
+ #
44
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DescribeHumanLoopRequest AWS API Documentation
45
+ #
46
+ class DescribeHumanLoopRequest < Struct.new(
47
+ :human_loop_name)
48
+ include Aws::Structure
49
+ end
50
+
51
+ # @!attribute [rw] creation_timestamp
52
+ # The timestamp when Amazon Augmented AI created the human loop.
53
+ # @return [Time]
54
+ #
55
+ # @!attribute [rw] failure_reason
56
+ # The reason why a human loop has failed. The failure reason is
57
+ # returned when the human loop status is `Failed`.
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] failure_code
61
+ # A failure code denoting a specific type of failure.
62
+ # @return [String]
63
+ #
64
+ # @!attribute [rw] human_loop_status
65
+ # The status of the human loop. Valid values:
66
+ # @return [String]
67
+ #
68
+ # @!attribute [rw] human_loop_name
69
+ # The name of the human loop.
70
+ # @return [String]
71
+ #
72
+ # @!attribute [rw] human_loop_arn
73
+ # The Amazon Resource Name (ARN) of the human loop.
74
+ # @return [String]
75
+ #
76
+ # @!attribute [rw] flow_definition_arn
77
+ # The Amazon Resource Name (ARN) of the flow definition.
78
+ # @return [String]
79
+ #
80
+ # @!attribute [rw] human_loop_input
81
+ # An object containing information about the human loop input.
82
+ # @return [Types::HumanLoopInputContent]
83
+ #
84
+ # @!attribute [rw] human_loop_output
85
+ # An object containing information about the output of the human loop.
86
+ # @return [Types::HumanLoopOutputContent]
87
+ #
88
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DescribeHumanLoopResponse AWS API Documentation
89
+ #
90
+ class DescribeHumanLoopResponse < Struct.new(
91
+ :creation_timestamp,
92
+ :failure_reason,
93
+ :failure_code,
94
+ :human_loop_status,
95
+ :human_loop_name,
96
+ :human_loop_arn,
97
+ :flow_definition_arn,
98
+ :human_loop_input,
99
+ :human_loop_output)
100
+ include Aws::Structure
101
+ end
102
+
103
+ # Contains information about why a human loop was triggered. If at least
104
+ # one activation reason is evaluated to be true, the human loop is
105
+ # activated.
106
+ #
107
+ # @!attribute [rw] conditions_matched
108
+ # True if the specified conditions were matched to trigger the human
109
+ # loop.
110
+ # @return [Boolean]
111
+ #
112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/HumanLoopActivationReason AWS API Documentation
113
+ #
114
+ class HumanLoopActivationReason < Struct.new(
115
+ :conditions_matched)
116
+ include Aws::Structure
117
+ end
118
+
119
+ # Information about the corresponding flow definition's human loop
120
+ # activation condition evaluation. Null if `StartHumanLoop` was invoked
121
+ # directly.
122
+ #
123
+ # @!attribute [rw] human_loop_activation_reason
124
+ # An object containing information about why a human loop was
125
+ # triggered.
126
+ # @return [Types::HumanLoopActivationReason]
127
+ #
128
+ # @!attribute [rw] human_loop_activation_conditions_evaluation_results
129
+ # A copy of the human loop activation conditions of the flow
130
+ # definition, augmented with the results of evaluating those
131
+ # conditions on the input provided to the `StartHumanLoop` operation.
132
+ # @return [String]
133
+ #
134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/HumanLoopActivationResults AWS API Documentation
135
+ #
136
+ class HumanLoopActivationResults < Struct.new(
137
+ :human_loop_activation_reason,
138
+ :human_loop_activation_conditions_evaluation_results)
139
+ include Aws::Structure
140
+ end
141
+
142
+ # An object containing the input.
143
+ #
144
+ # @note When making an API call, you may pass HumanLoopInputContent
145
+ # data as a hash:
146
+ #
147
+ # {
148
+ # input_content: "InputContent", # required
149
+ # }
150
+ #
151
+ # @!attribute [rw] input_content
152
+ # Serialized input from the human loop.
153
+ # @return [String]
154
+ #
155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/HumanLoopInputContent AWS API Documentation
156
+ #
157
+ class HumanLoopInputContent < Struct.new(
158
+ :input_content)
159
+ include Aws::Structure
160
+ end
161
+
162
+ # Information about where the human output will be stored.
163
+ #
164
+ # @!attribute [rw] output_s3_uri
165
+ # The location of the Amazon S3 object where Amazon Augmented AI
166
+ # stores your human loop output. The output is stored at the following
167
+ # location:
168
+ # `s3://S3OutputPath/HumanLoopName/CreationTime/output.json`.
169
+ # @return [String]
170
+ #
171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/HumanLoopOutputContent AWS API Documentation
172
+ #
173
+ class HumanLoopOutputContent < Struct.new(
174
+ :output_s3_uri)
175
+ include Aws::Structure
176
+ end
177
+
178
+ # Summary information about the human loop.
179
+ #
180
+ # @!attribute [rw] human_loop_name
181
+ # The name of the human loop.
182
+ # @return [String]
183
+ #
184
+ # @!attribute [rw] human_loop_status
185
+ # The status of the human loop. Valid values:
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] creation_time
189
+ # When Amazon Augmented AI created the human loop.
190
+ # @return [Time]
191
+ #
192
+ # @!attribute [rw] failure_reason
193
+ # The reason why the human loop failed. A failure reason is returned
194
+ # only when the status of the human loop is `Failed`.
195
+ # @return [String]
196
+ #
197
+ # @!attribute [rw] flow_definition_arn
198
+ # The Amazon Resource Name (ARN) of the flow definition.
199
+ # @return [String]
200
+ #
201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/HumanLoopSummary AWS API Documentation
202
+ #
203
+ class HumanLoopSummary < Struct.new(
204
+ :human_loop_name,
205
+ :human_loop_status,
206
+ :creation_time,
207
+ :failure_reason,
208
+ :flow_definition_arn)
209
+ include Aws::Structure
210
+ end
211
+
212
+ # Attributes of the data specified by the customer. Use these to
213
+ # describe the data to be labeled.
214
+ #
215
+ # @note When making an API call, you may pass HumanReviewDataAttributes
216
+ # data as a hash:
217
+ #
218
+ # {
219
+ # content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # required, accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
220
+ # }
221
+ #
222
+ # @!attribute [rw] content_classifiers
223
+ # Declares that your content is free of personally identifiable
224
+ # information or adult content. Amazon SageMaker may restrict the
225
+ # Amazon Mechanical Turk workers that can view your task based on this
226
+ # information.
227
+ # @return [Array<String>]
228
+ #
229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/HumanReviewDataAttributes AWS API Documentation
230
+ #
231
+ class HumanReviewDataAttributes < Struct.new(
232
+ :content_classifiers)
233
+ include Aws::Structure
234
+ end
235
+
236
+ # Your request could not be processed.
237
+ #
238
+ # @!attribute [rw] message
239
+ # @return [String]
240
+ #
241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/InternalServerException AWS API Documentation
242
+ #
243
+ class InternalServerException < Struct.new(
244
+ :message)
245
+ include Aws::Structure
246
+ end
247
+
248
+ # @note When making an API call, you may pass ListHumanLoopsRequest
249
+ # data as a hash:
250
+ #
251
+ # {
252
+ # creation_time_after: Time.now,
253
+ # creation_time_before: Time.now,
254
+ # sort_order: "Ascending", # accepts Ascending, Descending
255
+ # next_token: "NextToken",
256
+ # max_results: 1,
257
+ # }
258
+ #
259
+ # @!attribute [rw] creation_time_after
260
+ # (Optional) The timestamp of the date when you want the human loops
261
+ # to begin. For example, `1551000000`.
262
+ # @return [Time]
263
+ #
264
+ # @!attribute [rw] creation_time_before
265
+ # (Optional) The timestamp of the date before which you want the human
266
+ # loops to begin. For example, `1550000000`.
267
+ # @return [Time]
268
+ #
269
+ # @!attribute [rw] sort_order
270
+ # An optional value that specifies whether you want the results sorted
271
+ # in `Ascending` or `Descending` order.
272
+ # @return [String]
273
+ #
274
+ # @!attribute [rw] next_token
275
+ # A token to resume pagination.
276
+ # @return [String]
277
+ #
278
+ # @!attribute [rw] max_results
279
+ # The total number of items to return. If the total number of
280
+ # available items is more than the value specified in `MaxResults`,
281
+ # then a `NextToken` will be provided in the output that you can use
282
+ # to resume pagination.
283
+ # @return [Integer]
284
+ #
285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ListHumanLoopsRequest AWS API Documentation
286
+ #
287
+ class ListHumanLoopsRequest < Struct.new(
288
+ :creation_time_after,
289
+ :creation_time_before,
290
+ :sort_order,
291
+ :next_token,
292
+ :max_results)
293
+ include Aws::Structure
294
+ end
295
+
296
+ # @!attribute [rw] human_loop_summaries
297
+ # An array of objects containing information about the human loops.
298
+ # @return [Array<Types::HumanLoopSummary>]
299
+ #
300
+ # @!attribute [rw] next_token
301
+ # A token to resume pagination.
302
+ # @return [String]
303
+ #
304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ListHumanLoopsResponse AWS API Documentation
305
+ #
306
+ class ListHumanLoopsResponse < Struct.new(
307
+ :human_loop_summaries,
308
+ :next_token)
309
+ include Aws::Structure
310
+ end
311
+
312
+ # We were unable to find the requested resource.
313
+ #
314
+ # @!attribute [rw] message
315
+ # @return [String]
316
+ #
317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ResourceNotFoundException AWS API Documentation
318
+ #
319
+ class ResourceNotFoundException < Struct.new(
320
+ :message)
321
+ include Aws::Structure
322
+ end
323
+
324
+ # You have exceeded your service quota. To perform the requested action,
325
+ # remove some of the relevant resources, or request a service quota
326
+ # increase.
327
+ #
328
+ # @!attribute [rw] message
329
+ # @return [String]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ServiceQuotaExceededException AWS API Documentation
332
+ #
333
+ class ServiceQuotaExceededException < Struct.new(
334
+ :message)
335
+ include Aws::Structure
336
+ end
337
+
338
+ # @note When making an API call, you may pass StartHumanLoopRequest
339
+ # data as a hash:
340
+ #
341
+ # {
342
+ # human_loop_name: "HumanLoopName", # required
343
+ # flow_definition_arn: "FlowDefinitionArn", # required
344
+ # human_loop_input: { # required
345
+ # input_content: "InputContent", # required
346
+ # },
347
+ # data_attributes: {
348
+ # content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # required, accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
349
+ # },
350
+ # }
351
+ #
352
+ # @!attribute [rw] human_loop_name
353
+ # The name of the human loop.
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] flow_definition_arn
357
+ # The Amazon Resource Name (ARN) of the flow definition.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] human_loop_input
361
+ # An object containing information about the human loop.
362
+ # @return [Types::HumanLoopInputContent]
363
+ #
364
+ # @!attribute [rw] data_attributes
365
+ # Attributes of the data specified by the customer.
366
+ # @return [Types::HumanReviewDataAttributes]
367
+ #
368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StartHumanLoopRequest AWS API Documentation
369
+ #
370
+ class StartHumanLoopRequest < Struct.new(
371
+ :human_loop_name,
372
+ :flow_definition_arn,
373
+ :human_loop_input,
374
+ :data_attributes)
375
+ include Aws::Structure
376
+ end
377
+
378
+ # @!attribute [rw] human_loop_arn
379
+ # The Amazon Resource Name (ARN) of the human loop.
380
+ # @return [String]
381
+ #
382
+ # @!attribute [rw] human_loop_activation_results
383
+ # An object containing information about the human loop activation.
384
+ # @return [Types::HumanLoopActivationResults]
385
+ #
386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StartHumanLoopResponse AWS API Documentation
387
+ #
388
+ class StartHumanLoopResponse < Struct.new(
389
+ :human_loop_arn,
390
+ :human_loop_activation_results)
391
+ include Aws::Structure
392
+ end
393
+
394
+ # @note When making an API call, you may pass StopHumanLoopRequest
395
+ # data as a hash:
396
+ #
397
+ # {
398
+ # human_loop_name: "HumanLoopName", # required
399
+ # }
400
+ #
401
+ # @!attribute [rw] human_loop_name
402
+ # The name of the human loop you want to stop.
403
+ # @return [String]
404
+ #
405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StopHumanLoopRequest AWS API Documentation
406
+ #
407
+ class StopHumanLoopRequest < Struct.new(
408
+ :human_loop_name)
409
+ include Aws::Structure
410
+ end
411
+
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StopHumanLoopResponse AWS API Documentation
413
+ #
414
+ class StopHumanLoopResponse < Aws::EmptyStructure; end
415
+
416
+ # Your request has exceeded the allowed amount of requests.
417
+ #
418
+ # @!attribute [rw] message
419
+ # @return [String]
420
+ #
421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ThrottlingException AWS API Documentation
422
+ #
423
+ class ThrottlingException < Struct.new(
424
+ :message)
425
+ include Aws::Structure
426
+ end
427
+
428
+ # Your request was not valid. Check the syntax and try again.
429
+ #
430
+ # @!attribute [rw] message
431
+ # @return [String]
432
+ #
433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ValidationException AWS API Documentation
434
+ #
435
+ class ValidationException < Struct.new(
436
+ :message)
437
+ include Aws::Structure
438
+ end
439
+
440
+ end
441
+ end