aws-sdk-opensearchservice 1.58.0 → 1.60.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +376 -5
- data/lib/aws-sdk-opensearchservice/client_api.rb +236 -2
- data/lib/aws-sdk-opensearchservice/types.rb +617 -4
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- data/sig/client.rbs +127 -2
- data/sig/types.rbs +149 -0
- metadata +2 -2
@@ -411,6 +411,78 @@ module Aws::OpenSearchService
|
|
411
411
|
include Aws::Structure
|
412
412
|
end
|
413
413
|
|
414
|
+
# Configurations of the OpenSearch Application.
|
415
|
+
#
|
416
|
+
# @!attribute [rw] key
|
417
|
+
# Specify the item to configure, such as admin role for the OpenSearch
|
418
|
+
# Application.
|
419
|
+
# @return [String]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] value
|
422
|
+
# Specifies the value to configure for the key, such as an IAM user
|
423
|
+
# ARN.
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AppConfig AWS API Documentation
|
427
|
+
#
|
428
|
+
class AppConfig < Struct.new(
|
429
|
+
:key,
|
430
|
+
:value)
|
431
|
+
SENSITIVE = []
|
432
|
+
include Aws::Structure
|
433
|
+
end
|
434
|
+
|
435
|
+
# Basic information of the OpenSearch Application.
|
436
|
+
#
|
437
|
+
# @!attribute [rw] id
|
438
|
+
# Unique identifier for an OpenSearch application.
|
439
|
+
# @return [String]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] arn
|
442
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
443
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
444
|
+
# Management* for more information.
|
445
|
+
#
|
446
|
+
#
|
447
|
+
#
|
448
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
449
|
+
# @return [String]
|
450
|
+
#
|
451
|
+
# @!attribute [rw] name
|
452
|
+
# Name of an OpenSearch Application.
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] endpoint
|
456
|
+
# Endpoint URL of an OpenSearch Application.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] status
|
460
|
+
# Status of an OpenSearch Application. Possible values are `CREATING`,
|
461
|
+
# `UPDATING`,` DELETING`, `FAILED`, `ACTIVE`, and `DELETED`.
|
462
|
+
# @return [String]
|
463
|
+
#
|
464
|
+
# @!attribute [rw] created_at
|
465
|
+
# Timestamp at which an OpenSearch Application was created.
|
466
|
+
# @return [Time]
|
467
|
+
#
|
468
|
+
# @!attribute [rw] last_updated_at
|
469
|
+
# Timestamp at which an OpenSearch Application was last updated.
|
470
|
+
# @return [Time]
|
471
|
+
#
|
472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ApplicationSummary AWS API Documentation
|
473
|
+
#
|
474
|
+
class ApplicationSummary < Struct.new(
|
475
|
+
:id,
|
476
|
+
:arn,
|
477
|
+
:name,
|
478
|
+
:endpoint,
|
479
|
+
:status,
|
480
|
+
:created_at,
|
481
|
+
:last_updated_at)
|
482
|
+
SENSITIVE = []
|
483
|
+
include Aws::Structure
|
484
|
+
end
|
485
|
+
|
414
486
|
# Container for the request parameters to the `AssociatePackage`
|
415
487
|
# operation.
|
416
488
|
#
|
@@ -455,11 +527,16 @@ module Aws::OpenSearchService
|
|
455
527
|
# The Amazon Web Services account ID to grant access to.
|
456
528
|
# @return [String]
|
457
529
|
#
|
530
|
+
# @!attribute [rw] service
|
531
|
+
# The Amazon Web Services service SP to grant access to.
|
532
|
+
# @return [String]
|
533
|
+
#
|
458
534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccessRequest AWS API Documentation
|
459
535
|
#
|
460
536
|
class AuthorizeVpcEndpointAccessRequest < Struct.new(
|
461
537
|
:domain_name,
|
462
|
-
:account
|
538
|
+
:account,
|
539
|
+
:service)
|
463
540
|
SENSITIVE = []
|
464
541
|
include Aws::Structure
|
465
542
|
end
|
@@ -567,7 +644,7 @@ module Aws::OpenSearchService
|
|
567
644
|
#
|
568
645
|
# @!attribute [rw] duration
|
569
646
|
# The duration of the maintenance schedule. For example, `"Duration":
|
570
|
-
#
|
647
|
+
# {"Value": 2, "Unit": "HOURS"}`.
|
571
648
|
# @return [Types::Duration]
|
572
649
|
#
|
573
650
|
# @!attribute [rw] cron_expression_for_recurrence
|
@@ -1309,6 +1386,105 @@ module Aws::OpenSearchService
|
|
1309
1386
|
include Aws::Structure
|
1310
1387
|
end
|
1311
1388
|
|
1389
|
+
# @!attribute [rw] client_token
|
1390
|
+
# A unique client idempotency token. It will be auto generated if not
|
1391
|
+
# provided.
|
1392
|
+
#
|
1393
|
+
# **A suitable default value is auto-generated.** You should normally
|
1394
|
+
# not need to pass this option.
|
1395
|
+
# @return [String]
|
1396
|
+
#
|
1397
|
+
# @!attribute [rw] name
|
1398
|
+
# Name of the OpenSearch Appication to create. Application names are
|
1399
|
+
# unique across the applications owned by an account within an Amazon
|
1400
|
+
# Web Services Region.
|
1401
|
+
# @return [String]
|
1402
|
+
#
|
1403
|
+
# @!attribute [rw] data_sources
|
1404
|
+
# Data sources to be associated with the OpenSearch Application.
|
1405
|
+
# @return [Array<Types::DataSource>]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] iam_identity_center_options
|
1408
|
+
# Settings of IAM Identity Center for the OpenSearch Application.
|
1409
|
+
# @return [Types::IamIdentityCenterOptionsInput]
|
1410
|
+
#
|
1411
|
+
# @!attribute [rw] app_configs
|
1412
|
+
# Configurations of the OpenSearch Application, inlcuding admin
|
1413
|
+
# configuration.
|
1414
|
+
# @return [Array<Types::AppConfig>]
|
1415
|
+
#
|
1416
|
+
# @!attribute [rw] tag_list
|
1417
|
+
# A list of tags attached to a domain.
|
1418
|
+
# @return [Array<Types::Tag>]
|
1419
|
+
#
|
1420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateApplicationRequest AWS API Documentation
|
1421
|
+
#
|
1422
|
+
class CreateApplicationRequest < Struct.new(
|
1423
|
+
:client_token,
|
1424
|
+
:name,
|
1425
|
+
:data_sources,
|
1426
|
+
:iam_identity_center_options,
|
1427
|
+
:app_configs,
|
1428
|
+
:tag_list)
|
1429
|
+
SENSITIVE = []
|
1430
|
+
include Aws::Structure
|
1431
|
+
end
|
1432
|
+
|
1433
|
+
# @!attribute [rw] id
|
1434
|
+
# Unique identifier for the created OpenSearch Application.
|
1435
|
+
# @return [String]
|
1436
|
+
#
|
1437
|
+
# @!attribute [rw] name
|
1438
|
+
# Name of the created OpenSearch Application.
|
1439
|
+
# @return [String]
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] arn
|
1442
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
1443
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
1444
|
+
# Management* for more information.
|
1445
|
+
#
|
1446
|
+
#
|
1447
|
+
#
|
1448
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] data_sources
|
1452
|
+
# Data sources associated with the created OpenSearch Application.
|
1453
|
+
# @return [Array<Types::DataSource>]
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] iam_identity_center_options
|
1456
|
+
# Settings of IAM Identity Center for the created OpenSearch
|
1457
|
+
# Application.
|
1458
|
+
# @return [Types::IamIdentityCenterOptions]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] app_configs
|
1461
|
+
# Configurations of the OpenSearch Application, inlcuding admin
|
1462
|
+
# configuration.
|
1463
|
+
# @return [Array<Types::AppConfig>]
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] tag_list
|
1466
|
+
# A list of tags attached to a domain.
|
1467
|
+
# @return [Array<Types::Tag>]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] created_at
|
1470
|
+
# Timestamp when the OpenSearch Application was created.
|
1471
|
+
# @return [Time]
|
1472
|
+
#
|
1473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateApplicationResponse AWS API Documentation
|
1474
|
+
#
|
1475
|
+
class CreateApplicationResponse < Struct.new(
|
1476
|
+
:id,
|
1477
|
+
:name,
|
1478
|
+
:arn,
|
1479
|
+
:data_sources,
|
1480
|
+
:iam_identity_center_options,
|
1481
|
+
:app_configs,
|
1482
|
+
:tag_list,
|
1483
|
+
:created_at)
|
1484
|
+
SENSITIVE = []
|
1485
|
+
include Aws::Structure
|
1486
|
+
end
|
1487
|
+
|
1312
1488
|
# @!attribute [rw] domain_name
|
1313
1489
|
# Name of the OpenSearch Service domain to create. Domain names are
|
1314
1490
|
# unique across the domains owned by an account within an Amazon Web
|
@@ -1429,6 +1605,10 @@ module Aws::OpenSearchService
|
|
1429
1605
|
# Options for fine-grained access control.
|
1430
1606
|
# @return [Types::AdvancedSecurityOptionsInput]
|
1431
1607
|
#
|
1608
|
+
# @!attribute [rw] identity_center_options
|
1609
|
+
# Options for IAM Identity Center Option control for the domain.
|
1610
|
+
# @return [Types::IdentityCenterOptionsInput]
|
1611
|
+
#
|
1432
1612
|
# @!attribute [rw] tag_list
|
1433
1613
|
# List of tags to add to the domain upon creation.
|
1434
1614
|
# @return [Array<Types::Tag>]
|
@@ -1472,6 +1652,7 @@ module Aws::OpenSearchService
|
|
1472
1652
|
:log_publishing_options,
|
1473
1653
|
:domain_endpoint_options,
|
1474
1654
|
:advanced_security_options,
|
1655
|
+
:identity_center_options,
|
1475
1656
|
:tag_list,
|
1476
1657
|
:auto_tune_options,
|
1477
1658
|
:off_peak_window_options,
|
@@ -1673,6 +1854,31 @@ module Aws::OpenSearchService
|
|
1673
1854
|
include Aws::Structure
|
1674
1855
|
end
|
1675
1856
|
|
1857
|
+
# Data sources that are associated with an OpenSearch Application.
|
1858
|
+
#
|
1859
|
+
# @!attribute [rw] data_source_arn
|
1860
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
1861
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
1862
|
+
# Management* for more information.
|
1863
|
+
#
|
1864
|
+
#
|
1865
|
+
#
|
1866
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
1867
|
+
# @return [String]
|
1868
|
+
#
|
1869
|
+
# @!attribute [rw] data_source_description
|
1870
|
+
# Detailed description of a data source.
|
1871
|
+
# @return [String]
|
1872
|
+
#
|
1873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DataSource AWS API Documentation
|
1874
|
+
#
|
1875
|
+
class DataSource < Struct.new(
|
1876
|
+
:data_source_arn,
|
1877
|
+
:data_source_description)
|
1878
|
+
SENSITIVE = []
|
1879
|
+
include Aws::Structure
|
1880
|
+
end
|
1881
|
+
|
1676
1882
|
# Details about a direct-query data source.
|
1677
1883
|
#
|
1678
1884
|
# @!attribute [rw] data_source_type
|
@@ -1725,6 +1931,23 @@ module Aws::OpenSearchService
|
|
1725
1931
|
class Unknown < DataSourceType; end
|
1726
1932
|
end
|
1727
1933
|
|
1934
|
+
# @!attribute [rw] id
|
1935
|
+
# Unique identifier for the OpenSearch Application that you want to
|
1936
|
+
# delete.
|
1937
|
+
# @return [String]
|
1938
|
+
#
|
1939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteApplicationRequest AWS API Documentation
|
1940
|
+
#
|
1941
|
+
class DeleteApplicationRequest < Struct.new(
|
1942
|
+
:id)
|
1943
|
+
SENSITIVE = []
|
1944
|
+
include Aws::Structure
|
1945
|
+
end
|
1946
|
+
|
1947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteApplicationResponse AWS API Documentation
|
1948
|
+
#
|
1949
|
+
class DeleteApplicationResponse < Aws::EmptyStructure; end
|
1950
|
+
|
1728
1951
|
# Container for the parameters to the `DeleteDataSource` operation.
|
1729
1952
|
#
|
1730
1953
|
# @!attribute [rw] domain_name
|
@@ -2754,6 +2977,10 @@ module Aws::OpenSearchService
|
|
2754
2977
|
# Container for fine-grained access control settings for the domain.
|
2755
2978
|
# @return [Types::AdvancedSecurityOptionsStatus]
|
2756
2979
|
#
|
2980
|
+
# @!attribute [rw] identity_center_options
|
2981
|
+
# Container for IAM Identity Center Option control for the domain.
|
2982
|
+
# @return [Types::IdentityCenterOptionsStatus]
|
2983
|
+
#
|
2757
2984
|
# @!attribute [rw] auto_tune_options
|
2758
2985
|
# Container for Auto-Tune settings for the domain.
|
2759
2986
|
# @return [Types::AutoTuneOptionsStatus]
|
@@ -2798,6 +3025,7 @@ module Aws::OpenSearchService
|
|
2798
3025
|
:log_publishing_options,
|
2799
3026
|
:domain_endpoint_options,
|
2800
3027
|
:advanced_security_options,
|
3028
|
+
:identity_center_options,
|
2801
3029
|
:auto_tune_options,
|
2802
3030
|
:change_progress_details,
|
2803
3031
|
:off_peak_window_options,
|
@@ -3207,6 +3435,10 @@ module Aws::OpenSearchService
|
|
3207
3435
|
# Settings for fine-grained access control.
|
3208
3436
|
# @return [Types::AdvancedSecurityOptions]
|
3209
3437
|
#
|
3438
|
+
# @!attribute [rw] identity_center_options
|
3439
|
+
# Container for IAM Identity Center Option control for the domain.
|
3440
|
+
# @return [Types::IdentityCenterOptions]
|
3441
|
+
#
|
3210
3442
|
# @!attribute [rw] auto_tune_options
|
3211
3443
|
# Auto-Tune settings for the domain.
|
3212
3444
|
# @return [Types::AutoTuneOptionsOutput]
|
@@ -3268,6 +3500,7 @@ module Aws::OpenSearchService
|
|
3268
3500
|
:service_software_options,
|
3269
3501
|
:domain_endpoint_options,
|
3270
3502
|
:advanced_security_options,
|
3503
|
+
:identity_center_options,
|
3271
3504
|
:auto_tune_options,
|
3272
3505
|
:change_progress_details,
|
3273
3506
|
:off_peak_window_options,
|
@@ -3527,6 +3760,84 @@ module Aws::OpenSearchService
|
|
3527
3760
|
include Aws::Structure
|
3528
3761
|
end
|
3529
3762
|
|
3763
|
+
# @!attribute [rw] id
|
3764
|
+
# Unique identifier of the checked OpenSearch Application.
|
3765
|
+
# @return [String]
|
3766
|
+
#
|
3767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetApplicationRequest AWS API Documentation
|
3768
|
+
#
|
3769
|
+
class GetApplicationRequest < Struct.new(
|
3770
|
+
:id)
|
3771
|
+
SENSITIVE = []
|
3772
|
+
include Aws::Structure
|
3773
|
+
end
|
3774
|
+
|
3775
|
+
# @!attribute [rw] id
|
3776
|
+
# Unique identifier of the checked OpenSearch Application.
|
3777
|
+
# @return [String]
|
3778
|
+
#
|
3779
|
+
# @!attribute [rw] arn
|
3780
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
3781
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
3782
|
+
# Management* for more information.
|
3783
|
+
#
|
3784
|
+
#
|
3785
|
+
#
|
3786
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
3787
|
+
# @return [String]
|
3788
|
+
#
|
3789
|
+
# @!attribute [rw] name
|
3790
|
+
# Name of the checked OpenSearch Application.
|
3791
|
+
# @return [String]
|
3792
|
+
#
|
3793
|
+
# @!attribute [rw] endpoint
|
3794
|
+
# Endpoint URL of the checked OpenSearch Application.
|
3795
|
+
# @return [String]
|
3796
|
+
#
|
3797
|
+
# @!attribute [rw] status
|
3798
|
+
# Current status of the checked OpenSearch Application. Possible
|
3799
|
+
# values are `CREATING`, `UPDATING`, `DELETING`, `FAILED`, `ACTIVE`,
|
3800
|
+
# and `DELETED`.
|
3801
|
+
# @return [String]
|
3802
|
+
#
|
3803
|
+
# @!attribute [rw] iam_identity_center_options
|
3804
|
+
# IAM Identity Center settings for the checked OpenSearch Application.
|
3805
|
+
# @return [Types::IamIdentityCenterOptions]
|
3806
|
+
#
|
3807
|
+
# @!attribute [rw] data_sources
|
3808
|
+
# Associated data sources to the checked OpenSearch Application.
|
3809
|
+
# @return [Array<Types::DataSource>]
|
3810
|
+
#
|
3811
|
+
# @!attribute [rw] app_configs
|
3812
|
+
# App configurations of the checked OpenSearch Application.
|
3813
|
+
# @return [Array<Types::AppConfig>]
|
3814
|
+
#
|
3815
|
+
# @!attribute [rw] created_at
|
3816
|
+
# Timestamp at which the checked OpenSearch Application was created.
|
3817
|
+
# @return [Time]
|
3818
|
+
#
|
3819
|
+
# @!attribute [rw] last_updated_at
|
3820
|
+
# Timestamp at which the checked OpenSearch Application was last
|
3821
|
+
# updated.
|
3822
|
+
# @return [Time]
|
3823
|
+
#
|
3824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetApplicationResponse AWS API Documentation
|
3825
|
+
#
|
3826
|
+
class GetApplicationResponse < Struct.new(
|
3827
|
+
:id,
|
3828
|
+
:arn,
|
3829
|
+
:name,
|
3830
|
+
:endpoint,
|
3831
|
+
:status,
|
3832
|
+
:iam_identity_center_options,
|
3833
|
+
:data_sources,
|
3834
|
+
:app_configs,
|
3835
|
+
:created_at,
|
3836
|
+
:last_updated_at)
|
3837
|
+
SENSITIVE = []
|
3838
|
+
include Aws::Structure
|
3839
|
+
end
|
3840
|
+
|
3530
3841
|
# Container for the request parameters to `GetCompatibleVersions`
|
3531
3842
|
# operation.
|
3532
3843
|
#
|
@@ -3838,6 +4149,174 @@ module Aws::OpenSearchService
|
|
3838
4149
|
include Aws::Structure
|
3839
4150
|
end
|
3840
4151
|
|
4152
|
+
# Settings for IAM Identity Center for an OpenSearch Application.
|
4153
|
+
#
|
4154
|
+
# @!attribute [rw] enabled
|
4155
|
+
# IAM Identity Center is enabled for the OpenSearch Application.
|
4156
|
+
# @return [Boolean]
|
4157
|
+
#
|
4158
|
+
# @!attribute [rw] iam_identity_center_instance_arn
|
4159
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
4160
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
4161
|
+
# Management* for more information.
|
4162
|
+
#
|
4163
|
+
#
|
4164
|
+
#
|
4165
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
4166
|
+
# @return [String]
|
4167
|
+
#
|
4168
|
+
# @!attribute [rw] iam_role_for_identity_center_application_arn
|
4169
|
+
# Amazon Resource Name of the IAM Identity Center's Application
|
4170
|
+
# created for the OpenSearch Application after enabling IAM Identity
|
4171
|
+
# Center.
|
4172
|
+
# @return [String]
|
4173
|
+
#
|
4174
|
+
# @!attribute [rw] iam_identity_center_application_arn
|
4175
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
4176
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
4177
|
+
# Management* for more information.
|
4178
|
+
#
|
4179
|
+
#
|
4180
|
+
#
|
4181
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
4182
|
+
# @return [String]
|
4183
|
+
#
|
4184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IamIdentityCenterOptions AWS API Documentation
|
4185
|
+
#
|
4186
|
+
class IamIdentityCenterOptions < Struct.new(
|
4187
|
+
:enabled,
|
4188
|
+
:iam_identity_center_instance_arn,
|
4189
|
+
:iam_role_for_identity_center_application_arn,
|
4190
|
+
:iam_identity_center_application_arn)
|
4191
|
+
SENSITIVE = []
|
4192
|
+
include Aws::Structure
|
4193
|
+
end
|
4194
|
+
|
4195
|
+
# Settings for IAM Identity Center.
|
4196
|
+
#
|
4197
|
+
# @!attribute [rw] enabled
|
4198
|
+
# Enable/disable settings for IAM Identity Center.
|
4199
|
+
# @return [Boolean]
|
4200
|
+
#
|
4201
|
+
# @!attribute [rw] iam_identity_center_instance_arn
|
4202
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
4203
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
4204
|
+
# Management* for more information.
|
4205
|
+
#
|
4206
|
+
#
|
4207
|
+
#
|
4208
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
4209
|
+
# @return [String]
|
4210
|
+
#
|
4211
|
+
# @!attribute [rw] iam_role_for_identity_center_application_arn
|
4212
|
+
# Amazon Resource Name of IAM Identity Center's application.
|
4213
|
+
# @return [String]
|
4214
|
+
#
|
4215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IamIdentityCenterOptionsInput AWS API Documentation
|
4216
|
+
#
|
4217
|
+
class IamIdentityCenterOptionsInput < Struct.new(
|
4218
|
+
:enabled,
|
4219
|
+
:iam_identity_center_instance_arn,
|
4220
|
+
:iam_role_for_identity_center_application_arn)
|
4221
|
+
SENSITIVE = []
|
4222
|
+
include Aws::Structure
|
4223
|
+
end
|
4224
|
+
|
4225
|
+
# Container for IAM Identity Center Options settings.
|
4226
|
+
#
|
4227
|
+
# @!attribute [rw] enabled_api_access
|
4228
|
+
# True to enable IAM Identity Center for API access in Amazon
|
4229
|
+
# OpenSearch Service.
|
4230
|
+
# @return [Boolean]
|
4231
|
+
#
|
4232
|
+
# @!attribute [rw] identity_center_instance_arn
|
4233
|
+
# The ARN for IAM Identity Center Instance.
|
4234
|
+
# @return [String]
|
4235
|
+
#
|
4236
|
+
# @!attribute [rw] subject_key
|
4237
|
+
# Specify the attribute that contains the subject (username, userID,
|
4238
|
+
# email) of IAM Identity Center.
|
4239
|
+
# @return [String]
|
4240
|
+
#
|
4241
|
+
# @!attribute [rw] roles_key
|
4242
|
+
# Specify the attribute that contains the backend role (groupName,
|
4243
|
+
# groupID) of IAM Identity Center
|
4244
|
+
# @return [String]
|
4245
|
+
#
|
4246
|
+
# @!attribute [rw] identity_center_application_arn
|
4247
|
+
# The ARN for IAM Identity Center Application which will integrate
|
4248
|
+
# with Amazon OpenSearch Service.
|
4249
|
+
# @return [String]
|
4250
|
+
#
|
4251
|
+
# @!attribute [rw] identity_store_id
|
4252
|
+
# The ID of IAM Identity Store.
|
4253
|
+
# @return [String]
|
4254
|
+
#
|
4255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IdentityCenterOptions AWS API Documentation
|
4256
|
+
#
|
4257
|
+
class IdentityCenterOptions < Struct.new(
|
4258
|
+
:enabled_api_access,
|
4259
|
+
:identity_center_instance_arn,
|
4260
|
+
:subject_key,
|
4261
|
+
:roles_key,
|
4262
|
+
:identity_center_application_arn,
|
4263
|
+
:identity_store_id)
|
4264
|
+
SENSITIVE = []
|
4265
|
+
include Aws::Structure
|
4266
|
+
end
|
4267
|
+
|
4268
|
+
# Container for IAM Identity Center Options settings.
|
4269
|
+
#
|
4270
|
+
# @!attribute [rw] enabled_api_access
|
4271
|
+
# True to enable IAM Identity Center for API access in Amazon
|
4272
|
+
# OpenSearch Service.
|
4273
|
+
# @return [Boolean]
|
4274
|
+
#
|
4275
|
+
# @!attribute [rw] identity_center_instance_arn
|
4276
|
+
# The ARN for IAM Identity Center Instance which will be used for IAM
|
4277
|
+
# Identity Center Application creation.
|
4278
|
+
# @return [String]
|
4279
|
+
#
|
4280
|
+
# @!attribute [rw] subject_key
|
4281
|
+
# Specify the attribute that contains the subject (username, userID,
|
4282
|
+
# email) of IAM Identity Center.
|
4283
|
+
# @return [String]
|
4284
|
+
#
|
4285
|
+
# @!attribute [rw] roles_key
|
4286
|
+
# Specify the attribute that contains the backend role (groupName,
|
4287
|
+
# groupID) of IAM Identity Center
|
4288
|
+
# @return [String]
|
4289
|
+
#
|
4290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IdentityCenterOptionsInput AWS API Documentation
|
4291
|
+
#
|
4292
|
+
class IdentityCenterOptionsInput < Struct.new(
|
4293
|
+
:enabled_api_access,
|
4294
|
+
:identity_center_instance_arn,
|
4295
|
+
:subject_key,
|
4296
|
+
:roles_key)
|
4297
|
+
SENSITIVE = []
|
4298
|
+
include Aws::Structure
|
4299
|
+
end
|
4300
|
+
|
4301
|
+
# The status of IAM Identity Center Options settings for a domain.
|
4302
|
+
#
|
4303
|
+
# @!attribute [rw] options
|
4304
|
+
# Container for IAM Identity Center Options settings.
|
4305
|
+
# @return [Types::IdentityCenterOptions]
|
4306
|
+
#
|
4307
|
+
# @!attribute [rw] status
|
4308
|
+
# The status of IAM Identity Center Options settings for a domain.
|
4309
|
+
# @return [Types::OptionStatus]
|
4310
|
+
#
|
4311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IdentityCenterOptionsStatus AWS API Documentation
|
4312
|
+
#
|
4313
|
+
class IdentityCenterOptionsStatus < Struct.new(
|
4314
|
+
:options,
|
4315
|
+
:status)
|
4316
|
+
SENSITIVE = []
|
4317
|
+
include Aws::Structure
|
4318
|
+
end
|
4319
|
+
|
3841
4320
|
# Describes an inbound cross-cluster connection for Amazon OpenSearch
|
3842
4321
|
# Service. For more information, see [Cross-cluster search for Amazon
|
3843
4322
|
# OpenSearch Service][1].
|
@@ -4120,6 +4599,55 @@ module Aws::OpenSearchService
|
|
4120
4599
|
include Aws::Structure
|
4121
4600
|
end
|
4122
4601
|
|
4602
|
+
# @!attribute [rw] next_token
|
4603
|
+
# When `nextToken` is returned, there are more results available. The
|
4604
|
+
# value of `nextToken` is a unique pagination token for each page.
|
4605
|
+
# Send the request again using the returned token to retrieve the next
|
4606
|
+
# page.
|
4607
|
+
# @return [String]
|
4608
|
+
#
|
4609
|
+
# @!attribute [rw] statuses
|
4610
|
+
# OpenSearch Application Status can be used as filters for the listing
|
4611
|
+
# request. Possible values are `CREATING`, `UPDATING`, `DELETING`,
|
4612
|
+
# `FAILED`, `ACTIVE`, and `DELETED`.
|
4613
|
+
# @return [Array<String>]
|
4614
|
+
#
|
4615
|
+
# @!attribute [rw] max_results
|
4616
|
+
# An optional parameter that specifies the maximum number of results
|
4617
|
+
# to return for a given request.
|
4618
|
+
# @return [Integer]
|
4619
|
+
#
|
4620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListApplicationsRequest AWS API Documentation
|
4621
|
+
#
|
4622
|
+
class ListApplicationsRequest < Struct.new(
|
4623
|
+
:next_token,
|
4624
|
+
:statuses,
|
4625
|
+
:max_results)
|
4626
|
+
SENSITIVE = []
|
4627
|
+
include Aws::Structure
|
4628
|
+
end
|
4629
|
+
|
4630
|
+
# @!attribute [rw] application_summaries
|
4631
|
+
# Summary of the OpenSearch Applications, including ID, ARN, name,
|
4632
|
+
# endpoint, status, create time and last update time.
|
4633
|
+
# @return [Array<Types::ApplicationSummary>]
|
4634
|
+
#
|
4635
|
+
# @!attribute [rw] next_token
|
4636
|
+
# When `nextToken` is returned, there are more results available. The
|
4637
|
+
# value of `nextToken` is a unique pagination token for each page.
|
4638
|
+
# Send the request again using the returned token to retrieve the next
|
4639
|
+
# page.
|
4640
|
+
# @return [String]
|
4641
|
+
#
|
4642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListApplicationsResponse AWS API Documentation
|
4643
|
+
#
|
4644
|
+
class ListApplicationsResponse < Struct.new(
|
4645
|
+
:application_summaries,
|
4646
|
+
:next_token)
|
4647
|
+
SENSITIVE = []
|
4648
|
+
include Aws::Structure
|
4649
|
+
end
|
4650
|
+
|
4123
4651
|
# Container for the parameters to the `ListDataSources` operation.
|
4124
4652
|
#
|
4125
4653
|
# @!attribute [rw] domain_name
|
@@ -4755,7 +5283,7 @@ module Aws::OpenSearchService
|
|
4755
5283
|
# "c5.large.search".
|
4756
5284
|
#
|
4757
5285
|
# * `STRINGIFIED_JSON`: Contain content in JSON format, such as
|
4758
|
-
#
|
5286
|
+
# \{"Enabled":"True"}".
|
4759
5287
|
# @return [String]
|
4760
5288
|
#
|
4761
5289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ModifyingProperties AWS API Documentation
|
@@ -5526,11 +6054,16 @@ module Aws::OpenSearchService
|
|
5526
6054
|
# The account ID to revoke access from.
|
5527
6055
|
# @return [String]
|
5528
6056
|
#
|
6057
|
+
# @!attribute [rw] service
|
6058
|
+
# The service SP to revoke access from.
|
6059
|
+
# @return [String]
|
6060
|
+
#
|
5529
6061
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RevokeVpcEndpointAccessRequest AWS API Documentation
|
5530
6062
|
#
|
5531
6063
|
class RevokeVpcEndpointAccessRequest < Struct.new(
|
5532
6064
|
:domain_name,
|
5533
|
-
:account
|
6065
|
+
:account,
|
6066
|
+
:service)
|
5534
6067
|
SENSITIVE = []
|
5535
6068
|
include Aws::Structure
|
5536
6069
|
end
|
@@ -6092,6 +6625,81 @@ module Aws::OpenSearchService
|
|
6092
6625
|
include Aws::Structure
|
6093
6626
|
end
|
6094
6627
|
|
6628
|
+
# @!attribute [rw] id
|
6629
|
+
# Unique identifier of the OpenSearch Application to be updated.
|
6630
|
+
# @return [String]
|
6631
|
+
#
|
6632
|
+
# @!attribute [rw] data_sources
|
6633
|
+
# Data sources to be associated with the OpenSearch Application.
|
6634
|
+
# @return [Array<Types::DataSource>]
|
6635
|
+
#
|
6636
|
+
# @!attribute [rw] app_configs
|
6637
|
+
# Configurations to be changed for the OpenSearch Application.
|
6638
|
+
# @return [Array<Types::AppConfig>]
|
6639
|
+
#
|
6640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateApplicationRequest AWS API Documentation
|
6641
|
+
#
|
6642
|
+
class UpdateApplicationRequest < Struct.new(
|
6643
|
+
:id,
|
6644
|
+
:data_sources,
|
6645
|
+
:app_configs)
|
6646
|
+
SENSITIVE = []
|
6647
|
+
include Aws::Structure
|
6648
|
+
end
|
6649
|
+
|
6650
|
+
# @!attribute [rw] id
|
6651
|
+
# Unique identifier of the updated OpenSearch Application.
|
6652
|
+
# @return [String]
|
6653
|
+
#
|
6654
|
+
# @!attribute [rw] name
|
6655
|
+
# Name of the updated OpenSearch Application.
|
6656
|
+
# @return [String]
|
6657
|
+
#
|
6658
|
+
# @!attribute [rw] arn
|
6659
|
+
# The Amazon Resource Name (ARN) of the domain. See [Identifiers for
|
6660
|
+
# IAM Entities ][1] in *Using Amazon Web Services Identity and Access
|
6661
|
+
# Management* for more information.
|
6662
|
+
#
|
6663
|
+
#
|
6664
|
+
#
|
6665
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
|
6666
|
+
# @return [String]
|
6667
|
+
#
|
6668
|
+
# @!attribute [rw] data_sources
|
6669
|
+
# Data sources associated with the updated OpenSearch Application.
|
6670
|
+
# @return [Array<Types::DataSource>]
|
6671
|
+
#
|
6672
|
+
# @!attribute [rw] iam_identity_center_options
|
6673
|
+
# IAM Identity Center settings for the updated OpenSearch Application.
|
6674
|
+
# @return [Types::IamIdentityCenterOptions]
|
6675
|
+
#
|
6676
|
+
# @!attribute [rw] app_configs
|
6677
|
+
# Configurations for the updated OpenSearch Application.
|
6678
|
+
# @return [Array<Types::AppConfig>]
|
6679
|
+
#
|
6680
|
+
# @!attribute [rw] created_at
|
6681
|
+
# Timestamp at which the OpenSearch Application was created.
|
6682
|
+
# @return [Time]
|
6683
|
+
#
|
6684
|
+
# @!attribute [rw] last_updated_at
|
6685
|
+
# Timestamp at which the OpenSearch Application was last updated.
|
6686
|
+
# @return [Time]
|
6687
|
+
#
|
6688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateApplicationResponse AWS API Documentation
|
6689
|
+
#
|
6690
|
+
class UpdateApplicationResponse < Struct.new(
|
6691
|
+
:id,
|
6692
|
+
:name,
|
6693
|
+
:arn,
|
6694
|
+
:data_sources,
|
6695
|
+
:iam_identity_center_options,
|
6696
|
+
:app_configs,
|
6697
|
+
:created_at,
|
6698
|
+
:last_updated_at)
|
6699
|
+
SENSITIVE = []
|
6700
|
+
include Aws::Structure
|
6701
|
+
end
|
6702
|
+
|
6095
6703
|
# Container for the parameters to the `UpdateDataSource` operation.
|
6096
6704
|
#
|
6097
6705
|
# @!attribute [rw] domain_name
|
@@ -6237,6 +6845,10 @@ module Aws::OpenSearchService
|
|
6237
6845
|
# Options for fine-grained access control.
|
6238
6846
|
# @return [Types::AdvancedSecurityOptionsInput]
|
6239
6847
|
#
|
6848
|
+
# @!attribute [rw] identity_center_options
|
6849
|
+
# Container for IAM Identity Center Options settings.
|
6850
|
+
# @return [Types::IdentityCenterOptionsInput]
|
6851
|
+
#
|
6240
6852
|
# @!attribute [rw] auto_tune_options
|
6241
6853
|
# Options for Auto-Tune.
|
6242
6854
|
# @return [Types::AutoTuneOptions]
|
@@ -6291,6 +6903,7 @@ module Aws::OpenSearchService
|
|
6291
6903
|
:domain_endpoint_options,
|
6292
6904
|
:node_to_node_encryption_options,
|
6293
6905
|
:advanced_security_options,
|
6906
|
+
:identity_center_options,
|
6294
6907
|
:auto_tune_options,
|
6295
6908
|
:dry_run,
|
6296
6909
|
:dry_run_mode,
|