Skip to content

Commit ece147b

Browse files
This release introduces the Default Application feature, allowing users to set, change, or unset a preferred OpenSearch UI application on a per-region basis for a streamlined and consistent user experience.
1 parent 2390c3b commit ece147b

22 files changed

+1602
-32
lines changed

generator/ServiceModels/opensearch/opensearch-2021-01-01.api.json

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -679,6 +679,22 @@
679679
{"shape":"DependencyFailureException"}
680680
]
681681
},
682+
"GetDefaultApplicationSetting":{
683+
"name":"GetDefaultApplicationSetting",
684+
"http":{
685+
"method":"GET",
686+
"requestUri":"/2021-01-01/opensearch/defaultApplicationSetting",
687+
"responseCode":200
688+
},
689+
"input":{"shape":"GetDefaultApplicationSettingRequest"},
690+
"output":{"shape":"GetDefaultApplicationSettingResponse"},
691+
"errors":[
692+
{"shape":"ValidationException"},
693+
{"shape":"AccessDeniedException"},
694+
{"shape":"InternalException"},
695+
{"shape":"ResourceNotFoundException"}
696+
]
697+
},
682698
"GetDirectQueryDataSource":{
683699
"name":"GetDirectQueryDataSource",
684700
"http":{
@@ -993,6 +1009,22 @@
9931009
{"shape":"InternalException"}
9941010
]
9951011
},
1012+
"PutDefaultApplicationSetting":{
1013+
"name":"PutDefaultApplicationSetting",
1014+
"http":{
1015+
"method":"PUT",
1016+
"requestUri":"/2021-01-01/opensearch/defaultApplicationSetting",
1017+
"responseCode":200
1018+
},
1019+
"input":{"shape":"PutDefaultApplicationSettingRequest"},
1020+
"output":{"shape":"PutDefaultApplicationSettingResponse"},
1021+
"errors":[
1022+
{"shape":"ValidationException"},
1023+
{"shape":"AccessDeniedException"},
1024+
{"shape":"InternalException"},
1025+
{"shape":"ResourceNotFoundException"}
1026+
]
1027+
},
9961028
"RejectInboundConnection":{
9971029
"name":"RejectInboundConnection",
9981030
"http":{
@@ -3181,6 +3213,16 @@
31813213
"Status":{"shape":"DataSourceStatus"}
31823214
}
31833215
},
3216+
"GetDefaultApplicationSettingRequest":{
3217+
"type":"structure",
3218+
"members":{}
3219+
},
3220+
"GetDefaultApplicationSettingResponse":{
3221+
"type":"structure",
3222+
"members":{
3223+
"applicationArn":{"shape":"ARN"}
3224+
}
3225+
},
31843226
"GetDirectQueryDataSourceRequest":{
31853227
"type":"structure",
31863228
"required":["DataSourceName"],
@@ -4605,6 +4647,23 @@
46054647
"ReservationName":{"shape":"ReservationToken"}
46064648
}
46074649
},
4650+
"PutDefaultApplicationSettingRequest":{
4651+
"type":"structure",
4652+
"required":[
4653+
"applicationArn",
4654+
"setAsDefault"
4655+
],
4656+
"members":{
4657+
"applicationArn":{"shape":"ARN"},
4658+
"setAsDefault":{"shape":"Boolean"}
4659+
}
4660+
},
4661+
"PutDefaultApplicationSettingResponse":{
4662+
"type":"structure",
4663+
"members":{
4664+
"applicationArn":{"shape":"ARN"}
4665+
}
4666+
},
46084667
"RecurringCharge":{
46094668
"type":"structure",
46104669
"members":{

generator/ServiceModels/opensearch/opensearch-2021-01-01.docs.json

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
"GetApplication": "<p>Retrieves the configuration and status of an existing OpenSearch application.</p>",
4545
"GetCompatibleVersions": "<p>Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.</p>",
4646
"GetDataSource": "<p>Retrieves information about a direct query data source.</p>",
47+
"GetDefaultApplicationSetting": "<p>Gets the ARN of the current default application.</p> <p> If the default application isn't set, the operation returns a resource not found error.</p>",
4748
"GetDirectQueryDataSource": "<p> Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service. </p>",
4849
"GetDomainMaintenanceStatus": "<p>The status of the maintenance action.</p>",
4950
"GetPackageVersionHistory": "<p>Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html\">Custom packages for Amazon OpenSearch Service</a>.</p>",
@@ -64,6 +65,7 @@
6465
"ListVpcEndpoints": "<p>Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.</p>",
6566
"ListVpcEndpointsForDomain": "<p>Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.</p>",
6667
"PurchaseReservedInstanceOffering": "<p>Allows you to purchase Amazon OpenSearch Service Reserved Instances.</p>",
68+
"PutDefaultApplicationSetting": "<p>Sets the default application to the application with the specified ARN.</p> <p> To remove the default application, use the <code>GetDefaultApplicationSetting</code> operation to get the current default and then call the <code>PutDefaultApplicationSetting</code> with the current applications ARN and the <code>setAsDefault</code> parameter set to <code>false</code>.</p>",
6769
"RejectInboundConnection": "<p>Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.</p>",
6870
"RemoveTags": "<p>Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging\"> Tagging Amazon OpenSearch Service resources</a>.</p>",
6971
"RevokeVpcEndpointAccess": "<p>Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.</p>",
@@ -111,11 +113,14 @@
111113
"DomainEndpointOptions$CustomEndpointCertificateArn": "<p>The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).</p>",
112114
"DomainStatus$ARN": "<p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html\">IAM identifiers </a> in the <i>AWS Identity and Access Management User Guide</i>.</p>",
113115
"GetApplicationResponse$arn": null,
116+
"GetDefaultApplicationSettingResponse$applicationArn": null,
114117
"IamIdentityCenterOptions$iamIdentityCenterInstanceArn": null,
115118
"IamIdentityCenterOptions$iamIdentityCenterApplicationArn": null,
116119
"IamIdentityCenterOptionsInput$iamIdentityCenterInstanceArn": null,
117120
"ListTagsRequest$ARN": "<p>Amazon Resource Name (ARN) for the domain, data source, or application to view tags for.</p>",
118121
"MasterUserOptions$MasterUserARN": "<p>Amazon Resource Name (ARN) for the master user. Only specify if <code>InternalUserDatabaseEnabled</code> is <code>false</code>.</p>",
122+
"PutDefaultApplicationSettingRequest$applicationArn": null,
123+
"PutDefaultApplicationSettingResponse$applicationArn": null,
119124
"RemoveTagsRequest$ARN": "<p>The Amazon Resource Name (ARN) of the domain, data source, or application from which you want to delete the specified tags.</p>",
120125
"UpdateApplicationResponse$arn": null
121126
}
@@ -501,8 +506,8 @@
501506
"DomainStatus$UpgradeProcessing": "<p>The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.</p>",
502507
"EBSOptions$EBSEnabled": "<p>Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.</p>",
503508
"EncryptionAtRestOptions$Enabled": "<p>True to enable encryption at rest.</p>",
504-
"IAMFederationOptionsInput$Enabled": "<p>True to enable IAM federation authentication for a domain.</p>",
505-
"IAMFederationOptionsOutput$Enabled": "<p>True if IAM federation is enabled.</p>",
509+
"IAMFederationOptionsInput$Enabled": "<p>Specifies whether IAM identity federation is enabled for the OpenSearch domain.</p>",
510+
"IAMFederationOptionsOutput$Enabled": "<p>Indicates whether IAM identity federation is currently enabled for the domain.</p>",
506511
"IamIdentityCenterOptions$enabled": "<p>Indicates whether IAM Identity Center is enabled for the OpenSearch application.</p>",
507512
"IamIdentityCenterOptionsInput$enabled": "<p>Specifies whether IAM Identity Center is enabled or disabled.</p>",
508513
"IdentityCenterOptions$EnabledAPIAccess": "<p>Indicates whether IAM Identity Center is enabled for the application.</p>",
@@ -524,6 +529,7 @@
524529
"PackageConfiguration$RequiresRestartForConfigurationUpdate": "<p>This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.</p>",
525530
"PackageEncryptionOptions$EncryptionEnabled": "<p>Whether encryption is enabled for the package.</p>",
526531
"PackageVendingOptions$VendingEnabled": "<p>Indicates whether the package vending feature is enabled, allowing the package to be used by other users.</p>",
532+
"PutDefaultApplicationSettingRequest$setAsDefault": "<p>Set to true to set the specified ARN as the default application. Set to false to clear the default application.</p>",
527533
"S3VectorsEngine$Enabled": "<p>Enables S3 vectors engine features.</p>",
528534
"SAMLOptionsInput$Enabled": "<p>True to enable SAML authentication for a domain.</p>",
529535
"SAMLOptionsOutput$Enabled": "<p>True if SAML is enabled.</p>",
@@ -1576,6 +1582,14 @@
15761582
"base": "<p>The result of a <code>GetDataSource</code> operation.</p>",
15771583
"refs": {}
15781584
},
1585+
"GetDefaultApplicationSettingRequest": {
1586+
"base": null,
1587+
"refs": {}
1588+
},
1589+
"GetDefaultApplicationSettingResponse": {
1590+
"base": null,
1591+
"refs": {}
1592+
},
15791593
"GetDirectQueryDataSourceRequest": {
15801594
"base": null,
15811595
"refs": {}
@@ -1623,29 +1637,29 @@
16231637
}
16241638
},
16251639
"IAMFederationOptionsInput": {
1626-
"base": "<p>The IAM federation authentication configuration for an Amazon OpenSearch Service domain.</p>",
1640+
"base": "<p>Input parameters for configuring IAM identity federation settings.</p>",
16271641
"refs": {
1628-
"AdvancedSecurityOptionsInput$IAMFederationOptions": "<p>Container for information about the IAM federation configuration for an OpenSearch UI application.</p>"
1642+
"AdvancedSecurityOptionsInput$IAMFederationOptions": "<p>Input configuration for IAM identity federation within advanced security options.</p>"
16291643
}
16301644
},
16311645
"IAMFederationOptionsOutput": {
1632-
"base": "<p>Describes the IAM federation options configured for the domain.</p>",
1646+
"base": "<p>Output parameters showing the current IAM identity federation configuration.</p>",
16331647
"refs": {
1634-
"AdvancedSecurityOptions$IAMFederationOptions": "<p>Container for information about the IAM federation configuration for an OpenSearch UI application.</p>"
1648+
"AdvancedSecurityOptions$IAMFederationOptions": "<p>Configuration options for IAM identity federation in advanced security settings.</p>"
16351649
}
16361650
},
16371651
"IAMFederationRolesKey": {
16381652
"base": null,
16391653
"refs": {
1640-
"IAMFederationOptionsInput$RolesKey": "<p>Element of the IAM federation assertion to use for backend roles. Default is <code>roles</code>.</p>",
1641-
"IAMFederationOptionsOutput$RolesKey": "<p>The key used for matching the IAM federation roles attribute.</p>"
1654+
"IAMFederationOptionsInput$RolesKey": "<p>The key in the SAML assertion that contains the user's role information.</p>",
1655+
"IAMFederationOptionsOutput$RolesKey": "<p>The configured key in the SAML assertion for the user's role information.</p>"
16421656
}
16431657
},
16441658
"IAMFederationSubjectKey": {
16451659
"base": null,
16461660
"refs": {
1647-
"IAMFederationOptionsInput$SubjectKey": "<p>Element of the IAM federation assertion to use for the user name. Default is <code>sub</code>.</p>",
1648-
"IAMFederationOptionsOutput$SubjectKey": "<p>The key used for matching the IAM federation subject attribute.</p>"
1661+
"IAMFederationOptionsInput$SubjectKey": "<p>The key in the SAML assertion that contains the user's subject identifier.</p>",
1662+
"IAMFederationOptionsOutput$SubjectKey": "<p>The configured key in the SAML assertion for the user's subject identifier.</p>"
16491663
}
16501664
},
16511665
"IPAddressType": {
@@ -2676,6 +2690,14 @@
26762690
"base": "<p>Represents the output of a <code>PurchaseReservedInstanceOffering</code> operation.</p>",
26772691
"refs": {}
26782692
},
2693+
"PutDefaultApplicationSettingRequest": {
2694+
"base": null,
2695+
"refs": {}
2696+
},
2697+
"PutDefaultApplicationSettingResponse": {
2698+
"base": null,
2699+
"refs": {}
2700+
},
26792701
"RecurringCharge": {
26802702
"base": "<p>Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.</p>",
26812703
"refs": {

generator/ServiceModels/opensearch/opensearch-2021-01-01.normal.json

Lines changed: 74 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -721,6 +721,23 @@
721721
],
722722
"documentation":"<p>Retrieves information about a direct query data source.</p>"
723723
},
724+
"GetDefaultApplicationSetting":{
725+
"name":"GetDefaultApplicationSetting",
726+
"http":{
727+
"method":"GET",
728+
"requestUri":"/2021-01-01/opensearch/defaultApplicationSetting",
729+
"responseCode":200
730+
},
731+
"input":{"shape":"GetDefaultApplicationSettingRequest"},
732+
"output":{"shape":"GetDefaultApplicationSettingResponse"},
733+
"errors":[
734+
{"shape":"ValidationException"},
735+
{"shape":"AccessDeniedException"},
736+
{"shape":"InternalException"},
737+
{"shape":"ResourceNotFoundException"}
738+
],
739+
"documentation":"<p>Gets the ARN of the current default application.</p> <p> If the default application isn't set, the operation returns a resource not found error.</p>"
740+
},
724741
"GetDirectQueryDataSource":{
725742
"name":"GetDirectQueryDataSource",
726743
"http":{
@@ -1055,6 +1072,23 @@
10551072
],
10561073
"documentation":"<p>Allows you to purchase Amazon OpenSearch Service Reserved Instances.</p>"
10571074
},
1075+
"PutDefaultApplicationSetting":{
1076+
"name":"PutDefaultApplicationSetting",
1077+
"http":{
1078+
"method":"PUT",
1079+
"requestUri":"/2021-01-01/opensearch/defaultApplicationSetting",
1080+
"responseCode":200
1081+
},
1082+
"input":{"shape":"PutDefaultApplicationSettingRequest"},
1083+
"output":{"shape":"PutDefaultApplicationSettingResponse"},
1084+
"errors":[
1085+
{"shape":"ValidationException"},
1086+
{"shape":"AccessDeniedException"},
1087+
{"shape":"InternalException"},
1088+
{"shape":"ResourceNotFoundException"}
1089+
],
1090+
"documentation":"<p>Sets the default application to the application with the specified ARN.</p> <p> To remove the default application, use the <code>GetDefaultApplicationSetting</code> operation to get the current default and then call the <code>PutDefaultApplicationSetting</code> with the current applications ARN and the <code>setAsDefault</code> parameter set to <code>false</code>.</p>"
1091+
},
10581092
"RejectInboundConnection":{
10591093
"name":"RejectInboundConnection",
10601094
"http":{
@@ -1602,7 +1636,7 @@
16021636
},
16031637
"IAMFederationOptions":{
16041638
"shape":"IAMFederationOptionsOutput",
1605-
"documentation":"<p>Container for information about the IAM federation configuration for an OpenSearch UI application.</p>"
1639+
"documentation":"<p>Configuration options for IAM identity federation in advanced security settings.</p>"
16061640
},
16071641
"AnonymousAuthDisableDate":{
16081642
"shape":"DisableTimestamp",
@@ -1640,7 +1674,7 @@
16401674
},
16411675
"IAMFederationOptions":{
16421676
"shape":"IAMFederationOptionsInput",
1643-
"documentation":"<p>Container for information about the IAM federation configuration for an OpenSearch UI application.</p>"
1677+
"documentation":"<p>Input configuration for IAM identity federation within advanced security options.</p>"
16441678
},
16451679
"AnonymousAuthEnabled":{
16461680
"shape":"Boolean",
@@ -4667,6 +4701,16 @@
46674701
},
46684702
"documentation":"<p>The result of a <code>GetDataSource</code> operation.</p>"
46694703
},
4704+
"GetDefaultApplicationSettingRequest":{
4705+
"type":"structure",
4706+
"members":{}
4707+
},
4708+
"GetDefaultApplicationSettingResponse":{
4709+
"type":"structure",
4710+
"members":{
4711+
"applicationArn":{"shape":"ARN"}
4712+
}
4713+
},
46704714
"GetDirectQueryDataSourceRequest":{
46714715
"type":"structure",
46724716
"required":["DataSourceName"],
@@ -4875,36 +4919,36 @@
48754919
"members":{
48764920
"Enabled":{
48774921
"shape":"Boolean",
4878-
"documentation":"<p>True to enable IAM federation authentication for a domain.</p>"
4922+
"documentation":"<p>Specifies whether IAM identity federation is enabled for the OpenSearch domain.</p>"
48794923
},
48804924
"SubjectKey":{
48814925
"shape":"IAMFederationSubjectKey",
4882-
"documentation":"<p>Element of the IAM federation assertion to use for the user name. Default is <code>sub</code>.</p>"
4926+
"documentation":"<p>The key in the SAML assertion that contains the user's subject identifier.</p>"
48834927
},
48844928
"RolesKey":{
48854929
"shape":"IAMFederationRolesKey",
4886-
"documentation":"<p>Element of the IAM federation assertion to use for backend roles. Default is <code>roles</code>.</p>"
4930+
"documentation":"<p>The key in the SAML assertion that contains the user's role information.</p>"
48874931
}
48884932
},
4889-
"documentation":"<p>The IAM federation authentication configuration for an Amazon OpenSearch Service domain.</p>"
4933+
"documentation":"<p>Input parameters for configuring IAM identity federation settings.</p>"
48904934
},
48914935
"IAMFederationOptionsOutput":{
48924936
"type":"structure",
48934937
"members":{
48944938
"Enabled":{
48954939
"shape":"Boolean",
4896-
"documentation":"<p>True if IAM federation is enabled.</p>"
4940+
"documentation":"<p>Indicates whether IAM identity federation is currently enabled for the domain.</p>"
48974941
},
48984942
"SubjectKey":{
48994943
"shape":"IAMFederationSubjectKey",
4900-
"documentation":"<p>The key used for matching the IAM federation subject attribute.</p>"
4944+
"documentation":"<p>The configured key in the SAML assertion for the user's subject identifier.</p>"
49014945
},
49024946
"RolesKey":{
49034947
"shape":"IAMFederationRolesKey",
4904-
"documentation":"<p>The key used for matching the IAM federation roles attribute.</p>"
4948+
"documentation":"<p>The configured key in the SAML assertion for the user's role information.</p>"
49054949
}
49064950
},
4907-
"documentation":"<p>Describes the IAM federation options configured for the domain.</p>"
4951+
"documentation":"<p>Output parameters showing the current IAM identity federation configuration.</p>"
49084952
},
49094953
"IAMFederationRolesKey":{
49104954
"type":"string",
@@ -6761,6 +6805,26 @@
67616805
},
67626806
"documentation":"<p>Represents the output of a <code>PurchaseReservedInstanceOffering</code> operation.</p>"
67636807
},
6808+
"PutDefaultApplicationSettingRequest":{
6809+
"type":"structure",
6810+
"required":[
6811+
"applicationArn",
6812+
"setAsDefault"
6813+
],
6814+
"members":{
6815+
"applicationArn":{"shape":"ARN"},
6816+
"setAsDefault":{
6817+
"shape":"Boolean",
6818+
"documentation":"<p>Set to true to set the specified ARN as the default application. Set to false to clear the default application.</p>"
6819+
}
6820+
}
6821+
},
6822+
"PutDefaultApplicationSettingResponse":{
6823+
"type":"structure",
6824+
"members":{
6825+
"applicationArn":{"shape":"ARN"}
6826+
}
6827+
},
67646828
"RecurringCharge":{
67656829
"type":"structure",
67666830
"members":{

sdk/code-analysis/ServiceAnalysis/OpenSearchService/Generated/PropertyValueRules.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,12 @@
409409
<max>80</max>
410410
<pattern>[a-z][a-z0-9_]+</pattern>
411411
</property-value-rule>
412+
<property-value-rule>
413+
<property>Amazon.OpenSearchService.Model.GetDefaultApplicationSettingResponse.ApplicationArn</property>
414+
<min>20</min>
415+
<max>2048</max>
416+
<pattern>.*</pattern>
417+
</property-value-rule>
412418
<property-value-rule>
413419
<property>Amazon.OpenSearchService.Model.GetDirectQueryDataSourceRequest.DataSourceName</property>
414420
<min>3</min>
@@ -595,6 +601,18 @@
595601
<min>36</min>
596602
<max>36</max>
597603
</property-value-rule>
604+
<property-value-rule>
605+
<property>Amazon.OpenSearchService.Model.PutDefaultApplicationSettingRequest.ApplicationArn</property>
606+
<min>20</min>
607+
<max>2048</max>
608+
<pattern>.*</pattern>
609+
</property-value-rule>
610+
<property-value-rule>
611+
<property>Amazon.OpenSearchService.Model.PutDefaultApplicationSettingResponse.ApplicationArn</property>
612+
<min>20</min>
613+
<max>2048</max>
614+
<pattern>.*</pattern>
615+
</property-value-rule>
598616
<property-value-rule>
599617
<property>Amazon.OpenSearchService.Model.RejectInboundConnectionRequest.ConnectionId</property>
600618
<min>10</min>

0 commit comments

Comments
 (0)