Skip to content

Commit ca9b69b

Browse files
author
AWS
committed
Amazon OpenSearch Service Update: This release adds clear visibility to the customers on the changes that they make on the domain.
1 parent cd207db commit ca9b69b

File tree

2 files changed

+187
-1
lines changed

2 files changed

+187
-1
lines changed

‎.changes/next-release/feature-AmazonOpenSearchService-f70bb2b.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon OpenSearch Service",
4+
"contributor": "",
5+
"description": "This release adds clear visibility to the customers on the changes that they make on the domain."
6+
}

‎services/opensearch/src/main/resources/codegen-resources/service-2.json

Lines changed: 181 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,23 @@
9595
],
9696
"documentation":"<p>Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.</p>"
9797
},
98+
"CancelDomainConfigChange":{
99+
"name":"CancelDomainConfigChange",
100+
"http":{
101+
"method":"POST",
102+
"requestUri":"/2021-01-01/opensearch/domain/{DomainName}/config/cancel"
103+
},
104+
"input":{"shape":"CancelDomainConfigChangeRequest"},
105+
"output":{"shape":"CancelDomainConfigChangeResponse"},
106+
"errors":[
107+
{"shape":"BaseException"},
108+
{"shape":"InternalException"},
109+
{"shape":"ResourceNotFoundException"},
110+
{"shape":"ValidationException"},
111+
{"shape":"DisabledOperationException"}
112+
],
113+
"documentation":"<p>Cancels a pending configuration change on an Amazon OpenSearch Service domain.</p>"
114+
},
98115
"CancelServiceSoftwareUpdate":{
99116
"name":"CancelServiceSoftwareUpdate",
100117
"http":{
@@ -1648,6 +1665,38 @@
16481665
"exception":true
16491666
},
16501667
"Boolean":{"type":"boolean"},
1668+
"CancelDomainConfigChangeRequest":{
1669+
"type":"structure",
1670+
"required":["DomainName"],
1671+
"members":{
1672+
"DomainName":{
1673+
"shape":"DomainName",
1674+
"location":"uri",
1675+
"locationName":"DomainName"
1676+
},
1677+
"DryRun":{
1678+
"shape":"DryRun",
1679+
"documentation":"<p>When set to <code>True</code>, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.</p>"
1680+
}
1681+
}
1682+
},
1683+
"CancelDomainConfigChangeResponse":{
1684+
"type":"structure",
1685+
"members":{
1686+
"CancelledChangeIds":{
1687+
"shape":"GUIDList",
1688+
"documentation":"<p>The unique identifiers of the changes that were cancelled.</p>"
1689+
},
1690+
"CancelledChangeProperties":{
1691+
"shape":"CancelledChangePropertyList",
1692+
"documentation":"<p>The domain change properties that were cancelled.</p>"
1693+
},
1694+
"DryRun":{
1695+
"shape":"DryRun",
1696+
"documentation":"<p>Whether or not the request was a dry run. If <code>True</code>, the changes were not actually cancelled. </p>"
1697+
}
1698+
}
1699+
},
16511700
"CancelServiceSoftwareUpdateRequest":{
16521701
"type":"structure",
16531702
"required":["DomainName"],
@@ -1669,6 +1718,28 @@
16691718
},
16701719
"documentation":"<p>Container for the response to a <code>CancelServiceSoftwareUpdate</code> operation. Contains the status of the update.</p>"
16711720
},
1721+
"CancelledChangeProperty":{
1722+
"type":"structure",
1723+
"members":{
1724+
"PropertyName":{
1725+
"shape":"String",
1726+
"documentation":"<p>The name of the property whose change was cancelled.</p>"
1727+
},
1728+
"CancelledValue":{
1729+
"shape":"String",
1730+
"documentation":"<p>The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.</p>"
1731+
},
1732+
"ActiveValue":{
1733+
"shape":"String",
1734+
"documentation":"<p>The current value of the property, after the change was cancelled.</p>"
1735+
}
1736+
},
1737+
"documentation":"<p>A property change that was cancelled for an Amazon OpenSearch Service domain.</p>"
1738+
},
1739+
"CancelledChangePropertyList":{
1740+
"type":"list",
1741+
"member":{"shape":"CancelledChangeProperty"}
1742+
},
16721743
"ChangeProgressDetails":{
16731744
"type":"structure",
16741745
"members":{
@@ -1679,6 +1750,22 @@
16791750
"Message":{
16801751
"shape":"Message",
16811752
"documentation":"<p>A message corresponding to the status of the configuration change.</p>"
1753+
},
1754+
"ConfigChangeStatus":{
1755+
"shape":"ConfigChangeStatus",
1756+
"documentation":"<p>The current status of the configuration change.</p>"
1757+
},
1758+
"InitiatedBy":{
1759+
"shape":"InitiatedBy",
1760+
"documentation":"<p>The IAM principal who initiated the configuration change.</p>"
1761+
},
1762+
"StartTime":{
1763+
"shape":"UpdateTimestamp",
1764+
"documentation":"<p>The time that the configuration change was initiated, in Universal Coordinated Time (UTC).</p>"
1765+
},
1766+
"LastUpdatedTime":{
1767+
"shape":"UpdateTimestamp",
1768+
"documentation":"<p>The last time that the configuration change was updated.</p>"
16821769
}
16831770
},
16841771
"documentation":"<p>Container for information about a configuration change happening on a domain.</p>"
@@ -1750,6 +1837,18 @@
17501837
"ChangeProgressStages":{
17511838
"shape":"ChangeProgressStageList",
17521839
"documentation":"<p>The specific stages that the domain is going through to perform the configuration change.</p>"
1840+
},
1841+
"LastUpdatedTime":{
1842+
"shape":"UpdateTimestamp",
1843+
"documentation":"<p>The last time that the status of the configuration change was updated.</p>"
1844+
},
1845+
"ConfigChangeStatus":{
1846+
"shape":"ConfigChangeStatus",
1847+
"documentation":"<p>The current status of the configuration change.</p>"
1848+
},
1849+
"InitiatedBy":{
1850+
"shape":"InitiatedBy",
1851+
"documentation":"<p>The IAM principal who initiated the configuration change.</p>"
17531852
}
17541853
},
17551854
"documentation":"<p>The progress details of a specific domain configuration change.</p>"
@@ -1911,6 +2010,19 @@
19112010
},
19122011
"documentation":"<p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.</p>"
19132012
},
2013+
"ConfigChangeStatus":{
2014+
"type":"string",
2015+
"enum":[
2016+
"Pending",
2017+
"Initializing",
2018+
"Validating",
2019+
"ValidationFailed",
2020+
"ApplyingChanges",
2021+
"Completed",
2022+
"PendingUserInput",
2023+
"Cancelled"
2024+
]
2025+
},
19142026
"ConflictException":{
19152027
"type":"structure",
19162028
"members":{
@@ -3070,6 +3182,10 @@
30703182
"SoftwareUpdateOptions":{
30713183
"shape":"SoftwareUpdateOptionsStatus",
30723184
"documentation":"<p>Software update options for the domain.</p>"
3185+
},
3186+
"ModifyingProperties":{
3187+
"shape":"ModifyingPropertiesList",
3188+
"documentation":"<p>Information about the domain properties that are currently being modified.</p>"
30733189
}
30743190
},
30753191
"documentation":"<p>Container for the configuration of an OpenSearch Service domain.</p>"
@@ -3321,6 +3437,18 @@
33213437
"DISSOCIATION_FAILED"
33223438
]
33233439
},
3440+
"DomainProcessingStatusType":{
3441+
"type":"string",
3442+
"enum":[
3443+
"Creating",
3444+
"Active",
3445+
"Modifying",
3446+
"UpgradingEngineVersion",
3447+
"UpdatingServiceSoftware",
3448+
"Isolated",
3449+
"Deleting"
3450+
]
3451+
},
33243452
"DomainState":{
33253453
"type":"string",
33263454
"enum":[
@@ -3453,6 +3581,14 @@
34533581
"SoftwareUpdateOptions":{
34543582
"shape":"SoftwareUpdateOptions",
34553583
"documentation":"<p>Service software update options for the domain.</p>"
3584+
},
3585+
"DomainProcessingStatus":{
3586+
"shape":"DomainProcessingStatusType",
3587+
"documentation":"<p>The status of any changes that are currently in progress for the domain.</p>"
3588+
},
3589+
"ModifyingProperties":{
3590+
"shape":"ModifyingPropertiesList",
3591+
"documentation":"<p>Information about the domain properties that are currently being modified.</p>"
34563592
}
34573593
},
34583594
"documentation":"<p>The current status of an OpenSearch Service domain.</p>"
@@ -3593,7 +3729,7 @@
35933729
"documentation":"<p>The KMS key ID. Takes the form <code>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</code>.</p>"
35943730
}
35953731
},
3596-
"documentation":"<p>Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.</p>"
3732+
"documentation":"<p>Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.</p>"
35973733
},
35983734
"EncryptionAtRestOptionsStatus":{
35993735
"type":"structure",
@@ -3687,6 +3823,10 @@
36873823
"min":36,
36883824
"pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}"
36893825
},
3826+
"GUIDList":{
3827+
"type":"list",
3828+
"member":{"shape":"GUID"}
3829+
},
36903830
"GetCompatibleVersionsRequest":{
36913831
"type":"structure",
36923832
"members":{
@@ -3999,6 +4139,13 @@
39994139
"type":"list",
40004140
"member":{"shape":"InboundConnection"}
40014141
},
4142+
"InitiatedBy":{
4143+
"type":"string",
4144+
"enum":[
4145+
"CUSTOMER",
4146+
"SERVICE"
4147+
]
4148+
},
40024149
"InstanceCount":{
40034150
"type":"integer",
40044151
"documentation":"<p>Number of instances in an OpenSearch Service cluster.</p>",
@@ -4687,6 +4834,32 @@
46874834
"type":"integer",
46884835
"documentation":"<p> Minimum number of instances that can be instantiated for a given instance type.</p>"
46894836
},
4837+
"ModifyingProperties":{
4838+
"type":"structure",
4839+
"members":{
4840+
"Name":{
4841+
"shape":"String",
4842+
"documentation":"<p>The name of the property that is currently being modified.</p>"
4843+
},
4844+
"ActiveValue":{
4845+
"shape":"String",
4846+
"documentation":"<p>The current value of the domain property that is being modified.</p>"
4847+
},
4848+
"PendingValue":{
4849+
"shape":"String",
4850+
"documentation":"<p>The value that the property that is currently being modified will eventually have.</p>"
4851+
},
4852+
"ValueType":{
4853+
"shape":"PropertyValueType",
4854+
"documentation":"<p>The type of value that is currently being modified. Properties can have two types:</p> <ul> <li> <p> <code>PLAIN_TEXT</code>: Contain direct values such as \"1\", \"True\", or \"c5.large.search\".</p> </li> <li> <p> <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as {\"Enabled\":\"True\"}\".</p> </li> </ul>"
4855+
}
4856+
},
4857+
"documentation":"<p>Information about the domain properties that are currently being modified.</p>"
4858+
},
4859+
"ModifyingPropertiesList":{
4860+
"type":"list",
4861+
"member":{"shape":"ModifyingProperties"}
4862+
},
46904863
"NextToken":{
46914864
"type":"string",
46924865
"documentation":"<p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>"
@@ -5219,6 +5392,13 @@
52195392
"AWS_SERVICE"
52205393
]
52215394
},
5395+
"PropertyValueType":{
5396+
"type":"string",
5397+
"enum":[
5398+
"PLAIN_TEXT",
5399+
"STRINGIFIED_JSON"
5400+
]
5401+
},
52225402
"PurchaseReservedInstanceOfferingRequest":{
52235403
"type":"structure",
52245404
"required":[

0 commit comments

Comments
 (0)