URI HTTP methods Schemas Properties See also

Applications

URI

/applications

HTTP methods

GET

Operation ID: ListApplications

Lists applications owned by the requester.

Query parameters
Name	Type	Required	Description
`maxItems`	String	False	The total number of items to return.
`nextToken`	String	False	A token to specify where to start paginating.

Responses
Status code	Response model	Description
`200`	`ApplicationPage`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`403`	`ForbiddenException`	The client is not authenticated.
`404`	`NotFoundException`	The resource (for example, an access policy statement) specified in the request doesn't exist.
`500`	`InternalServerErrorException`	The AWS Serverless Application Repository service encountered an internal error.

POST

Operation ID: CreateApplication

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

Responses
Status code	Response model	Description
`201`	`Application`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`403`	`ForbiddenException`	The client is not authenticated.
`409`	`ConflictException`	The resource already exists.
`429`	`TooManyRequestsException`	The client is sending more than the allowed number of requests per unit of time.
`500`	`InternalServerErrorException`	The AWS Serverless Application Repository service encountered an internal error.

OPTIONS

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Request bodies


{
  "name": "string",
  "description": "string",
  "author": "string",
  "spdxLicenseId": "string",
  "licenseBody": "string",
  "licenseUrl": "string",
  "readmeBody": "string",
  "readmeUrl": "string",
  "labels": [
    "string"
  ],
  "homePageUrl": "string",
  "semanticVersion": "string",
  "templateBody": "string",
  "templateUrl": "string",
  "sourceCodeUrl": "string",
  "sourceCodeArchiveUrl": "string"
}

Response bodies


{
  "applications": [
    {
      "applicationId": "string",
      "name": "string",
      "description": "string",
      "author": "string",
      "spdxLicenseId": "string",
      "labels": [
        "string"
      ],
      "creationTime": "string",
      "homePageUrl": "string"
    }
  ],
  "nextToken": "string"
}


{
  "applicationId": "string",
  "name": "string",
  "description": "string",
  "author": "string",
  "isVerifiedAuthor": boolean,
  "verifiedAuthorUrl": "string",
  "spdxLicenseId": "string",
  "licenseUrl": "string",
  "readmeUrl": "string",
  "labels": [
    "string"
  ],
  "creationTime": "string",
  "homePageUrl": "string",
  "version": {
    "applicationId": "string",
    "semanticVersion": "string",
    "sourceCodeUrl": "string",
    "sourceCodeArchiveUrl": "string",
    "templateUrl": "string",
    "creationTime": "string",
    "parameterDefinitions": [
      {
        "name": "string",
        "defaultValue": "string",
        "description": "string",
        "type": "string",
        "noEcho": boolean,
        "allowedPattern": "string",
        "constraintDescription": "string",
        "minValue": integer,
        "maxValue": integer,
        "minLength": integer,
        "maxLength": integer,
        "allowedValues": [
          "string"
        ],
        "referencedByResources": [
          "string"
        ]
      }
    ],
    "requiredCapabilities": [
      enum
    ],
    "resourcesSupported": boolean
  }
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}

Properties

Application

Details about the application.

Property	Type	Required	Description
`applicationId`	string	True	The application Amazon Resource Name (ARN).
`author`	string	True	The name of the author publishing the app. Minimum length=1. Maximum length=127. Pattern "^[a-z0-9](([a-z0-9]\|-(?!-))*[a-z0-9])?$";
`creationTime`	string	False	The date and time this resource was created.
`description`	string	True	The description of the application. Minimum length=1. Maximum length=256
`homePageUrl`	string	False	A URL with more information about the application, for example the location of your GitHub repository for the application.
`isVerifiedAuthor`	boolean	False	Specifies whether the author of this application has been verified. This 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.
`labels`	Array of type string	False	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+\\-_:\\/@]+$";
`licenseUrl`	string	False	A link to a license file of the app that matches the spdxLicenseID value of your application. Maximum size 5 MB
`name`	string	True	The name of the application. Minimum length=1. Maximum length=140 Pattern: "[a-zA-Z0-9\\-]+";
`readmeUrl`	string	False	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
`spdxLicenseId`	string	False	A valid identifier from https://spdx.org/licenses/.
`verifiedAuthorUrl`	string	False	The URL to the public profile of a verified author. This URL is submitted by the author.
`version`	Version	False	Version information about the application.

ApplicationPage

A list of application details.

Property	Type	Required	Description
`applications`	Array of type ApplicationSummary	True	An array of application summaries.
`nextToken`	string	False	The token to request the next page of results.

ApplicationSummary

Summary of details about the application.

Property	Type	Required	Description
`applicationId`	string	True	The application Amazon Resource Name (ARN).
`author`	string	True	The name of the author publishing the app. Minimum length=1. Maximum length=127. Pattern "^[a-z0-9](([a-z0-9]\|-(?!-))*[a-z0-9])?$";
`creationTime`	string	False	The date and time this resource was created.
`description`	string	True	The description of the application. Minimum length=1. Maximum length=256
`homePageUrl`	string	False	A URL with more information about the application, for example the location of your GitHub repository for the application.
`labels`	Array of type string	False	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+\\-_:\\/@]+$";
`name`	string	True	The name of the application. Minimum length=1. Maximum length=140 Pattern: "[a-zA-Z0-9\\-]+";
`spdxLicenseId`	string	False	A valid identifier from https://spdx.org/licenses/.

BadRequestException

One of the parameters in the request is invalid.

Property	Type	Required	Description
`errorCode`	string	False	400
`message`	string	False	One of the parameters in the request is invalid.

Capability

Values that must be specified in order to deploy some applications.

CAPABILITY_IAM
CAPABILITY_NAMED_IAM
CAPABILITY_AUTO_EXPAND
CAPABILITY_RESOURCE_POLICY

ConflictException

The resource already exists.

Property	Type	Required	Description
`errorCode`	string	False	409
`message`	string	False	The resource already exists.

CreateApplicationInput

Create an application request.

Property	Type	Required	Description
`author`	string	True	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`	string	True	The description of the application. Minimum length=1. Maximum length=256
`homePageUrl`	string	False	A URL with more information about the application, for example the location of your GitHub repository for the application.
`labels`	Array of type string	False	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`	string	False	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`	string	False	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`	string	True	The name of the application that you want to publish. Minimum length=1. Maximum length=140 Pattern: "[a-zA-Z0-9\\-]+";
`readmeBody`	string	False	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`	string	False	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`	string	False	The semantic version of the application: https://semver.org/
`sourceCodeArchiveUrl`	string	False	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`	string	False	A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
`spdxLicenseId`	string	False	A valid identifier from https://spdx.org/licenses/.
`templateBody`	string	False	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`	string	False	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.

ForbiddenException

The client is not authenticated.

Property	Type	Required	Description