serverlessapplicationrepository.d.ts
43.7 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
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
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';
interface Blob {}
declare class ServerlessApplicationRepository extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ServerlessApplicationRepository.Types.ClientConfiguration)
config: Config & ServerlessApplicationRepository.Types.ClientConfiguration;
/**
* Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
*/
createApplication(params: ServerlessApplicationRepository.Types.CreateApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationResponse, AWSError>;
/**
* Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
*/
createApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationResponse, AWSError>;
/**
* Creates an application version.
*/
createApplicationVersion(params: ServerlessApplicationRepository.Types.CreateApplicationVersionRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationVersionResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationVersionResponse, AWSError>;
/**
* Creates an application version.
*/
createApplicationVersion(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationVersionResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationVersionResponse, AWSError>;
/**
* Creates an AWS CloudFormation change set for the given application.
*/
createCloudFormationChangeSet(params: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse, AWSError>;
/**
* Creates an AWS CloudFormation change set for the given application.
*/
createCloudFormationChangeSet(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse, AWSError>;
/**
* Creates an AWS CloudFormation template.
*/
createCloudFormationTemplate(params: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse, AWSError>;
/**
* Creates an AWS CloudFormation template.
*/
createCloudFormationTemplate(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse, AWSError>;
/**
* Deletes the specified application.
*/
deleteApplication(params: ServerlessApplicationRepository.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified application.
*/
deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Gets the specified application.
*/
getApplication(params: ServerlessApplicationRepository.Types.GetApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationResponse, AWSError>;
/**
* Gets the specified application.
*/
getApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationResponse, AWSError>;
/**
* Retrieves the policy for the application.
*/
getApplicationPolicy(params: ServerlessApplicationRepository.Types.GetApplicationPolicyRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationPolicyResponse, AWSError>;
/**
* Retrieves the policy for the application.
*/
getApplicationPolicy(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationPolicyResponse, AWSError>;
/**
* Gets the specified AWS CloudFormation template.
*/
getCloudFormationTemplate(params: ServerlessApplicationRepository.Types.GetCloudFormationTemplateRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse, AWSError>;
/**
* Gets the specified AWS CloudFormation template.
*/
getCloudFormationTemplate(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse, AWSError>;
/**
* Retrieves the list of applications nested in the containing application.
*/
listApplicationDependencies(params: ServerlessApplicationRepository.Types.ListApplicationDependenciesRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse, AWSError>;
/**
* Retrieves the list of applications nested in the containing application.
*/
listApplicationDependencies(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse, AWSError>;
/**
* Lists versions for the specified application.
*/
listApplicationVersions(params: ServerlessApplicationRepository.Types.ListApplicationVersionsRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationVersionsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationVersionsResponse, AWSError>;
/**
* Lists versions for the specified application.
*/
listApplicationVersions(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationVersionsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationVersionsResponse, AWSError>;
/**
* Lists applications owned by the requester.
*/
listApplications(params: ServerlessApplicationRepository.Types.ListApplicationsRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationsResponse, AWSError>;
/**
* Lists applications owned by the requester.
*/
listApplications(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationsResponse, AWSError>;
/**
* Sets the permission policy for an application. For the list of actions supported for this operation, see
Application
Permissions
.
*/
putApplicationPolicy(params: ServerlessApplicationRepository.Types.PutApplicationPolicyRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.PutApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.PutApplicationPolicyResponse, AWSError>;
/**
* Sets the permission policy for an application. For the list of actions supported for this operation, see
Application
Permissions
.
*/
putApplicationPolicy(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.PutApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.PutApplicationPolicyResponse, AWSError>;
/**
* Updates the specified application.
*/
updateApplication(params: ServerlessApplicationRepository.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.UpdateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.UpdateApplicationResponse, AWSError>;
/**
* Updates the specified application.
*/
updateApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.UpdateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.UpdateApplicationResponse, AWSError>;
}
declare namespace ServerlessApplicationRepository {
export interface ApplicationDependencySummary {
/**
* The Amazon Resource Name (ARN) of the nested application.
*/
ApplicationId: __string;
/**
* The semantic version of the nested application.
*/
SemanticVersion: __string;
}
export interface ApplicationPolicyStatement {
/**
* For the list of actions supported for this operation, see Application
Permissions.
*/
Actions: __listOf__string;
/**
* An array of AWS account IDs, or * to make the application public.
*/
Principals: __listOf__string;
/**
* A unique ID for the statement.
*/
StatementId?: __string;
}
export interface ApplicationSummary {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId: __string;
/**
* The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
*/
Author: __string;
/**
* The date and time this resource was created.
*/
CreationTime?: __string;
/**
* The description of the application.Minimum length=1. Maximum length=256
*/
Description: __string;
/**
* A URL with more information about the application, for example the location of your GitHub repository for the application.
*/
HomePageUrl?: __string;
/**
* Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
*/
Labels?: __listOf__string;
/**
* The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
*/
Name: __string;
/**
* A valid identifier from https://spdx.org/licenses/.
*/
SpdxLicenseId?: __string;
}
export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|"CAPABILITY_RESOURCE_POLICY"|string;
export interface CreateApplicationRequest {
/**
* The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
*/
Author: __string;
/**
* The description of the application.Minimum length=1. Maximum length=256
*/
Description: __string;
/**
* A URL with more information about the application, for example the location of your GitHub repository for the application.
*/
HomePageUrl?: __string;
/**
* Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
*/
Labels?: __listOf__string;
/**
* A local text file that contains the license of the app that matches the spdxLicenseID value of your application.
The file has the format file://<path>/<filename>.Maximum size 5 MBYou can specify only one of licenseBody and licenseUrl; otherwise, an error results.
*/
LicenseBody?: __string;
/**
* A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.Maximum size 5 MBYou can specify only one of licenseBody and licenseUrl; otherwise, an error results.
*/
LicenseUrl?: __string;
/**
* The name of the application that you want to publish.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
*/
Name: __string;
/**
* A local text readme file in Markdown language that contains a more detailed description of the application and how it works.
The file has the format file://<path>/<filename>.Maximum size 5 MBYou can specify only one of readmeBody and readmeUrl; otherwise, an error results.
*/
ReadmeBody?: __string;
/**
* A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MBYou can specify only one of readmeBody and readmeUrl; otherwise, an error results.
*/
ReadmeUrl?: __string;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion?: __string;
/**
* A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB
*/
SourceCodeArchiveUrl?: __string;
/**
* A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
*/
SourceCodeUrl?: __string;
/**
* A valid identifier from https://spdx.org/licenses/.
*/
SpdxLicenseId?: __string;
/**
* The local raw packaged AWS SAM template file of your application.
The file has the format file://<path>/<filename>.You can specify only one of templateBody and templateUrl; otherwise an error results.
*/
TemplateBody?: __string;
/**
* A link to the S3 object containing the packaged AWS SAM template of your application.You can specify only one of templateBody and templateUrl; otherwise an error results.
*/
TemplateUrl?: __string;
}
export interface CreateApplicationResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId?: __string;
/**
* The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
*/
Author?: __string;
/**
* The date and time this resource was created.
*/
CreationTime?: __string;
/**
* The description of the application.Minimum length=1. Maximum length=256
*/
Description?: __string;
/**
* A URL with more information about the application, for example the location of your GitHub repository for the application.
*/
HomePageUrl?: __string;
/**
* Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.
*/
IsVerifiedAuthor?: __boolean;
/**
* Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
*/
Labels?: __listOf__string;
/**
* A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB
*/
LicenseUrl?: __string;
/**
* The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
*/
Name?: __string;
/**
* A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB
*/
ReadmeUrl?: __string;
/**
* A valid identifier from https://spdx.org/licenses/.
*/
SpdxLicenseId?: __string;
/**
* The URL to the public profile of a verified author. This URL is submitted by the author.
*/
VerifiedAuthorUrl?: __string;
/**
* Version information about the application.
*/
Version?: Version;
}
export interface CreateApplicationVersionRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* The semantic version of the new version.
*/
SemanticVersion: __string;
/**
* A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB
*/
SourceCodeArchiveUrl?: __string;
/**
* A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
*/
SourceCodeUrl?: __string;
/**
* The raw packaged AWS SAM template of your application.
*/
TemplateBody?: __string;
/**
* A link to the packaged AWS SAM template of your application.
*/
TemplateUrl?: __string;
}
export interface CreateApplicationVersionResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId?: __string;
/**
* The date and time this resource was created.
*/
CreationTime?: __string;
/**
* An array of parameter types supported by the application.
*/
ParameterDefinitions?: __listOfParameterDefinition;
/**
* A list of values that you must specify before you can deploy certain applications.
Some applications might include resources that can affect permissions in your AWS
account, for example, by creating new AWS Identity and Access Management (IAM) users.
For those applications, you must explicitly acknowledge their capabilities by
specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,
CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or
CAPABILITY_NAMED_IAM:
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy, and
AWS::IAM::Role.
If the application contains IAM resources, you can specify either CAPABILITY_IAM
or CAPABILITY_NAMED_IAM. If the application contains IAM resources
with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY:
AWS::Lambda::Permission,
AWS::IAM:Policy,
AWS::ApplicationAutoScaling::ScalingPolicy,
AWS::S3::BucketPolicy,
AWS::SQS::QueuePolicy, and
AWS::SNS::TopicPolicy.Applications that contain one or more nested applications require you to specify
CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review
all permissions associated with the application before deploying. If you don't specify
this parameter for an application that requires capabilities, the call will fail.
*/
RequiredCapabilities?: __listOfCapability;
/**
* Whether all of the AWS resources contained in this application are supported in the region
in which it is being retrieved.
*/
ResourcesSupported?: __boolean;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion?: __string;
/**
* A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB
*/
SourceCodeArchiveUrl?: __string;
/**
* A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
*/
SourceCodeUrl?: __string;
/**
* A link to the packaged AWS SAM template of your application.
*/
TemplateUrl?: __string;
}
export interface CreateCloudFormationChangeSetRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* A list of values that you must specify before you can deploy certain applications.
Some applications might include resources that can affect permissions in your AWS
account, for example, by creating new AWS Identity and Access Management (IAM) users.
For those applications, you must explicitly acknowledge their capabilities by
specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,
CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or
CAPABILITY_NAMED_IAM:
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy, and
AWS::IAM::Role.
If the application contains IAM resources, you can specify either CAPABILITY_IAM
or CAPABILITY_NAMED_IAM. If the application contains IAM resources
with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY:
AWS::Lambda::Permission,
AWS::IAM:Policy,
AWS::ApplicationAutoScaling::ScalingPolicy,
AWS::S3::BucketPolicy,
AWS::SQS::QueuePolicy, and
AWS::SNS:TopicPolicy.Applications that contain one or more nested applications require you to specify
CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review
all permissions associated with the application before deploying. If you don't specify
this parameter for an application that requires capabilities, the call will fail.
*/
Capabilities?: __listOf__string;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
ChangeSetName?: __string;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
ClientToken?: __string;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
Description?: __string;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
NotificationArns?: __listOf__string;
/**
* A list of parameter values for the parameters of the application.
*/
ParameterOverrides?: __listOfParameterValue;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
ResourceTypes?: __listOf__string;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
RollbackConfiguration?: RollbackConfiguration;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion?: __string;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
StackName: __string;
/**
* This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
API.
*/
Tags?: __listOfTag;
/**
* The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
*/
TemplateId?: __string;
}
export interface CreateCloudFormationChangeSetResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId?: __string;
/**
* The Amazon Resource Name (ARN) of the change set.Length constraints: Minimum length of 1.Pattern: ARN:[-a-zA-Z0-9:/]*
*/
ChangeSetId?: __string;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion?: __string;
/**
* The unique ID of the stack.
*/
StackId?: __string;
}
export interface CreateCloudFormationTemplateRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion?: __string;
}
export interface CreateCloudFormationTemplateResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId?: __string;
/**
* The date and time this resource was created.
*/
CreationTime?: __string;
/**
* The date and time this template expires. Templates
expire 1 hour after creation.
*/
ExpirationTime?: __string;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion?: __string;
/**
* Status of the template creation workflow.Possible values: PREPARING | ACTIVE | EXPIRED
*/
Status?: Status;
/**
* The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
*/
TemplateId?: __string;
/**
* A link to the template that can be used to deploy the application using
AWS CloudFormation.
*/
TemplateUrl?: __string;
}
export interface DeleteApplicationRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
}
export interface GetApplicationPolicyRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
}
export interface GetApplicationPolicyResponse {
/**
* An array of policy statements applied to the application.
*/
Statements?: __listOfApplicationPolicyStatement;
}
export interface GetApplicationRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* The semantic version of the application to get.
*/
SemanticVersion?: __string;
}
export interface GetApplicationResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId?: __string;
/**
* The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
*/
Author?: __string;
/**
* The date and time this resource was created.
*/
CreationTime?: __string;
/**
* The description of the application.Minimum length=1. Maximum length=256
*/
Description?: __string;
/**
* A URL with more information about the application, for example the location of your GitHub repository for the application.
*/
HomePageUrl?: __string;
/**
* Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.
*/
IsVerifiedAuthor?: __boolean;
/**
* Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
*/
Labels?: __listOf__string;
/**
* A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB
*/
LicenseUrl?: __string;
/**
* The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
*/
Name?: __string;
/**
* A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB
*/
ReadmeUrl?: __string;
/**
* A valid identifier from https://spdx.org/licenses/.
*/
SpdxLicenseId?: __string;
/**
* The URL to the public profile of a verified author. This URL is submitted by the author.
*/
VerifiedAuthorUrl?: __string;
/**
* Version information about the application.
*/
Version?: Version;
}
export interface GetCloudFormationTemplateRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
*/
TemplateId: __string;
}
export interface GetCloudFormationTemplateResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId?: __string;
/**
* The date and time this resource was created.
*/
CreationTime?: __string;
/**
* The date and time this template expires. Templates
expire 1 hour after creation.
*/
ExpirationTime?: __string;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion?: __string;
/**
* Status of the template creation workflow.Possible values: PREPARING | ACTIVE | EXPIRED
*/
Status?: Status;
/**
* The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
*/
TemplateId?: __string;
/**
* A link to the template that can be used to deploy the application using
AWS CloudFormation.
*/
TemplateUrl?: __string;
}
export interface ListApplicationDependenciesRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* The total number of items to return.
*/
MaxItems?: MaxItems;
/**
* A token to specify where to start paginating.
*/
NextToken?: __string;
/**
* The semantic version of the application to get.
*/
SemanticVersion?: __string;
}
export interface ListApplicationDependenciesResponse {
/**
* An array of application summaries nested in the application.
*/
Dependencies?: __listOfApplicationDependencySummary;
/**
* The token to request the next page of results.
*/
NextToken?: __string;
}
export interface ListApplicationVersionsRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* The total number of items to return.
*/
MaxItems?: MaxItems;
/**
* A token to specify where to start paginating.
*/
NextToken?: __string;
}
export interface ListApplicationVersionsResponse {
/**
* The token to request the next page of results.
*/
NextToken?: __string;
/**
* An array of version summaries for the application.
*/
Versions?: __listOfVersionSummary;
}
export interface ListApplicationsRequest {
/**
* The total number of items to return.
*/
MaxItems?: MaxItems;
/**
* A token to specify where to start paginating.
*/
NextToken?: __string;
}
export interface ListApplicationsResponse {
/**
* An array of application summaries.
*/
Applications?: __listOfApplicationSummary;
/**
* The token to request the next page of results.
*/
NextToken?: __string;
}
export type MaxItems = number;
export interface ParameterDefinition {
/**
* A regular expression that represents the patterns to allow for String types.
*/
AllowedPattern?: __string;
/**
* An array containing the list of values allowed for the parameter.
*/
AllowedValues?: __listOf__string;
/**
* A string that explains a constraint when the constraint is violated. For example, without a constraint description,
a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user
specifies an invalid value:
Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display
the following customized error message:
Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.
*/
ConstraintDescription?: __string;
/**
* A value of the appropriate type for the template to use if no value is specified when a stack is created.
If you define constraints for the parameter, you must specify a value that adheres to those constraints.
*/
DefaultValue?: __string;
/**
* A string of up to 4,000 characters that describes the parameter.
*/
Description?: __string;
/**
* An integer value that determines the largest number of characters that you want to allow for String types.
*/
MaxLength?: __integer;
/**
* A numeric value that determines the largest numeric value that you want to allow for Number types.
*/
MaxValue?: __integer;
/**
* An integer value that determines the smallest number of characters that you want to allow for String types.
*/
MinLength?: __integer;
/**
* A numeric value that determines the smallest numeric value that you want to allow for Number types.
*/
MinValue?: __integer;
/**
* The name of the parameter.
*/
Name: __string;
/**
* Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the
value to true, the parameter value is masked with asterisks (*****).
*/
NoEcho?: __boolean;
/**
* A list of AWS SAM resources that use this parameter.
*/
ReferencedByResources: __listOf__string;
/**
* The type of the parameter.Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.For example, users can specify "MyUserName".
Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the
parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.For example, users might specify "8888".
List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when
you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.For example, users might specify "80,20", and then Ref results in ["80","20"].
CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas.
Also, each member string is space-trimmed.For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].
*/
Type?: __string;
}
export interface ParameterValue {
/**
* The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation
uses the default value that is specified in your template.
*/
Name: __string;
/**
* The input value associated with the parameter.
*/
Value: __string;
}
export interface PutApplicationPolicyRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* An array of policy statements applied to the application.
*/
Statements: __listOfApplicationPolicyStatement;
}
export interface PutApplicationPolicyResponse {
/**
* An array of policy statements applied to the application.
*/
Statements?: __listOfApplicationPolicyStatement;
}
export interface RollbackConfiguration {
/**
* This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration
Data Type.
*/
MonitoringTimeInMinutes?: __integer;
/**
* This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration
Data Type.
*/
RollbackTriggers?: __listOfRollbackTrigger;
}
export interface RollbackTrigger {
/**
* This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger
Data Type.
*/
Arn: __string;
/**
* This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger
Data Type.
*/
Type: __string;
}
export type Status = "PREPARING"|"ACTIVE"|"EXPIRED"|string;
export interface Tag {
/**
* This property corresponds to the content of the same name for the AWS CloudFormation Tag
Data Type.
*/
Key: __string;
/**
* This property corresponds to the content of the same name for the AWS CloudFormation
Tag
Data Type.
*/
Value: __string;
}
export interface UpdateApplicationRequest {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationId: __string;
/**
* The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
*/
Author?: __string;
/**
* The description of the application.Minimum length=1. Maximum length=256
*/
Description?: __string;
/**
* A URL with more information about the application, for example the location of your GitHub repository for the application.
*/
HomePageUrl?: __string;
/**
* Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
*/
Labels?: __listOf__string;
/**
* A text readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB
*/
ReadmeBody?: __string;
/**
* A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB
*/
ReadmeUrl?: __string;
}
export interface UpdateApplicationResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId?: __string;
/**
* The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
*/
Author?: __string;
/**
* The date and time this resource was created.
*/
CreationTime?: __string;
/**
* The description of the application.Minimum length=1. Maximum length=256
*/
Description?: __string;
/**
* A URL with more information about the application, for example the location of your GitHub repository for the application.
*/
HomePageUrl?: __string;
/**
* Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.
*/
IsVerifiedAuthor?: __boolean;
/**
* Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
*/
Labels?: __listOf__string;
/**
* A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB
*/
LicenseUrl?: __string;
/**
* The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
*/
Name?: __string;
/**
* A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB
*/
ReadmeUrl?: __string;
/**
* A valid identifier from https://spdx.org/licenses/.
*/
SpdxLicenseId?: __string;
/**
* The URL to the public profile of a verified author. This URL is submitted by the author.
*/
VerifiedAuthorUrl?: __string;
/**
* Version information about the application.
*/
Version?: Version;
}
export interface Version {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId: __string;
/**
* The date and time this resource was created.
*/
CreationTime: __string;
/**
* An array of parameter types supported by the application.
*/
ParameterDefinitions: __listOfParameterDefinition;
/**
* A list of values that you must specify before you can deploy certain applications.
Some applications might include resources that can affect permissions in your AWS
account, for example, by creating new AWS Identity and Access Management (IAM) users.
For those applications, you must explicitly acknowledge their capabilities by
specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,
CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or
CAPABILITY_NAMED_IAM:
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy, and
AWS::IAM::Role.
If the application contains IAM resources, you can specify either CAPABILITY_IAM
or CAPABILITY_NAMED_IAM. If the application contains IAM resources
with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY:
AWS::Lambda::Permission,
AWS::IAM:Policy,
AWS::ApplicationAutoScaling::ScalingPolicy,
AWS::S3::BucketPolicy,
AWS::SQS::QueuePolicy, and
AWS::SNS::TopicPolicy.Applications that contain one or more nested applications require you to specify
CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review
all permissions associated with the application before deploying. If you don't specify
this parameter for an application that requires capabilities, the call will fail.
*/
RequiredCapabilities: __listOfCapability;
/**
* Whether all of the AWS resources contained in this application are supported in the region
in which it is being retrieved.
*/
ResourcesSupported: __boolean;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion: __string;
/**
* A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB
*/
SourceCodeArchiveUrl?: __string;
/**
* A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
*/
SourceCodeUrl?: __string;
/**
* A link to the packaged AWS SAM template of your application.
*/
TemplateUrl: __string;
}
export interface VersionSummary {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationId: __string;
/**
* The date and time this resource was created.
*/
CreationTime: __string;
/**
* The semantic version of the application:
https://semver.org/
*/
SemanticVersion: __string;
/**
* A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
*/
SourceCodeUrl?: __string;
}
export type __boolean = boolean;
export type __integer = number;
export type __listOfApplicationDependencySummary = ApplicationDependencySummary[];
export type __listOfApplicationPolicyStatement = ApplicationPolicyStatement[];
export type __listOfApplicationSummary = ApplicationSummary[];
export type __listOfCapability = Capability[];
export type __listOfParameterDefinition = ParameterDefinition[];
export type __listOfParameterValue = ParameterValue[];
export type __listOfRollbackTrigger = RollbackTrigger[];
export type __listOfTag = Tag[];
export type __listOfVersionSummary = VersionSummary[];
export type __listOf__string = __string[];
export type __string = 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 = "2017-09-08"|"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 ServerlessApplicationRepository client.
*/
export import Types = ServerlessApplicationRepository;
}
export = ServerlessApplicationRepository;