applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	`applications`
Type	Resource
Id	`aws.serverlessrepo.applications`

Fields

The following fields are returned by SELECT queries:

get_application
list_applications

Name	Datatype	Description
`application_id`	`string`	The application Amazon Resource Name (ARN).
`author`	`string`	The name of the author publishing the app. Minimum length=1. Maximum length=127. Pattern "^[a-z0-9](([a-z0-9]\|-(?!-))*[a-z0-9])?$";
`creation_time`	`string`	The date and time this resource was created.
`description`	`string`	The description of the application. Minimum length=1. Maximum length=256
`home_page_url`	`string`	A URL with more information about the application, for example the location of your GitHub repository for the application.
`is_verified_author`	`boolean`	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.
`labels`	`array`	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+\-_:\/@]+$";
`license_url`	`string`	A link to a license file of the app that matches the spdxLicenseID value of your application. Maximum size 5 MB
`name`	`string`	The name of the application. Minimum length=1. Maximum length=140 Pattern: "[a-zA-Z0-9\-]+";
`readme_url`	`string`	A link to the readme file in Markdown language that contains a more detailed description of the application and how it works. Maximum size 5 MB
`spdx_license_id`	`string`	A valid identifier from https://spdx.org/licenses/.
`verified_author_url`	`string`	The URL to the public profile of a verified author. This URL is submitted by the author.
`version`	`object`	Version information about the application.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_application`	`select`	`application_id`, `region`	`semanticVersion`	Gets the specified application.
`list_applications`	`select`	`region`	`maxItems`, `nextToken`	Lists applications owned by the requester.
`create_cloud_formation_change_set`	`insert`	`application_id`, `region`, `StackName`		Creates an AWS CloudFormation change set for the given application.
`create_application`	`insert`	`region`		Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
`update_application`	`update`	`application_id`, `region`		Updates the specified application.
`delete_application`	`delete`	`application_id`, `region`		Deletes the specified application.
`unshare_application`	`exec`	`application_id`, `region`, `OrganizationId`		Unshares an application from an AWS Organization. This operation can be called only from the organization's master account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`application_id`	`string`	The Amazon Resource Name (ARN) of the application.
`region`	`string`	AWS region (default: us-east-1)
`maxItems`	`integer`	The total number of items to return.
`nextToken`	`string`	A token to specify where to start paginating.
`semanticVersion`	`string`	The semantic version of the application to get.

`SELECT` examples

get_application
list_applications

Gets the specified application.

SELECT
application_id,
author,
creation_time,
description,
home_page_url,
is_verified_author,
labels,
license_url,
name,
readme_url,
spdx_license_id,
verified_author_url,
version
FROM aws.serverlessrepo.applications
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND semanticVersion = '{{ semanticVersion }}'
;

Lists applications owned by the requester.

SELECT
application_id,
author,
creation_time,
description,
home_page_url,
labels,
name,
spdx_license_id
FROM aws.serverlessrepo.applications
WHERE region = '{{ region }}' -- required
AND maxItems = '{{ maxItems }}'
AND nextToken = '{{ nextToken }}'
;

`INSERT` examples

create_cloud_formation_change_set
create_application
Manifest

Creates an AWS CloudFormation change set for the given application.

INSERT INTO aws.serverlessrepo.applications (
Capabilities,
ChangeSetName,
ClientToken,
Description,
NotificationArns,
ParameterOverrides,
ResourceTypes,
RollbackConfiguration,
SemanticVersion,
StackName,
Tags,
TemplateId,
application_id,
region
)
SELECT 
'{{ Capabilities }}',
'{{ ChangeSetName }}',
'{{ ClientToken }}',
'{{ Description }}',
'{{ NotificationArns }}',
'{{ ParameterOverrides }}',
'{{ ResourceTypes }}',
'{{ RollbackConfiguration }}',
'{{ SemanticVersion }}',
'{{ StackName }}' /* required */,
'{{ Tags }}',
'{{ TemplateId }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
application_id,
change_set_id,
semantic_version,
stack_id
;

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

INSERT INTO aws.serverlessrepo.applications (
Author,
Description,
HomePageUrl,
Labels,
LicenseBody,
LicenseUrl,
Name,
ReadmeBody,
ReadmeUrl,
SemanticVersion,
SourceCodeArchiveUrl,
SourceCodeUrl,
SpdxLicenseId,
TemplateBody,
TemplateUrl,
region
)
SELECT 
'{{ Author }}',
'{{ Description }}',
'{{ HomePageUrl }}',
'{{ Labels }}',
'{{ LicenseBody }}',
'{{ LicenseUrl }}',
'{{ Name }}',
'{{ ReadmeBody }}',
'{{ ReadmeUrl }}',
'{{ SemanticVersion }}',
'{{ SourceCodeArchiveUrl }}',
'{{ SourceCodeUrl }}',
'{{ SpdxLicenseId }}',
'{{ TemplateBody }}',
'{{ TemplateUrl }}',
'{{ region }}'
RETURNING
application_id,
author,
creation_time,
description,
home_page_url,
is_verified_author,
labels,
license_url,
name,
readme_url,
spdx_license_id,
verified_author_url,
version
;

# Description fields are for documentation purposes
- name: applications
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the applications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: Capabilities
    value:
      - "{{ Capabilities }}"
  - name: ChangeSetName
    value: "{{ ChangeSetName }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Description
    value: "{{ Description }}"
  - name: NotificationArns
    value:
      - "{{ NotificationArns }}"
  - name: ParameterOverrides
    value:
      - Name: "{{ Name }}"
        Value: "{{ Value }}"
  - name: ResourceTypes
    value:
      - "{{ ResourceTypes }}"
  - name: RollbackConfiguration
    description: |
      This property corresponds to the AWS CloudFormation RollbackConfiguration Data Type.
    value:
      MonitoringTimeInMinutes: {{ MonitoringTimeInMinutes }}
      RollbackTriggers:
        - Arn: "{{ Arn }}"
          Type: "{{ Type }}"
  - name: SemanticVersion
    value: "{{ SemanticVersion }}"
  - name: StackName
    value: "{{ StackName }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: TemplateId
    value: "{{ TemplateId }}"
  - name: Author
    value: "{{ Author }}"
  - name: HomePageUrl
    value: "{{ HomePageUrl }}"
  - name: Labels
    value:
      - "{{ Labels }}"
  - name: LicenseBody
    value: "{{ LicenseBody }}"
  - name: LicenseUrl
    value: "{{ LicenseUrl }}"
  - name: Name
    value: "{{ Name }}"
  - name: ReadmeBody
    value: "{{ ReadmeBody }}"
  - name: ReadmeUrl
    value: "{{ ReadmeUrl }}"
  - name: SourceCodeArchiveUrl
    value: "{{ SourceCodeArchiveUrl }}"
  - name: SourceCodeUrl
    value: "{{ SourceCodeUrl }}"
  - name: SpdxLicenseId
    value: "{{ SpdxLicenseId }}"
  - name: TemplateBody
    value: "{{ TemplateBody }}"
  - name: TemplateUrl
    value: "{{ TemplateUrl }}"

`UPDATE` examples

update_application

Updates the specified application.

UPDATE aws.serverlessrepo.applications
SET 
Author = '{{ Author }}',
Description = '{{ Description }}',
HomePageUrl = '{{ HomePageUrl }}',
Labels = '{{ Labels }}',
ReadmeBody = '{{ ReadmeBody }}',
ReadmeUrl = '{{ ReadmeUrl }}'
WHERE 
application_id = '{{ application_id }}' --required
AND region = '{{ region }}' --required
RETURNING
application_id,
author,
creation_time,
description,
home_page_url,
is_verified_author,
labels,
license_url,
name,
readme_url,
spdx_license_id,
verified_author_url,
version;

`DELETE` examples

delete_application

Deletes the specified application.

DELETE FROM aws.serverlessrepo.applications
WHERE application_id = '{{ application_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

unshare_application

Unshares an application from an AWS Organization. This operation can be called only from the organization's master account.

EXEC aws.serverlessrepo.applications.unshare_application 
@application_id='{{ application_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"OrganizationId": "{{ OrganizationId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​