servicequotas.d.ts
40.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ServiceQuotas extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ServiceQuotas.Types.ClientConfiguration)
config: Config & ServiceQuotas.Types.ClientConfiguration;
/**
* Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template.
*/
associateServiceQuotaTemplate(params: ServiceQuotas.Types.AssociateServiceQuotaTemplateRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.AssociateServiceQuotaTemplateResponse) => void): Request<ServiceQuotas.Types.AssociateServiceQuotaTemplateResponse, AWSError>;
/**
* Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template.
*/
associateServiceQuotaTemplate(callback?: (err: AWSError, data: ServiceQuotas.Types.AssociateServiceQuotaTemplateResponse) => void): Request<ServiceQuotas.Types.AssociateServiceQuotaTemplateResponse, AWSError>;
/**
* Removes a service quota increase request from the Service Quotas template.
*/
deleteServiceQuotaIncreaseRequestFromTemplate(params: ServiceQuotas.Types.DeleteServiceQuotaIncreaseRequestFromTemplateRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.DeleteServiceQuotaIncreaseRequestFromTemplateResponse) => void): Request<ServiceQuotas.Types.DeleteServiceQuotaIncreaseRequestFromTemplateResponse, AWSError>;
/**
* Removes a service quota increase request from the Service Quotas template.
*/
deleteServiceQuotaIncreaseRequestFromTemplate(callback?: (err: AWSError, data: ServiceQuotas.Types.DeleteServiceQuotaIncreaseRequestFromTemplateResponse) => void): Request<ServiceQuotas.Types.DeleteServiceQuotaIncreaseRequestFromTemplateResponse, AWSError>;
/**
* Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template. Related operations To enable the quota template, call AssociateServiceQuotaTemplate. To delete a specific service quota from the template, use DeleteServiceQuotaIncreaseRequestFromTemplate.
*/
disassociateServiceQuotaTemplate(params: ServiceQuotas.Types.DisassociateServiceQuotaTemplateRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.DisassociateServiceQuotaTemplateResponse) => void): Request<ServiceQuotas.Types.DisassociateServiceQuotaTemplateResponse, AWSError>;
/**
* Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template. Related operations To enable the quota template, call AssociateServiceQuotaTemplate. To delete a specific service quota from the template, use DeleteServiceQuotaIncreaseRequestFromTemplate.
*/
disassociateServiceQuotaTemplate(callback?: (err: AWSError, data: ServiceQuotas.Types.DisassociateServiceQuotaTemplateResponse) => void): Request<ServiceQuotas.Types.DisassociateServiceQuotaTemplateResponse, AWSError>;
/**
* Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..
*/
getAWSDefaultServiceQuota(params: ServiceQuotas.Types.GetAWSDefaultServiceQuotaRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.GetAWSDefaultServiceQuotaResponse) => void): Request<ServiceQuotas.Types.GetAWSDefaultServiceQuotaResponse, AWSError>;
/**
* Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..
*/
getAWSDefaultServiceQuota(callback?: (err: AWSError, data: ServiceQuotas.Types.GetAWSDefaultServiceQuotaResponse) => void): Request<ServiceQuotas.Types.GetAWSDefaultServiceQuotaResponse, AWSError>;
/**
* Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.
*/
getAssociationForServiceQuotaTemplate(params: ServiceQuotas.Types.GetAssociationForServiceQuotaTemplateRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.GetAssociationForServiceQuotaTemplateResponse) => void): Request<ServiceQuotas.Types.GetAssociationForServiceQuotaTemplateResponse, AWSError>;
/**
* Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.
*/
getAssociationForServiceQuotaTemplate(callback?: (err: AWSError, data: ServiceQuotas.Types.GetAssociationForServiceQuotaTemplateResponse) => void): Request<ServiceQuotas.Types.GetAssociationForServiceQuotaTemplateResponse, AWSError>;
/**
* Retrieves the details for a particular increase request.
*/
getRequestedServiceQuotaChange(params: ServiceQuotas.Types.GetRequestedServiceQuotaChangeRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.GetRequestedServiceQuotaChangeResponse) => void): Request<ServiceQuotas.Types.GetRequestedServiceQuotaChangeResponse, AWSError>;
/**
* Retrieves the details for a particular increase request.
*/
getRequestedServiceQuotaChange(callback?: (err: AWSError, data: ServiceQuotas.Types.GetRequestedServiceQuotaChangeResponse) => void): Request<ServiceQuotas.Types.GetRequestedServiceQuotaChangeResponse, AWSError>;
/**
* Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.
*/
getServiceQuota(params: ServiceQuotas.Types.GetServiceQuotaRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.GetServiceQuotaResponse) => void): Request<ServiceQuotas.Types.GetServiceQuotaResponse, AWSError>;
/**
* Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.
*/
getServiceQuota(callback?: (err: AWSError, data: ServiceQuotas.Types.GetServiceQuotaResponse) => void): Request<ServiceQuotas.Types.GetServiceQuotaResponse, AWSError>;
/**
* Returns the details of the service quota increase request in your template.
*/
getServiceQuotaIncreaseRequestFromTemplate(params: ServiceQuotas.Types.GetServiceQuotaIncreaseRequestFromTemplateRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.GetServiceQuotaIncreaseRequestFromTemplateResponse) => void): Request<ServiceQuotas.Types.GetServiceQuotaIncreaseRequestFromTemplateResponse, AWSError>;
/**
* Returns the details of the service quota increase request in your template.
*/
getServiceQuotaIncreaseRequestFromTemplate(callback?: (err: AWSError, data: ServiceQuotas.Types.GetServiceQuotaIncreaseRequestFromTemplateResponse) => void): Request<ServiceQuotas.Types.GetServiceQuotaIncreaseRequestFromTemplateResponse, AWSError>;
/**
* Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you'll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
*/
listAWSDefaultServiceQuotas(params: ServiceQuotas.Types.ListAWSDefaultServiceQuotasRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.ListAWSDefaultServiceQuotasResponse) => void): Request<ServiceQuotas.Types.ListAWSDefaultServiceQuotasResponse, AWSError>;
/**
* Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you'll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
*/
listAWSDefaultServiceQuotas(callback?: (err: AWSError, data: ServiceQuotas.Types.ListAWSDefaultServiceQuotasResponse) => void): Request<ServiceQuotas.Types.ListAWSDefaultServiceQuotasResponse, AWSError>;
/**
* Requests a list of the changes to quotas for a service.
*/
listRequestedServiceQuotaChangeHistory(params: ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryResponse) => void): Request<ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryResponse, AWSError>;
/**
* Requests a list of the changes to quotas for a service.
*/
listRequestedServiceQuotaChangeHistory(callback?: (err: AWSError, data: ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryResponse) => void): Request<ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryResponse, AWSError>;
/**
* Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.
*/
listRequestedServiceQuotaChangeHistoryByQuota(params: ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryByQuotaRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryByQuotaResponse) => void): Request<ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryByQuotaResponse, AWSError>;
/**
* Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.
*/
listRequestedServiceQuotaChangeHistoryByQuota(callback?: (err: AWSError, data: ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryByQuotaResponse) => void): Request<ServiceQuotas.Types.ListRequestedServiceQuotaChangeHistoryByQuotaResponse, AWSError>;
/**
* Returns a list of the quota increase requests in the template.
*/
listServiceQuotaIncreaseRequestsInTemplate(params: ServiceQuotas.Types.ListServiceQuotaIncreaseRequestsInTemplateRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.ListServiceQuotaIncreaseRequestsInTemplateResponse) => void): Request<ServiceQuotas.Types.ListServiceQuotaIncreaseRequestsInTemplateResponse, AWSError>;
/**
* Returns a list of the quota increase requests in the template.
*/
listServiceQuotaIncreaseRequestsInTemplate(callback?: (err: AWSError, data: ServiceQuotas.Types.ListServiceQuotaIncreaseRequestsInTemplateResponse) => void): Request<ServiceQuotas.Types.ListServiceQuotaIncreaseRequestsInTemplateResponse, AWSError>;
/**
* Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
*/
listServiceQuotas(params: ServiceQuotas.Types.ListServiceQuotasRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.ListServiceQuotasResponse) => void): Request<ServiceQuotas.Types.ListServiceQuotasResponse, AWSError>;
/**
* Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
*/
listServiceQuotas(callback?: (err: AWSError, data: ServiceQuotas.Types.ListServiceQuotasResponse) => void): Request<ServiceQuotas.Types.ListServiceQuotasResponse, AWSError>;
/**
* Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.
*/
listServices(params: ServiceQuotas.Types.ListServicesRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.ListServicesResponse) => void): Request<ServiceQuotas.Types.ListServicesResponse, AWSError>;
/**
* Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.
*/
listServices(callback?: (err: AWSError, data: ServiceQuotas.Types.ListServicesResponse) => void): Request<ServiceQuotas.Types.ListServicesResponse, AWSError>;
/**
* Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the template.
*/
putServiceQuotaIncreaseRequestIntoTemplate(params: ServiceQuotas.Types.PutServiceQuotaIncreaseRequestIntoTemplateRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.PutServiceQuotaIncreaseRequestIntoTemplateResponse) => void): Request<ServiceQuotas.Types.PutServiceQuotaIncreaseRequestIntoTemplateResponse, AWSError>;
/**
* Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the template.
*/
putServiceQuotaIncreaseRequestIntoTemplate(callback?: (err: AWSError, data: ServiceQuotas.Types.PutServiceQuotaIncreaseRequestIntoTemplateResponse) => void): Request<ServiceQuotas.Types.PutServiceQuotaIncreaseRequestIntoTemplateResponse, AWSError>;
/**
* Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.
*/
requestServiceQuotaIncrease(params: ServiceQuotas.Types.RequestServiceQuotaIncreaseRequest, callback?: (err: AWSError, data: ServiceQuotas.Types.RequestServiceQuotaIncreaseResponse) => void): Request<ServiceQuotas.Types.RequestServiceQuotaIncreaseResponse, AWSError>;
/**
* Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.
*/
requestServiceQuotaIncrease(callback?: (err: AWSError, data: ServiceQuotas.Types.RequestServiceQuotaIncreaseResponse) => void): Request<ServiceQuotas.Types.RequestServiceQuotaIncreaseResponse, AWSError>;
}
declare namespace ServiceQuotas {
export interface AssociateServiceQuotaTemplateRequest {
}
export interface AssociateServiceQuotaTemplateResponse {
}
export type AwsRegion = string;
export type CustomerServiceEngagementId = string;
export type DateTime = Date;
export interface DeleteServiceQuotaIncreaseRequestFromTemplateRequest {
/**
* Specifies the code for the service that you want to delete.
*/
ServiceCode: ServiceCode;
/**
* Specifies the code for the quota that you want to delete.
*/
QuotaCode: QuotaCode;
/**
* Specifies the AWS Region for the quota that you want to delete.
*/
AwsRegion: AwsRegion;
}
export interface DeleteServiceQuotaIncreaseRequestFromTemplateResponse {
}
export interface DisassociateServiceQuotaTemplateRequest {
}
export interface DisassociateServiceQuotaTemplateResponse {
}
export type ErrorCode = "DEPENDENCY_ACCESS_DENIED_ERROR"|"DEPENDENCY_THROTTLING_ERROR"|"DEPENDENCY_SERVICE_ERROR"|"SERVICE_QUOTA_NOT_AVAILABLE_ERROR"|string;
export type ErrorMessage = string;
export interface ErrorReason {
/**
* Service Quotas returns the following error values. DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota. DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas. DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues. SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.
*/
ErrorCode?: ErrorCode;
/**
* The error message that provides more detail.
*/
ErrorMessage?: ErrorMessage;
}
export interface GetAWSDefaultServiceQuotaRequest {
/**
* Specifies the service that you want to use.
*/
ServiceCode: ServiceCode;
/**
* Identifies the service quota you want to select.
*/
QuotaCode: QuotaCode;
}
export interface GetAWSDefaultServiceQuotaResponse {
/**
* Returns the ServiceQuota object which contains all values for a quota.
*/
Quota?: ServiceQuota;
}
export interface GetAssociationForServiceQuotaTemplateRequest {
}
export interface GetAssociationForServiceQuotaTemplateResponse {
/**
* Specifies whether the template is ASSOCIATED or DISASSOCIATED. If the template is ASSOCIATED, then it requests service quota increases for all new accounts created in your organization.
*/
ServiceQuotaTemplateAssociationStatus?: ServiceQuotaTemplateAssociationStatus;
}
export interface GetRequestedServiceQuotaChangeRequest {
/**
* Identifies the quota increase request.
*/
RequestId: RequestId;
}
export interface GetRequestedServiceQuotaChangeResponse {
/**
* Returns the RequestedServiceQuotaChange object for the specific increase request.
*/
RequestedQuota?: RequestedServiceQuotaChange;
}
export interface GetServiceQuotaIncreaseRequestFromTemplateRequest {
/**
* Specifies the service that you want to use.
*/
ServiceCode: ServiceCode;
/**
* Specifies the quota you want.
*/
QuotaCode: QuotaCode;
/**
* Specifies the AWS Region for the quota that you want to use.
*/
AwsRegion: AwsRegion;
}
export interface GetServiceQuotaIncreaseRequestFromTemplateResponse {
/**
* This object contains the details about the quota increase request.
*/
ServiceQuotaIncreaseRequestInTemplate?: ServiceQuotaIncreaseRequestInTemplate;
}
export interface GetServiceQuotaRequest {
/**
* Specifies the service that you want to use.
*/
ServiceCode: ServiceCode;
/**
* Identifies the service quota you want to select.
*/
QuotaCode: QuotaCode;
}
export interface GetServiceQuotaResponse {
/**
* Returns the ServiceQuota object which contains all values for a quota.
*/
Quota?: ServiceQuota;
}
export type GlobalQuota = boolean;
export interface ListAWSDefaultServiceQuotasRequest {
/**
* Specifies the service that you want to use.
*/
ServiceCode: ServiceCode;
/**
* (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
*/
NextToken?: NextToken;
/**
* (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
}
export interface ListAWSDefaultServiceQuotasResponse {
/**
* (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
/**
* A list of the quotas in the account with the AWS default values.
*/
Quotas?: ServiceQuotaListDefinition;
}
export interface ListRequestedServiceQuotaChangeHistoryByQuotaRequest {
/**
* Specifies the service that you want to use.
*/
ServiceCode: ServiceCode;
/**
* Specifies the service quota that you want to use
*/
QuotaCode: QuotaCode;
/**
* Specifies the status value of the quota increase request.
*/
Status?: RequestStatus;
/**
* (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
/**
* (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
}
export interface ListRequestedServiceQuotaChangeHistoryByQuotaResponse {
/**
* If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
*/
NextToken?: NextToken;
/**
* Returns a list of service quota requests.
*/
RequestedQuotas?: RequestedServiceQuotaChangeHistoryListDefinition;
}
export interface ListRequestedServiceQuotaChangeHistoryRequest {
/**
* Specifies the service that you want to use.
*/
ServiceCode?: ServiceCode;
/**
* Specifies the status value of the quota increase request.
*/
Status?: RequestStatus;
/**
* (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
/**
* (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
}
export interface ListRequestedServiceQuotaChangeHistoryResponse {
/**
* If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
*/
NextToken?: NextToken;
/**
* Returns a list of service quota requests.
*/
RequestedQuotas?: RequestedServiceQuotaChangeHistoryListDefinition;
}
export interface ListServiceQuotaIncreaseRequestsInTemplateRequest {
/**
* The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.
*/
ServiceCode?: ServiceCode;
/**
* Specifies the AWS Region for the quota that you want to use.
*/
AwsRegion?: AwsRegion;
/**
* (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
/**
* (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
}
export interface ListServiceQuotaIncreaseRequestsInTemplateResponse {
/**
* Returns the list of values of the quota increase request in the template.
*/
ServiceQuotaIncreaseRequestInTemplateList?: ServiceQuotaIncreaseRequestInTemplateList;
/**
* If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
*/
NextToken?: NextToken;
}
export interface ListServiceQuotasRequest {
/**
* The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.
*/
ServiceCode: ServiceCode;
/**
* (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
/**
* (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
}
export interface ListServiceQuotasResponse {
/**
* If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
*/
NextToken?: NextToken;
/**
* The response information for a quota lists all attribute information for the quota.
*/
Quotas?: ServiceQuotaListDefinition;
}
export interface ListServicesRequest {
/**
* (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
/**
* (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
}
export interface ListServicesResponse {
/**
* If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
*/
NextToken?: NextToken;
/**
* Returns a list of services.
*/
Services?: ServiceInfoListDefinition;
}
export type MaxResults = number;
export type MetricDimensionName = string;
export type MetricDimensionValue = string;
export type MetricDimensionsMapDefinition = {[key: string]: MetricDimensionValue};
export interface MetricInfo {
/**
* The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.
*/
MetricNamespace?: QuotaMetricNamespace;
/**
* The name of the CloudWatch metric that measures usage of a service quota. This is a required field.
*/
MetricName?: QuotaMetricName;
/**
* A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.
*/
MetricDimensions?: MetricDimensionsMapDefinition;
/**
* Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.
*/
MetricStatisticRecommendation?: Statistic;
}
export type NextToken = string;
export type PeriodUnit = "MICROSECOND"|"MILLISECOND"|"SECOND"|"MINUTE"|"HOUR"|"DAY"|"WEEK"|string;
export type PeriodValue = number;
export interface PutServiceQuotaIncreaseRequestIntoTemplateRequest {
/**
* Specifies the service quota that you want to use.
*/
QuotaCode: QuotaCode;
/**
* Specifies the service that you want to use.
*/
ServiceCode: ServiceCode;
/**
* Specifies the AWS Region for the quota.
*/
AwsRegion: AwsRegion;
/**
* Specifies the new, increased value for the quota.
*/
DesiredValue: QuotaValue;
}
export interface PutServiceQuotaIncreaseRequestIntoTemplateResponse {
/**
* A structure that contains information about one service quota increase request.
*/
ServiceQuotaIncreaseRequestInTemplate?: ServiceQuotaIncreaseRequestInTemplate;
}
export type QuotaAdjustable = boolean;
export type QuotaArn = string;
export type QuotaCode = string;
export type QuotaMetricName = string;
export type QuotaMetricNamespace = string;
export type QuotaName = string;
export interface QuotaPeriod {
/**
* The value of a period.
*/
PeriodValue?: PeriodValue;
/**
* The time unit of a period.
*/
PeriodUnit?: PeriodUnit;
}
export type QuotaUnit = string;
export type QuotaValue = number;
export type RequestId = string;
export interface RequestServiceQuotaIncreaseRequest {
/**
* Specifies the service that you want to use.
*/
ServiceCode: ServiceCode;
/**
* Specifies the service quota that you want to use.
*/
QuotaCode: QuotaCode;
/**
* Specifies the value submitted in the service quota increase request.
*/
DesiredValue: QuotaValue;
}
export interface RequestServiceQuotaIncreaseResponse {
/**
* Returns a list of service quota requests.
*/
RequestedQuota?: RequestedServiceQuotaChange;
}
export type RequestStatus = "PENDING"|"CASE_OPENED"|"APPROVED"|"DENIED"|"CASE_CLOSED"|string;
export interface RequestedServiceQuotaChange {
/**
* The unique identifier of a requested service quota change.
*/
Id?: RequestId;
/**
* The case Id for the service quota increase request.
*/
CaseId?: CustomerServiceEngagementId;
/**
* Specifies the service that you want to use.
*/
ServiceCode?: ServiceCode;
/**
* The name of the AWS service specified in the increase request.
*/
ServiceName?: ServiceName;
/**
* Specifies the service quota that you want to use.
*/
QuotaCode?: QuotaCode;
/**
* Name of the service quota.
*/
QuotaName?: QuotaName;
/**
* New increased value for the service quota.
*/
DesiredValue?: QuotaValue;
/**
* State of the service quota increase request.
*/
Status?: RequestStatus;
/**
* The date and time when the service quota increase request was received and the case Id was created.
*/
Created?: DateTime;
/**
* The date and time of the most recent change in the service quota increase request.
*/
LastUpdated?: DateTime;
/**
* The IAM identity who submitted the service quota increase request.
*/
Requester?: Requester;
/**
* The Amazon Resource Name (ARN) of the service quota.
*/
QuotaArn?: QuotaArn;
/**
* Identifies if the quota is global.
*/
GlobalQuota?: GlobalQuota;
/**
* Specifies the unit used for the quota.
*/
Unit?: QuotaUnit;
}
export type RequestedServiceQuotaChangeHistoryListDefinition = RequestedServiceQuotaChange[];
export type Requester = string;
export type ServiceCode = string;
export interface ServiceInfo {
/**
* Specifies the service that you want to use.
*/
ServiceCode?: ServiceCode;
/**
* The name of the AWS service specified in the increase request.
*/
ServiceName?: ServiceName;
}
export type ServiceInfoListDefinition = ServiceInfo[];
export type ServiceName = string;
export interface ServiceQuota {
/**
* Specifies the service that you want to use.
*/
ServiceCode?: ServiceCode;
/**
* The name of the AWS service specified in the increase request.
*/
ServiceName?: ServiceName;
/**
* The Amazon Resource Name (ARN) of the service quota.
*/
QuotaArn?: QuotaArn;
/**
* The code identifier for the service quota specified.
*/
QuotaCode?: QuotaCode;
/**
* The name identifier of the service quota.
*/
QuotaName?: QuotaName;
/**
* The value of service quota.
*/
Value?: QuotaValue;
/**
* The unit of measurement for the value of the service quota.
*/
Unit?: QuotaUnit;
/**
* Specifies if the quota value can be increased.
*/
Adjustable?: QuotaAdjustable;
/**
* Specifies if the quota is global.
*/
GlobalQuota?: GlobalQuota;
/**
* Specifies the details about the measurement.
*/
UsageMetric?: MetricInfo;
/**
* Identifies the unit and value of how time is measured.
*/
Period?: QuotaPeriod;
/**
* Specifies the ErrorCode and ErrorMessage when success isn't achieved.
*/
ErrorReason?: ErrorReason;
}
export interface ServiceQuotaIncreaseRequestInTemplate {
/**
* The code identifier for the AWS service specified in the increase request.
*/
ServiceCode?: ServiceCode;
/**
* The name of the AWS service specified in the increase request.
*/
ServiceName?: ServiceName;
/**
* The code identifier for the service quota specified in the increase request.
*/
QuotaCode?: QuotaCode;
/**
* The name of the service quota in the increase request.
*/
QuotaName?: QuotaName;
/**
* Identifies the new, increased value of the service quota in the increase request.
*/
DesiredValue?: QuotaValue;
/**
* The AWS Region where the increase request occurs.
*/
AwsRegion?: AwsRegion;
/**
* The unit of measure for the increase request.
*/
Unit?: QuotaUnit;
/**
* Specifies if the quota is a global quota.
*/
GlobalQuota?: GlobalQuota;
}
export type ServiceQuotaIncreaseRequestInTemplateList = ServiceQuotaIncreaseRequestInTemplate[];
export type ServiceQuotaListDefinition = ServiceQuota[];
export type ServiceQuotaTemplateAssociationStatus = "ASSOCIATED"|"DISASSOCIATED"|string;
export type Statistic = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-06-24"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ServiceQuotas client.
*/
export import Types = ServiceQuotas;
}
export = ServiceQuotas;