Skip to content

Commit 2eca1d5

Browse files
Added APIs to manage QBusiness user subscriptions
1 parent 237c034 commit 2eca1d5

File tree

52 files changed

+5504
-290
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+5504
-290
lines changed

generator/ServiceModels/qbusiness/qbusiness-2023-11-27.api.json

Lines changed: 245 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,24 @@
7070
{"shape":"ServiceQuotaExceededException"}
7171
]
7272
},
73+
"CancelSubscription":{
74+
"name":"CancelSubscription",
75+
"http":{
76+
"method":"DELETE",
77+
"requestUri":"/applications/{applicationId}/subscriptions/{subscriptionId}",
78+
"responseCode":200
79+
},
80+
"input":{"shape":"CancelSubscriptionRequest"},
81+
"output":{"shape":"CancelSubscriptionResponse"},
82+
"errors":[
83+
{"shape":"ResourceNotFoundException"},
84+
{"shape":"InternalServerException"},
85+
{"shape":"ThrottlingException"},
86+
{"shape":"ValidationException"},
87+
{"shape":"AccessDeniedException"}
88+
],
89+
"idempotent":true
90+
},
7391
"Chat":{
7492
"name":"Chat",
7593
"http":{
@@ -228,6 +246,25 @@
228246
{"shape":"ServiceQuotaExceededException"}
229247
]
230248
},
249+
"CreateSubscription":{
250+
"name":"CreateSubscription",
251+
"http":{
252+
"method":"POST",
253+
"requestUri":"/applications/{applicationId}/subscriptions",
254+
"responseCode":200
255+
},
256+
"input":{"shape":"CreateSubscriptionRequest"},
257+
"output":{"shape":"CreateSubscriptionResponse"},
258+
"errors":[
259+
{"shape":"ResourceNotFoundException"},
260+
{"shape":"InternalServerException"},
261+
{"shape":"ConflictException"},
262+
{"shape":"ThrottlingException"},
263+
{"shape":"ValidationException"},
264+
{"shape":"AccessDeniedException"}
265+
],
266+
"idempotent":true
267+
},
231268
"CreateUser":{
232269
"name":"CreateUser",
233270
"http":{
@@ -959,6 +996,24 @@
959996
{"shape":"AccessDeniedException"}
960997
]
961998
},
999+
"ListSubscriptions":{
1000+
"name":"ListSubscriptions",
1001+
"http":{
1002+
"method":"GET",
1003+
"requestUri":"/applications/{applicationId}/subscriptions",
1004+
"responseCode":200
1005+
},
1006+
"input":{"shape":"ListSubscriptionsRequest"},
1007+
"output":{"shape":"ListSubscriptionsResponse"},
1008+
"errors":[
1009+
{"shape":"ResourceNotFoundException"},
1010+
{"shape":"InternalServerException"},
1011+
{"shape":"ConflictException"},
1012+
{"shape":"ThrottlingException"},
1013+
{"shape":"ValidationException"},
1014+
{"shape":"AccessDeniedException"}
1015+
]
1016+
},
9621017
"ListTagsForResource":{
9631018
"name":"ListTagsForResource",
9641019
"http":{
@@ -1258,6 +1313,25 @@
12581313
],
12591314
"idempotent":true
12601315
},
1316+
"UpdateSubscription":{
1317+
"name":"UpdateSubscription",
1318+
"http":{
1319+
"method":"PUT",
1320+
"requestUri":"/applications/{applicationId}/subscriptions/{subscriptionId}",
1321+
"responseCode":200
1322+
},
1323+
"input":{"shape":"UpdateSubscriptionRequest"},
1324+
"output":{"shape":"UpdateSubscriptionResponse"},
1325+
"errors":[
1326+
{"shape":"ResourceNotFoundException"},
1327+
{"shape":"InternalServerException"},
1328+
{"shape":"ConflictException"},
1329+
{"shape":"ThrottlingException"},
1330+
{"shape":"ValidationException"},
1331+
{"shape":"AccessDeniedException"}
1332+
],
1333+
"idempotent":true
1334+
},
12611335
"UpdateUser":{
12621336
"name":"UpdateUser",
12631337
"http":{
@@ -1884,6 +1958,33 @@
18841958
"max":2,
18851959
"min":0
18861960
},
1961+
"CancelSubscriptionRequest":{
1962+
"type":"structure",
1963+
"required":[
1964+
"applicationId",
1965+
"subscriptionId"
1966+
],
1967+
"members":{
1968+
"applicationId":{
1969+
"shape":"ApplicationId",
1970+
"location":"uri",
1971+
"locationName":"applicationId"
1972+
},
1973+
"subscriptionId":{
1974+
"shape":"SubscriptionId",
1975+
"location":"uri",
1976+
"locationName":"subscriptionId"
1977+
}
1978+
}
1979+
},
1980+
"CancelSubscriptionResponse":{
1981+
"type":"structure",
1982+
"members":{
1983+
"subscriptionArn":{"shape":"SubscriptionArn"},
1984+
"currentSubscription":{"shape":"SubscriptionDetails"},
1985+
"nextSubscription":{"shape":"SubscriptionDetails"}
1986+
}
1987+
},
18871988
"ChatInput":{
18881989
"type":"structure",
18891990
"required":["applicationId"],
@@ -2340,6 +2441,36 @@
23402441
"retrieverArn":{"shape":"RetrieverArn"}
23412442
}
23422443
},
2444+
"CreateSubscriptionRequest":{
2445+
"type":"structure",
2446+
"required":[
2447+
"applicationId",
2448+
"principal",
2449+
"type"
2450+
],
2451+
"members":{
2452+
"applicationId":{
2453+
"shape":"ApplicationId",
2454+
"location":"uri",
2455+
"locationName":"applicationId"
2456+
},
2457+
"principal":{"shape":"SubscriptionPrincipal"},
2458+
"type":{"shape":"SubscriptionType"},
2459+
"clientToken":{
2460+
"shape":"ClientToken",
2461+
"idempotencyToken":true
2462+
}
2463+
}
2464+
},
2465+
"CreateSubscriptionResponse":{
2466+
"type":"structure",
2467+
"members":{
2468+
"subscriptionId":{"shape":"SubscriptionId"},
2469+
"subscriptionArn":{"shape":"SubscriptionArn"},
2470+
"currentSubscription":{"shape":"SubscriptionDetails"},
2471+
"nextSubscription":{"shape":"SubscriptionDetails"}
2472+
}
2473+
},
23432474
"CreateUserRequest":{
23442475
"type":"structure",
23452476
"required":[
@@ -3635,6 +3766,12 @@
36353766
"customizationConfiguration":{"shape":"CustomizationConfiguration"}
36363767
}
36373768
},
3769+
"GroupIdentifier":{
3770+
"type":"string",
3771+
"max":47,
3772+
"min":1,
3773+
"pattern":"([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}"
3774+
},
36383775
"GroupMembers":{
36393776
"type":"structure",
36403777
"members":{
@@ -4408,6 +4545,34 @@
44084545
"nextToken":{"shape":"NextToken"}
44094546
}
44104547
},
4548+
"ListSubscriptionsRequest":{
4549+
"type":"structure",
4550+
"required":["applicationId"],
4551+
"members":{
4552+
"applicationId":{
4553+
"shape":"ApplicationId",
4554+
"location":"uri",
4555+
"locationName":"applicationId"
4556+
},
4557+
"nextToken":{
4558+
"shape":"NextToken",
4559+
"location":"querystring",
4560+
"locationName":"nextToken"
4561+
},
4562+
"maxResults":{
4563+
"shape":"MaxResultsIntegerForListSubscriptions",
4564+
"location":"querystring",
4565+
"locationName":"maxResults"
4566+
}
4567+
}
4568+
},
4569+
"ListSubscriptionsResponse":{
4570+
"type":"structure",
4571+
"members":{
4572+
"nextToken":{"shape":"NextToken"},
4573+
"subscriptions":{"shape":"Subscriptions"}
4574+
}
4575+
},
44114576
"ListTagsForResourceRequest":{
44124577
"type":"structure",
44134578
"required":["resourceARN"],
@@ -4563,6 +4728,12 @@
45634728
"max":50,
45644729
"min":1
45654730
},
4731+
"MaxResultsIntegerForListSubscriptions":{
4732+
"type":"integer",
4733+
"box":true,
4734+
"max":100,
4735+
"min":1
4736+
},
45664737
"MaxResultsIntegerForListWebExperiencesRequest":{
45674738
"type":"integer",
45684739
"box":true,
@@ -5492,13 +5663,52 @@
54925663
"type":"list",
54935664
"member":{"shape":"SubnetId"}
54945665
},
5666+
"Subscription":{
5667+
"type":"structure",
5668+
"members":{
5669+
"subscriptionId":{"shape":"SubscriptionId"},
5670+
"subscriptionArn":{"shape":"SubscriptionArn"},
5671+
"principal":{"shape":"SubscriptionPrincipal"},
5672+
"currentSubscription":{"shape":"SubscriptionDetails"},
5673+
"nextSubscription":{"shape":"SubscriptionDetails"}
5674+
}
5675+
},
5676+
"SubscriptionArn":{
5677+
"type":"string",
5678+
"max":1224,
5679+
"min":10,
5680+
"pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}"
5681+
},
5682+
"SubscriptionDetails":{
5683+
"type":"structure",
5684+
"members":{
5685+
"type":{"shape":"SubscriptionType"}
5686+
}
5687+
},
5688+
"SubscriptionId":{
5689+
"type":"string",
5690+
"max":1224,
5691+
"min":0
5692+
},
5693+
"SubscriptionPrincipal":{
5694+
"type":"structure",
5695+
"members":{
5696+
"user":{"shape":"UserIdentifier"},
5697+
"group":{"shape":"GroupIdentifier"}
5698+
},
5699+
"union":true
5700+
},
54955701
"SubscriptionType":{
54965702
"type":"string",
54975703
"enum":[
54985704
"Q_LITE",
54995705
"Q_BUSINESS"
55005706
]
55015707
},
5708+
"Subscriptions":{
5709+
"type":"list",
5710+
"member":{"shape":"Subscription"}
5711+
},
55025712
"SyncSchedule":{
55035713
"type":"string",
55045714
"max":998,
@@ -5880,6 +6090,35 @@
58806090
"members":{
58816091
}
58826092
},
6093+
"UpdateSubscriptionRequest":{
6094+
"type":"structure",
6095+
"required":[
6096+
"applicationId",
6097+
"subscriptionId",
6098+
"type"
6099+
],
6100+
"members":{
6101+
"applicationId":{
6102+
"shape":"ApplicationId",
6103+
"location":"uri",
6104+
"locationName":"applicationId"
6105+
},
6106+
"subscriptionId":{
6107+
"shape":"SubscriptionId",
6108+
"location":"uri",
6109+
"locationName":"subscriptionId"
6110+
},
6111+
"type":{"shape":"SubscriptionType"}
6112+
}
6113+
},
6114+
"UpdateSubscriptionResponse":{
6115+
"type":"structure",
6116+
"members":{
6117+
"subscriptionArn":{"shape":"SubscriptionArn"},
6118+
"currentSubscription":{"shape":"SubscriptionDetails"},
6119+
"nextSubscription":{"shape":"SubscriptionDetails"}
6120+
}
6121+
},
58836122
"UpdateUserRequest":{
58846123
"type":"structure",
58856124
"required":[
@@ -5976,6 +6215,12 @@
59766215
"min":1,
59776216
"pattern":"\\P{C}*"
59786217
},
6218+
"UserIdentifier":{
6219+
"type":"string",
6220+
"max":47,
6221+
"min":1,
6222+
"pattern":"([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}"
6223+
},
59796224
"UserIds":{
59806225
"type":"list",
59816226
"member":{"shape":"String"}

0 commit comments

Comments
 (0)