aws-sdk-opensearchserverless 1.0.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.
@@ -0,0 +1,2502 @@
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::OpenSearchServerless
11
+ module Types
12
+
13
+ # Details about an OpenSearch Serverless access policy.
14
+ #
15
+ # @!attribute [rw] created_date
16
+ # The date the policy was created.
17
+ # @return [Integer]
18
+ #
19
+ # @!attribute [rw] description
20
+ # The description of the policy.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] last_modified_date
24
+ # The timestamp of when the policy was last modified.
25
+ # @return [Integer]
26
+ #
27
+ # @!attribute [rw] name
28
+ # The name of the policy.
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] policy
32
+ # The JSON policy document without any whitespaces.
33
+ # @return [Hash,Array,String,Numeric,Boolean]
34
+ #
35
+ # @!attribute [rw] policy_version
36
+ # The version of the policy.
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] type
40
+ # The type of access policy.
41
+ # @return [String]
42
+ #
43
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/AccessPolicyDetail AWS API Documentation
44
+ #
45
+ class AccessPolicyDetail < Struct.new(
46
+ :created_date,
47
+ :description,
48
+ :last_modified_date,
49
+ :name,
50
+ :policy,
51
+ :policy_version,
52
+ :type)
53
+ SENSITIVE = []
54
+ include Aws::Structure
55
+ end
56
+
57
+ # Statistics for an OpenSearch Serverless access policy.
58
+ #
59
+ # @!attribute [rw] data_policy_count
60
+ # The number of data access policies in the current account.
61
+ # @return [Integer]
62
+ #
63
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/AccessPolicyStats AWS API Documentation
64
+ #
65
+ class AccessPolicyStats < Struct.new(
66
+ :data_policy_count)
67
+ SENSITIVE = []
68
+ include Aws::Structure
69
+ end
70
+
71
+ # A summary of the data access policy.
72
+ #
73
+ # @!attribute [rw] created_date
74
+ # The Epoch time when the access policy was created.
75
+ # @return [Integer]
76
+ #
77
+ # @!attribute [rw] description
78
+ # The description of the access policy.
79
+ # @return [String]
80
+ #
81
+ # @!attribute [rw] last_modified_date
82
+ # The date and time when the collection was last modified.
83
+ # @return [Integer]
84
+ #
85
+ # @!attribute [rw] name
86
+ # The name of the access policy.
87
+ # @return [String]
88
+ #
89
+ # @!attribute [rw] policy_version
90
+ # The version of the policy.
91
+ # @return [String]
92
+ #
93
+ # @!attribute [rw] type
94
+ # The type of access policy. Currently the only available type is
95
+ # `data`.
96
+ # @return [String]
97
+ #
98
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/AccessPolicySummary AWS API Documentation
99
+ #
100
+ class AccessPolicySummary < Struct.new(
101
+ :created_date,
102
+ :description,
103
+ :last_modified_date,
104
+ :name,
105
+ :policy_version,
106
+ :type)
107
+ SENSITIVE = []
108
+ include Aws::Structure
109
+ end
110
+
111
+ # OpenSearch Serverless-related information for the current account.
112
+ #
113
+ # @!attribute [rw] capacity_limits
114
+ # The maximum capacity limits for all OpenSearch Serverless
115
+ # collections, in OpenSearch Compute Units (OCUs). These limits are
116
+ # used to scale your collections based on the current workload. For
117
+ # more information, see [Autoscaling][1].
118
+ #
119
+ #
120
+ #
121
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling
122
+ # @return [Types::CapacityLimits]
123
+ #
124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/AccountSettingsDetail AWS API Documentation
125
+ #
126
+ class AccountSettingsDetail < Struct.new(
127
+ :capacity_limits)
128
+ SENSITIVE = []
129
+ include Aws::Structure
130
+ end
131
+
132
+ # @note When making an API call, you may pass BatchGetCollectionRequest
133
+ # data as a hash:
134
+ #
135
+ # {
136
+ # ids: ["CollectionId"],
137
+ # names: ["CollectionName"],
138
+ # }
139
+ #
140
+ # @!attribute [rw] ids
141
+ # A list of collection IDs. You can't provide names and IDs in the
142
+ # same request. The ID is part of the collection endpoint. You can
143
+ # also retrieve it using the [ListCollections][1] API.
144
+ #
145
+ #
146
+ #
147
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html
148
+ # @return [Array<String>]
149
+ #
150
+ # @!attribute [rw] names
151
+ # A list of collection names. You can't provide names and IDs in the
152
+ # same request.
153
+ # @return [Array<String>]
154
+ #
155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetCollectionRequest AWS API Documentation
156
+ #
157
+ class BatchGetCollectionRequest < Struct.new(
158
+ :ids,
159
+ :names)
160
+ SENSITIVE = []
161
+ include Aws::Structure
162
+ end
163
+
164
+ # @!attribute [rw] collection_details
165
+ # Details about each collection.
166
+ # @return [Array<Types::CollectionDetail>]
167
+ #
168
+ # @!attribute [rw] collection_error_details
169
+ # Error information for the request.
170
+ # @return [Array<Types::CollectionErrorDetail>]
171
+ #
172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetCollectionResponse AWS API Documentation
173
+ #
174
+ class BatchGetCollectionResponse < Struct.new(
175
+ :collection_details,
176
+ :collection_error_details)
177
+ SENSITIVE = []
178
+ include Aws::Structure
179
+ end
180
+
181
+ # @note When making an API call, you may pass BatchGetVpcEndpointRequest
182
+ # data as a hash:
183
+ #
184
+ # {
185
+ # ids: ["VpcEndpointId"], # required
186
+ # }
187
+ #
188
+ # @!attribute [rw] ids
189
+ # A list of VPC endpoint identifiers.
190
+ # @return [Array<String>]
191
+ #
192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetVpcEndpointRequest AWS API Documentation
193
+ #
194
+ class BatchGetVpcEndpointRequest < Struct.new(
195
+ :ids)
196
+ SENSITIVE = []
197
+ include Aws::Structure
198
+ end
199
+
200
+ # @!attribute [rw] vpc_endpoint_details
201
+ # Details about the specified VPC endpoint.
202
+ # @return [Array<Types::VpcEndpointDetail>]
203
+ #
204
+ # @!attribute [rw] vpc_endpoint_error_details
205
+ # Error information for a failed request.
206
+ # @return [Array<Types::VpcEndpointErrorDetail>]
207
+ #
208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetVpcEndpointResponse AWS API Documentation
209
+ #
210
+ class BatchGetVpcEndpointResponse < Struct.new(
211
+ :vpc_endpoint_details,
212
+ :vpc_endpoint_error_details)
213
+ SENSITIVE = []
214
+ include Aws::Structure
215
+ end
216
+
217
+ # The maximum capacity limits for all OpenSearch Serverless collections,
218
+ # in OpenSearch Compute Units (OCUs). These limits are used to scale
219
+ # your collections based on the current workload. For more information,
220
+ # see [Autoscaling][1].
221
+ #
222
+ #
223
+ #
224
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling
225
+ #
226
+ # @note When making an API call, you may pass CapacityLimits
227
+ # data as a hash:
228
+ #
229
+ # {
230
+ # max_indexing_capacity_in_ocu: 1,
231
+ # max_search_capacity_in_ocu: 1,
232
+ # }
233
+ #
234
+ # @!attribute [rw] max_indexing_capacity_in_ocu
235
+ # The maximum indexing capacity for collections.
236
+ # @return [Integer]
237
+ #
238
+ # @!attribute [rw] max_search_capacity_in_ocu
239
+ # The maximum search capacity for collections.
240
+ # @return [Integer]
241
+ #
242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CapacityLimits AWS API Documentation
243
+ #
244
+ class CapacityLimits < Struct.new(
245
+ :max_indexing_capacity_in_ocu,
246
+ :max_search_capacity_in_ocu)
247
+ SENSITIVE = []
248
+ include Aws::Structure
249
+ end
250
+
251
+ # Details about each OpenSearch Serverless collection, including the
252
+ # collection endpoint and the OpenSearch Dashboards endpoint.
253
+ #
254
+ # @!attribute [rw] arn
255
+ # The Amazon Resource Name (ARN) of the collection.
256
+ # @return [String]
257
+ #
258
+ # @!attribute [rw] collection_endpoint
259
+ # Collection-specific endpoint used to submit index, search, and data
260
+ # upload requests to an OpenSearch Serverless collection.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] created_date
264
+ # The Epoch time when the collection was created.
265
+ # @return [Integer]
266
+ #
267
+ # @!attribute [rw] dashboard_endpoint
268
+ # Collection-specific endpoint used to access OpenSearch Dashboards.
269
+ # @return [String]
270
+ #
271
+ # @!attribute [rw] description
272
+ # A description of the collection.
273
+ # @return [String]
274
+ #
275
+ # @!attribute [rw] id
276
+ # A unique identifier for the collection.
277
+ # @return [String]
278
+ #
279
+ # @!attribute [rw] kms_key_arn
280
+ # The ARN of the Amazon Web Services KMS key used to encrypt the
281
+ # collection.
282
+ # @return [String]
283
+ #
284
+ # @!attribute [rw] last_modified_date
285
+ # The date and time when the collection was last modified.
286
+ # @return [Integer]
287
+ #
288
+ # @!attribute [rw] name
289
+ # The name of the collection.
290
+ # @return [String]
291
+ #
292
+ # @!attribute [rw] status
293
+ # The current status of the collection.
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] type
297
+ # The type of collection.
298
+ # @return [String]
299
+ #
300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CollectionDetail AWS API Documentation
301
+ #
302
+ class CollectionDetail < Struct.new(
303
+ :arn,
304
+ :collection_endpoint,
305
+ :created_date,
306
+ :dashboard_endpoint,
307
+ :description,
308
+ :id,
309
+ :kms_key_arn,
310
+ :last_modified_date,
311
+ :name,
312
+ :status,
313
+ :type)
314
+ SENSITIVE = []
315
+ include Aws::Structure
316
+ end
317
+
318
+ # Error information for an OpenSearch Serverless request.
319
+ #
320
+ # @!attribute [rw] error_code
321
+ # The error code for the request. For example, `NOT_FOUND`.
322
+ # @return [String]
323
+ #
324
+ # @!attribute [rw] error_message
325
+ # A description of the error. For example, `The specified Collection
326
+ # is not found.`
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] id
330
+ # If the request contains collection IDs, the response includes the
331
+ # IDs provided in the request.
332
+ # @return [String]
333
+ #
334
+ # @!attribute [rw] name
335
+ # If the request contains collection names, the response includes the
336
+ # names provided in the request.
337
+ # @return [String]
338
+ #
339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CollectionErrorDetail AWS API Documentation
340
+ #
341
+ class CollectionErrorDetail < Struct.new(
342
+ :error_code,
343
+ :error_message,
344
+ :id,
345
+ :name)
346
+ SENSITIVE = []
347
+ include Aws::Structure
348
+ end
349
+
350
+ # List of filter keys that you can use for LIST, UPDATE, and DELETE
351
+ # requests to OpenSearch Serverless collections.
352
+ #
353
+ # @note When making an API call, you may pass CollectionFilters
354
+ # data as a hash:
355
+ #
356
+ # {
357
+ # name: "CollectionName",
358
+ # status: "CREATING", # accepts CREATING, DELETING, ACTIVE, FAILED
359
+ # }
360
+ #
361
+ # @!attribute [rw] name
362
+ # The name of the collection.
363
+ # @return [String]
364
+ #
365
+ # @!attribute [rw] status
366
+ # The current status of the collection.
367
+ # @return [String]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CollectionFilters AWS API Documentation
370
+ #
371
+ class CollectionFilters < Struct.new(
372
+ :name,
373
+ :status)
374
+ SENSITIVE = []
375
+ include Aws::Structure
376
+ end
377
+
378
+ # Details about each OpenSearch Serverless collection.
379
+ #
380
+ # @!attribute [rw] arn
381
+ # The Amazon Resource Name (ARN) of the collection.
382
+ # @return [String]
383
+ #
384
+ # @!attribute [rw] id
385
+ # The unique identifier of the collection.
386
+ # @return [String]
387
+ #
388
+ # @!attribute [rw] name
389
+ # The name of the collection.
390
+ # @return [String]
391
+ #
392
+ # @!attribute [rw] status
393
+ # The current status of the collection.
394
+ # @return [String]
395
+ #
396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CollectionSummary AWS API Documentation
397
+ #
398
+ class CollectionSummary < Struct.new(
399
+ :arn,
400
+ :id,
401
+ :name,
402
+ :status)
403
+ SENSITIVE = []
404
+ include Aws::Structure
405
+ end
406
+
407
+ # When creating a collection, thrown when a collection with the same
408
+ # name already exists or is being created. When deleting a collection,
409
+ # thrown when the collection is not in the ACTIVE or FAILED state.
410
+ #
411
+ # @!attribute [rw] message
412
+ # @return [String]
413
+ #
414
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ConflictException AWS API Documentation
415
+ #
416
+ class ConflictException < Struct.new(
417
+ :message)
418
+ SENSITIVE = []
419
+ include Aws::Structure
420
+ end
421
+
422
+ # @note When making an API call, you may pass CreateAccessPolicyRequest
423
+ # data as a hash:
424
+ #
425
+ # {
426
+ # client_token: "ClientToken",
427
+ # description: "PolicyDescription",
428
+ # name: "PolicyName", # required
429
+ # policy: "PolicyDocument", # required
430
+ # type: "data", # required, accepts data
431
+ # }
432
+ #
433
+ # @!attribute [rw] client_token
434
+ # Unique, case-sensitive identifier to ensure idempotency of the
435
+ # request.
436
+ #
437
+ # **A suitable default value is auto-generated.** You should normally
438
+ # not need to pass this option.
439
+ # @return [String]
440
+ #
441
+ # @!attribute [rw] description
442
+ # A description of the policy. Typically used to store information
443
+ # about the permissions defined in the policy.
444
+ # @return [String]
445
+ #
446
+ # @!attribute [rw] name
447
+ # The name of the policy.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] policy
451
+ # The JSON policy document to use as the content for the policy.
452
+ # @return [String]
453
+ #
454
+ # @!attribute [rw] type
455
+ # The type of policy.
456
+ # @return [String]
457
+ #
458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateAccessPolicyRequest AWS API Documentation
459
+ #
460
+ class CreateAccessPolicyRequest < Struct.new(
461
+ :client_token,
462
+ :description,
463
+ :name,
464
+ :policy,
465
+ :type)
466
+ SENSITIVE = []
467
+ include Aws::Structure
468
+ end
469
+
470
+ # @!attribute [rw] access_policy_detail
471
+ # Details about the created access policy.
472
+ # @return [Types::AccessPolicyDetail]
473
+ #
474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateAccessPolicyResponse AWS API Documentation
475
+ #
476
+ class CreateAccessPolicyResponse < Struct.new(
477
+ :access_policy_detail)
478
+ SENSITIVE = []
479
+ include Aws::Structure
480
+ end
481
+
482
+ # Details about the created OpenSearch Serverless collection.
483
+ #
484
+ # @!attribute [rw] arn
485
+ # The Amazon Resource Name (ARN) of the collection.
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] created_date
489
+ # The Epoch time when the collection was created.
490
+ # @return [Integer]
491
+ #
492
+ # @!attribute [rw] description
493
+ # A description of the collection.
494
+ # @return [String]
495
+ #
496
+ # @!attribute [rw] id
497
+ # The unique identifier of the collection.
498
+ # @return [String]
499
+ #
500
+ # @!attribute [rw] kms_key_arn
501
+ # The Amazon Resource Name (ARN) of the KMS key with which to encrypt
502
+ # the collection.
503
+ # @return [String]
504
+ #
505
+ # @!attribute [rw] last_modified_date
506
+ # The date and time when the collection was last modified.
507
+ # @return [Integer]
508
+ #
509
+ # @!attribute [rw] name
510
+ # The name of the collection.
511
+ # @return [String]
512
+ #
513
+ # @!attribute [rw] status
514
+ # The current status of the collection.
515
+ # @return [String]
516
+ #
517
+ # @!attribute [rw] type
518
+ # The type of collection.
519
+ # @return [String]
520
+ #
521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollectionDetail AWS API Documentation
522
+ #
523
+ class CreateCollectionDetail < Struct.new(
524
+ :arn,
525
+ :created_date,
526
+ :description,
527
+ :id,
528
+ :kms_key_arn,
529
+ :last_modified_date,
530
+ :name,
531
+ :status,
532
+ :type)
533
+ SENSITIVE = []
534
+ include Aws::Structure
535
+ end
536
+
537
+ # @note When making an API call, you may pass CreateCollectionRequest
538
+ # data as a hash:
539
+ #
540
+ # {
541
+ # client_token: "ClientToken",
542
+ # description: "CreateCollectionRequestDescriptionString",
543
+ # name: "CollectionName", # required
544
+ # tags: [
545
+ # {
546
+ # key: "TagKey", # required
547
+ # value: "TagValue", # required
548
+ # },
549
+ # ],
550
+ # type: "SEARCH", # accepts SEARCH, TIMESERIES
551
+ # }
552
+ #
553
+ # @!attribute [rw] client_token
554
+ # Unique, case-sensitive identifier to ensure idempotency of the
555
+ # request.
556
+ #
557
+ # **A suitable default value is auto-generated.** You should normally
558
+ # not need to pass this option.
559
+ # @return [String]
560
+ #
561
+ # @!attribute [rw] description
562
+ # Description of the collection.
563
+ # @return [String]
564
+ #
565
+ # @!attribute [rw] name
566
+ # Name of the collection.
567
+ # @return [String]
568
+ #
569
+ # @!attribute [rw] tags
570
+ # An arbitrary set of tags (key–value pairs) to associate with the
571
+ # OpenSearch Serverless collection.
572
+ # @return [Array<Types::Tag>]
573
+ #
574
+ # @!attribute [rw] type
575
+ # The type of collection.
576
+ # @return [String]
577
+ #
578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollectionRequest AWS API Documentation
579
+ #
580
+ class CreateCollectionRequest < Struct.new(
581
+ :client_token,
582
+ :description,
583
+ :name,
584
+ :tags,
585
+ :type)
586
+ SENSITIVE = []
587
+ include Aws::Structure
588
+ end
589
+
590
+ # @!attribute [rw] create_collection_detail
591
+ # Details about the collection.
592
+ # @return [Types::CreateCollectionDetail]
593
+ #
594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollectionResponse AWS API Documentation
595
+ #
596
+ class CreateCollectionResponse < Struct.new(
597
+ :create_collection_detail)
598
+ SENSITIVE = []
599
+ include Aws::Structure
600
+ end
601
+
602
+ # @note When making an API call, you may pass CreateSecurityConfigRequest
603
+ # data as a hash:
604
+ #
605
+ # {
606
+ # client_token: "ClientToken",
607
+ # description: "ConfigDescription",
608
+ # name: "ConfigName", # required
609
+ # saml_options: {
610
+ # group_attribute: "samlGroupAttribute",
611
+ # metadata: "samlMetadata", # required
612
+ # session_timeout: 1,
613
+ # user_attribute: "samlUserAttribute",
614
+ # },
615
+ # type: "saml", # required, accepts saml
616
+ # }
617
+ #
618
+ # @!attribute [rw] client_token
619
+ # Unique, case-sensitive identifier to ensure idempotency of the
620
+ # request.
621
+ #
622
+ # **A suitable default value is auto-generated.** You should normally
623
+ # not need to pass this option.
624
+ # @return [String]
625
+ #
626
+ # @!attribute [rw] description
627
+ # A description of the security configuration.
628
+ # @return [String]
629
+ #
630
+ # @!attribute [rw] name
631
+ # The name of the security configuration.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] saml_options
635
+ # Describes SAML options in in the form of a key-value map.
636
+ # @return [Types::SamlConfigOptions]
637
+ #
638
+ # @!attribute [rw] type
639
+ # The type of security configuration.
640
+ # @return [String]
641
+ #
642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityConfigRequest AWS API Documentation
643
+ #
644
+ class CreateSecurityConfigRequest < Struct.new(
645
+ :client_token,
646
+ :description,
647
+ :name,
648
+ :saml_options,
649
+ :type)
650
+ SENSITIVE = []
651
+ include Aws::Structure
652
+ end
653
+
654
+ # @!attribute [rw] security_config_detail
655
+ # Details about the created security configuration.
656
+ # @return [Types::SecurityConfigDetail]
657
+ #
658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityConfigResponse AWS API Documentation
659
+ #
660
+ class CreateSecurityConfigResponse < Struct.new(
661
+ :security_config_detail)
662
+ SENSITIVE = []
663
+ include Aws::Structure
664
+ end
665
+
666
+ # @note When making an API call, you may pass CreateSecurityPolicyRequest
667
+ # data as a hash:
668
+ #
669
+ # {
670
+ # client_token: "ClientToken",
671
+ # description: "PolicyDescription",
672
+ # name: "PolicyName", # required
673
+ # policy: "PolicyDocument", # required
674
+ # type: "encryption", # required, accepts encryption, network
675
+ # }
676
+ #
677
+ # @!attribute [rw] client_token
678
+ # Unique, case-sensitive identifier to ensure idempotency of the
679
+ # request.
680
+ #
681
+ # **A suitable default value is auto-generated.** You should normally
682
+ # not need to pass this option.
683
+ # @return [String]
684
+ #
685
+ # @!attribute [rw] description
686
+ # A description of the policy. Typically used to store information
687
+ # about the permissions defined in the policy.
688
+ # @return [String]
689
+ #
690
+ # @!attribute [rw] name
691
+ # The name of the policy.
692
+ # @return [String]
693
+ #
694
+ # @!attribute [rw] policy
695
+ # The JSON policy document to use as the content for the new policy.
696
+ # @return [String]
697
+ #
698
+ # @!attribute [rw] type
699
+ # The type of security policy.
700
+ # @return [String]
701
+ #
702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityPolicyRequest AWS API Documentation
703
+ #
704
+ class CreateSecurityPolicyRequest < Struct.new(
705
+ :client_token,
706
+ :description,
707
+ :name,
708
+ :policy,
709
+ :type)
710
+ SENSITIVE = []
711
+ include Aws::Structure
712
+ end
713
+
714
+ # @!attribute [rw] security_policy_detail
715
+ # Details about the created security policy.
716
+ # @return [Types::SecurityPolicyDetail]
717
+ #
718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityPolicyResponse AWS API Documentation
719
+ #
720
+ class CreateSecurityPolicyResponse < Struct.new(
721
+ :security_policy_detail)
722
+ SENSITIVE = []
723
+ include Aws::Structure
724
+ end
725
+
726
+ # Creation details for an OpenSearch Serverless-managed interface
727
+ # endpoint. For more information, see [Access Amazon OpenSearch
728
+ # Serverless using an interface endpoint][1].
729
+ #
730
+ #
731
+ #
732
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html
733
+ #
734
+ # @!attribute [rw] id
735
+ # The unique identifier of the endpoint.
736
+ # @return [String]
737
+ #
738
+ # @!attribute [rw] name
739
+ # The name of the endpoint.
740
+ # @return [String]
741
+ #
742
+ # @!attribute [rw] status
743
+ # The current status in the endpoint creation process.
744
+ # @return [String]
745
+ #
746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateVpcEndpointDetail AWS API Documentation
747
+ #
748
+ class CreateVpcEndpointDetail < Struct.new(
749
+ :id,
750
+ :name,
751
+ :status)
752
+ SENSITIVE = []
753
+ include Aws::Structure
754
+ end
755
+
756
+ # @note When making an API call, you may pass CreateVpcEndpointRequest
757
+ # data as a hash:
758
+ #
759
+ # {
760
+ # client_token: "ClientToken",
761
+ # name: "VpcEndpointName", # required
762
+ # security_group_ids: ["SecurityGroupId"],
763
+ # subnet_ids: ["SubnetId"], # required
764
+ # vpc_id: "VpcId", # required
765
+ # }
766
+ #
767
+ # @!attribute [rw] client_token
768
+ # Unique, case-sensitive identifier to ensure idempotency of the
769
+ # request.
770
+ #
771
+ # **A suitable default value is auto-generated.** You should normally
772
+ # not need to pass this option.
773
+ # @return [String]
774
+ #
775
+ # @!attribute [rw] name
776
+ # The name of the interface endpoint.
777
+ # @return [String]
778
+ #
779
+ # @!attribute [rw] security_group_ids
780
+ # The unique identifiers of the security groups that define the ports,
781
+ # protocols, and sources for inbound traffic that you are authorizing
782
+ # into your endpoint.
783
+ # @return [Array<String>]
784
+ #
785
+ # @!attribute [rw] subnet_ids
786
+ # The ID of one or more subnets from which you'll access OpenSearch
787
+ # Serverless.
788
+ # @return [Array<String>]
789
+ #
790
+ # @!attribute [rw] vpc_id
791
+ # The ID of the VPC from which you'll access OpenSearch Serverless.
792
+ # @return [String]
793
+ #
794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateVpcEndpointRequest AWS API Documentation
795
+ #
796
+ class CreateVpcEndpointRequest < Struct.new(
797
+ :client_token,
798
+ :name,
799
+ :security_group_ids,
800
+ :subnet_ids,
801
+ :vpc_id)
802
+ SENSITIVE = []
803
+ include Aws::Structure
804
+ end
805
+
806
+ # @!attribute [rw] create_vpc_endpoint_detail
807
+ # Details about the created interface VPC endpoint.
808
+ # @return [Types::CreateVpcEndpointDetail]
809
+ #
810
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateVpcEndpointResponse AWS API Documentation
811
+ #
812
+ class CreateVpcEndpointResponse < Struct.new(
813
+ :create_vpc_endpoint_detail)
814
+ SENSITIVE = []
815
+ include Aws::Structure
816
+ end
817
+
818
+ # @note When making an API call, you may pass DeleteAccessPolicyRequest
819
+ # data as a hash:
820
+ #
821
+ # {
822
+ # client_token: "ClientToken",
823
+ # name: "PolicyName", # required
824
+ # type: "data", # required, accepts data
825
+ # }
826
+ #
827
+ # @!attribute [rw] client_token
828
+ # Unique, case-sensitive identifier to ensure idempotency of the
829
+ # request.
830
+ #
831
+ # **A suitable default value is auto-generated.** You should normally
832
+ # not need to pass this option.
833
+ # @return [String]
834
+ #
835
+ # @!attribute [rw] name
836
+ # The name of the policy to delete.
837
+ # @return [String]
838
+ #
839
+ # @!attribute [rw] type
840
+ # The type of policy.
841
+ # @return [String]
842
+ #
843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteAccessPolicyRequest AWS API Documentation
844
+ #
845
+ class DeleteAccessPolicyRequest < Struct.new(
846
+ :client_token,
847
+ :name,
848
+ :type)
849
+ SENSITIVE = []
850
+ include Aws::Structure
851
+ end
852
+
853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteAccessPolicyResponse AWS API Documentation
854
+ #
855
+ class DeleteAccessPolicyResponse < Aws::EmptyStructure; end
856
+
857
+ # Details about a deleted OpenSearch Serverless collection.
858
+ #
859
+ # @!attribute [rw] id
860
+ # The unique identifier of the collection.
861
+ # @return [String]
862
+ #
863
+ # @!attribute [rw] name
864
+ # The name of the collection.
865
+ # @return [String]
866
+ #
867
+ # @!attribute [rw] status
868
+ # The current status of the collection.
869
+ # @return [String]
870
+ #
871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteCollectionDetail AWS API Documentation
872
+ #
873
+ class DeleteCollectionDetail < Struct.new(
874
+ :id,
875
+ :name,
876
+ :status)
877
+ SENSITIVE = []
878
+ include Aws::Structure
879
+ end
880
+
881
+ # @note When making an API call, you may pass DeleteCollectionRequest
882
+ # data as a hash:
883
+ #
884
+ # {
885
+ # client_token: "ClientToken",
886
+ # id: "CollectionId", # required
887
+ # }
888
+ #
889
+ # @!attribute [rw] client_token
890
+ # A unique, case-sensitive identifier to ensure idempotency of the
891
+ # request.
892
+ #
893
+ # **A suitable default value is auto-generated.** You should normally
894
+ # not need to pass this option.
895
+ # @return [String]
896
+ #
897
+ # @!attribute [rw] id
898
+ # The unique identifier of the collection. For example,
899
+ # `1iu5usc406kd`. The ID is part of the collection endpoint. You can
900
+ # also retrieve it using the [ListCollections][1] API.
901
+ #
902
+ #
903
+ #
904
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html
905
+ # @return [String]
906
+ #
907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteCollectionRequest AWS API Documentation
908
+ #
909
+ class DeleteCollectionRequest < Struct.new(
910
+ :client_token,
911
+ :id)
912
+ SENSITIVE = []
913
+ include Aws::Structure
914
+ end
915
+
916
+ # @!attribute [rw] delete_collection_detail
917
+ # Details of the deleted collection.
918
+ # @return [Types::DeleteCollectionDetail]
919
+ #
920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteCollectionResponse AWS API Documentation
921
+ #
922
+ class DeleteCollectionResponse < Struct.new(
923
+ :delete_collection_detail)
924
+ SENSITIVE = []
925
+ include Aws::Structure
926
+ end
927
+
928
+ # @note When making an API call, you may pass DeleteSecurityConfigRequest
929
+ # data as a hash:
930
+ #
931
+ # {
932
+ # client_token: "ClientToken",
933
+ # id: "SecurityConfigId", # required
934
+ # }
935
+ #
936
+ # @!attribute [rw] client_token
937
+ # Unique, case-sensitive identifier to ensure idempotency of the
938
+ # request.
939
+ #
940
+ # **A suitable default value is auto-generated.** You should normally
941
+ # not need to pass this option.
942
+ # @return [String]
943
+ #
944
+ # @!attribute [rw] id
945
+ # The security configuration identifier. For SAML the ID will be
946
+ # `saml/<accountId>/<idpProviderName>`. For example,
947
+ # `saml/123456789123/OKTADev`.
948
+ # @return [String]
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityConfigRequest AWS API Documentation
951
+ #
952
+ class DeleteSecurityConfigRequest < Struct.new(
953
+ :client_token,
954
+ :id)
955
+ SENSITIVE = []
956
+ include Aws::Structure
957
+ end
958
+
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityConfigResponse AWS API Documentation
960
+ #
961
+ class DeleteSecurityConfigResponse < Aws::EmptyStructure; end
962
+
963
+ # @note When making an API call, you may pass DeleteSecurityPolicyRequest
964
+ # data as a hash:
965
+ #
966
+ # {
967
+ # client_token: "ClientToken",
968
+ # name: "PolicyName", # required
969
+ # type: "encryption", # required, accepts encryption, network
970
+ # }
971
+ #
972
+ # @!attribute [rw] client_token
973
+ # Unique, case-sensitive identifier to ensure idempotency of the
974
+ # request.
975
+ #
976
+ # **A suitable default value is auto-generated.** You should normally
977
+ # not need to pass this option.
978
+ # @return [String]
979
+ #
980
+ # @!attribute [rw] name
981
+ # The name of the policy to delete.
982
+ # @return [String]
983
+ #
984
+ # @!attribute [rw] type
985
+ # The type of policy.
986
+ # @return [String]
987
+ #
988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityPolicyRequest AWS API Documentation
989
+ #
990
+ class DeleteSecurityPolicyRequest < Struct.new(
991
+ :client_token,
992
+ :name,
993
+ :type)
994
+ SENSITIVE = []
995
+ include Aws::Structure
996
+ end
997
+
998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityPolicyResponse AWS API Documentation
999
+ #
1000
+ class DeleteSecurityPolicyResponse < Aws::EmptyStructure; end
1001
+
1002
+ # Deletion details for an OpenSearch Serverless-managed interface
1003
+ # endpoint.
1004
+ #
1005
+ # @!attribute [rw] id
1006
+ # The unique identifier of the endpoint.
1007
+ # @return [String]
1008
+ #
1009
+ # @!attribute [rw] name
1010
+ # The name of the endpoint.
1011
+ # @return [String]
1012
+ #
1013
+ # @!attribute [rw] status
1014
+ # The current status of the endpoint deletion process.
1015
+ # @return [String]
1016
+ #
1017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteVpcEndpointDetail AWS API Documentation
1018
+ #
1019
+ class DeleteVpcEndpointDetail < Struct.new(
1020
+ :id,
1021
+ :name,
1022
+ :status)
1023
+ SENSITIVE = []
1024
+ include Aws::Structure
1025
+ end
1026
+
1027
+ # @note When making an API call, you may pass DeleteVpcEndpointRequest
1028
+ # data as a hash:
1029
+ #
1030
+ # {
1031
+ # client_token: "ClientToken",
1032
+ # id: "VpcEndpointId", # required
1033
+ # }
1034
+ #
1035
+ # @!attribute [rw] client_token
1036
+ # Unique, case-sensitive identifier to ensure idempotency of the
1037
+ # request.
1038
+ #
1039
+ # **A suitable default value is auto-generated.** You should normally
1040
+ # not need to pass this option.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] id
1044
+ # The VPC endpoint identifier.
1045
+ # @return [String]
1046
+ #
1047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteVpcEndpointRequest AWS API Documentation
1048
+ #
1049
+ class DeleteVpcEndpointRequest < Struct.new(
1050
+ :client_token,
1051
+ :id)
1052
+ SENSITIVE = []
1053
+ include Aws::Structure
1054
+ end
1055
+
1056
+ # @!attribute [rw] delete_vpc_endpoint_detail
1057
+ # Details about the deleted endpoint.
1058
+ # @return [Types::DeleteVpcEndpointDetail]
1059
+ #
1060
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteVpcEndpointResponse AWS API Documentation
1061
+ #
1062
+ class DeleteVpcEndpointResponse < Struct.new(
1063
+ :delete_vpc_endpoint_detail)
1064
+ SENSITIVE = []
1065
+ include Aws::Structure
1066
+ end
1067
+
1068
+ # @note When making an API call, you may pass GetAccessPolicyRequest
1069
+ # data as a hash:
1070
+ #
1071
+ # {
1072
+ # name: "PolicyName", # required
1073
+ # type: "data", # required, accepts data
1074
+ # }
1075
+ #
1076
+ # @!attribute [rw] name
1077
+ # The name of the access policy.
1078
+ # @return [String]
1079
+ #
1080
+ # @!attribute [rw] type
1081
+ # Tye type of policy. Currently the only supported value is `data`.
1082
+ # @return [String]
1083
+ #
1084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccessPolicyRequest AWS API Documentation
1085
+ #
1086
+ class GetAccessPolicyRequest < Struct.new(
1087
+ :name,
1088
+ :type)
1089
+ SENSITIVE = []
1090
+ include Aws::Structure
1091
+ end
1092
+
1093
+ # @!attribute [rw] access_policy_detail
1094
+ # Details about the requested access policy.
1095
+ # @return [Types::AccessPolicyDetail]
1096
+ #
1097
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccessPolicyResponse AWS API Documentation
1098
+ #
1099
+ class GetAccessPolicyResponse < Struct.new(
1100
+ :access_policy_detail)
1101
+ SENSITIVE = []
1102
+ include Aws::Structure
1103
+ end
1104
+
1105
+ # @api private
1106
+ #
1107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccountSettingsRequest AWS API Documentation
1108
+ #
1109
+ class GetAccountSettingsRequest < Aws::EmptyStructure; end
1110
+
1111
+ # @!attribute [rw] account_settings_detail
1112
+ # OpenSearch Serverless-related details for the current account.
1113
+ # @return [Types::AccountSettingsDetail]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccountSettingsResponse AWS API Documentation
1116
+ #
1117
+ class GetAccountSettingsResponse < Struct.new(
1118
+ :account_settings_detail)
1119
+ SENSITIVE = []
1120
+ include Aws::Structure
1121
+ end
1122
+
1123
+ # @api private
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetPoliciesStatsRequest AWS API Documentation
1126
+ #
1127
+ class GetPoliciesStatsRequest < Aws::EmptyStructure; end
1128
+
1129
+ # @!attribute [rw] access_policy_stats
1130
+ # Information about the data access policies in your account.
1131
+ # @return [Types::AccessPolicyStats]
1132
+ #
1133
+ # @!attribute [rw] security_config_stats
1134
+ # Information about the security configurations in your account.
1135
+ # @return [Types::SecurityConfigStats]
1136
+ #
1137
+ # @!attribute [rw] security_policy_stats
1138
+ # Information about the security policies in your account.
1139
+ # @return [Types::SecurityPolicyStats]
1140
+ #
1141
+ # @!attribute [rw] total_policy_count
1142
+ # The total number of OpenSearch Serverless security policies and
1143
+ # configurations in your account.
1144
+ # @return [Integer]
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetPoliciesStatsResponse AWS API Documentation
1147
+ #
1148
+ class GetPoliciesStatsResponse < Struct.new(
1149
+ :access_policy_stats,
1150
+ :security_config_stats,
1151
+ :security_policy_stats,
1152
+ :total_policy_count)
1153
+ SENSITIVE = []
1154
+ include Aws::Structure
1155
+ end
1156
+
1157
+ # @note When making an API call, you may pass GetSecurityConfigRequest
1158
+ # data as a hash:
1159
+ #
1160
+ # {
1161
+ # id: "SecurityConfigId", # required
1162
+ # }
1163
+ #
1164
+ # @!attribute [rw] id
1165
+ # The unique identifier of the security configuration.
1166
+ # @return [String]
1167
+ #
1168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityConfigRequest AWS API Documentation
1169
+ #
1170
+ class GetSecurityConfigRequest < Struct.new(
1171
+ :id)
1172
+ SENSITIVE = []
1173
+ include Aws::Structure
1174
+ end
1175
+
1176
+ # @!attribute [rw] security_config_detail
1177
+ # Details of the requested security configuration.
1178
+ # @return [Types::SecurityConfigDetail]
1179
+ #
1180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityConfigResponse AWS API Documentation
1181
+ #
1182
+ class GetSecurityConfigResponse < Struct.new(
1183
+ :security_config_detail)
1184
+ SENSITIVE = []
1185
+ include Aws::Structure
1186
+ end
1187
+
1188
+ # @note When making an API call, you may pass GetSecurityPolicyRequest
1189
+ # data as a hash:
1190
+ #
1191
+ # {
1192
+ # name: "PolicyName", # required
1193
+ # type: "encryption", # required, accepts encryption, network
1194
+ # }
1195
+ #
1196
+ # @!attribute [rw] name
1197
+ # The name of the security policy.
1198
+ # @return [String]
1199
+ #
1200
+ # @!attribute [rw] type
1201
+ # The type of security policy.
1202
+ # @return [String]
1203
+ #
1204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityPolicyRequest AWS API Documentation
1205
+ #
1206
+ class GetSecurityPolicyRequest < Struct.new(
1207
+ :name,
1208
+ :type)
1209
+ SENSITIVE = []
1210
+ include Aws::Structure
1211
+ end
1212
+
1213
+ # @!attribute [rw] security_policy_detail
1214
+ # Details about the requested security policy.
1215
+ # @return [Types::SecurityPolicyDetail]
1216
+ #
1217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityPolicyResponse AWS API Documentation
1218
+ #
1219
+ class GetSecurityPolicyResponse < Struct.new(
1220
+ :security_policy_detail)
1221
+ SENSITIVE = []
1222
+ include Aws::Structure
1223
+ end
1224
+
1225
+ # Thrown when an error internal to the service occurs while processing a
1226
+ # request.
1227
+ #
1228
+ # @!attribute [rw] message
1229
+ # @return [String]
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/InternalServerException AWS API Documentation
1232
+ #
1233
+ class InternalServerException < Struct.new(
1234
+ :message)
1235
+ SENSITIVE = []
1236
+ include Aws::Structure
1237
+ end
1238
+
1239
+ # @note When making an API call, you may pass ListAccessPoliciesRequest
1240
+ # data as a hash:
1241
+ #
1242
+ # {
1243
+ # max_results: 1,
1244
+ # next_token: "String",
1245
+ # resource: ["Resource"],
1246
+ # type: "data", # required, accepts data
1247
+ # }
1248
+ #
1249
+ # @!attribute [rw] max_results
1250
+ # An optional parameter that specifies the maximum number of results
1251
+ # to return. You can use `nextToken` to get the next page of results.
1252
+ # The default is 20.
1253
+ # @return [Integer]
1254
+ #
1255
+ # @!attribute [rw] next_token
1256
+ # If your initial `ListAccessPolicies` operation returns a
1257
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1258
+ # `ListAccessPolicies` operations, which returns results in the next
1259
+ # page.
1260
+ # @return [String]
1261
+ #
1262
+ # @!attribute [rw] resource
1263
+ # Resource filters (can be collection or indexes) that policies can
1264
+ # apply to.
1265
+ # @return [Array<String>]
1266
+ #
1267
+ # @!attribute [rw] type
1268
+ # The type of access policy.
1269
+ # @return [String]
1270
+ #
1271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListAccessPoliciesRequest AWS API Documentation
1272
+ #
1273
+ class ListAccessPoliciesRequest < Struct.new(
1274
+ :max_results,
1275
+ :next_token,
1276
+ :resource,
1277
+ :type)
1278
+ SENSITIVE = []
1279
+ include Aws::Structure
1280
+ end
1281
+
1282
+ # @!attribute [rw] access_policy_summaries
1283
+ # Details about the requested access policies.
1284
+ # @return [Array<Types::AccessPolicySummary>]
1285
+ #
1286
+ # @!attribute [rw] next_token
1287
+ # When `nextToken` is returned, there are more results available. The
1288
+ # value of `nextToken` is a unique pagination token for each page.
1289
+ # Make the call again using the returned token to retrieve the next
1290
+ # page.
1291
+ # @return [String]
1292
+ #
1293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListAccessPoliciesResponse AWS API Documentation
1294
+ #
1295
+ class ListAccessPoliciesResponse < Struct.new(
1296
+ :access_policy_summaries,
1297
+ :next_token)
1298
+ SENSITIVE = []
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # @note When making an API call, you may pass ListCollectionsRequest
1303
+ # data as a hash:
1304
+ #
1305
+ # {
1306
+ # collection_filters: {
1307
+ # name: "CollectionName",
1308
+ # status: "CREATING", # accepts CREATING, DELETING, ACTIVE, FAILED
1309
+ # },
1310
+ # max_results: 1,
1311
+ # next_token: "String",
1312
+ # }
1313
+ #
1314
+ # @!attribute [rw] collection_filters
1315
+ # List of filter names and values that you can use for requests.
1316
+ # @return [Types::CollectionFilters]
1317
+ #
1318
+ # @!attribute [rw] max_results
1319
+ # The maximum number of results to return. Default is 20. You can use
1320
+ # `nextToken` to get the next page of results.
1321
+ # @return [Integer]
1322
+ #
1323
+ # @!attribute [rw] next_token
1324
+ # If your initial `ListCollections` operation returns a `nextToken`,
1325
+ # you can include the returned `nextToken` in subsequent
1326
+ # `ListCollections` operations, which returns results in the next
1327
+ # page.
1328
+ # @return [String]
1329
+ #
1330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollectionsRequest AWS API Documentation
1331
+ #
1332
+ class ListCollectionsRequest < Struct.new(
1333
+ :collection_filters,
1334
+ :max_results,
1335
+ :next_token)
1336
+ SENSITIVE = []
1337
+ include Aws::Structure
1338
+ end
1339
+
1340
+ # @!attribute [rw] collection_summaries
1341
+ # Details about each collection.
1342
+ # @return [Array<Types::CollectionSummary>]
1343
+ #
1344
+ # @!attribute [rw] next_token
1345
+ # When `nextToken` is returned, there are more results available. The
1346
+ # value of `nextToken` is a unique pagination token for each page.
1347
+ # Make the call again using the returned token to retrieve the next
1348
+ # page.
1349
+ # @return [String]
1350
+ #
1351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollectionsResponse AWS API Documentation
1352
+ #
1353
+ class ListCollectionsResponse < Struct.new(
1354
+ :collection_summaries,
1355
+ :next_token)
1356
+ SENSITIVE = []
1357
+ include Aws::Structure
1358
+ end
1359
+
1360
+ # @note When making an API call, you may pass ListSecurityConfigsRequest
1361
+ # data as a hash:
1362
+ #
1363
+ # {
1364
+ # max_results: 1,
1365
+ # next_token: "String",
1366
+ # type: "saml", # required, accepts saml
1367
+ # }
1368
+ #
1369
+ # @!attribute [rw] max_results
1370
+ # An optional parameter that specifies the maximum number of results
1371
+ # to return. You can use `nextToken` to get the next page of results.
1372
+ # The default is 20.
1373
+ # @return [Integer]
1374
+ #
1375
+ # @!attribute [rw] next_token
1376
+ # If your initial `ListSecurityConfigs` operation returns a
1377
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1378
+ # `ListSecurityConfigs` operations, which returns results in the next
1379
+ # page.
1380
+ # @return [String]
1381
+ #
1382
+ # @!attribute [rw] type
1383
+ # The type of security configuration.
1384
+ # @return [String]
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityConfigsRequest AWS API Documentation
1387
+ #
1388
+ class ListSecurityConfigsRequest < Struct.new(
1389
+ :max_results,
1390
+ :next_token,
1391
+ :type)
1392
+ SENSITIVE = []
1393
+ include Aws::Structure
1394
+ end
1395
+
1396
+ # @!attribute [rw] next_token
1397
+ # When `nextToken` is returned, there are more results available. The
1398
+ # value of `nextToken` is a unique pagination token for each page.
1399
+ # Make the call again using the returned token to retrieve the next
1400
+ # page.
1401
+ # @return [String]
1402
+ #
1403
+ # @!attribute [rw] security_config_summaries
1404
+ # Details about the security configurations in your account.
1405
+ # @return [Array<Types::SecurityConfigSummary>]
1406
+ #
1407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityConfigsResponse AWS API Documentation
1408
+ #
1409
+ class ListSecurityConfigsResponse < Struct.new(
1410
+ :next_token,
1411
+ :security_config_summaries)
1412
+ SENSITIVE = []
1413
+ include Aws::Structure
1414
+ end
1415
+
1416
+ # @note When making an API call, you may pass ListSecurityPoliciesRequest
1417
+ # data as a hash:
1418
+ #
1419
+ # {
1420
+ # max_results: 1,
1421
+ # next_token: "String",
1422
+ # resource: ["Resource"],
1423
+ # type: "encryption", # required, accepts encryption, network
1424
+ # }
1425
+ #
1426
+ # @!attribute [rw] max_results
1427
+ # An optional parameter that specifies the maximum number of results
1428
+ # to return. You can use `nextToken` to get the next page of results.
1429
+ # The default is 20.
1430
+ # @return [Integer]
1431
+ #
1432
+ # @!attribute [rw] next_token
1433
+ # If your initial `ListSecurityPolicies` operation returns a
1434
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1435
+ # `ListSecurityPolicies` operations, which returns results in the next
1436
+ # page.
1437
+ # @return [String]
1438
+ #
1439
+ # @!attribute [rw] resource
1440
+ # Resource filters (can be collection or indexes) that policies can
1441
+ # apply to.
1442
+ # @return [Array<String>]
1443
+ #
1444
+ # @!attribute [rw] type
1445
+ # The type of policy.
1446
+ # @return [String]
1447
+ #
1448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityPoliciesRequest AWS API Documentation
1449
+ #
1450
+ class ListSecurityPoliciesRequest < Struct.new(
1451
+ :max_results,
1452
+ :next_token,
1453
+ :resource,
1454
+ :type)
1455
+ SENSITIVE = []
1456
+ include Aws::Structure
1457
+ end
1458
+
1459
+ # @!attribute [rw] next_token
1460
+ # When `nextToken` is returned, there are more results available. The
1461
+ # value of `nextToken` is a unique pagination token for each page.
1462
+ # Make the call again using the returned token to retrieve the next
1463
+ # page.
1464
+ # @return [String]
1465
+ #
1466
+ # @!attribute [rw] security_policy_summaries
1467
+ # Details about the security policies in your account.
1468
+ # @return [Array<Types::SecurityPolicySummary>]
1469
+ #
1470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityPoliciesResponse AWS API Documentation
1471
+ #
1472
+ class ListSecurityPoliciesResponse < Struct.new(
1473
+ :next_token,
1474
+ :security_policy_summaries)
1475
+ SENSITIVE = []
1476
+ include Aws::Structure
1477
+ end
1478
+
1479
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1480
+ # data as a hash:
1481
+ #
1482
+ # {
1483
+ # resource_arn: "Arn", # required
1484
+ # }
1485
+ #
1486
+ # @!attribute [rw] resource_arn
1487
+ # The Amazon Resource Name (ARN) of the resource. The resource must be
1488
+ # active (not in the `DELETING` state), and must be owned by the
1489
+ # account ID included in the request.
1490
+ # @return [String]
1491
+ #
1492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListTagsForResourceRequest AWS API Documentation
1493
+ #
1494
+ class ListTagsForResourceRequest < Struct.new(
1495
+ :resource_arn)
1496
+ SENSITIVE = []
1497
+ include Aws::Structure
1498
+ end
1499
+
1500
+ # @!attribute [rw] tags
1501
+ # The tags associated with the resource.
1502
+ # @return [Array<Types::Tag>]
1503
+ #
1504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListTagsForResourceResponse AWS API Documentation
1505
+ #
1506
+ class ListTagsForResourceResponse < Struct.new(
1507
+ :tags)
1508
+ SENSITIVE = []
1509
+ include Aws::Structure
1510
+ end
1511
+
1512
+ # @note When making an API call, you may pass ListVpcEndpointsRequest
1513
+ # data as a hash:
1514
+ #
1515
+ # {
1516
+ # max_results: 1,
1517
+ # next_token: "String",
1518
+ # vpc_endpoint_filters: {
1519
+ # status: "PENDING", # accepts PENDING, DELETING, ACTIVE, FAILED
1520
+ # },
1521
+ # }
1522
+ #
1523
+ # @!attribute [rw] max_results
1524
+ # An optional parameter that specifies the maximum number of results
1525
+ # to return. You can use `nextToken` to get the next page of results.
1526
+ # The default is 20.
1527
+ # @return [Integer]
1528
+ #
1529
+ # @!attribute [rw] next_token
1530
+ # If your initial `ListVpcEndpoints` operation returns a `nextToken`,
1531
+ # you can include the returned `nextToken` in subsequent
1532
+ # `ListVpcEndpoints` operations, which returns results in the next
1533
+ # page.
1534
+ # @return [String]
1535
+ #
1536
+ # @!attribute [rw] vpc_endpoint_filters
1537
+ # Filter the results according to the current status of the VPC
1538
+ # endpoint. Possible statuses are `CREATING`, `DELETING`, `UPDATING`,
1539
+ # `ACTIVE`, and `FAILED`.
1540
+ # @return [Types::VpcEndpointFilters]
1541
+ #
1542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListVpcEndpointsRequest AWS API Documentation
1543
+ #
1544
+ class ListVpcEndpointsRequest < Struct.new(
1545
+ :max_results,
1546
+ :next_token,
1547
+ :vpc_endpoint_filters)
1548
+ SENSITIVE = []
1549
+ include Aws::Structure
1550
+ end
1551
+
1552
+ # @!attribute [rw] next_token
1553
+ # When `nextToken` is returned, there are more results available. The
1554
+ # value of `nextToken` is a unique pagination token for each page.
1555
+ # Make the call again using the returned token to retrieve the next
1556
+ # page.
1557
+ # @return [String]
1558
+ #
1559
+ # @!attribute [rw] vpc_endpoint_summaries
1560
+ # Details about each VPC endpoint, including the name and current
1561
+ # status.
1562
+ # @return [Array<Types::VpcEndpointSummary>]
1563
+ #
1564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListVpcEndpointsResponse AWS API Documentation
1565
+ #
1566
+ class ListVpcEndpointsResponse < Struct.new(
1567
+ :next_token,
1568
+ :vpc_endpoint_summaries)
1569
+ SENSITIVE = []
1570
+ include Aws::Structure
1571
+ end
1572
+
1573
+ # Thrown when accessing or deleting a resource that does not exist.
1574
+ #
1575
+ # @!attribute [rw] message
1576
+ # @return [String]
1577
+ #
1578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ResourceNotFoundException AWS API Documentation
1579
+ #
1580
+ class ResourceNotFoundException < Struct.new(
1581
+ :message)
1582
+ SENSITIVE = []
1583
+ include Aws::Structure
1584
+ end
1585
+
1586
+ # Describes SAML options for an OpenSearch Serverless security
1587
+ # configuration in the form of a key-value map.
1588
+ #
1589
+ # @note When making an API call, you may pass SamlConfigOptions
1590
+ # data as a hash:
1591
+ #
1592
+ # {
1593
+ # group_attribute: "samlGroupAttribute",
1594
+ # metadata: "samlMetadata", # required
1595
+ # session_timeout: 1,
1596
+ # user_attribute: "samlUserAttribute",
1597
+ # }
1598
+ #
1599
+ # @!attribute [rw] group_attribute
1600
+ # The group attribute for this SAML integration.
1601
+ # @return [String]
1602
+ #
1603
+ # @!attribute [rw] metadata
1604
+ # The XML IdP metadata file generated from your identity provider.
1605
+ # @return [String]
1606
+ #
1607
+ # @!attribute [rw] session_timeout
1608
+ # The session timeout, in minutes. Minimum is 15 minutes and maximum
1609
+ # is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
1610
+ # @return [Integer]
1611
+ #
1612
+ # @!attribute [rw] user_attribute
1613
+ # A user attribute for this SAML integration.
1614
+ # @return [String]
1615
+ #
1616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SamlConfigOptions AWS API Documentation
1617
+ #
1618
+ class SamlConfigOptions < Struct.new(
1619
+ :group_attribute,
1620
+ :metadata,
1621
+ :session_timeout,
1622
+ :user_attribute)
1623
+ SENSITIVE = []
1624
+ include Aws::Structure
1625
+ end
1626
+
1627
+ # Details about a security configuration for OpenSearch Serverless.
1628
+ #
1629
+ # @!attribute [rw] config_version
1630
+ # The version of the security configuration.
1631
+ # @return [String]
1632
+ #
1633
+ # @!attribute [rw] created_date
1634
+ # The date the configuration was created.
1635
+ # @return [Integer]
1636
+ #
1637
+ # @!attribute [rw] description
1638
+ # The description of the security configuration.
1639
+ # @return [String]
1640
+ #
1641
+ # @!attribute [rw] id
1642
+ # The unique identifier of the security configuration.
1643
+ # @return [String]
1644
+ #
1645
+ # @!attribute [rw] last_modified_date
1646
+ # The timestamp of when the configuration was last modified.
1647
+ # @return [Integer]
1648
+ #
1649
+ # @!attribute [rw] saml_options
1650
+ # SAML options for the security configuration in the form of a
1651
+ # key-value map.
1652
+ # @return [Types::SamlConfigOptions]
1653
+ #
1654
+ # @!attribute [rw] type
1655
+ # The type of security configuration.
1656
+ # @return [String]
1657
+ #
1658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityConfigDetail AWS API Documentation
1659
+ #
1660
+ class SecurityConfigDetail < Struct.new(
1661
+ :config_version,
1662
+ :created_date,
1663
+ :description,
1664
+ :id,
1665
+ :last_modified_date,
1666
+ :saml_options,
1667
+ :type)
1668
+ SENSITIVE = []
1669
+ include Aws::Structure
1670
+ end
1671
+
1672
+ # Statistics for an OpenSearch Serverless security configuration.
1673
+ #
1674
+ # @!attribute [rw] saml_config_count
1675
+ # The number of security configurations in the current account.
1676
+ # @return [Integer]
1677
+ #
1678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityConfigStats AWS API Documentation
1679
+ #
1680
+ class SecurityConfigStats < Struct.new(
1681
+ :saml_config_count)
1682
+ SENSITIVE = []
1683
+ include Aws::Structure
1684
+ end
1685
+
1686
+ # A summary of a security configuration for OpenSearch Serverless.
1687
+ #
1688
+ # @!attribute [rw] config_version
1689
+ # The version of the security configuration.
1690
+ # @return [String]
1691
+ #
1692
+ # @!attribute [rw] created_date
1693
+ # The Epoch time when the security configuration was created.
1694
+ # @return [Integer]
1695
+ #
1696
+ # @!attribute [rw] description
1697
+ # The description of the security configuration.
1698
+ # @return [String]
1699
+ #
1700
+ # @!attribute [rw] id
1701
+ # The unique identifier of the security configuration.
1702
+ # @return [String]
1703
+ #
1704
+ # @!attribute [rw] last_modified_date
1705
+ # The timestamp of when the configuration was last modified.
1706
+ # @return [Integer]
1707
+ #
1708
+ # @!attribute [rw] type
1709
+ # The type of security configuration.
1710
+ # @return [String]
1711
+ #
1712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityConfigSummary AWS API Documentation
1713
+ #
1714
+ class SecurityConfigSummary < Struct.new(
1715
+ :config_version,
1716
+ :created_date,
1717
+ :description,
1718
+ :id,
1719
+ :last_modified_date,
1720
+ :type)
1721
+ SENSITIVE = []
1722
+ include Aws::Structure
1723
+ end
1724
+
1725
+ # Details about an OpenSearch Serverless security policy.
1726
+ #
1727
+ # @!attribute [rw] created_date
1728
+ # The date the policy was created.
1729
+ # @return [Integer]
1730
+ #
1731
+ # @!attribute [rw] description
1732
+ # The description of the security policy.
1733
+ # @return [String]
1734
+ #
1735
+ # @!attribute [rw] last_modified_date
1736
+ # The timestamp of when the policy was last modified.
1737
+ # @return [Integer]
1738
+ #
1739
+ # @!attribute [rw] name
1740
+ # The name of the policy.
1741
+ # @return [String]
1742
+ #
1743
+ # @!attribute [rw] policy
1744
+ # The JSON policy document without any whitespaces.
1745
+ # @return [Hash,Array,String,Numeric,Boolean]
1746
+ #
1747
+ # @!attribute [rw] policy_version
1748
+ # The version of the policy.
1749
+ # @return [String]
1750
+ #
1751
+ # @!attribute [rw] type
1752
+ # The type of security policy.
1753
+ # @return [String]
1754
+ #
1755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityPolicyDetail AWS API Documentation
1756
+ #
1757
+ class SecurityPolicyDetail < Struct.new(
1758
+ :created_date,
1759
+ :description,
1760
+ :last_modified_date,
1761
+ :name,
1762
+ :policy,
1763
+ :policy_version,
1764
+ :type)
1765
+ SENSITIVE = []
1766
+ include Aws::Structure
1767
+ end
1768
+
1769
+ # Statistics for an OpenSearch Serverless security policy.
1770
+ #
1771
+ # @!attribute [rw] encryption_policy_count
1772
+ # The number of encryption policies in the current account.
1773
+ # @return [Integer]
1774
+ #
1775
+ # @!attribute [rw] network_policy_count
1776
+ # The number of network policies in the current account.
1777
+ # @return [Integer]
1778
+ #
1779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityPolicyStats AWS API Documentation
1780
+ #
1781
+ class SecurityPolicyStats < Struct.new(
1782
+ :encryption_policy_count,
1783
+ :network_policy_count)
1784
+ SENSITIVE = []
1785
+ include Aws::Structure
1786
+ end
1787
+
1788
+ # A summary of a security policy for OpenSearch Serverless.
1789
+ #
1790
+ # @!attribute [rw] created_date
1791
+ # The date the policy was created.
1792
+ # @return [Integer]
1793
+ #
1794
+ # @!attribute [rw] description
1795
+ # The description of the security policy.
1796
+ # @return [String]
1797
+ #
1798
+ # @!attribute [rw] last_modified_date
1799
+ # The timestamp of when the policy was last modified.
1800
+ # @return [Integer]
1801
+ #
1802
+ # @!attribute [rw] name
1803
+ # The name of the policy.
1804
+ # @return [String]
1805
+ #
1806
+ # @!attribute [rw] policy_version
1807
+ # The version of the policy.
1808
+ # @return [String]
1809
+ #
1810
+ # @!attribute [rw] type
1811
+ # The type of security policy.
1812
+ # @return [String]
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityPolicySummary AWS API Documentation
1815
+ #
1816
+ class SecurityPolicySummary < Struct.new(
1817
+ :created_date,
1818
+ :description,
1819
+ :last_modified_date,
1820
+ :name,
1821
+ :policy_version,
1822
+ :type)
1823
+ SENSITIVE = []
1824
+ include Aws::Structure
1825
+ end
1826
+
1827
+ # A map of key-value pairs associated to an OpenSearch Serverless
1828
+ # resource.
1829
+ #
1830
+ # @note When making an API call, you may pass Tag
1831
+ # data as a hash:
1832
+ #
1833
+ # {
1834
+ # key: "TagKey", # required
1835
+ # value: "TagValue", # required
1836
+ # }
1837
+ #
1838
+ # @!attribute [rw] key
1839
+ # The key to use in the tag.
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] value
1843
+ # The value of the tag.
1844
+ # @return [String]
1845
+ #
1846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/Tag AWS API Documentation
1847
+ #
1848
+ class Tag < Struct.new(
1849
+ :key,
1850
+ :value)
1851
+ SENSITIVE = []
1852
+ include Aws::Structure
1853
+ end
1854
+
1855
+ # @note When making an API call, you may pass TagResourceRequest
1856
+ # data as a hash:
1857
+ #
1858
+ # {
1859
+ # resource_arn: "Arn", # required
1860
+ # tags: [ # required
1861
+ # {
1862
+ # key: "TagKey", # required
1863
+ # value: "TagValue", # required
1864
+ # },
1865
+ # ],
1866
+ # }
1867
+ #
1868
+ # @!attribute [rw] resource_arn
1869
+ # The Amazon Resource Name (ARN) of the resource. The resource must be
1870
+ # active (not in the `DELETING` state), and must be owned by the
1871
+ # account ID included in the request.
1872
+ # @return [String]
1873
+ #
1874
+ # @!attribute [rw] tags
1875
+ # A list of tags (key-value pairs) to add to the resource. All tag
1876
+ # keys in the request must be unique.
1877
+ # @return [Array<Types::Tag>]
1878
+ #
1879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/TagResourceRequest AWS API Documentation
1880
+ #
1881
+ class TagResourceRequest < Struct.new(
1882
+ :resource_arn,
1883
+ :tags)
1884
+ SENSITIVE = []
1885
+ include Aws::Structure
1886
+ end
1887
+
1888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/TagResourceResponse AWS API Documentation
1889
+ #
1890
+ class TagResourceResponse < Aws::EmptyStructure; end
1891
+
1892
+ # @note When making an API call, you may pass UntagResourceRequest
1893
+ # data as a hash:
1894
+ #
1895
+ # {
1896
+ # resource_arn: "Arn", # required
1897
+ # tag_keys: ["TagKey"], # required
1898
+ # }
1899
+ #
1900
+ # @!attribute [rw] resource_arn
1901
+ # The Amazon Resource Name (ARN) of the resource to remove tags from.
1902
+ # The resource must be active (not in the `DELETING` state), and must
1903
+ # be owned by the account ID included in the request.
1904
+ # @return [String]
1905
+ #
1906
+ # @!attribute [rw] tag_keys
1907
+ # The tag or set of tags to remove from the resource. All tag keys in
1908
+ # the request must be unique.
1909
+ # @return [Array<String>]
1910
+ #
1911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UntagResourceRequest AWS API Documentation
1912
+ #
1913
+ class UntagResourceRequest < Struct.new(
1914
+ :resource_arn,
1915
+ :tag_keys)
1916
+ SENSITIVE = []
1917
+ include Aws::Structure
1918
+ end
1919
+
1920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UntagResourceResponse AWS API Documentation
1921
+ #
1922
+ class UntagResourceResponse < Aws::EmptyStructure; end
1923
+
1924
+ # @note When making an API call, you may pass UpdateAccessPolicyRequest
1925
+ # data as a hash:
1926
+ #
1927
+ # {
1928
+ # client_token: "ClientToken",
1929
+ # description: "PolicyDescription",
1930
+ # name: "PolicyName", # required
1931
+ # policy: "PolicyDocument",
1932
+ # policy_version: "PolicyVersion", # required
1933
+ # type: "data", # required, accepts data
1934
+ # }
1935
+ #
1936
+ # @!attribute [rw] client_token
1937
+ # Unique, case-sensitive identifier to ensure idempotency of the
1938
+ # request.
1939
+ #
1940
+ # **A suitable default value is auto-generated.** You should normally
1941
+ # not need to pass this option.
1942
+ # @return [String]
1943
+ #
1944
+ # @!attribute [rw] description
1945
+ # A description of the policy. Typically used to store information
1946
+ # about the permissions defined in the policy.
1947
+ # @return [String]
1948
+ #
1949
+ # @!attribute [rw] name
1950
+ # The name of the policy.
1951
+ # @return [String]
1952
+ #
1953
+ # @!attribute [rw] policy
1954
+ # The JSON policy document to use as the content for the policy.
1955
+ # @return [String]
1956
+ #
1957
+ # @!attribute [rw] policy_version
1958
+ # The version of the policy being updated.
1959
+ # @return [String]
1960
+ #
1961
+ # @!attribute [rw] type
1962
+ # The type of policy.
1963
+ # @return [String]
1964
+ #
1965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccessPolicyRequest AWS API Documentation
1966
+ #
1967
+ class UpdateAccessPolicyRequest < Struct.new(
1968
+ :client_token,
1969
+ :description,
1970
+ :name,
1971
+ :policy,
1972
+ :policy_version,
1973
+ :type)
1974
+ SENSITIVE = []
1975
+ include Aws::Structure
1976
+ end
1977
+
1978
+ # @!attribute [rw] access_policy_detail
1979
+ # Details about the updated access policy.
1980
+ # @return [Types::AccessPolicyDetail]
1981
+ #
1982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccessPolicyResponse AWS API Documentation
1983
+ #
1984
+ class UpdateAccessPolicyResponse < Struct.new(
1985
+ :access_policy_detail)
1986
+ SENSITIVE = []
1987
+ include Aws::Structure
1988
+ end
1989
+
1990
+ # @note When making an API call, you may pass UpdateAccountSettingsRequest
1991
+ # data as a hash:
1992
+ #
1993
+ # {
1994
+ # capacity_limits: {
1995
+ # max_indexing_capacity_in_ocu: 1,
1996
+ # max_search_capacity_in_ocu: 1,
1997
+ # },
1998
+ # }
1999
+ #
2000
+ # @!attribute [rw] capacity_limits
2001
+ # The maximum capacity limits for all OpenSearch Serverless
2002
+ # collections, in OpenSearch Compute Units (OCUs). These limits are
2003
+ # used to scale your collections based on the current workload. For
2004
+ # more information, see [Autoscaling][1].
2005
+ #
2006
+ #
2007
+ #
2008
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling
2009
+ # @return [Types::CapacityLimits]
2010
+ #
2011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccountSettingsRequest AWS API Documentation
2012
+ #
2013
+ class UpdateAccountSettingsRequest < Struct.new(
2014
+ :capacity_limits)
2015
+ SENSITIVE = []
2016
+ include Aws::Structure
2017
+ end
2018
+
2019
+ # @!attribute [rw] account_settings_detail
2020
+ # OpenSearch Serverless-related settings for the current Amazon Web
2021
+ # Services account.
2022
+ # @return [Types::AccountSettingsDetail]
2023
+ #
2024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccountSettingsResponse AWS API Documentation
2025
+ #
2026
+ class UpdateAccountSettingsResponse < Struct.new(
2027
+ :account_settings_detail)
2028
+ SENSITIVE = []
2029
+ include Aws::Structure
2030
+ end
2031
+
2032
+ # Details about an updated OpenSearch Serverless collection.
2033
+ #
2034
+ # @!attribute [rw] arn
2035
+ # The Amazon Resource Name (ARN) of the collection.
2036
+ # @return [String]
2037
+ #
2038
+ # @!attribute [rw] created_date
2039
+ # The date and time when the collection was created.
2040
+ # @return [Integer]
2041
+ #
2042
+ # @!attribute [rw] description
2043
+ # The description of the collection.
2044
+ # @return [String]
2045
+ #
2046
+ # @!attribute [rw] id
2047
+ # The unique identifier of the collection.
2048
+ # @return [String]
2049
+ #
2050
+ # @!attribute [rw] last_modified_date
2051
+ # The date and time when the collection was last modified.
2052
+ # @return [Integer]
2053
+ #
2054
+ # @!attribute [rw] name
2055
+ # The name of the collection.
2056
+ # @return [String]
2057
+ #
2058
+ # @!attribute [rw] status
2059
+ # The current status of the collection.
2060
+ # @return [String]
2061
+ #
2062
+ # @!attribute [rw] type
2063
+ # The collection type.
2064
+ # @return [String]
2065
+ #
2066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollectionDetail AWS API Documentation
2067
+ #
2068
+ class UpdateCollectionDetail < Struct.new(
2069
+ :arn,
2070
+ :created_date,
2071
+ :description,
2072
+ :id,
2073
+ :last_modified_date,
2074
+ :name,
2075
+ :status,
2076
+ :type)
2077
+ SENSITIVE = []
2078
+ include Aws::Structure
2079
+ end
2080
+
2081
+ # @note When making an API call, you may pass UpdateCollectionRequest
2082
+ # data as a hash:
2083
+ #
2084
+ # {
2085
+ # client_token: "ClientToken",
2086
+ # description: "UpdateCollectionRequestDescriptionString",
2087
+ # id: "CollectionId", # required
2088
+ # }
2089
+ #
2090
+ # @!attribute [rw] client_token
2091
+ # Unique, case-sensitive identifier to ensure idempotency of the
2092
+ # request.
2093
+ #
2094
+ # **A suitable default value is auto-generated.** You should normally
2095
+ # not need to pass this option.
2096
+ # @return [String]
2097
+ #
2098
+ # @!attribute [rw] description
2099
+ # A description of the collection.
2100
+ # @return [String]
2101
+ #
2102
+ # @!attribute [rw] id
2103
+ # The unique identifier of the collection.
2104
+ # @return [String]
2105
+ #
2106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollectionRequest AWS API Documentation
2107
+ #
2108
+ class UpdateCollectionRequest < Struct.new(
2109
+ :client_token,
2110
+ :description,
2111
+ :id)
2112
+ SENSITIVE = []
2113
+ include Aws::Structure
2114
+ end
2115
+
2116
+ # @!attribute [rw] update_collection_detail
2117
+ # Details about the updated collection.
2118
+ # @return [Types::UpdateCollectionDetail]
2119
+ #
2120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollectionResponse AWS API Documentation
2121
+ #
2122
+ class UpdateCollectionResponse < Struct.new(
2123
+ :update_collection_detail)
2124
+ SENSITIVE = []
2125
+ include Aws::Structure
2126
+ end
2127
+
2128
+ # @note When making an API call, you may pass UpdateSecurityConfigRequest
2129
+ # data as a hash:
2130
+ #
2131
+ # {
2132
+ # client_token: "ClientToken",
2133
+ # config_version: "PolicyVersion", # required
2134
+ # description: "ConfigDescription",
2135
+ # id: "SecurityConfigId", # required
2136
+ # saml_options: {
2137
+ # group_attribute: "samlGroupAttribute",
2138
+ # metadata: "samlMetadata", # required
2139
+ # session_timeout: 1,
2140
+ # user_attribute: "samlUserAttribute",
2141
+ # },
2142
+ # }
2143
+ #
2144
+ # @!attribute [rw] client_token
2145
+ # Unique, case-sensitive identifier to ensure idempotency of the
2146
+ # request.
2147
+ #
2148
+ # **A suitable default value is auto-generated.** You should normally
2149
+ # not need to pass this option.
2150
+ # @return [String]
2151
+ #
2152
+ # @!attribute [rw] config_version
2153
+ # The version of the security configuration to be updated. You can
2154
+ # find the most recent version of a security configuration using the
2155
+ # `GetSecurityPolicy` command.
2156
+ # @return [String]
2157
+ #
2158
+ # @!attribute [rw] description
2159
+ # A description of the security configuration.
2160
+ # @return [String]
2161
+ #
2162
+ # @!attribute [rw] id
2163
+ # The security configuration identifier. For SAML the ID will be
2164
+ # `saml/<accountId>/<idpProviderName>`. For example,
2165
+ # `saml/123456789123/OKTADev`.
2166
+ # @return [String]
2167
+ #
2168
+ # @!attribute [rw] saml_options
2169
+ # SAML options in in the form of a key-value map.
2170
+ # @return [Types::SamlConfigOptions]
2171
+ #
2172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityConfigRequest AWS API Documentation
2173
+ #
2174
+ class UpdateSecurityConfigRequest < Struct.new(
2175
+ :client_token,
2176
+ :config_version,
2177
+ :description,
2178
+ :id,
2179
+ :saml_options)
2180
+ SENSITIVE = []
2181
+ include Aws::Structure
2182
+ end
2183
+
2184
+ # @!attribute [rw] security_config_detail
2185
+ # Details about the updated security configuration.
2186
+ # @return [Types::SecurityConfigDetail]
2187
+ #
2188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityConfigResponse AWS API Documentation
2189
+ #
2190
+ class UpdateSecurityConfigResponse < Struct.new(
2191
+ :security_config_detail)
2192
+ SENSITIVE = []
2193
+ include Aws::Structure
2194
+ end
2195
+
2196
+ # @note When making an API call, you may pass UpdateSecurityPolicyRequest
2197
+ # data as a hash:
2198
+ #
2199
+ # {
2200
+ # client_token: "ClientToken",
2201
+ # description: "PolicyDescription",
2202
+ # name: "PolicyName", # required
2203
+ # policy: "PolicyDocument",
2204
+ # policy_version: "PolicyVersion", # required
2205
+ # type: "encryption", # required, accepts encryption, network
2206
+ # }
2207
+ #
2208
+ # @!attribute [rw] client_token
2209
+ # Unique, case-sensitive identifier to ensure idempotency of the
2210
+ # request.
2211
+ #
2212
+ # **A suitable default value is auto-generated.** You should normally
2213
+ # not need to pass this option.
2214
+ # @return [String]
2215
+ #
2216
+ # @!attribute [rw] description
2217
+ # A description of the policy. Typically used to store information
2218
+ # about the permissions defined in the policy.
2219
+ # @return [String]
2220
+ #
2221
+ # @!attribute [rw] name
2222
+ # The name of the policy.
2223
+ # @return [String]
2224
+ #
2225
+ # @!attribute [rw] policy
2226
+ # The JSON policy document to use as the content for the new policy.
2227
+ # @return [String]
2228
+ #
2229
+ # @!attribute [rw] policy_version
2230
+ # The version of the policy being updated.
2231
+ # @return [String]
2232
+ #
2233
+ # @!attribute [rw] type
2234
+ # The type of access policy.
2235
+ # @return [String]
2236
+ #
2237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityPolicyRequest AWS API Documentation
2238
+ #
2239
+ class UpdateSecurityPolicyRequest < Struct.new(
2240
+ :client_token,
2241
+ :description,
2242
+ :name,
2243
+ :policy,
2244
+ :policy_version,
2245
+ :type)
2246
+ SENSITIVE = []
2247
+ include Aws::Structure
2248
+ end
2249
+
2250
+ # @!attribute [rw] security_policy_detail
2251
+ # Details about the updated security policy.
2252
+ # @return [Types::SecurityPolicyDetail]
2253
+ #
2254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityPolicyResponse AWS API Documentation
2255
+ #
2256
+ class UpdateSecurityPolicyResponse < Struct.new(
2257
+ :security_policy_detail)
2258
+ SENSITIVE = []
2259
+ include Aws::Structure
2260
+ end
2261
+
2262
+ # Update details for an OpenSearch Serverless-managed interface
2263
+ # endpoint.
2264
+ #
2265
+ # @!attribute [rw] id
2266
+ # The unique identifier of the endpoint.
2267
+ # @return [String]
2268
+ #
2269
+ # @!attribute [rw] last_modified_date
2270
+ # The timestamp of when the endpoint was last modified.
2271
+ # @return [Integer]
2272
+ #
2273
+ # @!attribute [rw] name
2274
+ # The name of the endpoint.
2275
+ # @return [String]
2276
+ #
2277
+ # @!attribute [rw] security_group_ids
2278
+ # The unique identifiers of the security groups that define the ports,
2279
+ # protocols, and sources for inbound traffic that you are authorizing
2280
+ # into your endpoint.
2281
+ # @return [Array<String>]
2282
+ #
2283
+ # @!attribute [rw] status
2284
+ # The current status of the endpoint update process.
2285
+ # @return [String]
2286
+ #
2287
+ # @!attribute [rw] subnet_ids
2288
+ # The ID of the subnets from which you access OpenSearch Serverless.
2289
+ # @return [Array<String>]
2290
+ #
2291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpointDetail AWS API Documentation
2292
+ #
2293
+ class UpdateVpcEndpointDetail < Struct.new(
2294
+ :id,
2295
+ :last_modified_date,
2296
+ :name,
2297
+ :security_group_ids,
2298
+ :status,
2299
+ :subnet_ids)
2300
+ SENSITIVE = []
2301
+ include Aws::Structure
2302
+ end
2303
+
2304
+ # @note When making an API call, you may pass UpdateVpcEndpointRequest
2305
+ # data as a hash:
2306
+ #
2307
+ # {
2308
+ # add_security_group_ids: ["SecurityGroupId"],
2309
+ # add_subnet_ids: ["SubnetId"],
2310
+ # client_token: "ClientToken",
2311
+ # id: "VpcEndpointId", # required
2312
+ # remove_security_group_ids: ["SecurityGroupId"],
2313
+ # remove_subnet_ids: ["SubnetId"],
2314
+ # }
2315
+ #
2316
+ # @!attribute [rw] add_security_group_ids
2317
+ # The unique identifiers of the security groups to add to the
2318
+ # endpoint. Security groups define the ports, protocols, and sources
2319
+ # for inbound traffic that you are authorizing into your endpoint.
2320
+ # @return [Array<String>]
2321
+ #
2322
+ # @!attribute [rw] add_subnet_ids
2323
+ # The ID of one or more subnets to add to the endpoint.
2324
+ # @return [Array<String>]
2325
+ #
2326
+ # @!attribute [rw] client_token
2327
+ # Unique, case-sensitive identifier to ensure idempotency of the
2328
+ # request.
2329
+ #
2330
+ # **A suitable default value is auto-generated.** You should normally
2331
+ # not need to pass this option.
2332
+ # @return [String]
2333
+ #
2334
+ # @!attribute [rw] id
2335
+ # The unique identifier of the interface endpoint to update.
2336
+ # @return [String]
2337
+ #
2338
+ # @!attribute [rw] remove_security_group_ids
2339
+ # The unique identifiers of the security groups to remove from the
2340
+ # endpoint.
2341
+ # @return [Array<String>]
2342
+ #
2343
+ # @!attribute [rw] remove_subnet_ids
2344
+ # The unique identifiers of the subnets to remove from the endpoint.
2345
+ # @return [Array<String>]
2346
+ #
2347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpointRequest AWS API Documentation
2348
+ #
2349
+ class UpdateVpcEndpointRequest < Struct.new(
2350
+ :add_security_group_ids,
2351
+ :add_subnet_ids,
2352
+ :client_token,
2353
+ :id,
2354
+ :remove_security_group_ids,
2355
+ :remove_subnet_ids)
2356
+ SENSITIVE = []
2357
+ include Aws::Structure
2358
+ end
2359
+
2360
+ # @!attribute [rw] update_vpc_endpoint_detail
2361
+ # Details about the updated VPC endpoint.
2362
+ # @return [Types::UpdateVpcEndpointDetail]
2363
+ #
2364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpointResponse AWS API Documentation
2365
+ #
2366
+ class UpdateVpcEndpointResponse < Struct.new(
2367
+ :update_vpc_endpoint_detail)
2368
+ SENSITIVE = []
2369
+ include Aws::Structure
2370
+ end
2371
+
2372
+ # Thrown when the HTTP request contains invalid input or is missing
2373
+ # required input.
2374
+ #
2375
+ # @!attribute [rw] message
2376
+ # @return [String]
2377
+ #
2378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ValidationException AWS API Documentation
2379
+ #
2380
+ class ValidationException < Struct.new(
2381
+ :message)
2382
+ SENSITIVE = []
2383
+ include Aws::Structure
2384
+ end
2385
+
2386
+ # Details about an OpenSearch Serverless-managed interface endpoint.
2387
+ #
2388
+ # @!attribute [rw] created_date
2389
+ # The date the endpoint was created.
2390
+ # @return [Integer]
2391
+ #
2392
+ # @!attribute [rw] id
2393
+ # The unique identifier of the endpoint.
2394
+ # @return [String]
2395
+ #
2396
+ # @!attribute [rw] name
2397
+ # The name of the endpoint.
2398
+ # @return [String]
2399
+ #
2400
+ # @!attribute [rw] security_group_ids
2401
+ # The unique identifiers of the security groups that define the ports,
2402
+ # protocols, and sources for inbound traffic that you are authorizing
2403
+ # into your endpoint.
2404
+ # @return [Array<String>]
2405
+ #
2406
+ # @!attribute [rw] status
2407
+ # The current status of the endpoint.
2408
+ # @return [String]
2409
+ #
2410
+ # @!attribute [rw] subnet_ids
2411
+ # The ID of the subnets from which you access OpenSearch Serverless.
2412
+ # @return [Array<String>]
2413
+ #
2414
+ # @!attribute [rw] vpc_id
2415
+ # The ID of the VPC from which you access OpenSearch Serverless
2416
+ # @return [String]
2417
+ #
2418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/VpcEndpointDetail AWS API Documentation
2419
+ #
2420
+ class VpcEndpointDetail < Struct.new(
2421
+ :created_date,
2422
+ :id,
2423
+ :name,
2424
+ :security_group_ids,
2425
+ :status,
2426
+ :subnet_ids,
2427
+ :vpc_id)
2428
+ SENSITIVE = []
2429
+ include Aws::Structure
2430
+ end
2431
+
2432
+ # Error information for a failed `BatchGetVpcEndpoint` request.
2433
+ #
2434
+ # @!attribute [rw] error_code
2435
+ # The error code for the failed request.
2436
+ # @return [String]
2437
+ #
2438
+ # @!attribute [rw] error_message
2439
+ # An error message describing the reason for the failure.
2440
+ # @return [String]
2441
+ #
2442
+ # @!attribute [rw] id
2443
+ # The unique identifier of the VPC endpoint.
2444
+ # @return [String]
2445
+ #
2446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/VpcEndpointErrorDetail AWS API Documentation
2447
+ #
2448
+ class VpcEndpointErrorDetail < Struct.new(
2449
+ :error_code,
2450
+ :error_message,
2451
+ :id)
2452
+ SENSITIVE = []
2453
+ include Aws::Structure
2454
+ end
2455
+
2456
+ # Filter the results of a `ListVpcEndpoints` request.
2457
+ #
2458
+ # @note When making an API call, you may pass VpcEndpointFilters
2459
+ # data as a hash:
2460
+ #
2461
+ # {
2462
+ # status: "PENDING", # accepts PENDING, DELETING, ACTIVE, FAILED
2463
+ # }
2464
+ #
2465
+ # @!attribute [rw] status
2466
+ # The current status of the endpoint.
2467
+ # @return [String]
2468
+ #
2469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/VpcEndpointFilters AWS API Documentation
2470
+ #
2471
+ class VpcEndpointFilters < Struct.new(
2472
+ :status)
2473
+ SENSITIVE = []
2474
+ include Aws::Structure
2475
+ end
2476
+
2477
+ # The VPC endpoint object.
2478
+ #
2479
+ # @!attribute [rw] id
2480
+ # The unique identifier of the endpoint.
2481
+ # @return [String]
2482
+ #
2483
+ # @!attribute [rw] name
2484
+ # The name of the endpoint.
2485
+ # @return [String]
2486
+ #
2487
+ # @!attribute [rw] status
2488
+ # The current status of the endpoint.
2489
+ # @return [String]
2490
+ #
2491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/VpcEndpointSummary AWS API Documentation
2492
+ #
2493
+ class VpcEndpointSummary < Struct.new(
2494
+ :id,
2495
+ :name,
2496
+ :status)
2497
+ SENSITIVE = []
2498
+ include Aws::Structure
2499
+ end
2500
+
2501
+ end
2502
+ end