aws-sdk-opensearchserverless 1.33.0 → 1.34.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchserverless/client.rb +440 -435
- data/lib/aws-sdk-opensearchserverless/client_api.rb +157 -155
- data/lib/aws-sdk-opensearchserverless/errors.rb +5 -5
- data/lib/aws-sdk-opensearchserverless/types.rb +767 -761
- data/lib/aws-sdk-opensearchserverless/waiters.rb +15 -0
- data/lib/aws-sdk-opensearchserverless.rb +2 -1
- data/sig/client.rbs +98 -96
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +156 -155
- metadata +3 -2
@@ -12,44 +12,44 @@ module Aws::OpenSearchServerless
|
|
12
12
|
|
13
13
|
# Details about an OpenSearch Serverless access policy.
|
14
14
|
#
|
15
|
-
# @!attribute [rw]
|
16
|
-
# The
|
17
|
-
# @return [Integer]
|
18
|
-
#
|
19
|
-
# @!attribute [rw] description
|
20
|
-
# The description of the policy.
|
15
|
+
# @!attribute [rw] type
|
16
|
+
# The type of access policy.
|
21
17
|
# @return [String]
|
22
18
|
#
|
23
|
-
# @!attribute [rw] last_modified_date
|
24
|
-
# The timestamp of when the policy was last modified.
|
25
|
-
# @return [Integer]
|
26
|
-
#
|
27
19
|
# @!attribute [rw] name
|
28
20
|
# The name of the policy.
|
29
21
|
# @return [String]
|
30
22
|
#
|
31
|
-
# @!attribute [rw] policy
|
32
|
-
# The JSON policy document without any whitespaces.
|
33
|
-
# @return [Hash,Array,String,Numeric,Boolean]
|
34
|
-
#
|
35
23
|
# @!attribute [rw] policy_version
|
36
24
|
# The version of the policy.
|
37
25
|
# @return [String]
|
38
26
|
#
|
39
|
-
# @!attribute [rw]
|
40
|
-
# The
|
27
|
+
# @!attribute [rw] description
|
28
|
+
# The description of the policy.
|
41
29
|
# @return [String]
|
42
30
|
#
|
31
|
+
# @!attribute [rw] policy
|
32
|
+
# The JSON policy document without any whitespaces.
|
33
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] created_date
|
36
|
+
# The date the policy was created.
|
37
|
+
# @return [Integer]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] last_modified_date
|
40
|
+
# The timestamp of when the policy was last modified.
|
41
|
+
# @return [Integer]
|
42
|
+
#
|
43
43
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/AccessPolicyDetail AWS API Documentation
|
44
44
|
#
|
45
45
|
class AccessPolicyDetail < Struct.new(
|
46
|
-
:
|
47
|
-
:description,
|
48
|
-
:last_modified_date,
|
46
|
+
:type,
|
49
47
|
:name,
|
50
|
-
:policy,
|
51
48
|
:policy_version,
|
52
|
-
:
|
49
|
+
:description,
|
50
|
+
:policy,
|
51
|
+
:created_date,
|
52
|
+
:last_modified_date)
|
53
53
|
SENSITIVE = []
|
54
54
|
include Aws::Structure
|
55
55
|
end
|
@@ -70,18 +70,11 @@ module Aws::OpenSearchServerless
|
|
70
70
|
|
71
71
|
# A summary of the data access policy.
|
72
72
|
#
|
73
|
-
# @!attribute [rw]
|
74
|
-
# The
|
75
|
-
#
|
76
|
-
#
|
77
|
-
# @!attribute [rw] description
|
78
|
-
# The description of the access policy.
|
73
|
+
# @!attribute [rw] type
|
74
|
+
# The type of access policy. Currently, the only available type is
|
75
|
+
# `data`.
|
79
76
|
# @return [String]
|
80
77
|
#
|
81
|
-
# @!attribute [rw] last_modified_date
|
82
|
-
# The date and time when the collection was last modified.
|
83
|
-
# @return [Integer]
|
84
|
-
#
|
85
78
|
# @!attribute [rw] name
|
86
79
|
# The name of the access policy.
|
87
80
|
# @return [String]
|
@@ -90,20 +83,27 @@ module Aws::OpenSearchServerless
|
|
90
83
|
# The version of the policy.
|
91
84
|
# @return [String]
|
92
85
|
#
|
93
|
-
# @!attribute [rw]
|
94
|
-
# The
|
95
|
-
# `data`.
|
86
|
+
# @!attribute [rw] description
|
87
|
+
# The description of the access policy.
|
96
88
|
# @return [String]
|
97
89
|
#
|
90
|
+
# @!attribute [rw] created_date
|
91
|
+
# The Epoch time when the access policy was created.
|
92
|
+
# @return [Integer]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] last_modified_date
|
95
|
+
# The date and time when the collection was last modified.
|
96
|
+
# @return [Integer]
|
97
|
+
#
|
98
98
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/AccessPolicySummary AWS API Documentation
|
99
99
|
#
|
100
100
|
class AccessPolicySummary < Struct.new(
|
101
|
-
:
|
102
|
-
:description,
|
103
|
-
:last_modified_date,
|
101
|
+
:type,
|
104
102
|
:name,
|
105
103
|
:policy_version,
|
106
|
-
:
|
104
|
+
:description,
|
105
|
+
:created_date,
|
106
|
+
:last_modified_date)
|
107
107
|
SENSITIVE = []
|
108
108
|
include Aws::Structure
|
109
109
|
end
|
@@ -290,37 +290,28 @@ module Aws::OpenSearchServerless
|
|
290
290
|
# Details about each OpenSearch Serverless collection, including the
|
291
291
|
# collection endpoint and the OpenSearch Dashboards endpoint.
|
292
292
|
#
|
293
|
-
# @!attribute [rw]
|
294
|
-
#
|
293
|
+
# @!attribute [rw] id
|
294
|
+
# A unique identifier for the collection.
|
295
295
|
# @return [String]
|
296
296
|
#
|
297
|
-
# @!attribute [rw]
|
298
|
-
#
|
299
|
-
# upload requests to an OpenSearch Serverless collection.
|
297
|
+
# @!attribute [rw] name
|
298
|
+
# The name of the collection.
|
300
299
|
# @return [String]
|
301
300
|
#
|
302
|
-
# @!attribute [rw]
|
303
|
-
# The
|
304
|
-
# @return [
|
301
|
+
# @!attribute [rw] status
|
302
|
+
# The current status of the collection.
|
303
|
+
# @return [String]
|
305
304
|
#
|
306
|
-
# @!attribute [rw]
|
307
|
-
#
|
305
|
+
# @!attribute [rw] type
|
306
|
+
# The type of collection.
|
308
307
|
# @return [String]
|
309
308
|
#
|
310
309
|
# @!attribute [rw] description
|
311
310
|
# A description of the collection.
|
312
311
|
# @return [String]
|
313
312
|
#
|
314
|
-
# @!attribute [rw]
|
315
|
-
#
|
316
|
-
# @return [String]
|
317
|
-
#
|
318
|
-
# @!attribute [rw] failure_message
|
319
|
-
# A message associated with the failure code.
|
320
|
-
# @return [String]
|
321
|
-
#
|
322
|
-
# @!attribute [rw] id
|
323
|
-
# A unique identifier for the collection.
|
313
|
+
# @!attribute [rw] arn
|
314
|
+
# The Amazon Resource Name (ARN) of the collection.
|
324
315
|
# @return [String]
|
325
316
|
#
|
326
317
|
# @!attribute [rw] kms_key_arn
|
@@ -328,58 +319,58 @@ module Aws::OpenSearchServerless
|
|
328
319
|
# collection.
|
329
320
|
# @return [String]
|
330
321
|
#
|
322
|
+
# @!attribute [rw] standby_replicas
|
323
|
+
# Details about an OpenSearch Serverless collection.
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] created_date
|
327
|
+
# The Epoch time when the collection was created.
|
328
|
+
# @return [Integer]
|
329
|
+
#
|
331
330
|
# @!attribute [rw] last_modified_date
|
332
331
|
# The date and time when the collection was last modified.
|
333
332
|
# @return [Integer]
|
334
333
|
#
|
335
|
-
# @!attribute [rw]
|
336
|
-
#
|
334
|
+
# @!attribute [rw] collection_endpoint
|
335
|
+
# Collection-specific endpoint used to submit index, search, and data
|
336
|
+
# upload requests to an OpenSearch Serverless collection.
|
337
337
|
# @return [String]
|
338
338
|
#
|
339
|
-
# @!attribute [rw]
|
340
|
-
#
|
339
|
+
# @!attribute [rw] dashboard_endpoint
|
340
|
+
# Collection-specific endpoint used to access OpenSearch Dashboards.
|
341
341
|
# @return [String]
|
342
342
|
#
|
343
|
-
# @!attribute [rw]
|
344
|
-
#
|
343
|
+
# @!attribute [rw] failure_code
|
344
|
+
# A failure code associated with the request.
|
345
345
|
# @return [String]
|
346
346
|
#
|
347
|
-
# @!attribute [rw]
|
348
|
-
#
|
347
|
+
# @!attribute [rw] failure_message
|
348
|
+
# A message associated with the failure code.
|
349
349
|
# @return [String]
|
350
350
|
#
|
351
351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CollectionDetail AWS API Documentation
|
352
352
|
#
|
353
353
|
class CollectionDetail < Struct.new(
|
354
|
+
:id,
|
355
|
+
:name,
|
356
|
+
:status,
|
357
|
+
:type,
|
358
|
+
:description,
|
354
359
|
:arn,
|
355
|
-
:
|
360
|
+
:kms_key_arn,
|
361
|
+
:standby_replicas,
|
356
362
|
:created_date,
|
363
|
+
:last_modified_date,
|
364
|
+
:collection_endpoint,
|
357
365
|
:dashboard_endpoint,
|
358
|
-
:description,
|
359
366
|
:failure_code,
|
360
|
-
:failure_message
|
361
|
-
:id,
|
362
|
-
:kms_key_arn,
|
363
|
-
:last_modified_date,
|
364
|
-
:name,
|
365
|
-
:standby_replicas,
|
366
|
-
:status,
|
367
|
-
:type)
|
367
|
+
:failure_message)
|
368
368
|
SENSITIVE = []
|
369
369
|
include Aws::Structure
|
370
370
|
end
|
371
371
|
|
372
372
|
# Error information for an OpenSearch Serverless request.
|
373
373
|
#
|
374
|
-
# @!attribute [rw] error_code
|
375
|
-
# The error code for the request. For example, `NOT_FOUND`.
|
376
|
-
# @return [String]
|
377
|
-
#
|
378
|
-
# @!attribute [rw] error_message
|
379
|
-
# A description of the error. For example, `The specified Collection
|
380
|
-
# is not found.`
|
381
|
-
# @return [String]
|
382
|
-
#
|
383
374
|
# @!attribute [rw] id
|
384
375
|
# If the request contains collection IDs, the response includes the
|
385
376
|
# IDs provided in the request.
|
@@ -390,13 +381,22 @@ module Aws::OpenSearchServerless
|
|
390
381
|
# names provided in the request.
|
391
382
|
# @return [String]
|
392
383
|
#
|
384
|
+
# @!attribute [rw] error_message
|
385
|
+
# A description of the error. For example, `The specified Collection
|
386
|
+
# is not found.`
|
387
|
+
# @return [String]
|
388
|
+
#
|
389
|
+
# @!attribute [rw] error_code
|
390
|
+
# The error code for the request. For example, `NOT_FOUND`.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
393
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CollectionErrorDetail AWS API Documentation
|
394
394
|
#
|
395
395
|
class CollectionErrorDetail < Struct.new(
|
396
|
-
:error_code,
|
397
|
-
:error_message,
|
398
396
|
:id,
|
399
|
-
:name
|
397
|
+
:name,
|
398
|
+
:error_message,
|
399
|
+
:error_code)
|
400
400
|
SENSITIVE = []
|
401
401
|
include Aws::Structure
|
402
402
|
end
|
@@ -423,10 +423,6 @@ module Aws::OpenSearchServerless
|
|
423
423
|
|
424
424
|
# Details about each OpenSearch Serverless collection.
|
425
425
|
#
|
426
|
-
# @!attribute [rw] arn
|
427
|
-
# The Amazon Resource Name (ARN) of the collection.
|
428
|
-
# @return [String]
|
429
|
-
#
|
430
426
|
# @!attribute [rw] id
|
431
427
|
# The unique identifier of the collection.
|
432
428
|
# @return [String]
|
@@ -439,13 +435,17 @@ module Aws::OpenSearchServerless
|
|
439
435
|
# The current status of the collection.
|
440
436
|
# @return [String]
|
441
437
|
#
|
438
|
+
# @!attribute [rw] arn
|
439
|
+
# The Amazon Resource Name (ARN) of the collection.
|
440
|
+
# @return [String]
|
441
|
+
#
|
442
442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CollectionSummary AWS API Documentation
|
443
443
|
#
|
444
444
|
class CollectionSummary < Struct.new(
|
445
|
-
:arn,
|
446
445
|
:id,
|
447
446
|
:name,
|
448
|
-
:status
|
447
|
+
:status,
|
448
|
+
:arn)
|
449
449
|
SENSITIVE = []
|
450
450
|
include Aws::Structure
|
451
451
|
end
|
@@ -465,12 +465,12 @@ module Aws::OpenSearchServerless
|
|
465
465
|
include Aws::Structure
|
466
466
|
end
|
467
467
|
|
468
|
-
# @!attribute [rw]
|
469
|
-
#
|
470
|
-
#
|
468
|
+
# @!attribute [rw] type
|
469
|
+
# The type of policy.
|
470
|
+
# @return [String]
|
471
471
|
#
|
472
|
-
#
|
473
|
-
#
|
472
|
+
# @!attribute [rw] name
|
473
|
+
# The name of the policy.
|
474
474
|
# @return [String]
|
475
475
|
#
|
476
476
|
# @!attribute [rw] description
|
@@ -478,26 +478,26 @@ module Aws::OpenSearchServerless
|
|
478
478
|
# about the permissions defined in the policy.
|
479
479
|
# @return [String]
|
480
480
|
#
|
481
|
-
# @!attribute [rw] name
|
482
|
-
# The name of the policy.
|
483
|
-
# @return [String]
|
484
|
-
#
|
485
481
|
# @!attribute [rw] policy
|
486
482
|
# The JSON policy document to use as the content for the policy.
|
487
483
|
# @return [String]
|
488
484
|
#
|
489
|
-
# @!attribute [rw]
|
490
|
-
#
|
485
|
+
# @!attribute [rw] client_token
|
486
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
487
|
+
# request.
|
488
|
+
#
|
489
|
+
# **A suitable default value is auto-generated.** You should normally
|
490
|
+
# not need to pass this option.
|
491
491
|
# @return [String]
|
492
492
|
#
|
493
493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateAccessPolicyRequest AWS API Documentation
|
494
494
|
#
|
495
495
|
class CreateAccessPolicyRequest < Struct.new(
|
496
|
-
:
|
497
|
-
:description,
|
496
|
+
:type,
|
498
497
|
:name,
|
498
|
+
:description,
|
499
499
|
:policy,
|
500
|
-
:
|
500
|
+
:client_token)
|
501
501
|
SENSITIVE = []
|
502
502
|
include Aws::Structure
|
503
503
|
end
|
@@ -516,20 +516,28 @@ module Aws::OpenSearchServerless
|
|
516
516
|
|
517
517
|
# Details about the created OpenSearch Serverless collection.
|
518
518
|
#
|
519
|
-
# @!attribute [rw]
|
520
|
-
# The
|
519
|
+
# @!attribute [rw] id
|
520
|
+
# The unique identifier of the collection.
|
521
521
|
# @return [String]
|
522
522
|
#
|
523
|
-
# @!attribute [rw]
|
524
|
-
# The
|
525
|
-
# @return [
|
523
|
+
# @!attribute [rw] name
|
524
|
+
# The name of the collection.
|
525
|
+
# @return [String]
|
526
|
+
#
|
527
|
+
# @!attribute [rw] status
|
528
|
+
# The current status of the collection.
|
529
|
+
# @return [String]
|
530
|
+
#
|
531
|
+
# @!attribute [rw] type
|
532
|
+
# The type of collection.
|
533
|
+
# @return [String]
|
526
534
|
#
|
527
535
|
# @!attribute [rw] description
|
528
536
|
# A description of the collection.
|
529
537
|
# @return [String]
|
530
538
|
#
|
531
|
-
# @!attribute [rw]
|
532
|
-
# The
|
539
|
+
# @!attribute [rw] arn
|
540
|
+
# The Amazon Resource Name (ARN) of the collection.
|
533
541
|
# @return [String]
|
534
542
|
#
|
535
543
|
# @!attribute [rw] kms_key_arn
|
@@ -537,81 +545,73 @@ module Aws::OpenSearchServerless
|
|
537
545
|
# the collection.
|
538
546
|
# @return [String]
|
539
547
|
#
|
540
|
-
# @!attribute [rw] last_modified_date
|
541
|
-
# The date and time when the collection was last modified.
|
542
|
-
# @return [Integer]
|
543
|
-
#
|
544
|
-
# @!attribute [rw] name
|
545
|
-
# The name of the collection.
|
546
|
-
# @return [String]
|
547
|
-
#
|
548
548
|
# @!attribute [rw] standby_replicas
|
549
549
|
# Creates details about an OpenSearch Serverless collection.
|
550
550
|
# @return [String]
|
551
551
|
#
|
552
|
-
# @!attribute [rw]
|
553
|
-
# The
|
554
|
-
# @return [
|
552
|
+
# @!attribute [rw] created_date
|
553
|
+
# The Epoch time when the collection was created.
|
554
|
+
# @return [Integer]
|
555
555
|
#
|
556
|
-
# @!attribute [rw]
|
557
|
-
# The
|
558
|
-
# @return [
|
556
|
+
# @!attribute [rw] last_modified_date
|
557
|
+
# The date and time when the collection was last modified.
|
558
|
+
# @return [Integer]
|
559
559
|
#
|
560
560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollectionDetail AWS API Documentation
|
561
561
|
#
|
562
562
|
class CreateCollectionDetail < Struct.new(
|
563
|
-
:arn,
|
564
|
-
:created_date,
|
565
|
-
:description,
|
566
563
|
:id,
|
567
|
-
:kms_key_arn,
|
568
|
-
:last_modified_date,
|
569
564
|
:name,
|
570
|
-
:standby_replicas,
|
571
565
|
:status,
|
572
|
-
:type
|
566
|
+
:type,
|
567
|
+
:description,
|
568
|
+
:arn,
|
569
|
+
:kms_key_arn,
|
570
|
+
:standby_replicas,
|
571
|
+
:created_date,
|
572
|
+
:last_modified_date)
|
573
573
|
SENSITIVE = []
|
574
574
|
include Aws::Structure
|
575
575
|
end
|
576
576
|
|
577
|
-
# @!attribute [rw]
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
577
|
+
# @!attribute [rw] name
|
578
|
+
# Name of the collection.
|
579
|
+
# @return [String]
|
580
|
+
#
|
581
|
+
# @!attribute [rw] type
|
582
|
+
# The type of collection.
|
583
583
|
# @return [String]
|
584
584
|
#
|
585
585
|
# @!attribute [rw] description
|
586
586
|
# Description of the collection.
|
587
587
|
# @return [String]
|
588
588
|
#
|
589
|
-
# @!attribute [rw]
|
590
|
-
#
|
591
|
-
#
|
589
|
+
# @!attribute [rw] tags
|
590
|
+
# An arbitrary set of tags (key–value pairs) to associate with the
|
591
|
+
# OpenSearch Serverless collection.
|
592
|
+
# @return [Array<Types::Tag>]
|
592
593
|
#
|
593
594
|
# @!attribute [rw] standby_replicas
|
594
595
|
# Indicates whether standby replicas should be used for a collection.
|
595
596
|
# @return [String]
|
596
597
|
#
|
597
|
-
# @!attribute [rw]
|
598
|
-
#
|
599
|
-
#
|
600
|
-
# @return [Array<Types::Tag>]
|
598
|
+
# @!attribute [rw] client_token
|
599
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
600
|
+
# request.
|
601
601
|
#
|
602
|
-
#
|
603
|
-
#
|
602
|
+
# **A suitable default value is auto-generated.** You should normally
|
603
|
+
# not need to pass this option.
|
604
604
|
# @return [String]
|
605
605
|
#
|
606
606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollectionRequest AWS API Documentation
|
607
607
|
#
|
608
608
|
class CreateCollectionRequest < Struct.new(
|
609
|
-
:client_token,
|
610
|
-
:description,
|
611
609
|
:name,
|
612
|
-
:
|
610
|
+
:type,
|
611
|
+
:description,
|
613
612
|
:tags,
|
614
|
-
:
|
613
|
+
:standby_replicas,
|
614
|
+
:client_token)
|
615
615
|
SENSITIVE = []
|
616
616
|
include Aws::Structure
|
617
617
|
end
|
@@ -631,11 +631,6 @@ module Aws::OpenSearchServerless
|
|
631
631
|
# Describes IAM Identity Center options for creating an OpenSearch
|
632
632
|
# Serverless security configuration in the form of a key-value map.
|
633
633
|
#
|
634
|
-
# @!attribute [rw] group_attribute
|
635
|
-
# The group attribute for this IAM Identity Center integration.
|
636
|
-
# Defaults to `GroupId`.
|
637
|
-
# @return [String]
|
638
|
-
#
|
639
634
|
# @!attribute [rw] instance_arn
|
640
635
|
# The ARN of the IAM Identity Center instance used to integrate with
|
641
636
|
# OpenSearch Serverless.
|
@@ -646,49 +641,54 @@ module Aws::OpenSearchServerless
|
|
646
641
|
# Defaults to `UserId`.
|
647
642
|
# @return [String]
|
648
643
|
#
|
644
|
+
# @!attribute [rw] group_attribute
|
645
|
+
# The group attribute for this IAM Identity Center integration.
|
646
|
+
# Defaults to `GroupId`.
|
647
|
+
# @return [String]
|
648
|
+
#
|
649
649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateIamIdentityCenterConfigOptions AWS API Documentation
|
650
650
|
#
|
651
651
|
class CreateIamIdentityCenterConfigOptions < Struct.new(
|
652
|
-
:group_attribute,
|
653
652
|
:instance_arn,
|
654
|
-
:user_attribute
|
653
|
+
:user_attribute,
|
654
|
+
:group_attribute)
|
655
655
|
SENSITIVE = []
|
656
656
|
include Aws::Structure
|
657
657
|
end
|
658
658
|
|
659
|
-
# @!attribute [rw]
|
660
|
-
#
|
661
|
-
#
|
659
|
+
# @!attribute [rw] type
|
660
|
+
# The type of lifecycle policy.
|
661
|
+
# @return [String]
|
662
662
|
#
|
663
|
-
#
|
664
|
-
#
|
663
|
+
# @!attribute [rw] name
|
664
|
+
# The name of the lifecycle policy.
|
665
665
|
# @return [String]
|
666
666
|
#
|
667
667
|
# @!attribute [rw] description
|
668
668
|
# A description of the lifecycle policy.
|
669
669
|
# @return [String]
|
670
670
|
#
|
671
|
-
# @!attribute [rw] name
|
672
|
-
# The name of the lifecycle policy.
|
673
|
-
# @return [String]
|
674
|
-
#
|
675
671
|
# @!attribute [rw] policy
|
676
672
|
# The JSON policy document to use as the content for the lifecycle
|
677
673
|
# policy.
|
678
674
|
# @return [String]
|
679
675
|
#
|
680
|
-
# @!attribute [rw]
|
681
|
-
#
|
676
|
+
# @!attribute [rw] client_token
|
677
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
678
|
+
# request.
|
679
|
+
#
|
680
|
+
# **A suitable default value is auto-generated.** You should normally
|
681
|
+
# not need to pass this option.
|
682
682
|
# @return [String]
|
683
683
|
#
|
684
684
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateLifecyclePolicyRequest AWS API Documentation
|
685
685
|
#
|
686
686
|
class CreateLifecyclePolicyRequest < Struct.new(
|
687
|
-
:
|
688
|
-
:description,
|
687
|
+
:type,
|
689
688
|
:name,
|
689
|
+
:description,
|
690
690
|
:policy,
|
691
|
-
:
|
691
|
+
:client_token)
|
692
692
|
SENSITIVE = []
|
693
693
|
include Aws::Structure
|
694
694
|
end
|
@@ -705,46 +705,46 @@ module Aws::OpenSearchServerless
|
|
705
705
|
include Aws::Structure
|
706
706
|
end
|
707
707
|
|
708
|
-
# @!attribute [rw]
|
709
|
-
#
|
710
|
-
#
|
708
|
+
# @!attribute [rw] type
|
709
|
+
# The type of security configuration.
|
710
|
+
# @return [String]
|
711
711
|
#
|
712
|
-
#
|
713
|
-
#
|
712
|
+
# @!attribute [rw] name
|
713
|
+
# The name of the security configuration.
|
714
714
|
# @return [String]
|
715
715
|
#
|
716
716
|
# @!attribute [rw] description
|
717
717
|
# A description of the security configuration.
|
718
718
|
# @return [String]
|
719
719
|
#
|
720
|
+
# @!attribute [rw] saml_options
|
721
|
+
# Describes SAML options in in the form of a key-value map. This field
|
722
|
+
# is required if you specify `saml` for the `type` parameter.
|
723
|
+
# @return [Types::SamlConfigOptions]
|
724
|
+
#
|
720
725
|
# @!attribute [rw] iam_identity_center_options
|
721
726
|
# Describes IAM Identity Center options in the form of a key-value
|
722
727
|
# map. This field is required if you specify iamidentitycenter for the
|
723
728
|
# type parameter.
|
724
729
|
# @return [Types::CreateIamIdentityCenterConfigOptions]
|
725
730
|
#
|
726
|
-
# @!attribute [rw]
|
727
|
-
#
|
728
|
-
#
|
729
|
-
#
|
730
|
-
# @!attribute [rw] saml_options
|
731
|
-
# Describes SAML options in in the form of a key-value map. This field
|
732
|
-
# is required if you specify `saml` for the `type` parameter.
|
733
|
-
# @return [Types::SamlConfigOptions]
|
731
|
+
# @!attribute [rw] client_token
|
732
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
733
|
+
# request.
|
734
734
|
#
|
735
|
-
#
|
736
|
-
#
|
735
|
+
# **A suitable default value is auto-generated.** You should normally
|
736
|
+
# not need to pass this option.
|
737
737
|
# @return [String]
|
738
738
|
#
|
739
739
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityConfigRequest AWS API Documentation
|
740
740
|
#
|
741
741
|
class CreateSecurityConfigRequest < Struct.new(
|
742
|
-
:
|
743
|
-
:description,
|
744
|
-
:iam_identity_center_options,
|
742
|
+
:type,
|
745
743
|
:name,
|
744
|
+
:description,
|
746
745
|
:saml_options,
|
747
|
-
:
|
746
|
+
:iam_identity_center_options,
|
747
|
+
:client_token)
|
748
748
|
SENSITIVE = []
|
749
749
|
include Aws::Structure
|
750
750
|
end
|
@@ -761,12 +761,12 @@ module Aws::OpenSearchServerless
|
|
761
761
|
include Aws::Structure
|
762
762
|
end
|
763
763
|
|
764
|
-
# @!attribute [rw]
|
765
|
-
#
|
766
|
-
#
|
764
|
+
# @!attribute [rw] type
|
765
|
+
# The type of security policy.
|
766
|
+
# @return [String]
|
767
767
|
#
|
768
|
-
#
|
769
|
-
#
|
768
|
+
# @!attribute [rw] name
|
769
|
+
# The name of the policy.
|
770
770
|
# @return [String]
|
771
771
|
#
|
772
772
|
# @!attribute [rw] description
|
@@ -774,26 +774,26 @@ module Aws::OpenSearchServerless
|
|
774
774
|
# about the permissions defined in the policy.
|
775
775
|
# @return [String]
|
776
776
|
#
|
777
|
-
# @!attribute [rw] name
|
778
|
-
# The name of the policy.
|
779
|
-
# @return [String]
|
780
|
-
#
|
781
777
|
# @!attribute [rw] policy
|
782
778
|
# The JSON policy document to use as the content for the new policy.
|
783
779
|
# @return [String]
|
784
780
|
#
|
785
|
-
# @!attribute [rw]
|
786
|
-
#
|
781
|
+
# @!attribute [rw] client_token
|
782
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
783
|
+
# request.
|
784
|
+
#
|
785
|
+
# **A suitable default value is auto-generated.** You should normally
|
786
|
+
# not need to pass this option.
|
787
787
|
# @return [String]
|
788
788
|
#
|
789
789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityPolicyRequest AWS API Documentation
|
790
790
|
#
|
791
791
|
class CreateSecurityPolicyRequest < Struct.new(
|
792
|
-
:
|
793
|
-
:description,
|
792
|
+
:type,
|
794
793
|
:name,
|
794
|
+
:description,
|
795
795
|
:policy,
|
796
|
-
:
|
796
|
+
:client_token)
|
797
797
|
SENSITIVE = []
|
798
798
|
include Aws::Structure
|
799
799
|
end
|
@@ -840,41 +840,41 @@ module Aws::OpenSearchServerless
|
|
840
840
|
include Aws::Structure
|
841
841
|
end
|
842
842
|
|
843
|
-
# @!attribute [rw] client_token
|
844
|
-
# Unique, case-sensitive identifier to ensure idempotency of the
|
845
|
-
# request.
|
846
|
-
#
|
847
|
-
# **A suitable default value is auto-generated.** You should normally
|
848
|
-
# not need to pass this option.
|
849
|
-
# @return [String]
|
850
|
-
#
|
851
843
|
# @!attribute [rw] name
|
852
844
|
# The name of the interface endpoint.
|
853
845
|
# @return [String]
|
854
846
|
#
|
847
|
+
# @!attribute [rw] vpc_id
|
848
|
+
# The ID of the VPC from which you'll access OpenSearch Serverless.
|
849
|
+
# @return [String]
|
850
|
+
#
|
851
|
+
# @!attribute [rw] subnet_ids
|
852
|
+
# The ID of one or more subnets from which you'll access OpenSearch
|
853
|
+
# Serverless.
|
854
|
+
# @return [Array<String>]
|
855
|
+
#
|
855
856
|
# @!attribute [rw] security_group_ids
|
856
857
|
# The unique identifiers of the security groups that define the ports,
|
857
858
|
# protocols, and sources for inbound traffic that you are authorizing
|
858
859
|
# into your endpoint.
|
859
860
|
# @return [Array<String>]
|
860
861
|
#
|
861
|
-
# @!attribute [rw]
|
862
|
-
#
|
863
|
-
#
|
864
|
-
# @return [Array<String>]
|
862
|
+
# @!attribute [rw] client_token
|
863
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
864
|
+
# request.
|
865
865
|
#
|
866
|
-
#
|
867
|
-
#
|
866
|
+
# **A suitable default value is auto-generated.** You should normally
|
867
|
+
# not need to pass this option.
|
868
868
|
# @return [String]
|
869
869
|
#
|
870
870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateVpcEndpointRequest AWS API Documentation
|
871
871
|
#
|
872
872
|
class CreateVpcEndpointRequest < Struct.new(
|
873
|
-
:client_token,
|
874
873
|
:name,
|
875
|
-
:
|
874
|
+
:vpc_id,
|
876
875
|
:subnet_ids,
|
877
|
-
:
|
876
|
+
:security_group_ids,
|
877
|
+
:client_token)
|
878
878
|
SENSITIVE = []
|
879
879
|
include Aws::Structure
|
880
880
|
end
|
@@ -891,28 +891,28 @@ module Aws::OpenSearchServerless
|
|
891
891
|
include Aws::Structure
|
892
892
|
end
|
893
893
|
|
894
|
-
# @!attribute [rw]
|
895
|
-
#
|
896
|
-
# request.
|
897
|
-
#
|
898
|
-
# **A suitable default value is auto-generated.** You should normally
|
899
|
-
# not need to pass this option.
|
894
|
+
# @!attribute [rw] type
|
895
|
+
# The type of policy.
|
900
896
|
# @return [String]
|
901
897
|
#
|
902
898
|
# @!attribute [rw] name
|
903
899
|
# The name of the policy to delete.
|
904
900
|
# @return [String]
|
905
901
|
#
|
906
|
-
# @!attribute [rw]
|
907
|
-
#
|
902
|
+
# @!attribute [rw] client_token
|
903
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
904
|
+
# request.
|
905
|
+
#
|
906
|
+
# **A suitable default value is auto-generated.** You should normally
|
907
|
+
# not need to pass this option.
|
908
908
|
# @return [String]
|
909
909
|
#
|
910
910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteAccessPolicyRequest AWS API Documentation
|
911
911
|
#
|
912
912
|
class DeleteAccessPolicyRequest < Struct.new(
|
913
|
-
:
|
913
|
+
:type,
|
914
914
|
:name,
|
915
|
-
:
|
915
|
+
:client_token)
|
916
916
|
SENSITIVE = []
|
917
917
|
include Aws::Structure
|
918
918
|
end
|
@@ -945,14 +945,6 @@ module Aws::OpenSearchServerless
|
|
945
945
|
include Aws::Structure
|
946
946
|
end
|
947
947
|
|
948
|
-
# @!attribute [rw] client_token
|
949
|
-
# A unique, case-sensitive identifier to ensure idempotency of the
|
950
|
-
# request.
|
951
|
-
#
|
952
|
-
# **A suitable default value is auto-generated.** You should normally
|
953
|
-
# not need to pass this option.
|
954
|
-
# @return [String]
|
955
|
-
#
|
956
948
|
# @!attribute [rw] id
|
957
949
|
# The unique identifier of the collection. For example,
|
958
950
|
# `1iu5usc406kd`. The ID is part of the collection endpoint. You can
|
@@ -963,11 +955,19 @@ module Aws::OpenSearchServerless
|
|
963
955
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html
|
964
956
|
# @return [String]
|
965
957
|
#
|
958
|
+
# @!attribute [rw] client_token
|
959
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
960
|
+
# request.
|
961
|
+
#
|
962
|
+
# **A suitable default value is auto-generated.** You should normally
|
963
|
+
# not need to pass this option.
|
964
|
+
# @return [String]
|
965
|
+
#
|
966
966
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteCollectionRequest AWS API Documentation
|
967
967
|
#
|
968
968
|
class DeleteCollectionRequest < Struct.new(
|
969
|
-
:
|
970
|
-
:
|
969
|
+
:id,
|
970
|
+
:client_token)
|
971
971
|
SENSITIVE = []
|
972
972
|
include Aws::Structure
|
973
973
|
end
|
@@ -984,28 +984,28 @@ module Aws::OpenSearchServerless
|
|
984
984
|
include Aws::Structure
|
985
985
|
end
|
986
986
|
|
987
|
-
# @!attribute [rw]
|
988
|
-
#
|
989
|
-
# request.
|
990
|
-
#
|
991
|
-
# **A suitable default value is auto-generated.** You should normally
|
992
|
-
# not need to pass this option.
|
987
|
+
# @!attribute [rw] type
|
988
|
+
# The type of lifecycle policy.
|
993
989
|
# @return [String]
|
994
990
|
#
|
995
991
|
# @!attribute [rw] name
|
996
992
|
# The name of the policy to delete.
|
997
993
|
# @return [String]
|
998
994
|
#
|
999
|
-
# @!attribute [rw]
|
1000
|
-
#
|
995
|
+
# @!attribute [rw] client_token
|
996
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
997
|
+
# request.
|
998
|
+
#
|
999
|
+
# **A suitable default value is auto-generated.** You should normally
|
1000
|
+
# not need to pass this option.
|
1001
1001
|
# @return [String]
|
1002
1002
|
#
|
1003
1003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteLifecyclePolicyRequest AWS API Documentation
|
1004
1004
|
#
|
1005
1005
|
class DeleteLifecyclePolicyRequest < Struct.new(
|
1006
|
-
:
|
1006
|
+
:type,
|
1007
1007
|
:name,
|
1008
|
-
:
|
1008
|
+
:client_token)
|
1009
1009
|
SENSITIVE = []
|
1010
1010
|
include Aws::Structure
|
1011
1011
|
end
|
@@ -1014,6 +1014,12 @@ module Aws::OpenSearchServerless
|
|
1014
1014
|
#
|
1015
1015
|
class DeleteLifecyclePolicyResponse < Aws::EmptyStructure; end
|
1016
1016
|
|
1017
|
+
# @!attribute [rw] id
|
1018
|
+
# The security configuration identifier. For SAML the ID will be
|
1019
|
+
# `saml/<accountId>/<idpProviderName>`. For example,
|
1020
|
+
# `saml/123456789123/OKTADev`.
|
1021
|
+
# @return [String]
|
1022
|
+
#
|
1017
1023
|
# @!attribute [rw] client_token
|
1018
1024
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
1019
1025
|
# request.
|
@@ -1022,17 +1028,11 @@ module Aws::OpenSearchServerless
|
|
1022
1028
|
# not need to pass this option.
|
1023
1029
|
# @return [String]
|
1024
1030
|
#
|
1025
|
-
# @!attribute [rw] id
|
1026
|
-
# The security configuration identifier. For SAML the ID will be
|
1027
|
-
# `saml/<accountId>/<idpProviderName>`. For example,
|
1028
|
-
# `saml/123456789123/OKTADev`.
|
1029
|
-
# @return [String]
|
1030
|
-
#
|
1031
1031
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityConfigRequest AWS API Documentation
|
1032
1032
|
#
|
1033
1033
|
class DeleteSecurityConfigRequest < Struct.new(
|
1034
|
-
:
|
1035
|
-
:
|
1034
|
+
:id,
|
1035
|
+
:client_token)
|
1036
1036
|
SENSITIVE = []
|
1037
1037
|
include Aws::Structure
|
1038
1038
|
end
|
@@ -1041,28 +1041,28 @@ module Aws::OpenSearchServerless
|
|
1041
1041
|
#
|
1042
1042
|
class DeleteSecurityConfigResponse < Aws::EmptyStructure; end
|
1043
1043
|
|
1044
|
-
# @!attribute [rw]
|
1045
|
-
#
|
1046
|
-
# request.
|
1047
|
-
#
|
1048
|
-
# **A suitable default value is auto-generated.** You should normally
|
1049
|
-
# not need to pass this option.
|
1044
|
+
# @!attribute [rw] type
|
1045
|
+
# The type of policy.
|
1050
1046
|
# @return [String]
|
1051
1047
|
#
|
1052
1048
|
# @!attribute [rw] name
|
1053
1049
|
# The name of the policy to delete.
|
1054
1050
|
# @return [String]
|
1055
1051
|
#
|
1056
|
-
# @!attribute [rw]
|
1057
|
-
#
|
1052
|
+
# @!attribute [rw] client_token
|
1053
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
1054
|
+
# request.
|
1055
|
+
#
|
1056
|
+
# **A suitable default value is auto-generated.** You should normally
|
1057
|
+
# not need to pass this option.
|
1058
1058
|
# @return [String]
|
1059
1059
|
#
|
1060
1060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityPolicyRequest AWS API Documentation
|
1061
1061
|
#
|
1062
1062
|
class DeleteSecurityPolicyRequest < Struct.new(
|
1063
|
-
:
|
1063
|
+
:type,
|
1064
1064
|
:name,
|
1065
|
-
:
|
1065
|
+
:client_token)
|
1066
1066
|
SENSITIVE = []
|
1067
1067
|
include Aws::Structure
|
1068
1068
|
end
|
@@ -1096,6 +1096,10 @@ module Aws::OpenSearchServerless
|
|
1096
1096
|
include Aws::Structure
|
1097
1097
|
end
|
1098
1098
|
|
1099
|
+
# @!attribute [rw] id
|
1100
|
+
# The VPC endpoint identifier.
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1099
1103
|
# @!attribute [rw] client_token
|
1100
1104
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
1101
1105
|
# request.
|
@@ -1104,15 +1108,11 @@ module Aws::OpenSearchServerless
|
|
1104
1108
|
# not need to pass this option.
|
1105
1109
|
# @return [String]
|
1106
1110
|
#
|
1107
|
-
# @!attribute [rw] id
|
1108
|
-
# The VPC endpoint identifier.
|
1109
|
-
# @return [String]
|
1110
|
-
#
|
1111
1111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteVpcEndpointRequest AWS API Documentation
|
1112
1112
|
#
|
1113
1113
|
class DeleteVpcEndpointRequest < Struct.new(
|
1114
|
-
:
|
1115
|
-
:
|
1114
|
+
:id,
|
1115
|
+
:client_token)
|
1116
1116
|
SENSITIVE = []
|
1117
1117
|
include Aws::Structure
|
1118
1118
|
end
|
@@ -1131,23 +1131,21 @@ module Aws::OpenSearchServerless
|
|
1131
1131
|
|
1132
1132
|
# Error information for an OpenSearch Serverless request.
|
1133
1133
|
#
|
1134
|
-
# @!attribute [rw]
|
1135
|
-
# The
|
1136
|
-
# param that will return as `true` if the minimum number of days or
|
1137
|
-
# hours is not set to a index resource.
|
1138
|
-
# @return [Boolean]
|
1139
|
-
#
|
1140
|
-
# @!attribute [rw] policy_name
|
1141
|
-
# The name of the lifecycle policy.
|
1134
|
+
# @!attribute [rw] type
|
1135
|
+
# The type of lifecycle policy.
|
1142
1136
|
# @return [String]
|
1143
1137
|
#
|
1144
1138
|
# @!attribute [rw] resource
|
1145
1139
|
# The name of the OpenSearch Serverless index resource.
|
1146
1140
|
# @return [String]
|
1147
1141
|
#
|
1148
|
-
# @!attribute [rw]
|
1149
|
-
# The
|
1150
|
-
#
|
1142
|
+
# @!attribute [rw] policy_name
|
1143
|
+
# The name of the lifecycle policy.
|
1144
|
+
# @return [String]
|
1145
|
+
#
|
1146
|
+
# @!attribute [rw] resource_type
|
1147
|
+
# The type of OpenSearch Serverless resource. Currently, the only
|
1148
|
+
# supported resource is `index`.
|
1151
1149
|
# @return [String]
|
1152
1150
|
#
|
1153
1151
|
# @!attribute [rw] retention_period
|
@@ -1155,27 +1153,33 @@ module Aws::OpenSearchServerless
|
|
1155
1153
|
# optional parameter that will return only if it’s set.
|
1156
1154
|
# @return [String]
|
1157
1155
|
#
|
1158
|
-
# @!attribute [rw]
|
1159
|
-
# The
|
1160
|
-
#
|
1156
|
+
# @!attribute [rw] no_min_retention_period
|
1157
|
+
# The minimum number of index retention days set. That is an optional
|
1158
|
+
# param that will return as `true` if the minimum number of days or
|
1159
|
+
# hours is not set to a index resource.
|
1160
|
+
# @return [Boolean]
|
1161
1161
|
#
|
1162
1162
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyDetail AWS API Documentation
|
1163
1163
|
#
|
1164
1164
|
class EffectiveLifecyclePolicyDetail < Struct.new(
|
1165
|
-
:
|
1166
|
-
:policy_name,
|
1165
|
+
:type,
|
1167
1166
|
:resource,
|
1167
|
+
:policy_name,
|
1168
1168
|
:resource_type,
|
1169
1169
|
:retention_period,
|
1170
|
-
:
|
1170
|
+
:no_min_retention_period)
|
1171
1171
|
SENSITIVE = []
|
1172
1172
|
include Aws::Structure
|
1173
1173
|
end
|
1174
1174
|
|
1175
1175
|
# Error information for an OpenSearch Serverless request.
|
1176
1176
|
#
|
1177
|
-
# @!attribute [rw]
|
1178
|
-
# The
|
1177
|
+
# @!attribute [rw] type
|
1178
|
+
# The type of lifecycle policy.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] resource
|
1182
|
+
# The name of OpenSearch Serverless index resource.
|
1179
1183
|
# @return [String]
|
1180
1184
|
#
|
1181
1185
|
# @!attribute [rw] error_message
|
@@ -1183,38 +1187,34 @@ module Aws::OpenSearchServerless
|
|
1183
1187
|
# resource is not found`.
|
1184
1188
|
# @return [String]
|
1185
1189
|
#
|
1186
|
-
# @!attribute [rw]
|
1187
|
-
# The
|
1188
|
-
# @return [String]
|
1189
|
-
#
|
1190
|
-
# @!attribute [rw] type
|
1191
|
-
# The type of lifecycle policy.
|
1190
|
+
# @!attribute [rw] error_code
|
1191
|
+
# The error code for the request.
|
1192
1192
|
# @return [String]
|
1193
1193
|
#
|
1194
1194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/EffectiveLifecyclePolicyErrorDetail AWS API Documentation
|
1195
1195
|
#
|
1196
1196
|
class EffectiveLifecyclePolicyErrorDetail < Struct.new(
|
1197
|
-
:
|
1198
|
-
:error_message,
|
1197
|
+
:type,
|
1199
1198
|
:resource,
|
1200
|
-
:
|
1199
|
+
:error_message,
|
1200
|
+
:error_code)
|
1201
1201
|
SENSITIVE = []
|
1202
1202
|
include Aws::Structure
|
1203
1203
|
end
|
1204
1204
|
|
1205
|
-
# @!attribute [rw] name
|
1206
|
-
# The name of the access policy.
|
1207
|
-
# @return [String]
|
1208
|
-
#
|
1209
1205
|
# @!attribute [rw] type
|
1210
1206
|
# Tye type of policy. Currently, the only supported value is `data`.
|
1211
1207
|
# @return [String]
|
1212
1208
|
#
|
1209
|
+
# @!attribute [rw] name
|
1210
|
+
# The name of the access policy.
|
1211
|
+
# @return [String]
|
1212
|
+
#
|
1213
1213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccessPolicyRequest AWS API Documentation
|
1214
1214
|
#
|
1215
1215
|
class GetAccessPolicyRequest < Struct.new(
|
1216
|
-
:
|
1217
|
-
:
|
1216
|
+
:type,
|
1217
|
+
:name)
|
1218
1218
|
SENSITIVE = []
|
1219
1219
|
include Aws::Structure
|
1220
1220
|
end
|
@@ -1259,17 +1259,17 @@ module Aws::OpenSearchServerless
|
|
1259
1259
|
# Information about the data access policies in your account.
|
1260
1260
|
# @return [Types::AccessPolicyStats]
|
1261
1261
|
#
|
1262
|
-
# @!attribute [rw]
|
1263
|
-
# Information about the
|
1264
|
-
# @return [Types::
|
1262
|
+
# @!attribute [rw] security_policy_stats
|
1263
|
+
# Information about the security policies in your account.
|
1264
|
+
# @return [Types::SecurityPolicyStats]
|
1265
1265
|
#
|
1266
1266
|
# @!attribute [rw] security_config_stats
|
1267
1267
|
# Information about the security configurations in your account.
|
1268
1268
|
# @return [Types::SecurityConfigStats]
|
1269
1269
|
#
|
1270
|
-
# @!attribute [rw]
|
1271
|
-
# Information about the
|
1272
|
-
# @return [Types::
|
1270
|
+
# @!attribute [rw] lifecycle_policy_stats
|
1271
|
+
# Information about the lifecycle policies in your account.
|
1272
|
+
# @return [Types::LifecyclePolicyStats]
|
1273
1273
|
#
|
1274
1274
|
# @!attribute [rw] total_policy_count
|
1275
1275
|
# The total number of OpenSearch Serverless security policies and
|
@@ -1280,9 +1280,9 @@ module Aws::OpenSearchServerless
|
|
1280
1280
|
#
|
1281
1281
|
class GetPoliciesStatsResponse < Struct.new(
|
1282
1282
|
:access_policy_stats,
|
1283
|
-
:lifecycle_policy_stats,
|
1284
|
-
:security_config_stats,
|
1285
1283
|
:security_policy_stats,
|
1284
|
+
:security_config_stats,
|
1285
|
+
:lifecycle_policy_stats,
|
1286
1286
|
:total_policy_count)
|
1287
1287
|
SENSITIVE = []
|
1288
1288
|
include Aws::Structure
|
@@ -1312,19 +1312,19 @@ module Aws::OpenSearchServerless
|
|
1312
1312
|
include Aws::Structure
|
1313
1313
|
end
|
1314
1314
|
|
1315
|
-
# @!attribute [rw] name
|
1316
|
-
# The name of the security policy.
|
1317
|
-
# @return [String]
|
1318
|
-
#
|
1319
1315
|
# @!attribute [rw] type
|
1320
1316
|
# The type of security policy.
|
1321
1317
|
# @return [String]
|
1322
1318
|
#
|
1319
|
+
# @!attribute [rw] name
|
1320
|
+
# The name of the security policy.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
1323
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityPolicyRequest AWS API Documentation
|
1324
1324
|
#
|
1325
1325
|
class GetSecurityPolicyRequest < Struct.new(
|
1326
|
-
:
|
1327
|
-
:
|
1326
|
+
:type,
|
1327
|
+
:name)
|
1328
1328
|
SENSITIVE = []
|
1329
1329
|
include Aws::Structure
|
1330
1330
|
end
|
@@ -1344,29 +1344,24 @@ module Aws::OpenSearchServerless
|
|
1344
1344
|
# Describes IAM Identity Center options for an OpenSearch Serverless
|
1345
1345
|
# security configuration in the form of a key-value map.
|
1346
1346
|
#
|
1347
|
+
# @!attribute [rw] instance_arn
|
1348
|
+
# The ARN of the IAM Identity Center instance used to integrate with
|
1349
|
+
# OpenSearch Serverless.
|
1350
|
+
# @return [String]
|
1351
|
+
#
|
1347
1352
|
# @!attribute [rw] application_arn
|
1348
1353
|
# The ARN of the IAM Identity Center application used to integrate
|
1349
1354
|
# with OpenSearch Serverless.
|
1350
1355
|
# @return [String]
|
1351
1356
|
#
|
1352
|
-
# @!attribute [rw] application_description
|
1353
|
-
# The description of the IAM Identity Center application used to
|
1354
|
-
# integrate with OpenSearch Serverless.
|
1355
|
-
# @return [String]
|
1356
|
-
#
|
1357
1357
|
# @!attribute [rw] application_name
|
1358
1358
|
# The name of the IAM Identity Center application used to integrate
|
1359
1359
|
# with OpenSearch Serverless.
|
1360
1360
|
# @return [String]
|
1361
1361
|
#
|
1362
|
-
# @!attribute [rw]
|
1363
|
-
# The
|
1364
|
-
#
|
1365
|
-
# @return [String]
|
1366
|
-
#
|
1367
|
-
# @!attribute [rw] instance_arn
|
1368
|
-
# The ARN of the IAM Identity Center instance used to integrate with
|
1369
|
-
# OpenSearch Serverless.
|
1362
|
+
# @!attribute [rw] application_description
|
1363
|
+
# The description of the IAM Identity Center application used to
|
1364
|
+
# integrate with OpenSearch Serverless.
|
1370
1365
|
# @return [String]
|
1371
1366
|
#
|
1372
1367
|
# @!attribute [rw] user_attribute
|
@@ -1374,15 +1369,20 @@ module Aws::OpenSearchServerless
|
|
1374
1369
|
# Defaults to `UserId`
|
1375
1370
|
# @return [String]
|
1376
1371
|
#
|
1372
|
+
# @!attribute [rw] group_attribute
|
1373
|
+
# The group attribute for this IAM Identity Center integration.
|
1374
|
+
# Defaults to `GroupId`.
|
1375
|
+
# @return [String]
|
1376
|
+
#
|
1377
1377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/IamIdentityCenterConfigOptions AWS API Documentation
|
1378
1378
|
#
|
1379
1379
|
class IamIdentityCenterConfigOptions < Struct.new(
|
1380
|
+
:instance_arn,
|
1380
1381
|
:application_arn,
|
1381
|
-
:application_description,
|
1382
1382
|
:application_name,
|
1383
|
-
:
|
1384
|
-
:
|
1385
|
-
:
|
1383
|
+
:application_description,
|
1384
|
+
:user_attribute,
|
1385
|
+
:group_attribute)
|
1386
1386
|
SENSITIVE = []
|
1387
1387
|
include Aws::Structure
|
1388
1388
|
end
|
@@ -1403,52 +1403,56 @@ module Aws::OpenSearchServerless
|
|
1403
1403
|
|
1404
1404
|
# Details about an OpenSearch Serverless lifecycle policy.
|
1405
1405
|
#
|
1406
|
-
# @!attribute [rw]
|
1407
|
-
# The
|
1408
|
-
# @return [Integer]
|
1409
|
-
#
|
1410
|
-
# @!attribute [rw] description
|
1411
|
-
# The description of the lifecycle policy.
|
1406
|
+
# @!attribute [rw] type
|
1407
|
+
# The type of lifecycle policy.
|
1412
1408
|
# @return [String]
|
1413
1409
|
#
|
1414
|
-
# @!attribute [rw] last_modified_date
|
1415
|
-
# The timestamp of when the lifecycle policy was last modified.
|
1416
|
-
# @return [Integer]
|
1417
|
-
#
|
1418
1410
|
# @!attribute [rw] name
|
1419
1411
|
# The name of the lifecycle policy.
|
1420
1412
|
# @return [String]
|
1421
1413
|
#
|
1422
|
-
# @!attribute [rw] policy
|
1423
|
-
# The JSON policy document without any whitespaces.
|
1424
|
-
# @return [Hash,Array,String,Numeric,Boolean]
|
1425
|
-
#
|
1426
1414
|
# @!attribute [rw] policy_version
|
1427
1415
|
# The version of the lifecycle policy.
|
1428
1416
|
# @return [String]
|
1429
1417
|
#
|
1430
|
-
# @!attribute [rw]
|
1431
|
-
# The
|
1418
|
+
# @!attribute [rw] description
|
1419
|
+
# The description of the lifecycle policy.
|
1432
1420
|
# @return [String]
|
1433
1421
|
#
|
1422
|
+
# @!attribute [rw] policy
|
1423
|
+
# The JSON policy document without any whitespaces.
|
1424
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
1425
|
+
#
|
1426
|
+
# @!attribute [rw] created_date
|
1427
|
+
# The date the lifecycle policy was created.
|
1428
|
+
# @return [Integer]
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] last_modified_date
|
1431
|
+
# The timestamp of when the lifecycle policy was last modified.
|
1432
|
+
# @return [Integer]
|
1433
|
+
#
|
1434
1434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/LifecyclePolicyDetail AWS API Documentation
|
1435
1435
|
#
|
1436
1436
|
class LifecyclePolicyDetail < Struct.new(
|
1437
|
-
:
|
1438
|
-
:description,
|
1439
|
-
:last_modified_date,
|
1437
|
+
:type,
|
1440
1438
|
:name,
|
1441
|
-
:policy,
|
1442
1439
|
:policy_version,
|
1443
|
-
:
|
1440
|
+
:description,
|
1441
|
+
:policy,
|
1442
|
+
:created_date,
|
1443
|
+
:last_modified_date)
|
1444
1444
|
SENSITIVE = []
|
1445
1445
|
include Aws::Structure
|
1446
1446
|
end
|
1447
1447
|
|
1448
1448
|
# Error information for an OpenSearch Serverless request.
|
1449
1449
|
#
|
1450
|
-
# @!attribute [rw]
|
1451
|
-
# The
|
1450
|
+
# @!attribute [rw] type
|
1451
|
+
# The type of lifecycle policy.
|
1452
|
+
# @return [String]
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] name
|
1455
|
+
# The name of the lifecycle policy.
|
1452
1456
|
# @return [String]
|
1453
1457
|
#
|
1454
1458
|
# @!attribute [rw] error_message
|
@@ -1456,59 +1460,55 @@ module Aws::OpenSearchServerless
|
|
1456
1460
|
# Policy is not found`.
|
1457
1461
|
# @return [String]
|
1458
1462
|
#
|
1459
|
-
# @!attribute [rw]
|
1460
|
-
# The
|
1461
|
-
# @return [String]
|
1462
|
-
#
|
1463
|
-
# @!attribute [rw] type
|
1464
|
-
# The type of lifecycle policy.
|
1463
|
+
# @!attribute [rw] error_code
|
1464
|
+
# The error code for the request. For example, `NOT_FOUND`.
|
1465
1465
|
# @return [String]
|
1466
1466
|
#
|
1467
1467
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/LifecyclePolicyErrorDetail AWS API Documentation
|
1468
1468
|
#
|
1469
1469
|
class LifecyclePolicyErrorDetail < Struct.new(
|
1470
|
-
:
|
1471
|
-
:error_message,
|
1470
|
+
:type,
|
1472
1471
|
:name,
|
1473
|
-
:
|
1472
|
+
:error_message,
|
1473
|
+
:error_code)
|
1474
1474
|
SENSITIVE = []
|
1475
1475
|
include Aws::Structure
|
1476
1476
|
end
|
1477
1477
|
|
1478
1478
|
# The unique identifiers of policy types and policy names.
|
1479
1479
|
#
|
1480
|
-
# @!attribute [rw] name
|
1481
|
-
# The name of the lifecycle policy.
|
1482
|
-
# @return [String]
|
1483
|
-
#
|
1484
1480
|
# @!attribute [rw] type
|
1485
1481
|
# The type of lifecycle policy.
|
1486
1482
|
# @return [String]
|
1487
1483
|
#
|
1484
|
+
# @!attribute [rw] name
|
1485
|
+
# The name of the lifecycle policy.
|
1486
|
+
# @return [String]
|
1487
|
+
#
|
1488
1488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/LifecyclePolicyIdentifier AWS API Documentation
|
1489
1489
|
#
|
1490
1490
|
class LifecyclePolicyIdentifier < Struct.new(
|
1491
|
-
:
|
1492
|
-
:
|
1491
|
+
:type,
|
1492
|
+
:name)
|
1493
1493
|
SENSITIVE = []
|
1494
1494
|
include Aws::Structure
|
1495
1495
|
end
|
1496
1496
|
|
1497
1497
|
# The unique identifiers of policy types and resource names.
|
1498
1498
|
#
|
1499
|
-
# @!attribute [rw] resource
|
1500
|
-
# The name of the OpenSearch Serverless ilndex resource.
|
1501
|
-
# @return [String]
|
1502
|
-
#
|
1503
1499
|
# @!attribute [rw] type
|
1504
1500
|
# The type of lifecycle policy.
|
1505
1501
|
# @return [String]
|
1506
1502
|
#
|
1503
|
+
# @!attribute [rw] resource
|
1504
|
+
# The name of the OpenSearch Serverless ilndex resource.
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1507
1507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/LifecyclePolicyResourceIdentifier AWS API Documentation
|
1508
1508
|
#
|
1509
1509
|
class LifecyclePolicyResourceIdentifier < Struct.new(
|
1510
|
-
:
|
1511
|
-
:
|
1510
|
+
:type,
|
1511
|
+
:resource)
|
1512
1512
|
SENSITIVE = []
|
1513
1513
|
include Aws::Structure
|
1514
1514
|
end
|
@@ -1529,18 +1529,10 @@ module Aws::OpenSearchServerless
|
|
1529
1529
|
|
1530
1530
|
# A summary of the lifecycle policy.
|
1531
1531
|
#
|
1532
|
-
# @!attribute [rw]
|
1533
|
-
# The
|
1534
|
-
# @return [Integer]
|
1535
|
-
#
|
1536
|
-
# @!attribute [rw] description
|
1537
|
-
# The description of the lifecycle policy.
|
1532
|
+
# @!attribute [rw] type
|
1533
|
+
# The type of lifecycle policy.
|
1538
1534
|
# @return [String]
|
1539
1535
|
#
|
1540
|
-
# @!attribute [rw] last_modified_date
|
1541
|
-
# The date and time when the lifecycle policy was last modified.
|
1542
|
-
# @return [Integer]
|
1543
|
-
#
|
1544
1536
|
# @!attribute [rw] name
|
1545
1537
|
# The name of the lifecycle policy.
|
1546
1538
|
# @return [String]
|
@@ -1549,34 +1541,33 @@ module Aws::OpenSearchServerless
|
|
1549
1541
|
# The version of the lifecycle policy.
|
1550
1542
|
# @return [String]
|
1551
1543
|
#
|
1552
|
-
# @!attribute [rw]
|
1553
|
-
# The
|
1544
|
+
# @!attribute [rw] description
|
1545
|
+
# The description of the lifecycle policy.
|
1554
1546
|
# @return [String]
|
1555
1547
|
#
|
1548
|
+
# @!attribute [rw] created_date
|
1549
|
+
# The Epoch time when the lifecycle policy was created.
|
1550
|
+
# @return [Integer]
|
1551
|
+
#
|
1552
|
+
# @!attribute [rw] last_modified_date
|
1553
|
+
# The date and time when the lifecycle policy was last modified.
|
1554
|
+
# @return [Integer]
|
1555
|
+
#
|
1556
1556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/LifecyclePolicySummary AWS API Documentation
|
1557
1557
|
#
|
1558
1558
|
class LifecyclePolicySummary < Struct.new(
|
1559
|
-
:
|
1560
|
-
:description,
|
1561
|
-
:last_modified_date,
|
1559
|
+
:type,
|
1562
1560
|
:name,
|
1563
1561
|
:policy_version,
|
1564
|
-
:
|
1562
|
+
:description,
|
1563
|
+
:created_date,
|
1564
|
+
:last_modified_date)
|
1565
1565
|
SENSITIVE = []
|
1566
1566
|
include Aws::Structure
|
1567
1567
|
end
|
1568
1568
|
|
1569
|
-
# @!attribute [rw]
|
1570
|
-
#
|
1571
|
-
# to return. You can use `nextToken` to get the next page of results.
|
1572
|
-
# The default is 20.
|
1573
|
-
# @return [Integer]
|
1574
|
-
#
|
1575
|
-
# @!attribute [rw] next_token
|
1576
|
-
# If your initial `ListAccessPolicies` operation returns a
|
1577
|
-
# `nextToken`, you can include the returned `nextToken` in subsequent
|
1578
|
-
# `ListAccessPolicies` operations, which returns results in the next
|
1579
|
-
# page.
|
1569
|
+
# @!attribute [rw] type
|
1570
|
+
# The type of access policy.
|
1580
1571
|
# @return [String]
|
1581
1572
|
#
|
1582
1573
|
# @!attribute [rw] resource
|
@@ -1584,17 +1575,26 @@ module Aws::OpenSearchServerless
|
|
1584
1575
|
# apply to.
|
1585
1576
|
# @return [Array<String>]
|
1586
1577
|
#
|
1587
|
-
# @!attribute [rw]
|
1588
|
-
#
|
1578
|
+
# @!attribute [rw] next_token
|
1579
|
+
# If your initial `ListAccessPolicies` operation returns a
|
1580
|
+
# `nextToken`, you can include the returned `nextToken` in subsequent
|
1581
|
+
# `ListAccessPolicies` operations, which returns results in the next
|
1582
|
+
# page.
|
1589
1583
|
# @return [String]
|
1590
1584
|
#
|
1585
|
+
# @!attribute [rw] max_results
|
1586
|
+
# An optional parameter that specifies the maximum number of results
|
1587
|
+
# to return. You can use `nextToken` to get the next page of results.
|
1588
|
+
# The default is 20.
|
1589
|
+
# @return [Integer]
|
1590
|
+
#
|
1591
1591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListAccessPoliciesRequest AWS API Documentation
|
1592
1592
|
#
|
1593
1593
|
class ListAccessPoliciesRequest < Struct.new(
|
1594
|
-
:
|
1595
|
-
:next_token,
|
1594
|
+
:type,
|
1596
1595
|
:resource,
|
1597
|
-
:
|
1596
|
+
:next_token,
|
1597
|
+
:max_results)
|
1598
1598
|
SENSITIVE = []
|
1599
1599
|
include Aws::Structure
|
1600
1600
|
end
|
@@ -1623,11 +1623,6 @@ module Aws::OpenSearchServerless
|
|
1623
1623
|
# A list of filter names and values that you can use for requests.
|
1624
1624
|
# @return [Types::CollectionFilters]
|
1625
1625
|
#
|
1626
|
-
# @!attribute [rw] max_results
|
1627
|
-
# The maximum number of results to return. Default is 20. You can use
|
1628
|
-
# `nextToken` to get the next page of results.
|
1629
|
-
# @return [Integer]
|
1630
|
-
#
|
1631
1626
|
# @!attribute [rw] next_token
|
1632
1627
|
# If your initial `ListCollections` operation returns a `nextToken`,
|
1633
1628
|
# you can include the returned `nextToken` in subsequent
|
@@ -1635,12 +1630,17 @@ module Aws::OpenSearchServerless
|
|
1635
1630
|
# page.
|
1636
1631
|
# @return [String]
|
1637
1632
|
#
|
1633
|
+
# @!attribute [rw] max_results
|
1634
|
+
# The maximum number of results to return. Default is 20. You can use
|
1635
|
+
# `nextToken` to get the next page of results.
|
1636
|
+
# @return [Integer]
|
1637
|
+
#
|
1638
1638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollectionsRequest AWS API Documentation
|
1639
1639
|
#
|
1640
1640
|
class ListCollectionsRequest < Struct.new(
|
1641
1641
|
:collection_filters,
|
1642
|
-
:
|
1643
|
-
:
|
1642
|
+
:next_token,
|
1643
|
+
:max_results)
|
1644
1644
|
SENSITIVE = []
|
1645
1645
|
include Aws::Structure
|
1646
1646
|
end
|
@@ -1665,35 +1665,35 @@ module Aws::OpenSearchServerless
|
|
1665
1665
|
include Aws::Structure
|
1666
1666
|
end
|
1667
1667
|
|
1668
|
-
# @!attribute [rw]
|
1669
|
-
#
|
1670
|
-
#
|
1671
|
-
# results. The default is 10.
|
1672
|
-
# @return [Integer]
|
1673
|
-
#
|
1674
|
-
# @!attribute [rw] next_token
|
1675
|
-
# If your initial `ListLifecyclePolicies` operation returns a
|
1676
|
-
# `nextToken`, you can include the returned `nextToken` in subsequent
|
1677
|
-
# `ListLifecyclePolicies` operations, which returns results in the
|
1678
|
-
# next page.
|
1679
|
-
# @return [String]
|
1668
|
+
# @!attribute [rw] type
|
1669
|
+
# The type of lifecycle policy.
|
1670
|
+
# @return [String]
|
1680
1671
|
#
|
1681
1672
|
# @!attribute [rw] resources
|
1682
1673
|
# Resource filters that policies can apply to. Currently, the only
|
1683
1674
|
# supported resource type is `index`.
|
1684
1675
|
# @return [Array<String>]
|
1685
1676
|
#
|
1686
|
-
# @!attribute [rw]
|
1687
|
-
#
|
1677
|
+
# @!attribute [rw] next_token
|
1678
|
+
# If your initial `ListLifecyclePolicies` operation returns a
|
1679
|
+
# `nextToken`, you can include the returned `nextToken` in subsequent
|
1680
|
+
# `ListLifecyclePolicies` operations, which returns results in the
|
1681
|
+
# next page.
|
1688
1682
|
# @return [String]
|
1689
1683
|
#
|
1684
|
+
# @!attribute [rw] max_results
|
1685
|
+
# An optional parameter that specifies the maximum number of results
|
1686
|
+
# to return. You can use use `nextToken` to get the next page of
|
1687
|
+
# results. The default is 10.
|
1688
|
+
# @return [Integer]
|
1689
|
+
#
|
1690
1690
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListLifecyclePoliciesRequest AWS API Documentation
|
1691
1691
|
#
|
1692
1692
|
class ListLifecyclePoliciesRequest < Struct.new(
|
1693
|
-
:
|
1694
|
-
:next_token,
|
1693
|
+
:type,
|
1695
1694
|
:resources,
|
1696
|
-
:
|
1695
|
+
:next_token,
|
1696
|
+
:max_results)
|
1697
1697
|
SENSITIVE = []
|
1698
1698
|
include Aws::Structure
|
1699
1699
|
end
|
@@ -1718,11 +1718,9 @@ module Aws::OpenSearchServerless
|
|
1718
1718
|
include Aws::Structure
|
1719
1719
|
end
|
1720
1720
|
|
1721
|
-
# @!attribute [rw]
|
1722
|
-
#
|
1723
|
-
#
|
1724
|
-
# The default is 20.
|
1725
|
-
# @return [Integer]
|
1721
|
+
# @!attribute [rw] type
|
1722
|
+
# The type of security configuration.
|
1723
|
+
# @return [String]
|
1726
1724
|
#
|
1727
1725
|
# @!attribute [rw] next_token
|
1728
1726
|
# If your initial `ListSecurityConfigs` operation returns a
|
@@ -1731,20 +1729,26 @@ module Aws::OpenSearchServerless
|
|
1731
1729
|
# page.
|
1732
1730
|
# @return [String]
|
1733
1731
|
#
|
1734
|
-
# @!attribute [rw]
|
1735
|
-
#
|
1736
|
-
#
|
1732
|
+
# @!attribute [rw] max_results
|
1733
|
+
# An optional parameter that specifies the maximum number of results
|
1734
|
+
# to return. You can use `nextToken` to get the next page of results.
|
1735
|
+
# The default is 20.
|
1736
|
+
# @return [Integer]
|
1737
1737
|
#
|
1738
1738
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityConfigsRequest AWS API Documentation
|
1739
1739
|
#
|
1740
1740
|
class ListSecurityConfigsRequest < Struct.new(
|
1741
|
-
:
|
1741
|
+
:type,
|
1742
1742
|
:next_token,
|
1743
|
-
:
|
1743
|
+
:max_results)
|
1744
1744
|
SENSITIVE = []
|
1745
1745
|
include Aws::Structure
|
1746
1746
|
end
|
1747
1747
|
|
1748
|
+
# @!attribute [rw] security_config_summaries
|
1749
|
+
# Details about the security configurations in your account.
|
1750
|
+
# @return [Array<Types::SecurityConfigSummary>]
|
1751
|
+
#
|
1748
1752
|
# @!attribute [rw] next_token
|
1749
1753
|
# When `nextToken` is returned, there are more results available. The
|
1750
1754
|
# value of `nextToken` is a unique pagination token for each page.
|
@@ -1752,30 +1756,17 @@ module Aws::OpenSearchServerless
|
|
1752
1756
|
# page.
|
1753
1757
|
# @return [String]
|
1754
1758
|
#
|
1755
|
-
# @!attribute [rw] security_config_summaries
|
1756
|
-
# Details about the security configurations in your account.
|
1757
|
-
# @return [Array<Types::SecurityConfigSummary>]
|
1758
|
-
#
|
1759
1759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityConfigsResponse AWS API Documentation
|
1760
1760
|
#
|
1761
1761
|
class ListSecurityConfigsResponse < Struct.new(
|
1762
|
-
:
|
1763
|
-
:
|
1762
|
+
:security_config_summaries,
|
1763
|
+
:next_token)
|
1764
1764
|
SENSITIVE = []
|
1765
1765
|
include Aws::Structure
|
1766
1766
|
end
|
1767
1767
|
|
1768
|
-
# @!attribute [rw]
|
1769
|
-
#
|
1770
|
-
# to return. You can use `nextToken` to get the next page of results.
|
1771
|
-
# The default is 20.
|
1772
|
-
# @return [Integer]
|
1773
|
-
#
|
1774
|
-
# @!attribute [rw] next_token
|
1775
|
-
# If your initial `ListSecurityPolicies` operation returns a
|
1776
|
-
# `nextToken`, you can include the returned `nextToken` in subsequent
|
1777
|
-
# `ListSecurityPolicies` operations, which returns results in the next
|
1778
|
-
# page.
|
1768
|
+
# @!attribute [rw] type
|
1769
|
+
# The type of policy.
|
1779
1770
|
# @return [String]
|
1780
1771
|
#
|
1781
1772
|
# @!attribute [rw] resource
|
@@ -1783,21 +1774,34 @@ module Aws::OpenSearchServerless
|
|
1783
1774
|
# apply to.
|
1784
1775
|
# @return [Array<String>]
|
1785
1776
|
#
|
1786
|
-
# @!attribute [rw]
|
1787
|
-
#
|
1777
|
+
# @!attribute [rw] next_token
|
1778
|
+
# If your initial `ListSecurityPolicies` operation returns a
|
1779
|
+
# `nextToken`, you can include the returned `nextToken` in subsequent
|
1780
|
+
# `ListSecurityPolicies` operations, which returns results in the next
|
1781
|
+
# page.
|
1788
1782
|
# @return [String]
|
1789
1783
|
#
|
1784
|
+
# @!attribute [rw] max_results
|
1785
|
+
# An optional parameter that specifies the maximum number of results
|
1786
|
+
# to return. You can use `nextToken` to get the next page of results.
|
1787
|
+
# The default is 20.
|
1788
|
+
# @return [Integer]
|
1789
|
+
#
|
1790
1790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityPoliciesRequest AWS API Documentation
|
1791
1791
|
#
|
1792
1792
|
class ListSecurityPoliciesRequest < Struct.new(
|
1793
|
-
:
|
1794
|
-
:next_token,
|
1793
|
+
:type,
|
1795
1794
|
:resource,
|
1796
|
-
:
|
1795
|
+
:next_token,
|
1796
|
+
:max_results)
|
1797
1797
|
SENSITIVE = []
|
1798
1798
|
include Aws::Structure
|
1799
1799
|
end
|
1800
1800
|
|
1801
|
+
# @!attribute [rw] security_policy_summaries
|
1802
|
+
# Details about the security policies in your account.
|
1803
|
+
# @return [Array<Types::SecurityPolicySummary>]
|
1804
|
+
#
|
1801
1805
|
# @!attribute [rw] next_token
|
1802
1806
|
# When `nextToken` is returned, there are more results available. The
|
1803
1807
|
# value of `nextToken` is a unique pagination token for each page.
|
@@ -1805,15 +1809,11 @@ module Aws::OpenSearchServerless
|
|
1805
1809
|
# page.
|
1806
1810
|
# @return [String]
|
1807
1811
|
#
|
1808
|
-
# @!attribute [rw] security_policy_summaries
|
1809
|
-
# Details about the security policies in your account.
|
1810
|
-
# @return [Array<Types::SecurityPolicySummary>]
|
1811
|
-
#
|
1812
1812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityPoliciesResponse AWS API Documentation
|
1813
1813
|
#
|
1814
1814
|
class ListSecurityPoliciesResponse < Struct.new(
|
1815
|
-
:
|
1816
|
-
:
|
1815
|
+
:security_policy_summaries,
|
1816
|
+
:next_token)
|
1817
1817
|
SENSITIVE = []
|
1818
1818
|
include Aws::Structure
|
1819
1819
|
end
|
@@ -1844,11 +1844,11 @@ module Aws::OpenSearchServerless
|
|
1844
1844
|
include Aws::Structure
|
1845
1845
|
end
|
1846
1846
|
|
1847
|
-
# @!attribute [rw]
|
1848
|
-
#
|
1849
|
-
#
|
1850
|
-
#
|
1851
|
-
# @return [
|
1847
|
+
# @!attribute [rw] vpc_endpoint_filters
|
1848
|
+
# Filter the results according to the current status of the VPC
|
1849
|
+
# endpoint. Possible statuses are `CREATING`, `DELETING`, `UPDATING`,
|
1850
|
+
# `ACTIVE`, and `FAILED`.
|
1851
|
+
# @return [Types::VpcEndpointFilters]
|
1852
1852
|
#
|
1853
1853
|
# @!attribute [rw] next_token
|
1854
1854
|
# If your initial `ListVpcEndpoints` operation returns a `nextToken`,
|
@@ -1857,22 +1857,27 @@ module Aws::OpenSearchServerless
|
|
1857
1857
|
# page.
|
1858
1858
|
# @return [String]
|
1859
1859
|
#
|
1860
|
-
# @!attribute [rw]
|
1861
|
-
#
|
1862
|
-
#
|
1863
|
-
#
|
1864
|
-
# @return [
|
1860
|
+
# @!attribute [rw] max_results
|
1861
|
+
# An optional parameter that specifies the maximum number of results
|
1862
|
+
# to return. You can use `nextToken` to get the next page of results.
|
1863
|
+
# The default is 20.
|
1864
|
+
# @return [Integer]
|
1865
1865
|
#
|
1866
1866
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListVpcEndpointsRequest AWS API Documentation
|
1867
1867
|
#
|
1868
1868
|
class ListVpcEndpointsRequest < Struct.new(
|
1869
|
-
:
|
1869
|
+
:vpc_endpoint_filters,
|
1870
1870
|
:next_token,
|
1871
|
-
:
|
1871
|
+
:max_results)
|
1872
1872
|
SENSITIVE = []
|
1873
1873
|
include Aws::Structure
|
1874
1874
|
end
|
1875
1875
|
|
1876
|
+
# @!attribute [rw] vpc_endpoint_summaries
|
1877
|
+
# Details about each VPC endpoint, including the name and current
|
1878
|
+
# status.
|
1879
|
+
# @return [Array<Types::VpcEndpointSummary>]
|
1880
|
+
#
|
1876
1881
|
# @!attribute [rw] next_token
|
1877
1882
|
# When `nextToken` is returned, there are more results available. The
|
1878
1883
|
# value of `nextToken` is a unique pagination token for each page.
|
@@ -1880,16 +1885,11 @@ module Aws::OpenSearchServerless
|
|
1880
1885
|
# page.
|
1881
1886
|
# @return [String]
|
1882
1887
|
#
|
1883
|
-
# @!attribute [rw] vpc_endpoint_summaries
|
1884
|
-
# Details about each VPC endpoint, including the name and current
|
1885
|
-
# status.
|
1886
|
-
# @return [Array<Types::VpcEndpointSummary>]
|
1887
|
-
#
|
1888
1888
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListVpcEndpointsResponse AWS API Documentation
|
1889
1889
|
#
|
1890
1890
|
class ListVpcEndpointsResponse < Struct.new(
|
1891
|
-
:
|
1892
|
-
:
|
1891
|
+
:vpc_endpoint_summaries,
|
1892
|
+
:next_token)
|
1893
1893
|
SENSITIVE = []
|
1894
1894
|
include Aws::Structure
|
1895
1895
|
end
|
@@ -1925,80 +1925,86 @@ module Aws::OpenSearchServerless
|
|
1925
1925
|
# Describes SAML options for an OpenSearch Serverless security
|
1926
1926
|
# configuration in the form of a key-value map.
|
1927
1927
|
#
|
1928
|
+
# @!attribute [rw] metadata
|
1929
|
+
# The XML IdP metadata file generated from your identity provider.
|
1930
|
+
# @return [String]
|
1931
|
+
#
|
1932
|
+
# @!attribute [rw] user_attribute
|
1933
|
+
# A user attribute for this SAML integration.
|
1934
|
+
# @return [String]
|
1935
|
+
#
|
1928
1936
|
# @!attribute [rw] group_attribute
|
1929
1937
|
# The group attribute for this SAML integration.
|
1930
1938
|
# @return [String]
|
1931
1939
|
#
|
1932
|
-
# @!attribute [rw]
|
1933
|
-
#
|
1940
|
+
# @!attribute [rw] open_search_serverless_entity_id
|
1941
|
+
# Custom entity id attribute to override default entity id for this
|
1942
|
+
# saml integration.
|
1934
1943
|
# @return [String]
|
1935
1944
|
#
|
1936
1945
|
# @!attribute [rw] session_timeout
|
1937
1946
|
# The session timeout, in minutes. Default is 60 minutes (12 hours).
|
1938
1947
|
# @return [Integer]
|
1939
1948
|
#
|
1940
|
-
# @!attribute [rw] user_attribute
|
1941
|
-
# A user attribute for this SAML integration.
|
1942
|
-
# @return [String]
|
1943
|
-
#
|
1944
1949
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SamlConfigOptions AWS API Documentation
|
1945
1950
|
#
|
1946
1951
|
class SamlConfigOptions < Struct.new(
|
1947
|
-
:group_attribute,
|
1948
1952
|
:metadata,
|
1949
|
-
:
|
1950
|
-
:
|
1953
|
+
:user_attribute,
|
1954
|
+
:group_attribute,
|
1955
|
+
:open_search_serverless_entity_id,
|
1956
|
+
:session_timeout)
|
1951
1957
|
SENSITIVE = []
|
1952
1958
|
include Aws::Structure
|
1953
1959
|
end
|
1954
1960
|
|
1955
1961
|
# Details about a security configuration for OpenSearch Serverless.
|
1956
1962
|
#
|
1963
|
+
# @!attribute [rw] id
|
1964
|
+
# The unique identifier of the security configuration.
|
1965
|
+
# @return [String]
|
1966
|
+
#
|
1967
|
+
# @!attribute [rw] type
|
1968
|
+
# The type of security configuration.
|
1969
|
+
# @return [String]
|
1970
|
+
#
|
1957
1971
|
# @!attribute [rw] config_version
|
1958
1972
|
# The version of the security configuration.
|
1959
1973
|
# @return [String]
|
1960
1974
|
#
|
1961
|
-
# @!attribute [rw] created_date
|
1962
|
-
# The date the configuration was created.
|
1963
|
-
# @return [Integer]
|
1964
|
-
#
|
1965
1975
|
# @!attribute [rw] description
|
1966
1976
|
# The description of the security configuration.
|
1967
1977
|
# @return [String]
|
1968
1978
|
#
|
1979
|
+
# @!attribute [rw] saml_options
|
1980
|
+
# SAML options for the security configuration in the form of a
|
1981
|
+
# key-value map.
|
1982
|
+
# @return [Types::SamlConfigOptions]
|
1983
|
+
#
|
1969
1984
|
# @!attribute [rw] iam_identity_center_options
|
1970
1985
|
# Describes IAM Identity Center options in the form of a key-value
|
1971
1986
|
# map.
|
1972
1987
|
# @return [Types::IamIdentityCenterConfigOptions]
|
1973
1988
|
#
|
1974
|
-
# @!attribute [rw]
|
1975
|
-
# The
|
1976
|
-
# @return [
|
1989
|
+
# @!attribute [rw] created_date
|
1990
|
+
# The date the configuration was created.
|
1991
|
+
# @return [Integer]
|
1977
1992
|
#
|
1978
1993
|
# @!attribute [rw] last_modified_date
|
1979
1994
|
# The timestamp of when the configuration was last modified.
|
1980
1995
|
# @return [Integer]
|
1981
1996
|
#
|
1982
|
-
# @!attribute [rw] saml_options
|
1983
|
-
# SAML options for the security configuration in the form of a
|
1984
|
-
# key-value map.
|
1985
|
-
# @return [Types::SamlConfigOptions]
|
1986
|
-
#
|
1987
|
-
# @!attribute [rw] type
|
1988
|
-
# The type of security configuration.
|
1989
|
-
# @return [String]
|
1990
|
-
#
|
1991
1997
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityConfigDetail AWS API Documentation
|
1992
1998
|
#
|
1993
1999
|
class SecurityConfigDetail < Struct.new(
|
2000
|
+
:id,
|
2001
|
+
:type,
|
1994
2002
|
:config_version,
|
1995
|
-
:created_date,
|
1996
2003
|
:description,
|
1997
|
-
:iam_identity_center_options,
|
1998
|
-
:id,
|
1999
|
-
:last_modified_date,
|
2000
2004
|
:saml_options,
|
2001
|
-
:
|
2005
|
+
:iam_identity_center_options,
|
2006
|
+
:created_date,
|
2007
|
+
:last_modified_date)
|
2002
2008
|
SENSITIVE = []
|
2003
2009
|
include Aws::Structure
|
2004
2010
|
end
|
@@ -2019,83 +2025,83 @@ module Aws::OpenSearchServerless
|
|
2019
2025
|
|
2020
2026
|
# A summary of a security configuration for OpenSearch Serverless.
|
2021
2027
|
#
|
2028
|
+
# @!attribute [rw] id
|
2029
|
+
# The unique identifier of the security configuration.
|
2030
|
+
# @return [String]
|
2031
|
+
#
|
2032
|
+
# @!attribute [rw] type
|
2033
|
+
# The type of security configuration.
|
2034
|
+
# @return [String]
|
2035
|
+
#
|
2022
2036
|
# @!attribute [rw] config_version
|
2023
2037
|
# The version of the security configuration.
|
2024
2038
|
# @return [String]
|
2025
2039
|
#
|
2026
|
-
# @!attribute [rw] created_date
|
2027
|
-
# The Epoch time when the security configuration was created.
|
2028
|
-
# @return [Integer]
|
2029
|
-
#
|
2030
2040
|
# @!attribute [rw] description
|
2031
2041
|
# The description of the security configuration.
|
2032
2042
|
# @return [String]
|
2033
2043
|
#
|
2034
|
-
# @!attribute [rw]
|
2035
|
-
# The
|
2036
|
-
# @return [
|
2044
|
+
# @!attribute [rw] created_date
|
2045
|
+
# The Epoch time when the security configuration was created.
|
2046
|
+
# @return [Integer]
|
2037
2047
|
#
|
2038
2048
|
# @!attribute [rw] last_modified_date
|
2039
2049
|
# The timestamp of when the configuration was last modified.
|
2040
2050
|
# @return [Integer]
|
2041
2051
|
#
|
2042
|
-
# @!attribute [rw] type
|
2043
|
-
# The type of security configuration.
|
2044
|
-
# @return [String]
|
2045
|
-
#
|
2046
2052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityConfigSummary AWS API Documentation
|
2047
2053
|
#
|
2048
2054
|
class SecurityConfigSummary < Struct.new(
|
2055
|
+
:id,
|
2056
|
+
:type,
|
2049
2057
|
:config_version,
|
2050
|
-
:created_date,
|
2051
2058
|
:description,
|
2052
|
-
:
|
2053
|
-
:last_modified_date
|
2054
|
-
:type)
|
2059
|
+
:created_date,
|
2060
|
+
:last_modified_date)
|
2055
2061
|
SENSITIVE = []
|
2056
2062
|
include Aws::Structure
|
2057
2063
|
end
|
2058
2064
|
|
2059
2065
|
# Details about an OpenSearch Serverless security policy.
|
2060
2066
|
#
|
2061
|
-
# @!attribute [rw]
|
2062
|
-
# The
|
2063
|
-
# @return [Integer]
|
2064
|
-
#
|
2065
|
-
# @!attribute [rw] description
|
2066
|
-
# The description of the security policy.
|
2067
|
+
# @!attribute [rw] type
|
2068
|
+
# The type of security policy.
|
2067
2069
|
# @return [String]
|
2068
2070
|
#
|
2069
|
-
# @!attribute [rw] last_modified_date
|
2070
|
-
# The timestamp of when the policy was last modified.
|
2071
|
-
# @return [Integer]
|
2072
|
-
#
|
2073
2071
|
# @!attribute [rw] name
|
2074
2072
|
# The name of the policy.
|
2075
2073
|
# @return [String]
|
2076
2074
|
#
|
2077
|
-
# @!attribute [rw] policy
|
2078
|
-
# The JSON policy document without any whitespaces.
|
2079
|
-
# @return [Hash,Array,String,Numeric,Boolean]
|
2080
|
-
#
|
2081
2075
|
# @!attribute [rw] policy_version
|
2082
2076
|
# The version of the policy.
|
2083
2077
|
# @return [String]
|
2084
2078
|
#
|
2085
|
-
# @!attribute [rw]
|
2086
|
-
# The
|
2079
|
+
# @!attribute [rw] description
|
2080
|
+
# The description of the security policy.
|
2087
2081
|
# @return [String]
|
2088
2082
|
#
|
2083
|
+
# @!attribute [rw] policy
|
2084
|
+
# The JSON policy document without any whitespaces.
|
2085
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] created_date
|
2088
|
+
# The date the policy was created.
|
2089
|
+
# @return [Integer]
|
2090
|
+
#
|
2091
|
+
# @!attribute [rw] last_modified_date
|
2092
|
+
# The timestamp of when the policy was last modified.
|
2093
|
+
# @return [Integer]
|
2094
|
+
#
|
2089
2095
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityPolicyDetail AWS API Documentation
|
2090
2096
|
#
|
2091
2097
|
class SecurityPolicyDetail < Struct.new(
|
2092
|
-
:
|
2093
|
-
:description,
|
2094
|
-
:last_modified_date,
|
2098
|
+
:type,
|
2095
2099
|
:name,
|
2096
|
-
:policy,
|
2097
2100
|
:policy_version,
|
2098
|
-
:
|
2101
|
+
:description,
|
2102
|
+
:policy,
|
2103
|
+
:created_date,
|
2104
|
+
:last_modified_date)
|
2099
2105
|
SENSITIVE = []
|
2100
2106
|
include Aws::Structure
|
2101
2107
|
end
|
@@ -2121,18 +2127,10 @@ module Aws::OpenSearchServerless
|
|
2121
2127
|
|
2122
2128
|
# A summary of a security policy for OpenSearch Serverless.
|
2123
2129
|
#
|
2124
|
-
# @!attribute [rw]
|
2125
|
-
# The
|
2126
|
-
# @return [Integer]
|
2127
|
-
#
|
2128
|
-
# @!attribute [rw] description
|
2129
|
-
# The description of the security policy.
|
2130
|
+
# @!attribute [rw] type
|
2131
|
+
# The type of security policy.
|
2130
2132
|
# @return [String]
|
2131
2133
|
#
|
2132
|
-
# @!attribute [rw] last_modified_date
|
2133
|
-
# The timestamp of when the policy was last modified.
|
2134
|
-
# @return [Integer]
|
2135
|
-
#
|
2136
2134
|
# @!attribute [rw] name
|
2137
2135
|
# The name of the policy.
|
2138
2136
|
# @return [String]
|
@@ -2141,19 +2139,27 @@ module Aws::OpenSearchServerless
|
|
2141
2139
|
# The version of the policy.
|
2142
2140
|
# @return [String]
|
2143
2141
|
#
|
2144
|
-
# @!attribute [rw]
|
2145
|
-
# The
|
2142
|
+
# @!attribute [rw] description
|
2143
|
+
# The description of the security policy.
|
2146
2144
|
# @return [String]
|
2147
2145
|
#
|
2148
|
-
#
|
2149
|
-
#
|
2146
|
+
# @!attribute [rw] created_date
|
2147
|
+
# The date the policy was created.
|
2148
|
+
# @return [Integer]
|
2149
|
+
#
|
2150
|
+
# @!attribute [rw] last_modified_date
|
2151
|
+
# The timestamp of when the policy was last modified.
|
2152
|
+
# @return [Integer]
|
2153
|
+
#
|
2154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/SecurityPolicySummary AWS API Documentation
|
2155
|
+
#
|
2150
2156
|
class SecurityPolicySummary < Struct.new(
|
2151
|
-
:
|
2152
|
-
:description,
|
2153
|
-
:last_modified_date,
|
2157
|
+
:type,
|
2154
2158
|
:name,
|
2155
2159
|
:policy_version,
|
2156
|
-
:
|
2160
|
+
:description,
|
2161
|
+
:created_date,
|
2162
|
+
:last_modified_date)
|
2157
2163
|
SENSITIVE = []
|
2158
2164
|
include Aws::Structure
|
2159
2165
|
end
|
@@ -2165,10 +2171,6 @@ module Aws::OpenSearchServerless
|
|
2165
2171
|
# Description of the error.
|
2166
2172
|
# @return [String]
|
2167
2173
|
#
|
2168
|
-
# @!attribute [rw] quota_code
|
2169
|
-
# Service Quotas requirement to identify originating quota.
|
2170
|
-
# @return [String]
|
2171
|
-
#
|
2172
2174
|
# @!attribute [rw] resource_id
|
2173
2175
|
# Identifier of the resource affected.
|
2174
2176
|
# @return [String]
|
@@ -2181,14 +2183,18 @@ module Aws::OpenSearchServerless
|
|
2181
2183
|
# Service Quotas requirement to identify originating service.
|
2182
2184
|
# @return [String]
|
2183
2185
|
#
|
2186
|
+
# @!attribute [rw] quota_code
|
2187
|
+
# Service Quotas requirement to identify originating quota.
|
2188
|
+
# @return [String]
|
2189
|
+
#
|
2184
2190
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ServiceQuotaExceededException AWS API Documentation
|
2185
2191
|
#
|
2186
2192
|
class ServiceQuotaExceededException < Struct.new(
|
2187
2193
|
:message,
|
2188
|
-
:quota_code,
|
2189
2194
|
:resource_id,
|
2190
2195
|
:resource_type,
|
2191
|
-
:service_code
|
2196
|
+
:service_code,
|
2197
|
+
:quota_code)
|
2192
2198
|
SENSITIVE = []
|
2193
2199
|
include Aws::Structure
|
2194
2200
|
end
|
@@ -2261,12 +2267,16 @@ module Aws::OpenSearchServerless
|
|
2261
2267
|
#
|
2262
2268
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
2263
2269
|
|
2264
|
-
# @!attribute [rw]
|
2265
|
-
#
|
2266
|
-
#
|
2270
|
+
# @!attribute [rw] type
|
2271
|
+
# The type of policy.
|
2272
|
+
# @return [String]
|
2267
2273
|
#
|
2268
|
-
#
|
2269
|
-
#
|
2274
|
+
# @!attribute [rw] name
|
2275
|
+
# The name of the policy.
|
2276
|
+
# @return [String]
|
2277
|
+
#
|
2278
|
+
# @!attribute [rw] policy_version
|
2279
|
+
# The version of the policy being updated.
|
2270
2280
|
# @return [String]
|
2271
2281
|
#
|
2272
2282
|
# @!attribute [rw] description
|
@@ -2274,31 +2284,27 @@ module Aws::OpenSearchServerless
|
|
2274
2284
|
# about the permissions defined in the policy.
|
2275
2285
|
# @return [String]
|
2276
2286
|
#
|
2277
|
-
# @!attribute [rw] name
|
2278
|
-
# The name of the policy.
|
2279
|
-
# @return [String]
|
2280
|
-
#
|
2281
2287
|
# @!attribute [rw] policy
|
2282
2288
|
# The JSON policy document to use as the content for the policy.
|
2283
2289
|
# @return [String]
|
2284
2290
|
#
|
2285
|
-
# @!attribute [rw]
|
2286
|
-
#
|
2287
|
-
#
|
2291
|
+
# @!attribute [rw] client_token
|
2292
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
2293
|
+
# request.
|
2288
2294
|
#
|
2289
|
-
#
|
2290
|
-
#
|
2295
|
+
# **A suitable default value is auto-generated.** You should normally
|
2296
|
+
# not need to pass this option.
|
2291
2297
|
# @return [String]
|
2292
2298
|
#
|
2293
2299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccessPolicyRequest AWS API Documentation
|
2294
2300
|
#
|
2295
2301
|
class UpdateAccessPolicyRequest < Struct.new(
|
2296
|
-
:
|
2297
|
-
:description,
|
2302
|
+
:type,
|
2298
2303
|
:name,
|
2299
|
-
:policy,
|
2300
2304
|
:policy_version,
|
2301
|
-
:
|
2305
|
+
:description,
|
2306
|
+
:policy,
|
2307
|
+
:client_token)
|
2302
2308
|
SENSITIVE = []
|
2303
2309
|
include Aws::Structure
|
2304
2310
|
end
|
@@ -2350,26 +2356,10 @@ module Aws::OpenSearchServerless
|
|
2350
2356
|
|
2351
2357
|
# Details about an updated OpenSearch Serverless collection.
|
2352
2358
|
#
|
2353
|
-
# @!attribute [rw] arn
|
2354
|
-
# The Amazon Resource Name (ARN) of the collection.
|
2355
|
-
# @return [String]
|
2356
|
-
#
|
2357
|
-
# @!attribute [rw] created_date
|
2358
|
-
# The date and time when the collection was created.
|
2359
|
-
# @return [Integer]
|
2360
|
-
#
|
2361
|
-
# @!attribute [rw] description
|
2362
|
-
# The description of the collection.
|
2363
|
-
# @return [String]
|
2364
|
-
#
|
2365
2359
|
# @!attribute [rw] id
|
2366
2360
|
# The unique identifier of the collection.
|
2367
2361
|
# @return [String]
|
2368
2362
|
#
|
2369
|
-
# @!attribute [rw] last_modified_date
|
2370
|
-
# The date and time when the collection was last modified.
|
2371
|
-
# @return [Integer]
|
2372
|
-
#
|
2373
2363
|
# @!attribute [rw] name
|
2374
2364
|
# The name of the collection.
|
2375
2365
|
# @return [String]
|
@@ -2382,43 +2372,59 @@ module Aws::OpenSearchServerless
|
|
2382
2372
|
# The collection type.
|
2383
2373
|
# @return [String]
|
2384
2374
|
#
|
2375
|
+
# @!attribute [rw] description
|
2376
|
+
# The description of the collection.
|
2377
|
+
# @return [String]
|
2378
|
+
#
|
2379
|
+
# @!attribute [rw] arn
|
2380
|
+
# The Amazon Resource Name (ARN) of the collection.
|
2381
|
+
# @return [String]
|
2382
|
+
#
|
2383
|
+
# @!attribute [rw] created_date
|
2384
|
+
# The date and time when the collection was created.
|
2385
|
+
# @return [Integer]
|
2386
|
+
#
|
2387
|
+
# @!attribute [rw] last_modified_date
|
2388
|
+
# The date and time when the collection was last modified.
|
2389
|
+
# @return [Integer]
|
2390
|
+
#
|
2385
2391
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollectionDetail AWS API Documentation
|
2386
2392
|
#
|
2387
2393
|
class UpdateCollectionDetail < Struct.new(
|
2388
|
-
:arn,
|
2389
|
-
:created_date,
|
2390
|
-
:description,
|
2391
2394
|
:id,
|
2392
|
-
:last_modified_date,
|
2393
2395
|
:name,
|
2394
2396
|
:status,
|
2395
|
-
:type
|
2397
|
+
:type,
|
2398
|
+
:description,
|
2399
|
+
:arn,
|
2400
|
+
:created_date,
|
2401
|
+
:last_modified_date)
|
2396
2402
|
SENSITIVE = []
|
2397
2403
|
include Aws::Structure
|
2398
2404
|
end
|
2399
2405
|
|
2400
|
-
# @!attribute [rw]
|
2401
|
-
#
|
2402
|
-
# request.
|
2403
|
-
#
|
2404
|
-
# **A suitable default value is auto-generated.** You should normally
|
2405
|
-
# not need to pass this option.
|
2406
|
+
# @!attribute [rw] id
|
2407
|
+
# The unique identifier of the collection.
|
2406
2408
|
# @return [String]
|
2407
2409
|
#
|
2408
2410
|
# @!attribute [rw] description
|
2409
2411
|
# A description of the collection.
|
2410
2412
|
# @return [String]
|
2411
2413
|
#
|
2412
|
-
# @!attribute [rw]
|
2413
|
-
#
|
2414
|
+
# @!attribute [rw] client_token
|
2415
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
2416
|
+
# request.
|
2417
|
+
#
|
2418
|
+
# **A suitable default value is auto-generated.** You should normally
|
2419
|
+
# not need to pass this option.
|
2414
2420
|
# @return [String]
|
2415
2421
|
#
|
2416
2422
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollectionRequest AWS API Documentation
|
2417
2423
|
#
|
2418
2424
|
class UpdateCollectionRequest < Struct.new(
|
2419
|
-
:
|
2425
|
+
:id,
|
2420
2426
|
:description,
|
2421
|
-
:
|
2427
|
+
:client_token)
|
2422
2428
|
SENSITIVE = []
|
2423
2429
|
include Aws::Structure
|
2424
2430
|
end
|
@@ -2438,39 +2444,39 @@ module Aws::OpenSearchServerless
|
|
2438
2444
|
# Describes IAM Identity Center options for updating an OpenSearch
|
2439
2445
|
# Serverless security configuration in the form of a key-value map.
|
2440
2446
|
#
|
2441
|
-
# @!attribute [rw] group_attribute
|
2442
|
-
# The group attribute for this IAM Identity Center integration.
|
2443
|
-
# Defaults to `GroupId`.
|
2444
|
-
# @return [String]
|
2445
|
-
#
|
2446
2447
|
# @!attribute [rw] user_attribute
|
2447
2448
|
# The user attribute for this IAM Identity Center integration.
|
2448
2449
|
# Defaults to `UserId`.
|
2449
2450
|
# @return [String]
|
2450
2451
|
#
|
2452
|
+
# @!attribute [rw] group_attribute
|
2453
|
+
# The group attribute for this IAM Identity Center integration.
|
2454
|
+
# Defaults to `GroupId`.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2451
2457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateIamIdentityCenterConfigOptions AWS API Documentation
|
2452
2458
|
#
|
2453
2459
|
class UpdateIamIdentityCenterConfigOptions < Struct.new(
|
2454
|
-
:
|
2455
|
-
:
|
2460
|
+
:user_attribute,
|
2461
|
+
:group_attribute)
|
2456
2462
|
SENSITIVE = []
|
2457
2463
|
include Aws::Structure
|
2458
2464
|
end
|
2459
2465
|
|
2460
|
-
# @!attribute [rw]
|
2461
|
-
#
|
2462
|
-
#
|
2466
|
+
# @!attribute [rw] type
|
2467
|
+
# The type of lifecycle policy.
|
2468
|
+
# @return [String]
|
2463
2469
|
#
|
2464
|
-
#
|
2465
|
-
#
|
2470
|
+
# @!attribute [rw] name
|
2471
|
+
# The name of the policy.
|
2466
2472
|
# @return [String]
|
2467
2473
|
#
|
2468
|
-
# @!attribute [rw]
|
2469
|
-
#
|
2474
|
+
# @!attribute [rw] policy_version
|
2475
|
+
# The version of the policy being updated.
|
2470
2476
|
# @return [String]
|
2471
2477
|
#
|
2472
|
-
# @!attribute [rw]
|
2473
|
-
#
|
2478
|
+
# @!attribute [rw] description
|
2479
|
+
# A description of the lifecycle policy.
|
2474
2480
|
# @return [String]
|
2475
2481
|
#
|
2476
2482
|
# @!attribute [rw] policy
|
@@ -2478,23 +2484,23 @@ module Aws::OpenSearchServerless
|
|
2478
2484
|
# policy.
|
2479
2485
|
# @return [String]
|
2480
2486
|
#
|
2481
|
-
# @!attribute [rw]
|
2482
|
-
#
|
2483
|
-
#
|
2487
|
+
# @!attribute [rw] client_token
|
2488
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
2489
|
+
# request.
|
2484
2490
|
#
|
2485
|
-
#
|
2486
|
-
#
|
2491
|
+
# **A suitable default value is auto-generated.** You should normally
|
2492
|
+
# not need to pass this option.
|
2487
2493
|
# @return [String]
|
2488
2494
|
#
|
2489
2495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateLifecyclePolicyRequest AWS API Documentation
|
2490
2496
|
#
|
2491
2497
|
class UpdateLifecyclePolicyRequest < Struct.new(
|
2492
|
-
:
|
2493
|
-
:description,
|
2498
|
+
:type,
|
2494
2499
|
:name,
|
2495
|
-
:policy,
|
2496
2500
|
:policy_version,
|
2497
|
-
:
|
2501
|
+
:description,
|
2502
|
+
:policy,
|
2503
|
+
:client_token)
|
2498
2504
|
SENSITIVE = []
|
2499
2505
|
include Aws::Structure
|
2500
2506
|
end
|
@@ -2511,12 +2517,10 @@ module Aws::OpenSearchServerless
|
|
2511
2517
|
include Aws::Structure
|
2512
2518
|
end
|
2513
2519
|
|
2514
|
-
# @!attribute [rw]
|
2515
|
-
#
|
2516
|
-
#
|
2517
|
-
#
|
2518
|
-
# **A suitable default value is auto-generated.** You should normally
|
2519
|
-
# not need to pass this option.
|
2520
|
+
# @!attribute [rw] id
|
2521
|
+
# The security configuration identifier. For SAML the ID will be
|
2522
|
+
# `saml/<accountId>/<idpProviderName>`. For example,
|
2523
|
+
# `saml/123456789123/OKTADev`.
|
2520
2524
|
# @return [String]
|
2521
2525
|
#
|
2522
2526
|
# @!attribute [rw] config_version
|
@@ -2529,30 +2533,32 @@ module Aws::OpenSearchServerless
|
|
2529
2533
|
# A description of the security configuration.
|
2530
2534
|
# @return [String]
|
2531
2535
|
#
|
2536
|
+
# @!attribute [rw] saml_options
|
2537
|
+
# SAML options in in the form of a key-value map.
|
2538
|
+
# @return [Types::SamlConfigOptions]
|
2539
|
+
#
|
2532
2540
|
# @!attribute [rw] iam_identity_center_options_updates
|
2533
2541
|
# Describes IAM Identity Center options in the form of a key-value
|
2534
2542
|
# map.
|
2535
2543
|
# @return [Types::UpdateIamIdentityCenterConfigOptions]
|
2536
2544
|
#
|
2537
|
-
# @!attribute [rw]
|
2538
|
-
#
|
2539
|
-
#
|
2540
|
-
# `saml/123456789123/OKTADev`.
|
2541
|
-
# @return [String]
|
2545
|
+
# @!attribute [rw] client_token
|
2546
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
2547
|
+
# request.
|
2542
2548
|
#
|
2543
|
-
#
|
2544
|
-
#
|
2545
|
-
# @return [
|
2549
|
+
# **A suitable default value is auto-generated.** You should normally
|
2550
|
+
# not need to pass this option.
|
2551
|
+
# @return [String]
|
2546
2552
|
#
|
2547
2553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityConfigRequest AWS API Documentation
|
2548
2554
|
#
|
2549
2555
|
class UpdateSecurityConfigRequest < Struct.new(
|
2550
|
-
:
|
2556
|
+
:id,
|
2551
2557
|
:config_version,
|
2552
2558
|
:description,
|
2559
|
+
:saml_options,
|
2553
2560
|
:iam_identity_center_options_updates,
|
2554
|
-
:
|
2555
|
-
:saml_options)
|
2561
|
+
:client_token)
|
2556
2562
|
SENSITIVE = []
|
2557
2563
|
include Aws::Structure
|
2558
2564
|
end
|
@@ -2569,12 +2575,16 @@ module Aws::OpenSearchServerless
|
|
2569
2575
|
include Aws::Structure
|
2570
2576
|
end
|
2571
2577
|
|
2572
|
-
# @!attribute [rw]
|
2573
|
-
#
|
2574
|
-
#
|
2578
|
+
# @!attribute [rw] type
|
2579
|
+
# The type of access policy.
|
2580
|
+
# @return [String]
|
2575
2581
|
#
|
2576
|
-
#
|
2577
|
-
#
|
2582
|
+
# @!attribute [rw] name
|
2583
|
+
# The name of the policy.
|
2584
|
+
# @return [String]
|
2585
|
+
#
|
2586
|
+
# @!attribute [rw] policy_version
|
2587
|
+
# The version of the policy being updated.
|
2578
2588
|
# @return [String]
|
2579
2589
|
#
|
2580
2590
|
# @!attribute [rw] description
|
@@ -2582,31 +2592,27 @@ module Aws::OpenSearchServerless
|
|
2582
2592
|
# about the permissions defined in the policy.
|
2583
2593
|
# @return [String]
|
2584
2594
|
#
|
2585
|
-
# @!attribute [rw] name
|
2586
|
-
# The name of the policy.
|
2587
|
-
# @return [String]
|
2588
|
-
#
|
2589
2595
|
# @!attribute [rw] policy
|
2590
2596
|
# The JSON policy document to use as the content for the new policy.
|
2591
2597
|
# @return [String]
|
2592
2598
|
#
|
2593
|
-
# @!attribute [rw]
|
2594
|
-
#
|
2595
|
-
#
|
2599
|
+
# @!attribute [rw] client_token
|
2600
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
2601
|
+
# request.
|
2596
2602
|
#
|
2597
|
-
#
|
2598
|
-
#
|
2603
|
+
# **A suitable default value is auto-generated.** You should normally
|
2604
|
+
# not need to pass this option.
|
2599
2605
|
# @return [String]
|
2600
2606
|
#
|
2601
2607
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityPolicyRequest AWS API Documentation
|
2602
2608
|
#
|
2603
2609
|
class UpdateSecurityPolicyRequest < Struct.new(
|
2604
|
-
:
|
2605
|
-
:description,
|
2610
|
+
:type,
|
2606
2611
|
:name,
|
2607
|
-
:policy,
|
2608
2612
|
:policy_version,
|
2609
|
-
:
|
2613
|
+
:description,
|
2614
|
+
:policy,
|
2615
|
+
:client_token)
|
2610
2616
|
SENSITIVE = []
|
2611
2617
|
include Aws::Structure
|
2612
2618
|
end
|
@@ -2630,20 +2636,10 @@ module Aws::OpenSearchServerless
|
|
2630
2636
|
# The unique identifier of the endpoint.
|
2631
2637
|
# @return [String]
|
2632
2638
|
#
|
2633
|
-
# @!attribute [rw] last_modified_date
|
2634
|
-
# The timestamp of when the endpoint was last modified.
|
2635
|
-
# @return [Integer]
|
2636
|
-
#
|
2637
2639
|
# @!attribute [rw] name
|
2638
2640
|
# The name of the endpoint.
|
2639
2641
|
# @return [String]
|
2640
2642
|
#
|
2641
|
-
# @!attribute [rw] security_group_ids
|
2642
|
-
# The unique identifiers of the security groups that define the ports,
|
2643
|
-
# protocols, and sources for inbound traffic that you are authorizing
|
2644
|
-
# into your endpoint.
|
2645
|
-
# @return [Array<String>]
|
2646
|
-
#
|
2647
2643
|
# @!attribute [rw] status
|
2648
2644
|
# The current status of the endpoint update process.
|
2649
2645
|
# @return [String]
|
@@ -2652,27 +2648,50 @@ module Aws::OpenSearchServerless
|
|
2652
2648
|
# The ID of the subnets from which you access OpenSearch Serverless.
|
2653
2649
|
# @return [Array<String>]
|
2654
2650
|
#
|
2651
|
+
# @!attribute [rw] security_group_ids
|
2652
|
+
# The unique identifiers of the security groups that define the ports,
|
2653
|
+
# protocols, and sources for inbound traffic that you are authorizing
|
2654
|
+
# into your endpoint.
|
2655
|
+
# @return [Array<String>]
|
2656
|
+
#
|
2657
|
+
# @!attribute [rw] last_modified_date
|
2658
|
+
# The timestamp of when the endpoint was last modified.
|
2659
|
+
# @return [Integer]
|
2660
|
+
#
|
2655
2661
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpointDetail AWS API Documentation
|
2656
2662
|
#
|
2657
2663
|
class UpdateVpcEndpointDetail < Struct.new(
|
2658
2664
|
:id,
|
2659
|
-
:last_modified_date,
|
2660
2665
|
:name,
|
2661
|
-
:security_group_ids,
|
2662
2666
|
:status,
|
2663
|
-
:subnet_ids
|
2667
|
+
:subnet_ids,
|
2668
|
+
:security_group_ids,
|
2669
|
+
:last_modified_date)
|
2664
2670
|
SENSITIVE = []
|
2665
2671
|
include Aws::Structure
|
2666
2672
|
end
|
2667
2673
|
|
2674
|
+
# @!attribute [rw] id
|
2675
|
+
# The unique identifier of the interface endpoint to update.
|
2676
|
+
# @return [String]
|
2677
|
+
#
|
2678
|
+
# @!attribute [rw] add_subnet_ids
|
2679
|
+
# The ID of one or more subnets to add to the endpoint.
|
2680
|
+
# @return [Array<String>]
|
2681
|
+
#
|
2682
|
+
# @!attribute [rw] remove_subnet_ids
|
2683
|
+
# The unique identifiers of the subnets to remove from the endpoint.
|
2684
|
+
# @return [Array<String>]
|
2685
|
+
#
|
2668
2686
|
# @!attribute [rw] add_security_group_ids
|
2669
2687
|
# The unique identifiers of the security groups to add to the
|
2670
2688
|
# endpoint. Security groups define the ports, protocols, and sources
|
2671
2689
|
# for inbound traffic that you are authorizing into your endpoint.
|
2672
2690
|
# @return [Array<String>]
|
2673
2691
|
#
|
2674
|
-
# @!attribute [rw]
|
2675
|
-
# The
|
2692
|
+
# @!attribute [rw] remove_security_group_ids
|
2693
|
+
# The unique identifiers of the security groups to remove from the
|
2694
|
+
# endpoint.
|
2676
2695
|
# @return [Array<String>]
|
2677
2696
|
#
|
2678
2697
|
# @!attribute [rw] client_token
|
@@ -2683,28 +2702,15 @@ module Aws::OpenSearchServerless
|
|
2683
2702
|
# not need to pass this option.
|
2684
2703
|
# @return [String]
|
2685
2704
|
#
|
2686
|
-
# @!attribute [rw] id
|
2687
|
-
# The unique identifier of the interface endpoint to update.
|
2688
|
-
# @return [String]
|
2689
|
-
#
|
2690
|
-
# @!attribute [rw] remove_security_group_ids
|
2691
|
-
# The unique identifiers of the security groups to remove from the
|
2692
|
-
# endpoint.
|
2693
|
-
# @return [Array<String>]
|
2694
|
-
#
|
2695
|
-
# @!attribute [rw] remove_subnet_ids
|
2696
|
-
# The unique identifiers of the subnets to remove from the endpoint.
|
2697
|
-
# @return [Array<String>]
|
2698
|
-
#
|
2699
2705
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpointRequest AWS API Documentation
|
2700
2706
|
#
|
2701
2707
|
class UpdateVpcEndpointRequest < Struct.new(
|
2702
|
-
:add_security_group_ids,
|
2703
|
-
:add_subnet_ids,
|
2704
|
-
:client_token,
|
2705
2708
|
:id,
|
2709
|
+
:add_subnet_ids,
|
2710
|
+
:remove_subnet_ids,
|
2711
|
+
:add_security_group_ids,
|
2706
2712
|
:remove_security_group_ids,
|
2707
|
-
:
|
2713
|
+
:client_token)
|
2708
2714
|
SENSITIVE = []
|
2709
2715
|
include Aws::Structure
|
2710
2716
|
end
|
@@ -2737,18 +2743,6 @@ module Aws::OpenSearchServerless
|
|
2737
2743
|
|
2738
2744
|
# Details about an OpenSearch Serverless-managed interface endpoint.
|
2739
2745
|
#
|
2740
|
-
# @!attribute [rw] created_date
|
2741
|
-
# The date the endpoint was created.
|
2742
|
-
# @return [Integer]
|
2743
|
-
#
|
2744
|
-
# @!attribute [rw] failure_code
|
2745
|
-
# A failure code associated with the request.
|
2746
|
-
# @return [String]
|
2747
|
-
#
|
2748
|
-
# @!attribute [rw] failure_message
|
2749
|
-
# A message associated with the failure code.
|
2750
|
-
# @return [String]
|
2751
|
-
#
|
2752
2746
|
# @!attribute [rw] id
|
2753
2747
|
# The unique identifier of the endpoint.
|
2754
2748
|
# @return [String]
|
@@ -2757,6 +2751,14 @@ module Aws::OpenSearchServerless
|
|
2757
2751
|
# The name of the endpoint.
|
2758
2752
|
# @return [String]
|
2759
2753
|
#
|
2754
|
+
# @!attribute [rw] vpc_id
|
2755
|
+
# The ID of the VPC from which you access OpenSearch Serverless.
|
2756
|
+
# @return [String]
|
2757
|
+
#
|
2758
|
+
# @!attribute [rw] subnet_ids
|
2759
|
+
# The ID of the subnets from which you access OpenSearch Serverless.
|
2760
|
+
# @return [Array<String>]
|
2761
|
+
#
|
2760
2762
|
# @!attribute [rw] security_group_ids
|
2761
2763
|
# The unique identifiers of the security groups that define the ports,
|
2762
2764
|
# protocols, and sources for inbound traffic that you are authorizing
|
@@ -2767,50 +2769,54 @@ module Aws::OpenSearchServerless
|
|
2767
2769
|
# The current status of the endpoint.
|
2768
2770
|
# @return [String]
|
2769
2771
|
#
|
2770
|
-
# @!attribute [rw]
|
2771
|
-
# The
|
2772
|
-
# @return [
|
2772
|
+
# @!attribute [rw] created_date
|
2773
|
+
# The date the endpoint was created.
|
2774
|
+
# @return [Integer]
|
2773
2775
|
#
|
2774
|
-
# @!attribute [rw]
|
2775
|
-
#
|
2776
|
+
# @!attribute [rw] failure_code
|
2777
|
+
# A failure code associated with the request.
|
2778
|
+
# @return [String]
|
2779
|
+
#
|
2780
|
+
# @!attribute [rw] failure_message
|
2781
|
+
# A message associated with the failure code.
|
2776
2782
|
# @return [String]
|
2777
2783
|
#
|
2778
2784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/VpcEndpointDetail AWS API Documentation
|
2779
2785
|
#
|
2780
2786
|
class VpcEndpointDetail < Struct.new(
|
2781
|
-
:created_date,
|
2782
|
-
:failure_code,
|
2783
|
-
:failure_message,
|
2784
2787
|
:id,
|
2785
2788
|
:name,
|
2789
|
+
:vpc_id,
|
2790
|
+
:subnet_ids,
|
2786
2791
|
:security_group_ids,
|
2787
2792
|
:status,
|
2788
|
-
:
|
2789
|
-
:
|
2793
|
+
:created_date,
|
2794
|
+
:failure_code,
|
2795
|
+
:failure_message)
|
2790
2796
|
SENSITIVE = []
|
2791
2797
|
include Aws::Structure
|
2792
2798
|
end
|
2793
2799
|
|
2794
2800
|
# Error information for a failed `BatchGetVpcEndpoint` request.
|
2795
2801
|
#
|
2796
|
-
# @!attribute [rw]
|
2797
|
-
# The
|
2802
|
+
# @!attribute [rw] id
|
2803
|
+
# The unique identifier of the VPC endpoint.
|
2798
2804
|
# @return [String]
|
2799
2805
|
#
|
2800
2806
|
# @!attribute [rw] error_message
|
2801
2807
|
# An error message describing the reason for the failure.
|
2802
2808
|
# @return [String]
|
2803
2809
|
#
|
2804
|
-
# @!attribute [rw]
|
2805
|
-
# The
|
2810
|
+
# @!attribute [rw] error_code
|
2811
|
+
# The error code for the failed request.
|
2806
2812
|
# @return [String]
|
2807
2813
|
#
|
2808
2814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/VpcEndpointErrorDetail AWS API Documentation
|
2809
2815
|
#
|
2810
2816
|
class VpcEndpointErrorDetail < Struct.new(
|
2811
|
-
:
|
2817
|
+
:id,
|
2812
2818
|
:error_message,
|
2813
|
-
:
|
2819
|
+
:error_code)
|
2814
2820
|
SENSITIVE = []
|
2815
2821
|
include Aws::Structure
|
2816
2822
|
end
|