UNPKG

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