UNPKG

45.7 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class ServerlessApplicationRepository extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: ServerlessApplicationRepository.Types.ClientConfiguration)
13 config: Config & ServerlessApplicationRepository.Types.ClientConfiguration;
14 /**
15 * Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
16 */
17 createApplication(params: ServerlessApplicationRepository.Types.CreateApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationResponse, AWSError>;
18 /**
19 * Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
20 */
21 createApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationResponse, AWSError>;
22 /**
23 * Creates an application version.
24 */
25 createApplicationVersion(params: ServerlessApplicationRepository.Types.CreateApplicationVersionRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationVersionResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationVersionResponse, AWSError>;
26 /**
27 * Creates an application version.
28 */
29 createApplicationVersion(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationVersionResponse) => void): Request<ServerlessApplicationRepository.Types.CreateApplicationVersionResponse, AWSError>;
30 /**
31 * Creates an AWS CloudFormation change set for the given application.
32 */
33 createCloudFormationChangeSet(params: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse, AWSError>;
34 /**
35 * Creates an AWS CloudFormation change set for the given application.
36 */
37 createCloudFormationChangeSet(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse, AWSError>;
38 /**
39 * Creates an AWS CloudFormation template.
40 */
41 createCloudFormationTemplate(params: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse, AWSError>;
42 /**
43 * Creates an AWS CloudFormation template.
44 */
45 createCloudFormationTemplate(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse, AWSError>;
46 /**
47 * Deletes the specified application.
48 */
49 deleteApplication(params: ServerlessApplicationRepository.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50 /**
51 * Deletes the specified application.
52 */
53 deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54 /**
55 * Gets the specified application.
56 */
57 getApplication(params: ServerlessApplicationRepository.Types.GetApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationResponse, AWSError>;
58 /**
59 * Gets the specified application.
60 */
61 getApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationResponse, AWSError>;
62 /**
63 * Retrieves the policy for the application.
64 */
65 getApplicationPolicy(params: ServerlessApplicationRepository.Types.GetApplicationPolicyRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationPolicyResponse, AWSError>;
66 /**
67 * Retrieves the policy for the application.
68 */
69 getApplicationPolicy(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.GetApplicationPolicyResponse, AWSError>;
70 /**
71 * Gets the specified AWS CloudFormation template.
72 */
73 getCloudFormationTemplate(params: ServerlessApplicationRepository.Types.GetCloudFormationTemplateRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse, AWSError>;
74 /**
75 * Gets the specified AWS CloudFormation template.
76 */
77 getCloudFormationTemplate(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse) => void): Request<ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse, AWSError>;
78 /**
79 * Retrieves the list of applications nested in the containing application.
80 */
81 listApplicationDependencies(params: ServerlessApplicationRepository.Types.ListApplicationDependenciesRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse, AWSError>;
82 /**
83 * Retrieves the list of applications nested in the containing application.
84 */
85 listApplicationDependencies(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse, AWSError>;
86 /**
87 * Lists versions for the specified application.
88 */
89 listApplicationVersions(params: ServerlessApplicationRepository.Types.ListApplicationVersionsRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationVersionsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationVersionsResponse, AWSError>;
90 /**
91 * Lists versions for the specified application.
92 */
93 listApplicationVersions(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationVersionsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationVersionsResponse, AWSError>;
94 /**
95 * Lists applications owned by the requester.
96 */
97 listApplications(params: ServerlessApplicationRepository.Types.ListApplicationsRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationsResponse, AWSError>;
98 /**
99 * Lists applications owned by the requester.
100 */
101 listApplications(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationsResponse) => void): Request<ServerlessApplicationRepository.Types.ListApplicationsResponse, AWSError>;
102 /**
103 * Sets the permission policy for an application. For the list of actions supported for this operation, see
104 Application
105 Permissions
106 .
107 */
108 putApplicationPolicy(params: ServerlessApplicationRepository.Types.PutApplicationPolicyRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.PutApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.PutApplicationPolicyResponse, AWSError>;
109 /**
110 * Sets the permission policy for an application. For the list of actions supported for this operation, see
111 Application
112 Permissions
113 .
114 */
115 putApplicationPolicy(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.PutApplicationPolicyResponse) => void): Request<ServerlessApplicationRepository.Types.PutApplicationPolicyResponse, AWSError>;
116 /**
117 * Unshares an application from an AWS Organization.This operation can be called only from the organization's master account.
118 */
119 unshareApplication(params: ServerlessApplicationRepository.Types.UnshareApplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
120 /**
121 * Unshares an application from an AWS Organization.This operation can be called only from the organization's master account.
122 */
123 unshareApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
124 /**
125 * Updates the specified application.
126 */
127 updateApplication(params: ServerlessApplicationRepository.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.UpdateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.UpdateApplicationResponse, AWSError>;
128 /**
129 * Updates the specified application.
130 */
131 updateApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.UpdateApplicationResponse) => void): Request<ServerlessApplicationRepository.Types.UpdateApplicationResponse, AWSError>;
132}
133declare namespace ServerlessApplicationRepository {
134 export interface ApplicationDependencySummary {
135 /**
136 * The Amazon Resource Name (ARN) of the nested application.
137 */
138 ApplicationId: __string;
139 /**
140 * The semantic version of the nested application.
141 */
142 SemanticVersion: __string;
143 }
144 export interface ApplicationPolicyStatement {
145 /**
146 * For the list of actions supported for this operation, see Application
147 Permissions.
148 */
149 Actions: __listOf__string;
150 /**
151 * An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.
152 */
153 PrincipalOrgIDs?: __listOf__string;
154 /**
155 * An array of AWS account IDs, or * to make the application public.
156 */
157 Principals: __listOf__string;
158 /**
159 * A unique ID for the statement.
160 */
161 StatementId?: __string;
162 }
163 export interface ApplicationSummary {
164 /**
165 * The application Amazon Resource Name (ARN).
166 */
167 ApplicationId: __string;
168 /**
169 * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
170 */
171 Author: __string;
172 /**
173 * The date and time this resource was created.
174 */
175 CreationTime?: __string;
176 /**
177 * The description of the application.Minimum length=1. Maximum length=256
178 */
179 Description: __string;
180 /**
181 * A URL with more information about the application, for example the location of your GitHub repository for the application.
182 */
183 HomePageUrl?: __string;
184 /**
185 * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
186 */
187 Labels?: __listOf__string;
188 /**
189 * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
190 */
191 Name: __string;
192 /**
193 * A valid identifier from https://spdx.org/licenses/.
194 */
195 SpdxLicenseId?: __string;
196 }
197 export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|"CAPABILITY_RESOURCE_POLICY"|string;
198 export interface CreateApplicationRequest {
199 /**
200 * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
201 */
202 Author: __string;
203 /**
204 * The description of the application.Minimum length=1. Maximum length=256
205 */
206 Description: __string;
207 /**
208 * A URL with more information about the application, for example the location of your GitHub repository for the application.
209 */
210 HomePageUrl?: __string;
211 /**
212 * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
213 */
214 Labels?: __listOf__string;
215 /**
216 * A local text file that contains the license of the app that matches the spdxLicenseID value of your application.
217 The file has the format file://&lt;path>/&lt;filename>.Maximum size 5 MBYou can specify only one of licenseBody and licenseUrl; otherwise, an error results.
218 */
219 LicenseBody?: __string;
220 /**
221 * 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.
222 */
223 LicenseUrl?: __string;
224 /**
225 * The name of the application that you want to publish.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
226 */
227 Name: __string;
228 /**
229 * A local text readme file in Markdown language that contains a more detailed description of the application and how it works.
230 The file has the format file://&lt;path>/&lt;filename>.Maximum size 5 MBYou can specify only one of readmeBody and readmeUrl; otherwise, an error results.
231 */
232 ReadmeBody?: __string;
233 /**
234 * 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.
235 */
236 ReadmeUrl?: __string;
237 /**
238 * The semantic version of the application:
239 https://semver.org/
240
241 */
242 SemanticVersion?: __string;
243 /**
244 * 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
245 */
246 SourceCodeArchiveUrl?: __string;
247 /**
248 * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
249 */
250 SourceCodeUrl?: __string;
251 /**
252 * A valid identifier from https://spdx.org/licenses/.
253 */
254 SpdxLicenseId?: __string;
255 /**
256 * The local raw packaged AWS SAM template file of your application.
257 The file has the format file://&lt;path>/&lt;filename>.You can specify only one of templateBody and templateUrl; otherwise an error results.
258 */
259 TemplateBody?: __string;
260 /**
261 * 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.
262 */
263 TemplateUrl?: __string;
264 }
265 export interface CreateApplicationResponse {
266 /**
267 * The application Amazon Resource Name (ARN).
268 */
269 ApplicationId?: __string;
270 /**
271 * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
272 */
273 Author?: __string;
274 /**
275 * The date and time this resource was created.
276 */
277 CreationTime?: __string;
278 /**
279 * The description of the application.Minimum length=1. Maximum length=256
280 */
281 Description?: __string;
282 /**
283 * A URL with more information about the application, for example the location of your GitHub repository for the application.
284 */
285 HomePageUrl?: __string;
286 /**
287 * 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.
288 */
289 IsVerifiedAuthor?: __boolean;
290 /**
291 * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
292 */
293 Labels?: __listOf__string;
294 /**
295 * A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB
296 */
297 LicenseUrl?: __string;
298 /**
299 * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
300 */
301 Name?: __string;
302 /**
303 * 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
304 */
305 ReadmeUrl?: __string;
306 /**
307 * A valid identifier from https://spdx.org/licenses/.
308 */
309 SpdxLicenseId?: __string;
310 /**
311 * The URL to the public profile of a verified author. This URL is submitted by the author.
312 */
313 VerifiedAuthorUrl?: __string;
314 /**
315 * Version information about the application.
316 */
317 Version?: Version;
318 }
319 export interface CreateApplicationVersionRequest {
320 /**
321 * The Amazon Resource Name (ARN) of the application.
322 */
323 ApplicationId: __string;
324 /**
325 * The semantic version of the new version.
326 */
327 SemanticVersion: __string;
328 /**
329 * 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
330 */
331 SourceCodeArchiveUrl?: __string;
332 /**
333 * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
334 */
335 SourceCodeUrl?: __string;
336 /**
337 * The raw packaged AWS SAM template of your application.
338 */
339 TemplateBody?: __string;
340 /**
341 * A link to the packaged AWS SAM template of your application.
342 */
343 TemplateUrl?: __string;
344 }
345 export interface CreateApplicationVersionResponse {
346 /**
347 * The application Amazon Resource Name (ARN).
348 */
349 ApplicationId?: __string;
350 /**
351 * The date and time this resource was created.
352 */
353 CreationTime?: __string;
354 /**
355 * An array of parameter types supported by the application.
356 */
357 ParameterDefinitions?: __listOfParameterDefinition;
358 /**
359 * A list of values that you must specify before you can deploy certain applications.
360 Some applications might include resources that can affect permissions in your AWS
361 account, for example, by creating new AWS Identity and Access Management (IAM) users.
362 For those applications, you must explicitly acknowledge their capabilities by
363 specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,
364 CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or
365 CAPABILITY_NAMED_IAM:
366 AWS::IAM::Group,
367 AWS::IAM::InstanceProfile,
368 AWS::IAM::Policy, and
369 AWS::IAM::Role.
370 If the application contains IAM resources, you can specify either CAPABILITY_IAM
371 or CAPABILITY_NAMED_IAM. If the application contains IAM resources
372 with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY:
373 AWS::Lambda::Permission,
374 AWS::IAM:Policy,
375 AWS::ApplicationAutoScaling::ScalingPolicy,
376 AWS::S3::BucketPolicy,
377 AWS::SQS::QueuePolicy, and
378 AWS::SNS::TopicPolicy.Applications that contain one or more nested applications require you to specify
379 CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review
380 all permissions associated with the application before deploying. If you don't specify
381 this parameter for an application that requires capabilities, the call will fail.
382 */
383 RequiredCapabilities?: __listOfCapability;
384 /**
385 * Whether all of the AWS resources contained in this application are supported in the region
386 in which it is being retrieved.
387 */
388 ResourcesSupported?: __boolean;
389 /**
390 * The semantic version of the application:
391 https://semver.org/
392
393 */
394 SemanticVersion?: __string;
395 /**
396 * 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
397 */
398 SourceCodeArchiveUrl?: __string;
399 /**
400 * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
401 */
402 SourceCodeUrl?: __string;
403 /**
404 * A link to the packaged AWS SAM template of your application.
405 */
406 TemplateUrl?: __string;
407 }
408 export interface CreateCloudFormationChangeSetRequest {
409 /**
410 * The Amazon Resource Name (ARN) of the application.
411 */
412 ApplicationId: __string;
413 /**
414 * A list of values that you must specify before you can deploy certain applications.
415 Some applications might include resources that can affect permissions in your AWS
416 account, for example, by creating new AWS Identity and Access Management (IAM) users.
417 For those applications, you must explicitly acknowledge their capabilities by
418 specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,
419 CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or
420 CAPABILITY_NAMED_IAM:
421 AWS::IAM::Group,
422 AWS::IAM::InstanceProfile,
423 AWS::IAM::Policy, and
424 AWS::IAM::Role.
425 If the application contains IAM resources, you can specify either CAPABILITY_IAM
426 or CAPABILITY_NAMED_IAM. If the application contains IAM resources
427 with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY:
428 AWS::Lambda::Permission,
429 AWS::IAM:Policy,
430 AWS::ApplicationAutoScaling::ScalingPolicy,
431 AWS::S3::BucketPolicy,
432 AWS::SQS::QueuePolicy, and
433 AWS::SNS:TopicPolicy.Applications that contain one or more nested applications require you to specify
434 CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review
435 all permissions associated with the application before deploying. If you don't specify
436 this parameter for an application that requires capabilities, the call will fail.
437 */
438 Capabilities?: __listOf__string;
439 /**
440 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
441 API.
442 */
443 ChangeSetName?: __string;
444 /**
445 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
446 API.
447 */
448 ClientToken?: __string;
449 /**
450 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
451 API.
452 */
453 Description?: __string;
454 /**
455 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
456 API.
457 */
458 NotificationArns?: __listOf__string;
459 /**
460 * A list of parameter values for the parameters of the application.
461 */
462 ParameterOverrides?: __listOfParameterValue;
463 /**
464 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
465 API.
466 */
467 ResourceTypes?: __listOf__string;
468 /**
469 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
470 API.
471 */
472 RollbackConfiguration?: RollbackConfiguration;
473 /**
474 * The semantic version of the application:
475 https://semver.org/
476
477 */
478 SemanticVersion?: __string;
479 /**
480 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
481 API.
482 */
483 StackName: __string;
484 /**
485 * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet
486 API.
487 */
488 Tags?: __listOfTag;
489 /**
490 * 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}
491 */
492 TemplateId?: __string;
493 }
494 export interface CreateCloudFormationChangeSetResponse {
495 /**
496 * The application Amazon Resource Name (ARN).
497 */
498 ApplicationId?: __string;
499 /**
500 * The Amazon Resource Name (ARN) of the change set.Length constraints: Minimum length of 1.Pattern: ARN:[-a-zA-Z0-9:/]*
501 */
502 ChangeSetId?: __string;
503 /**
504 * The semantic version of the application:
505 https://semver.org/
506
507 */
508 SemanticVersion?: __string;
509 /**
510 * The unique ID of the stack.
511 */
512 StackId?: __string;
513 }
514 export interface CreateCloudFormationTemplateRequest {
515 /**
516 * The Amazon Resource Name (ARN) of the application.
517 */
518 ApplicationId: __string;
519 /**
520 * The semantic version of the application:
521 https://semver.org/
522
523 */
524 SemanticVersion?: __string;
525 }
526 export interface CreateCloudFormationTemplateResponse {
527 /**
528 * The application Amazon Resource Name (ARN).
529 */
530 ApplicationId?: __string;
531 /**
532 * The date and time this resource was created.
533 */
534 CreationTime?: __string;
535 /**
536 * The date and time this template expires. Templates
537 expire 1 hour after creation.
538 */
539 ExpirationTime?: __string;
540 /**
541 * The semantic version of the application:
542 https://semver.org/
543
544 */
545 SemanticVersion?: __string;
546 /**
547 * Status of the template creation workflow.Possible values: PREPARING | ACTIVE | EXPIRED
548
549 */
550 Status?: Status;
551 /**
552 * 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}
553 */
554 TemplateId?: __string;
555 /**
556 * A link to the template that can be used to deploy the application using
557 AWS CloudFormation.
558 */
559 TemplateUrl?: __string;
560 }
561 export interface DeleteApplicationRequest {
562 /**
563 * The Amazon Resource Name (ARN) of the application.
564 */
565 ApplicationId: __string;
566 }
567 export interface GetApplicationPolicyRequest {
568 /**
569 * The Amazon Resource Name (ARN) of the application.
570 */
571 ApplicationId: __string;
572 }
573 export interface GetApplicationPolicyResponse {
574 /**
575 * An array of policy statements applied to the application.
576 */
577 Statements?: __listOfApplicationPolicyStatement;
578 }
579 export interface GetApplicationRequest {
580 /**
581 * The Amazon Resource Name (ARN) of the application.
582 */
583 ApplicationId: __string;
584 /**
585 * The semantic version of the application to get.
586 */
587 SemanticVersion?: __string;
588 }
589 export interface GetApplicationResponse {
590 /**
591 * The application Amazon Resource Name (ARN).
592 */
593 ApplicationId?: __string;
594 /**
595 * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
596 */
597 Author?: __string;
598 /**
599 * The date and time this resource was created.
600 */
601 CreationTime?: __string;
602 /**
603 * The description of the application.Minimum length=1. Maximum length=256
604 */
605 Description?: __string;
606 /**
607 * A URL with more information about the application, for example the location of your GitHub repository for the application.
608 */
609 HomePageUrl?: __string;
610 /**
611 * 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.
612 */
613 IsVerifiedAuthor?: __boolean;
614 /**
615 * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
616 */
617 Labels?: __listOf__string;
618 /**
619 * A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB
620 */
621 LicenseUrl?: __string;
622 /**
623 * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
624 */
625 Name?: __string;
626 /**
627 * 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
628 */
629 ReadmeUrl?: __string;
630 /**
631 * A valid identifier from https://spdx.org/licenses/.
632 */
633 SpdxLicenseId?: __string;
634 /**
635 * The URL to the public profile of a verified author. This URL is submitted by the author.
636 */
637 VerifiedAuthorUrl?: __string;
638 /**
639 * Version information about the application.
640 */
641 Version?: Version;
642 }
643 export interface GetCloudFormationTemplateRequest {
644 /**
645 * The Amazon Resource Name (ARN) of the application.
646 */
647 ApplicationId: __string;
648 /**
649 * 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}
650 */
651 TemplateId: __string;
652 }
653 export interface GetCloudFormationTemplateResponse {
654 /**
655 * The application Amazon Resource Name (ARN).
656 */
657 ApplicationId?: __string;
658 /**
659 * The date and time this resource was created.
660 */
661 CreationTime?: __string;
662 /**
663 * The date and time this template expires. Templates
664 expire 1 hour after creation.
665 */
666 ExpirationTime?: __string;
667 /**
668 * The semantic version of the application:
669 https://semver.org/
670
671 */
672 SemanticVersion?: __string;
673 /**
674 * Status of the template creation workflow.Possible values: PREPARING | ACTIVE | EXPIRED
675
676 */
677 Status?: Status;
678 /**
679 * 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}
680 */
681 TemplateId?: __string;
682 /**
683 * A link to the template that can be used to deploy the application using
684 AWS CloudFormation.
685 */
686 TemplateUrl?: __string;
687 }
688 export interface ListApplicationDependenciesRequest {
689 /**
690 * The Amazon Resource Name (ARN) of the application.
691 */
692 ApplicationId: __string;
693 /**
694 * The total number of items to return.
695 */
696 MaxItems?: MaxItems;
697 /**
698 * A token to specify where to start paginating.
699 */
700 NextToken?: __string;
701 /**
702 * The semantic version of the application to get.
703 */
704 SemanticVersion?: __string;
705 }
706 export interface ListApplicationDependenciesResponse {
707 /**
708 * An array of application summaries nested in the application.
709 */
710 Dependencies?: __listOfApplicationDependencySummary;
711 /**
712 * The token to request the next page of results.
713 */
714 NextToken?: __string;
715 }
716 export interface ListApplicationVersionsRequest {
717 /**
718 * The Amazon Resource Name (ARN) of the application.
719 */
720 ApplicationId: __string;
721 /**
722 * The total number of items to return.
723 */
724 MaxItems?: MaxItems;
725 /**
726 * A token to specify where to start paginating.
727 */
728 NextToken?: __string;
729 }
730 export interface ListApplicationVersionsResponse {
731 /**
732 * The token to request the next page of results.
733 */
734 NextToken?: __string;
735 /**
736 * An array of version summaries for the application.
737 */
738 Versions?: __listOfVersionSummary;
739 }
740 export interface ListApplicationsRequest {
741 /**
742 * The total number of items to return.
743 */
744 MaxItems?: MaxItems;
745 /**
746 * A token to specify where to start paginating.
747 */
748 NextToken?: __string;
749 }
750 export interface ListApplicationsResponse {
751 /**
752 * An array of application summaries.
753 */
754 Applications?: __listOfApplicationSummary;
755 /**
756 * The token to request the next page of results.
757 */
758 NextToken?: __string;
759 }
760 export type MaxItems = number;
761 export interface ParameterDefinition {
762 /**
763 * A regular expression that represents the patterns to allow for String types.
764 */
765 AllowedPattern?: __string;
766 /**
767 * An array containing the list of values allowed for the parameter.
768 */
769 AllowedValues?: __listOf__string;
770 /**
771 * A string that explains a constraint when the constraint is violated. For example, without a constraint description,
772 a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user
773 specifies an invalid value:
774 Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
775 By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display
776 the following customized error message:
777 Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.
778
779 */
780 ConstraintDescription?: __string;
781 /**
782 * A value of the appropriate type for the template to use if no value is specified when a stack is created.
783 If you define constraints for the parameter, you must specify a value that adheres to those constraints.
784 */
785 DefaultValue?: __string;
786 /**
787 * A string of up to 4,000 characters that describes the parameter.
788 */
789 Description?: __string;
790 /**
791 * An integer value that determines the largest number of characters that you want to allow for String types.
792 */
793 MaxLength?: __integer;
794 /**
795 * A numeric value that determines the largest numeric value that you want to allow for Number types.
796 */
797 MaxValue?: __integer;
798 /**
799 * An integer value that determines the smallest number of characters that you want to allow for String types.
800 */
801 MinLength?: __integer;
802 /**
803 * A numeric value that determines the smallest numeric value that you want to allow for Number types.
804 */
805 MinValue?: __integer;
806 /**
807 * The name of the parameter.
808 */
809 Name: __string;
810 /**
811 * Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the
812 value to true, the parameter value is masked with asterisks (*****).
813 */
814 NoEcho?: __boolean;
815 /**
816 * A list of AWS SAM resources that use this parameter.
817 */
818 ReferencedByResources: __listOf__string;
819 /**
820 * The type of the parameter.Valid values: String | Number | List&lt;Number> | CommaDelimitedList
821
822 String: A literal string.For example, users can specify "MyUserName".
823 Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the
824 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".
825 List&lt;Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when
826 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"].
827 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.
828 Also, each member string is space-trimmed.For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].
829 */
830 Type?: __string;
831 }
832 export interface ParameterValue {
833 /**
834 * The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation
835 uses the default value that is specified in your template.
836 */
837 Name: __string;
838 /**
839 * The input value associated with the parameter.
840 */
841 Value: __string;
842 }
843 export interface PutApplicationPolicyRequest {
844 /**
845 * The Amazon Resource Name (ARN) of the application.
846 */
847 ApplicationId: __string;
848 /**
849 * An array of policy statements applied to the application.
850 */
851 Statements: __listOfApplicationPolicyStatement;
852 }
853 export interface PutApplicationPolicyResponse {
854 /**
855 * An array of policy statements applied to the application.
856 */
857 Statements?: __listOfApplicationPolicyStatement;
858 }
859 export interface RollbackConfiguration {
860 /**
861 * This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration
862 Data Type.
863 */
864 MonitoringTimeInMinutes?: __integer;
865 /**
866 * This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration
867 Data Type.
868 */
869 RollbackTriggers?: __listOfRollbackTrigger;
870 }
871 export interface RollbackTrigger {
872 /**
873 * This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger
874 Data Type.
875 */
876 Arn: __string;
877 /**
878 * This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger
879 Data Type.
880 */
881 Type: __string;
882 }
883 export type Status = "PREPARING"|"ACTIVE"|"EXPIRED"|string;
884 export interface Tag {
885 /**
886 * This property corresponds to the content of the same name for the AWS CloudFormation Tag
887 Data Type.
888 */
889 Key: __string;
890 /**
891 * This property corresponds to the content of the same name for the AWS CloudFormation
892 Tag
893
894 Data Type.
895 */
896 Value: __string;
897 }
898 export interface UnshareApplicationRequest {
899 /**
900 * The Amazon Resource Name (ARN) of the application.
901 */
902 ApplicationId: __string;
903 /**
904 * The AWS Organization ID to unshare the application from.
905 */
906 OrganizationId: __string;
907 }
908 export interface UpdateApplicationRequest {
909 /**
910 * The Amazon Resource Name (ARN) of the application.
911 */
912 ApplicationId: __string;
913 /**
914 * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
915 */
916 Author?: __string;
917 /**
918 * The description of the application.Minimum length=1. Maximum length=256
919 */
920 Description?: __string;
921 /**
922 * A URL with more information about the application, for example the location of your GitHub repository for the application.
923 */
924 HomePageUrl?: __string;
925 /**
926 * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
927 */
928 Labels?: __listOf__string;
929 /**
930 * A text readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB
931 */
932 ReadmeBody?: __string;
933 /**
934 * 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
935 */
936 ReadmeUrl?: __string;
937 }
938 export interface UpdateApplicationResponse {
939 /**
940 * The application Amazon Resource Name (ARN).
941 */
942 ApplicationId?: __string;
943 /**
944 * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
945 */
946 Author?: __string;
947 /**
948 * The date and time this resource was created.
949 */
950 CreationTime?: __string;
951 /**
952 * The description of the application.Minimum length=1. Maximum length=256
953 */
954 Description?: __string;
955 /**
956 * A URL with more information about the application, for example the location of your GitHub repository for the application.
957 */
958 HomePageUrl?: __string;
959 /**
960 * 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.
961 */
962 IsVerifiedAuthor?: __boolean;
963 /**
964 * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
965 */
966 Labels?: __listOf__string;
967 /**
968 * A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB
969 */
970 LicenseUrl?: __string;
971 /**
972 * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+";
973 */
974 Name?: __string;
975 /**
976 * 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
977 */
978 ReadmeUrl?: __string;
979 /**
980 * A valid identifier from https://spdx.org/licenses/.
981 */
982 SpdxLicenseId?: __string;
983 /**
984 * The URL to the public profile of a verified author. This URL is submitted by the author.
985 */
986 VerifiedAuthorUrl?: __string;
987 /**
988 * Version information about the application.
989 */
990 Version?: Version;
991 }
992 export interface Version {
993 /**
994 * The application Amazon Resource Name (ARN).
995 */
996 ApplicationId: __string;
997 /**
998 * The date and time this resource was created.
999 */
1000 CreationTime: __string;
1001 /**
1002 * An array of parameter types supported by the application.
1003 */
1004 ParameterDefinitions: __listOfParameterDefinition;
1005 /**
1006 * A list of values that you must specify before you can deploy certain applications.
1007 Some applications might include resources that can affect permissions in your AWS
1008 account, for example, by creating new AWS Identity and Access Management (IAM) users.
1009 For those applications, you must explicitly acknowledge their capabilities by
1010 specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,
1011 CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or
1012 CAPABILITY_NAMED_IAM:
1013 AWS::IAM::Group,
1014 AWS::IAM::InstanceProfile,
1015 AWS::IAM::Policy, and
1016 AWS::IAM::Role.
1017 If the application contains IAM resources, you can specify either CAPABILITY_IAM
1018 or CAPABILITY_NAMED_IAM. If the application contains IAM resources
1019 with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY:
1020 AWS::Lambda::Permission,
1021 AWS::IAM:Policy,
1022 AWS::ApplicationAutoScaling::ScalingPolicy,
1023 AWS::S3::BucketPolicy,
1024 AWS::SQS::QueuePolicy, and
1025 AWS::SNS::TopicPolicy.Applications that contain one or more nested applications require you to specify
1026 CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review
1027 all permissions associated with the application before deploying. If you don't specify
1028 this parameter for an application that requires capabilities, the call will fail.
1029 */
1030 RequiredCapabilities: __listOfCapability;
1031 /**
1032 * Whether all of the AWS resources contained in this application are supported in the region
1033 in which it is being retrieved.
1034 */
1035 ResourcesSupported: __boolean;
1036 /**
1037 * The semantic version of the application:
1038 https://semver.org/
1039
1040 */
1041 SemanticVersion: __string;
1042 /**
1043 * 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
1044 */
1045 SourceCodeArchiveUrl?: __string;
1046 /**
1047 * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
1048 */
1049 SourceCodeUrl?: __string;
1050 /**
1051 * A link to the packaged AWS SAM template of your application.
1052 */
1053 TemplateUrl: __string;
1054 }
1055 export interface VersionSummary {
1056 /**
1057 * The application Amazon Resource Name (ARN).
1058 */
1059 ApplicationId: __string;
1060 /**
1061 * The date and time this resource was created.
1062 */
1063 CreationTime: __string;
1064 /**
1065 * The semantic version of the application:
1066 https://semver.org/
1067
1068 */
1069 SemanticVersion: __string;
1070 /**
1071 * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
1072 */
1073 SourceCodeUrl?: __string;
1074 }
1075 export type __boolean = boolean;
1076 export type __integer = number;
1077 export type __listOfApplicationDependencySummary = ApplicationDependencySummary[];
1078 export type __listOfApplicationPolicyStatement = ApplicationPolicyStatement[];
1079 export type __listOfApplicationSummary = ApplicationSummary[];
1080 export type __listOfCapability = Capability[];
1081 export type __listOfParameterDefinition = ParameterDefinition[];
1082 export type __listOfParameterValue = ParameterValue[];
1083 export type __listOfRollbackTrigger = RollbackTrigger[];
1084 export type __listOfTag = Tag[];
1085 export type __listOfVersionSummary = VersionSummary[];
1086 export type __listOf__string = __string[];
1087 export type __string = string;
1088 /**
1089 * 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.
1090 */
1091 export type apiVersion = "2017-09-08"|"latest"|string;
1092 export interface ClientApiVersions {
1093 /**
1094 * 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.
1095 */
1096 apiVersion?: apiVersion;
1097 }
1098 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1099 /**
1100 * Contains interfaces for use with the ServerlessApplicationRepository client.
1101 */
1102 export import Types = ServerlessApplicationRepository;
1103}
1104export = ServerlessApplicationRepository;