Skip to content

Commit ae9237a

Browse files
author
AWS
committed
Amazon OpenSearch Service Update: Allows customers to get progress updates for blue/green deployments
1 parent 407e198 commit ae9237a

File tree

2 files changed

+158
-1
lines changed

2 files changed

+158
-1
lines changed

‎.changes/next-release/feature-AmazonOpenSearchService-4f071c1.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": "Allows customers to get progress updates for blue/green deployments"
6+
}

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

Lines changed: 152 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,22 @@
222222
],
223223
"documentation":"<p>Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date. </p>"
224224
},
225+
"DescribeDomainChangeProgress":{
226+
"name":"DescribeDomainChangeProgress",
227+
"http":{
228+
"method":"GET",
229+
"requestUri":"/2021-01-01/opensearch/domain/{DomainName}/progress"
230+
},
231+
"input":{"shape":"DescribeDomainChangeProgressRequest"},
232+
"output":{"shape":"DescribeDomainChangeProgressResponse"},
233+
"errors":[
234+
{"shape":"BaseException"},
235+
{"shape":"InternalException"},
236+
{"shape":"ResourceNotFoundException"},
237+
{"shape":"ValidationException"}
238+
],
239+
"documentation":"<p>Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.</p>"
240+
},
225241
"DescribeDomainConfig":{
226242
"name":"DescribeDomainConfig",
227243
"http":{
@@ -1087,6 +1103,91 @@
10871103
},
10881104
"documentation":"<p>The result of a <code>CancelServiceSoftwareUpdate</code> operation. Contains the status of the update. </p>"
10891105
},
1106+
"ChangeProgressDetails":{
1107+
"type":"structure",
1108+
"members":{
1109+
"ChangeId":{
1110+
"shape":"GUID",
1111+
"documentation":"<p>The unique change identifier associated with a specific domain configuration change.</p>"
1112+
},
1113+
"Message":{
1114+
"shape":"Message",
1115+
"documentation":"<p>Contains an optional message associated with the domain configuration change.</p>"
1116+
}
1117+
},
1118+
"documentation":"<p>Specifies change details of the domain configuration change.</p>"
1119+
},
1120+
"ChangeProgressStage":{
1121+
"type":"structure",
1122+
"members":{
1123+
"Name":{
1124+
"shape":"ChangeProgressStageName",
1125+
"documentation":"<p>The name of the specific progress stage.</p>"
1126+
},
1127+
"Status":{
1128+
"shape":"ChangeProgressStageStatus",
1129+
"documentation":"<p>The overall status of a specific progress stage.</p>"
1130+
},
1131+
"Description":{
1132+
"shape":"Description",
1133+
"documentation":"<p>The description of the progress stage.</p>"
1134+
},
1135+
"LastUpdated":{
1136+
"shape":"LastUpdated",
1137+
"documentation":"<p>The last updated timestamp of the progress stage.</p>"
1138+
}
1139+
},
1140+
"documentation":"<p>A progress stage details of a specific domain configuration change.</p>"
1141+
},
1142+
"ChangeProgressStageList":{
1143+
"type":"list",
1144+
"member":{"shape":"ChangeProgressStage"},
1145+
"documentation":"<p>The list of progress stages of a specific domain configuration change.</p>"
1146+
},
1147+
"ChangeProgressStageName":{
1148+
"type":"string",
1149+
"max":64,
1150+
"min":1
1151+
},
1152+
"ChangeProgressStageStatus":{
1153+
"type":"string",
1154+
"max":256,
1155+
"min":1
1156+
},
1157+
"ChangeProgressStatusDetails":{
1158+
"type":"structure",
1159+
"members":{
1160+
"ChangeId":{
1161+
"shape":"GUID",
1162+
"documentation":"<p>The unique change identifier associated with a specific domain configuration change.</p>"
1163+
},
1164+
"StartTime":{
1165+
"shape":"UpdateTimestamp",
1166+
"documentation":"<p>The time at which the configuration change is made on the domain.</p>"
1167+
},
1168+
"Status":{
1169+
"shape":"OverallChangeStatus",
1170+
"documentation":"<p>The overall status of the domain configuration change. This field can take the following values: <code>PENDING</code>, <code>PROCESSING</code>, <code>COMPLETED</code> and <code>FAILED</code></p>"
1171+
},
1172+
"PendingProperties":{
1173+
"shape":"StringList",
1174+
"documentation":"<p>The list of properties involved in the domain configuration change that are still in pending.</p>"
1175+
},
1176+
"CompletedProperties":{
1177+
"shape":"StringList",
1178+
"documentation":"<p>The list of properties involved in the domain configuration change that are completed.</p>"
1179+
},
1180+
"TotalNumberOfStages":{
1181+
"shape":"TotalNumberOfStages",
1182+
"documentation":"<p>The total number of stages required for the configuration change.</p>"
1183+
},
1184+
"ChangeProgressStages":{
1185+
"shape":"ChangeProgressStageList",
1186+
"documentation":"<p>The specific stages that the domain is going through to perform the configuration change.</p>"
1187+
}
1188+
},
1189+
"documentation":"<p>The progress details of a specific domain configuration change.</p>"
1190+
},
10901191
"CloudWatchLogsLogGroupArn":{
10911192
"type":"string",
10921193
"documentation":"<p>ARN of the Cloudwatch log group to publish logs to.</p>",
@@ -1563,6 +1664,35 @@
15631664
},
15641665
"documentation":"<p>The result of a <code>DescribeDomainAutoTunes</code> request. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>"
15651666
},
1667+
"DescribeDomainChangeProgressRequest":{
1668+
"type":"structure",
1669+
"required":["DomainName"],
1670+
"members":{
1671+
"DomainName":{
1672+
"shape":"DomainName",
1673+
"documentation":"<p>The domain you want to get the progress information about.</p>",
1674+
"location":"uri",
1675+
"locationName":"DomainName"
1676+
},
1677+
"ChangeId":{
1678+
"shape":"GUID",
1679+
"documentation":"<p>The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change. </p>",
1680+
"location":"querystring",
1681+
"locationName":"changeid"
1682+
}
1683+
},
1684+
"documentation":"<p>Container for the parameters to the <code>DescribeDomainChangeProgress</code> operation. Specifies the domain name and optional change specific identity for which you want progress information. </p>"
1685+
},
1686+
"DescribeDomainChangeProgressResponse":{
1687+
"type":"structure",
1688+
"members":{
1689+
"ChangeProgressStatus":{
1690+
"shape":"ChangeProgressStatusDetails",
1691+
"documentation":"<p>Progress information for the configuration change that is requested in the <code>DescribeDomainChangeProgress</code> request. </p>"
1692+
}
1693+
},
1694+
"documentation":"<p>The result of a <code>DescribeDomainChangeProgress</code> request. Contains the progress information of the requested domain change. </p>"
1695+
},
15661696
"DescribeDomainConfigRequest":{
15671697
"type":"structure",
15681698
"required":["DomainName"],
@@ -1872,6 +2002,7 @@
18722002
},
18732003
"documentation":"<p>Container for results from <code>DescribeReservedInstances</code> </p>"
18742004
},
2005+
"Description":{"type":"string"},
18752006
"DisableTimestamp":{"type":"timestamp"},
18762007
"DisabledOperationException":{
18772008
"type":"structure",
@@ -1971,6 +2102,10 @@
19712102
"AutoTuneOptions":{
19722103
"shape":"AutoTuneOptionsStatus",
19732104
"documentation":"<p>Specifies <code>AutoTuneOptions</code> for the domain. </p>"
2105+
},
2106+
"ChangeProgressDetails":{
2107+
"shape":"ChangeProgressDetails",
2108+
"documentation":"<p>Specifies change details of the domain configuration change.</p>"
19742109
}
19752110
},
19762111
"documentation":"<p>The configuration of a domain.</p>"
@@ -2221,6 +2356,10 @@
22212356
"AutoTuneOptions":{
22222357
"shape":"AutoTuneOptionsOutput",
22232358
"documentation":"<p>The current status of the domain's Auto-Tune options.</p>"
2359+
},
2360+
"ChangeProgressDetails":{
2361+
"shape":"ChangeProgressDetails",
2362+
"documentation":"<p>Specifies change details of the domain configuration change.</p>"
22242363
}
22252364
},
22262365
"documentation":"<p>The current status of a domain.</p>"
@@ -3179,6 +3318,16 @@
31793318
"type":"list",
31803319
"member":{"shape":"OutboundConnection"}
31813320
},
3321+
"OverallChangeStatus":{
3322+
"type":"string",
3323+
"documentation":"<p>The overall status value of the domain configuration change.</p>",
3324+
"enum":[
3325+
"PENDING",
3326+
"PROCESSING",
3327+
"COMPLETED",
3328+
"FAILED"
3329+
]
3330+
},
31823331
"OwnerId":{
31833332
"type":"string",
31843333
"max":12,
@@ -3885,6 +4034,7 @@
38854034
"documentation":"<p>The unit of a maintenance schedule duration. Valid value is HOUR. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>",
38864035
"enum":["HOURS"]
38874036
},
4037+
"TotalNumberOfStages":{"type":"integer"},
38884038
"UIntValue":{
38894039
"type":"integer",
38904040
"min":0
@@ -4040,7 +4190,8 @@
40404190
"shape":"Boolean",
40414191
"documentation":"<p> When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. </p>"
40424192
},
4043-
"AdvancedOptions":{"shape":"AdvancedOptions"}
4193+
"AdvancedOptions":{"shape":"AdvancedOptions"},
4194+
"ChangeProgressDetails":{"shape":"ChangeProgressDetails"}
40444195
},
40454196
"documentation":"<p> Container for response returned by <code> <a>UpgradeDomain</a> </code> operation. </p>"
40464197
},

0 commit comments

Comments
 (0)