aws-sdk-osis 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,816 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::OSIS
11
+ module Types
12
+
13
+ # You don't have permissions to access the resource.
14
+ #
15
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/AccessDeniedException AWS API Documentation
16
+ #
17
+ class AccessDeniedException < Aws::EmptyStructure; end
18
+
19
+ # Progress details for a specific stage of a pipeline configuration
20
+ # change.
21
+ #
22
+ # @!attribute [rw] name
23
+ # The name of the stage.
24
+ # @return [String]
25
+ #
26
+ # @!attribute [rw] status
27
+ # The current status of the stage that the change is in.
28
+ # @return [String]
29
+ #
30
+ # @!attribute [rw] description
31
+ # A description of the stage.
32
+ # @return [String]
33
+ #
34
+ # @!attribute [rw] last_updated_at
35
+ # The most recent updated timestamp of the stage.
36
+ # @return [Time]
37
+ #
38
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ChangeProgressStage AWS API Documentation
39
+ #
40
+ class ChangeProgressStage < Struct.new(
41
+ :name,
42
+ :status,
43
+ :description,
44
+ :last_updated_at)
45
+ SENSITIVE = []
46
+ include Aws::Structure
47
+ end
48
+
49
+ # The progress details of a pipeline configuration change.
50
+ #
51
+ # @!attribute [rw] start_time
52
+ # The time at which the configuration change is made on the pipeline.
53
+ # @return [Time]
54
+ #
55
+ # @!attribute [rw] status
56
+ # The overall status of the pipeline configuration change.
57
+ # @return [String]
58
+ #
59
+ # @!attribute [rw] total_number_of_stages
60
+ # The total number of stages required for the pipeline configuration
61
+ # change.
62
+ # @return [Integer]
63
+ #
64
+ # @!attribute [rw] change_progress_stages
65
+ # Information about the stages that the pipeline is going through to
66
+ # perform the configuration change.
67
+ # @return [Array<Types::ChangeProgressStage>]
68
+ #
69
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ChangeProgressStatus AWS API Documentation
70
+ #
71
+ class ChangeProgressStatus < Struct.new(
72
+ :start_time,
73
+ :status,
74
+ :total_number_of_stages,
75
+ :change_progress_stages)
76
+ SENSITIVE = []
77
+ include Aws::Structure
78
+ end
79
+
80
+ # The destination for OpenSearch Ingestion logs sent to Amazon
81
+ # CloudWatch.
82
+ #
83
+ # @!attribute [rw] log_group
84
+ # The name of the CloudWatch Logs group to send pipeline logs to. You
85
+ # can specify an existing log group or create a new one. For example,
86
+ # `/aws/OpenSearchService/IngestionService/my-pipeline`.
87
+ # @return [String]
88
+ #
89
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/CloudWatchLogDestination AWS API Documentation
90
+ #
91
+ class CloudWatchLogDestination < Struct.new(
92
+ :log_group)
93
+ SENSITIVE = []
94
+ include Aws::Structure
95
+ end
96
+
97
+ # The client attempted to remove a resource that is currently in use.
98
+ #
99
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ConflictException AWS API Documentation
100
+ #
101
+ class ConflictException < Aws::EmptyStructure; end
102
+
103
+ # @!attribute [rw] pipeline_name
104
+ # The name of the OpenSearch Ingestion pipeline to create. Pipeline
105
+ # names are unique across the pipelines owned by an account within an
106
+ # Amazon Web Services Region.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] min_units
110
+ # The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
111
+ # @return [Integer]
112
+ #
113
+ # @!attribute [rw] max_units
114
+ # The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
115
+ # @return [Integer]
116
+ #
117
+ # @!attribute [rw] pipeline_configuration_body
118
+ # The pipeline configuration in YAML format. The command accepts the
119
+ # pipeline configuration as a string or within a .yaml file. If you
120
+ # provide the configuration as a string, each new line must be escaped
121
+ # with `\n`.
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] log_publishing_options
125
+ # Key-value pairs to configure log publishing.
126
+ # @return [Types::LogPublishingOptions]
127
+ #
128
+ # @!attribute [rw] vpc_options
129
+ # Container for the values required to configure VPC access for the
130
+ # pipeline. If you don't specify these values, OpenSearch Ingestion
131
+ # creates the pipeline with a public endpoint.
132
+ # @return [Types::VpcOptions]
133
+ #
134
+ # @!attribute [rw] tags
135
+ # List of tags to add to the pipeline upon creation.
136
+ # @return [Array<Types::Tag>]
137
+ #
138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/CreatePipelineRequest AWS API Documentation
139
+ #
140
+ class CreatePipelineRequest < Struct.new(
141
+ :pipeline_name,
142
+ :min_units,
143
+ :max_units,
144
+ :pipeline_configuration_body,
145
+ :log_publishing_options,
146
+ :vpc_options,
147
+ :tags)
148
+ SENSITIVE = []
149
+ include Aws::Structure
150
+ end
151
+
152
+ # @!attribute [rw] pipeline
153
+ # Container for information about the created pipeline.
154
+ # @return [Types::Pipeline]
155
+ #
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/CreatePipelineResponse AWS API Documentation
157
+ #
158
+ class CreatePipelineResponse < Struct.new(
159
+ :pipeline)
160
+ SENSITIVE = []
161
+ include Aws::Structure
162
+ end
163
+
164
+ # @!attribute [rw] pipeline_name
165
+ # The name of the pipeline to delete.
166
+ # @return [String]
167
+ #
168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/DeletePipelineRequest AWS API Documentation
169
+ #
170
+ class DeletePipelineRequest < Struct.new(
171
+ :pipeline_name)
172
+ SENSITIVE = []
173
+ include Aws::Structure
174
+ end
175
+
176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/DeletePipelineResponse AWS API Documentation
177
+ #
178
+ class DeletePipelineResponse < Aws::EmptyStructure; end
179
+
180
+ # @!attribute [rw] blueprint_name
181
+ # The name of the blueprint to retrieve.
182
+ # @return [String]
183
+ #
184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineBlueprintRequest AWS API Documentation
185
+ #
186
+ class GetPipelineBlueprintRequest < Struct.new(
187
+ :blueprint_name)
188
+ SENSITIVE = []
189
+ include Aws::Structure
190
+ end
191
+
192
+ # @!attribute [rw] blueprint
193
+ # The requested blueprint in YAML format.
194
+ # @return [Types::PipelineBlueprint]
195
+ #
196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineBlueprintResponse AWS API Documentation
197
+ #
198
+ class GetPipelineBlueprintResponse < Struct.new(
199
+ :blueprint)
200
+ SENSITIVE = []
201
+ include Aws::Structure
202
+ end
203
+
204
+ # @!attribute [rw] pipeline_name
205
+ # The name of the pipeline.
206
+ # @return [String]
207
+ #
208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineChangeProgressRequest AWS API Documentation
209
+ #
210
+ class GetPipelineChangeProgressRequest < Struct.new(
211
+ :pipeline_name)
212
+ SENSITIVE = []
213
+ include Aws::Structure
214
+ end
215
+
216
+ # @!attribute [rw] change_progress_statuses
217
+ # The current status of the change happening on the pipeline.
218
+ # @return [Array<Types::ChangeProgressStatus>]
219
+ #
220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineChangeProgressResponse AWS API Documentation
221
+ #
222
+ class GetPipelineChangeProgressResponse < Struct.new(
223
+ :change_progress_statuses)
224
+ SENSITIVE = []
225
+ include Aws::Structure
226
+ end
227
+
228
+ # @!attribute [rw] pipeline_name
229
+ # The name of the pipeline to get information about.
230
+ # @return [String]
231
+ #
232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineRequest AWS API Documentation
233
+ #
234
+ class GetPipelineRequest < Struct.new(
235
+ :pipeline_name)
236
+ SENSITIVE = []
237
+ include Aws::Structure
238
+ end
239
+
240
+ # @!attribute [rw] pipeline
241
+ # Detailed information about the requested pipeline.
242
+ # @return [Types::Pipeline]
243
+ #
244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineResponse AWS API Documentation
245
+ #
246
+ class GetPipelineResponse < Struct.new(
247
+ :pipeline)
248
+ SENSITIVE = []
249
+ include Aws::Structure
250
+ end
251
+
252
+ # The request failed because of an unknown error, exception, or failure
253
+ # (the failure is internal to the service).
254
+ #
255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/InternalException AWS API Documentation
256
+ #
257
+ class InternalException < Aws::EmptyStructure; end
258
+
259
+ # An invalid pagination token provided in the request.
260
+ #
261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/InvalidPaginationTokenException AWS API Documentation
262
+ #
263
+ class InvalidPaginationTokenException < Aws::EmptyStructure; end
264
+
265
+ # You attempted to create more than the allowed number of tags.
266
+ #
267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/LimitExceededException AWS API Documentation
268
+ #
269
+ class LimitExceededException < Aws::EmptyStructure; end
270
+
271
+ # @api private
272
+ #
273
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelineBlueprintsRequest AWS API Documentation
274
+ #
275
+ class ListPipelineBlueprintsRequest < Aws::EmptyStructure; end
276
+
277
+ # @!attribute [rw] blueprints
278
+ # A list of available blueprints for Data Prepper.
279
+ # @return [Array<Types::PipelineBlueprintSummary>]
280
+ #
281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelineBlueprintsResponse AWS API Documentation
282
+ #
283
+ class ListPipelineBlueprintsResponse < Struct.new(
284
+ :blueprints)
285
+ SENSITIVE = []
286
+ include Aws::Structure
287
+ end
288
+
289
+ # @!attribute [rw] max_results
290
+ # An optional parameter that specifies the maximum number of results
291
+ # to return. You can use `nextToken` to get the next page of results.
292
+ # @return [Integer]
293
+ #
294
+ # @!attribute [rw] next_token
295
+ # If your initial `ListPipelines` operation returns a `nextToken`, you
296
+ # can include the returned `nextToken` in subsequent `ListPipelines`
297
+ # operations, which returns results in the next page.
298
+ # @return [String]
299
+ #
300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelinesRequest AWS API Documentation
301
+ #
302
+ class ListPipelinesRequest < Struct.new(
303
+ :max_results,
304
+ :next_token)
305
+ SENSITIVE = []
306
+ include Aws::Structure
307
+ end
308
+
309
+ # @!attribute [rw] next_token
310
+ # When `nextToken` is returned, there are more results available. The
311
+ # value of `nextToken` is a unique pagination token for each page.
312
+ # Make the call again using the returned token to retrieve the next
313
+ # page.
314
+ # @return [String]
315
+ #
316
+ # @!attribute [rw] pipelines
317
+ # A list of all existing Data Prepper pipelines.
318
+ # @return [Array<Types::PipelineSummary>]
319
+ #
320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelinesResponse AWS API Documentation
321
+ #
322
+ class ListPipelinesResponse < Struct.new(
323
+ :next_token,
324
+ :pipelines)
325
+ SENSITIVE = []
326
+ include Aws::Structure
327
+ end
328
+
329
+ # @!attribute [rw] arn
330
+ # The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
331
+ # @return [String]
332
+ #
333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListTagsForResourceRequest AWS API Documentation
334
+ #
335
+ class ListTagsForResourceRequest < Struct.new(
336
+ :arn)
337
+ SENSITIVE = []
338
+ include Aws::Structure
339
+ end
340
+
341
+ # @!attribute [rw] tags
342
+ # A list of tags associated with the given pipeline.
343
+ # @return [Array<Types::Tag>]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListTagsForResourceResponse AWS API Documentation
346
+ #
347
+ class ListTagsForResourceResponse < Struct.new(
348
+ :tags)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # Container for the values required to configure logging for the
354
+ # pipeline. If you don't specify these values, OpenSearch Ingestion
355
+ # will not publish logs from your application to CloudWatch Logs.
356
+ #
357
+ # @!attribute [rw] is_logging_enabled
358
+ # Whether logs should be published.
359
+ # @return [Boolean]
360
+ #
361
+ # @!attribute [rw] cloud_watch_log_destination
362
+ # The destination for OpenSearch Ingestion logs sent to Amazon
363
+ # CloudWatch Logs. This parameter is required if `IsLoggingEnabled` is
364
+ # set to `true`.
365
+ # @return [Types::CloudWatchLogDestination]
366
+ #
367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/LogPublishingOptions AWS API Documentation
368
+ #
369
+ class LogPublishingOptions < Struct.new(
370
+ :is_logging_enabled,
371
+ :cloud_watch_log_destination)
372
+ SENSITIVE = []
373
+ include Aws::Structure
374
+ end
375
+
376
+ # Information about an existing OpenSearch Ingestion pipeline.
377
+ #
378
+ # @!attribute [rw] pipeline_name
379
+ # The name of the pipeline.
380
+ # @return [String]
381
+ #
382
+ # @!attribute [rw] pipeline_arn
383
+ # The Amazon Resource Name (ARN) of the pipeline.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] min_units
387
+ # The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
388
+ # @return [Integer]
389
+ #
390
+ # @!attribute [rw] max_units
391
+ # The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
392
+ # @return [Integer]
393
+ #
394
+ # @!attribute [rw] status
395
+ # The current status of the pipeline.
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] status_reason
399
+ # The reason for the current status of the pipeline.
400
+ # @return [Types::PipelineStatusReason]
401
+ #
402
+ # @!attribute [rw] pipeline_configuration_body
403
+ # The Data Prepper pipeline configuration in YAML format.
404
+ # @return [String]
405
+ #
406
+ # @!attribute [rw] created_at
407
+ # The date and time when the pipeline was created.
408
+ # @return [Time]
409
+ #
410
+ # @!attribute [rw] last_updated_at
411
+ # The date and time when the pipeline was last updated.
412
+ # @return [Time]
413
+ #
414
+ # @!attribute [rw] ingest_endpoint_urls
415
+ # The ingestion endpoints for the pipeline, which you can send data
416
+ # to.
417
+ # @return [Array<String>]
418
+ #
419
+ # @!attribute [rw] log_publishing_options
420
+ # Key-value pairs that represent log publishing settings.
421
+ # @return [Types::LogPublishingOptions]
422
+ #
423
+ # @!attribute [rw] vpc_endpoints
424
+ # The VPC interface endpoints that have access to the pipeline.
425
+ # @return [Array<Types::VpcEndpoint>]
426
+ #
427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/Pipeline AWS API Documentation
428
+ #
429
+ class Pipeline < Struct.new(
430
+ :pipeline_name,
431
+ :pipeline_arn,
432
+ :min_units,
433
+ :max_units,
434
+ :status,
435
+ :status_reason,
436
+ :pipeline_configuration_body,
437
+ :created_at,
438
+ :last_updated_at,
439
+ :ingest_endpoint_urls,
440
+ :log_publishing_options,
441
+ :vpc_endpoints)
442
+ SENSITIVE = []
443
+ include Aws::Structure
444
+ end
445
+
446
+ # Container for information about an OpenSearch Ingestion blueprint.
447
+ #
448
+ # @!attribute [rw] blueprint_name
449
+ # The name of the blueprint.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] pipeline_configuration_body
453
+ # The YAML configuration of the blueprint.
454
+ # @return [String]
455
+ #
456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/PipelineBlueprint AWS API Documentation
457
+ #
458
+ class PipelineBlueprint < Struct.new(
459
+ :blueprint_name,
460
+ :pipeline_configuration_body)
461
+ SENSITIVE = []
462
+ include Aws::Structure
463
+ end
464
+
465
+ # A summary of an OpenSearch Ingestion blueprint.
466
+ #
467
+ # @!attribute [rw] blueprint_name
468
+ # The name of the blueprint.
469
+ # @return [String]
470
+ #
471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/PipelineBlueprintSummary AWS API Documentation
472
+ #
473
+ class PipelineBlueprintSummary < Struct.new(
474
+ :blueprint_name)
475
+ SENSITIVE = []
476
+ include Aws::Structure
477
+ end
478
+
479
+ # Information about a pipeline's current status.
480
+ #
481
+ # @!attribute [rw] description
482
+ # A description of why a pipeline has a certain status.
483
+ # @return [String]
484
+ #
485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/PipelineStatusReason AWS API Documentation
486
+ #
487
+ class PipelineStatusReason < Struct.new(
488
+ :description)
489
+ SENSITIVE = []
490
+ include Aws::Structure
491
+ end
492
+
493
+ # Summary information for an OpenSearch Ingestion pipeline.
494
+ #
495
+ # @!attribute [rw] status
496
+ # The current status of the pipeline.
497
+ # @return [String]
498
+ #
499
+ # @!attribute [rw] status_reason
500
+ # Information about a pipeline's current status.
501
+ # @return [Types::PipelineStatusReason]
502
+ #
503
+ # @!attribute [rw] pipeline_name
504
+ # The name of the pipeline.
505
+ # @return [String]
506
+ #
507
+ # @!attribute [rw] pipeline_arn
508
+ # The Amazon Resource Name (ARN) of the pipeline.
509
+ # @return [String]
510
+ #
511
+ # @!attribute [rw] min_units
512
+ # The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
513
+ # @return [Integer]
514
+ #
515
+ # @!attribute [rw] max_units
516
+ # The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
517
+ # @return [Integer]
518
+ #
519
+ # @!attribute [rw] created_at
520
+ # The date and time when the pipeline was created.
521
+ # @return [Time]
522
+ #
523
+ # @!attribute [rw] last_updated_at
524
+ # The date and time when the pipeline was last updated.
525
+ # @return [Time]
526
+ #
527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/PipelineSummary AWS API Documentation
528
+ #
529
+ class PipelineSummary < Struct.new(
530
+ :status,
531
+ :status_reason,
532
+ :pipeline_name,
533
+ :pipeline_arn,
534
+ :min_units,
535
+ :max_units,
536
+ :created_at,
537
+ :last_updated_at)
538
+ SENSITIVE = []
539
+ include Aws::Structure
540
+ end
541
+
542
+ # You attempted to create a resource that already exists.
543
+ #
544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ResourceAlreadyExistsException AWS API Documentation
545
+ #
546
+ class ResourceAlreadyExistsException < Aws::EmptyStructure; end
547
+
548
+ # You attempted to access or delete a resource that does not exist.
549
+ #
550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ResourceNotFoundException AWS API Documentation
551
+ #
552
+ class ResourceNotFoundException < Aws::EmptyStructure; end
553
+
554
+ # @!attribute [rw] pipeline_name
555
+ # The name of the pipeline to start.
556
+ # @return [String]
557
+ #
558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StartPipelineRequest AWS API Documentation
559
+ #
560
+ class StartPipelineRequest < Struct.new(
561
+ :pipeline_name)
562
+ SENSITIVE = []
563
+ include Aws::Structure
564
+ end
565
+
566
+ # @!attribute [rw] pipeline
567
+ # Information about an existing OpenSearch Ingestion pipeline.
568
+ # @return [Types::Pipeline]
569
+ #
570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StartPipelineResponse AWS API Documentation
571
+ #
572
+ class StartPipelineResponse < Struct.new(
573
+ :pipeline)
574
+ SENSITIVE = []
575
+ include Aws::Structure
576
+ end
577
+
578
+ # @!attribute [rw] pipeline_name
579
+ # The name of the pipeline to stop.
580
+ # @return [String]
581
+ #
582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StopPipelineRequest AWS API Documentation
583
+ #
584
+ class StopPipelineRequest < Struct.new(
585
+ :pipeline_name)
586
+ SENSITIVE = []
587
+ include Aws::Structure
588
+ end
589
+
590
+ # @!attribute [rw] pipeline
591
+ # Information about an existing OpenSearch Ingestion pipeline.
592
+ # @return [Types::Pipeline]
593
+ #
594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StopPipelineResponse AWS API Documentation
595
+ #
596
+ class StopPipelineResponse < Struct.new(
597
+ :pipeline)
598
+ SENSITIVE = []
599
+ include Aws::Structure
600
+ end
601
+
602
+ # A tag (key-value pair) for an OpenSearch Ingestion pipeline.
603
+ #
604
+ # @!attribute [rw] key
605
+ # The tag key. Tag keys must be unique for the pipeline to which they
606
+ # are attached.
607
+ # @return [String]
608
+ #
609
+ # @!attribute [rw] value
610
+ # The value assigned to the corresponding tag key. Tag values can be
611
+ # null and don't have to be unique in a tag set. For example, you can
612
+ # have a key value pair in a tag set of `project : Trinity` and
613
+ # `cost-center : Trinity`
614
+ # @return [String]
615
+ #
616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/Tag AWS API Documentation
617
+ #
618
+ class Tag < Struct.new(
619
+ :key,
620
+ :value)
621
+ SENSITIVE = []
622
+ include Aws::Structure
623
+ end
624
+
625
+ # @!attribute [rw] arn
626
+ # The Amazon Resource Name (ARN) of the pipeline to tag.
627
+ # @return [String]
628
+ #
629
+ # @!attribute [rw] tags
630
+ # The list of key-value tags to add to the pipeline.
631
+ # @return [Array<Types::Tag>]
632
+ #
633
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/TagResourceRequest AWS API Documentation
634
+ #
635
+ class TagResourceRequest < Struct.new(
636
+ :arn,
637
+ :tags)
638
+ SENSITIVE = []
639
+ include Aws::Structure
640
+ end
641
+
642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/TagResourceResponse AWS API Documentation
643
+ #
644
+ class TagResourceResponse < Aws::EmptyStructure; end
645
+
646
+ # @!attribute [rw] arn
647
+ # The Amazon Resource Name (ARN) of the pipeline to remove tags from.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] tag_keys
651
+ # The tag keys to remove.
652
+ # @return [Array<String>]
653
+ #
654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/UntagResourceRequest AWS API Documentation
655
+ #
656
+ class UntagResourceRequest < Struct.new(
657
+ :arn,
658
+ :tag_keys)
659
+ SENSITIVE = []
660
+ include Aws::Structure
661
+ end
662
+
663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/UntagResourceResponse AWS API Documentation
664
+ #
665
+ class UntagResourceResponse < Aws::EmptyStructure; end
666
+
667
+ # @!attribute [rw] pipeline_name
668
+ # The name of the pipeline to update.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] min_units
672
+ # The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
673
+ # @return [Integer]
674
+ #
675
+ # @!attribute [rw] max_units
676
+ # The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
677
+ # @return [Integer]
678
+ #
679
+ # @!attribute [rw] pipeline_configuration_body
680
+ # The pipeline configuration in YAML format. The command accepts the
681
+ # pipeline configuration as a string or within a .yaml file. If you
682
+ # provide the configuration as a string, each new line must be escaped
683
+ # with `\n`.
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] log_publishing_options
687
+ # Key-value pairs to configure log publishing.
688
+ # @return [Types::LogPublishingOptions]
689
+ #
690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/UpdatePipelineRequest AWS API Documentation
691
+ #
692
+ class UpdatePipelineRequest < Struct.new(
693
+ :pipeline_name,
694
+ :min_units,
695
+ :max_units,
696
+ :pipeline_configuration_body,
697
+ :log_publishing_options)
698
+ SENSITIVE = []
699
+ include Aws::Structure
700
+ end
701
+
702
+ # @!attribute [rw] pipeline
703
+ # Container for information about the updated pipeline.
704
+ # @return [Types::Pipeline]
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/UpdatePipelineResponse AWS API Documentation
707
+ #
708
+ class UpdatePipelineResponse < Struct.new(
709
+ :pipeline)
710
+ SENSITIVE = []
711
+ include Aws::Structure
712
+ end
713
+
714
+ # @!attribute [rw] pipeline_configuration_body
715
+ # The pipeline configuration in YAML format. The command accepts the
716
+ # pipeline configuration as a string or within a .yaml file. If you
717
+ # provide the configuration as a string, each new line must be escaped
718
+ # with `\n`.
719
+ # @return [String]
720
+ #
721
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ValidatePipelineRequest AWS API Documentation
722
+ #
723
+ class ValidatePipelineRequest < Struct.new(
724
+ :pipeline_configuration_body)
725
+ SENSITIVE = []
726
+ include Aws::Structure
727
+ end
728
+
729
+ # @!attribute [rw] is_valid
730
+ # A boolean indicating whether or not the pipeline configuration is
731
+ # valid.
732
+ # @return [Boolean]
733
+ #
734
+ # @!attribute [rw] errors
735
+ # A list of errors if the configuration is invalid.
736
+ # @return [Array<Types::ValidationMessage>]
737
+ #
738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ValidatePipelineResponse AWS API Documentation
739
+ #
740
+ class ValidatePipelineResponse < Struct.new(
741
+ :is_valid,
742
+ :errors)
743
+ SENSITIVE = []
744
+ include Aws::Structure
745
+ end
746
+
747
+ # An exception for missing or invalid input fields.
748
+ #
749
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ValidationException AWS API Documentation
750
+ #
751
+ class ValidationException < Aws::EmptyStructure; end
752
+
753
+ # A validation message associated with a `ValidatePipeline` request in
754
+ # OpenSearch Ingestion.
755
+ #
756
+ # @!attribute [rw] message
757
+ # The validation message.
758
+ # @return [String]
759
+ #
760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ValidationMessage AWS API Documentation
761
+ #
762
+ class ValidationMessage < Struct.new(
763
+ :message)
764
+ SENSITIVE = []
765
+ include Aws::Structure
766
+ end
767
+
768
+ # An OpenSearch Ingestion-managed VPC endpoint that will access one or
769
+ # more pipelines.
770
+ #
771
+ # @!attribute [rw] vpc_endpoint_id
772
+ # The unique identifier of the endpoint.
773
+ # @return [String]
774
+ #
775
+ # @!attribute [rw] vpc_id
776
+ # The ID for your VPC. Amazon Web Services PrivateLink generates this
777
+ # value when you create a VPC.
778
+ # @return [String]
779
+ #
780
+ # @!attribute [rw] vpc_options
781
+ # Information about the VPC, including associated subnets and security
782
+ # groups.
783
+ # @return [Types::VpcOptions]
784
+ #
785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/VpcEndpoint AWS API Documentation
786
+ #
787
+ class VpcEndpoint < Struct.new(
788
+ :vpc_endpoint_id,
789
+ :vpc_id,
790
+ :vpc_options)
791
+ SENSITIVE = []
792
+ include Aws::Structure
793
+ end
794
+
795
+ # Options that specify the subnets and security groups for an OpenSearch
796
+ # Ingestion VPC endpoint.
797
+ #
798
+ # @!attribute [rw] subnet_ids
799
+ # A list of subnet IDs associated with the VPC endpoint.
800
+ # @return [Array<String>]
801
+ #
802
+ # @!attribute [rw] security_group_ids
803
+ # A list of security groups associated with the VPC endpoint.
804
+ # @return [Array<String>]
805
+ #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/VpcOptions AWS API Documentation
807
+ #
808
+ class VpcOptions < Struct.new(
809
+ :subnet_ids,
810
+ :security_group_ids)
811
+ SENSITIVE = []
812
+ include Aws::Structure
813
+ end
814
+
815
+ end
816
+ end