Skip to content

Create Application

serverlessapplicationrepository_create_application R Documentation

Creates an application, optionally including an AWS SAM file to create the first application version in the same call

Description

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

Usage

serverlessapplicationrepository_create_application(Author, Description,
  HomePageUrl, Labels, LicenseBody, LicenseUrl, Name, ReadmeBody,
  ReadmeUrl, SemanticVersion, SourceCodeArchiveUrl, SourceCodeUrl,
  SpdxLicenseId, TemplateBody, TemplateUrl)

Arguments

Author

[required] The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

Description

[required] The description of the application.

Minimum length=1. Maximum length=256

HomePageUrl

A URL with more information about the application, for example the location of your GitHub repository for the application.

Labels

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";

LicenseBody

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 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

LicenseUrl

A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

Name

[required] The name of the application that you want to publish.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\-]+";

ReadmeBody

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 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

ReadmeUrl

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 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

SemanticVersion

The semantic version of the application:

https://semver.org/

SourceCodeArchiveUrl

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

SourceCodeUrl

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

SpdxLicenseId

A valid identifier from https://spdx.org/licenses/.

TemplateBody

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.

TemplateUrl

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.

Value

A list with the following syntax: 

list(
  ApplicationId = "string",
  Author = "string",
  CreationTime = "string",
  Description = "string",
  HomePageUrl = "string",
  IsVerifiedAuthor = TRUE|FALSE,
  Labels = list(
    "string"
  ),
  LicenseUrl = "string",
  Name = "string",
  ReadmeUrl = "string",
  SpdxLicenseId = "string",
  VerifiedAuthorUrl = "string",
  Version = list(
    ApplicationId = "string",
    CreationTime = "string",
    ParameterDefinitions = list(
      list(
        AllowedPattern = "string",
        AllowedValues = list(
          "string"
        ),
        ConstraintDescription = "string",
        DefaultValue = "string",
        Description = "string",
        MaxLength = 123,
        MaxValue = 123,
        MinLength = 123,
        MinValue = 123,
        Name = "string",
        NoEcho = TRUE|FALSE,
        ReferencedByResources = list(
          "string"
        ),
        Type = "string"
      )
    ),
    RequiredCapabilities = list(
      "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|"CAPABILITY_RESOURCE_POLICY"
    ),
    ResourcesSupported = TRUE|FALSE,
    SemanticVersion = "string",
    SourceCodeArchiveUrl = "string",
    SourceCodeUrl = "string",
    TemplateUrl = "string"
  )
)

Request syntax

svc$create_application(
  Author = "string",
  Description = "string",
  HomePageUrl = "string",
  Labels = list(
    "string"
  ),
  LicenseBody = "string",
  LicenseUrl = "string",
  Name = "string",
  ReadmeBody = "string",
  ReadmeUrl = "string",
  SemanticVersion = "string",
  SourceCodeArchiveUrl = "string",
  SourceCodeUrl = "string",
  SpdxLicenseId = "string",
  TemplateBody = "string",
  TemplateUrl = "string"
)