Skip to content
AWS for Query.Farm

aws.serverlessrepo.get_application

Example SQL Queries

SELECT * FROM
aws.serverlessrepo.get_application
WHERE
"application_id" = 'VALUE';

Description

Gets the specified application.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The application Amazon Resource Name (ARN).

VARCHAR
semantic_version Input Column

The semantic version of the application to get.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
author

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

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

VARCHAR
creation_time

The date and time this resource was created.

VARCHAR
description

The description of the application.

Minimum length=1. Maximum length=256

VARCHAR
home_page_url

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

VARCHAR
is_verified_author

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.

BOOLEAN
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+\\-_:\\/@]+$";

VARCHAR[]
Show child fields
labels[]
license_url

A link to a license file of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

VARCHAR
name

The name of the application.

Minimum length=1. Maximum length=140

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

VARCHAR
readme_url

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

VARCHAR
spdx_license_id

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

VARCHAR
verified_author_url

The URL to the public profile of a verified author. This URL is submitted by the author.

VARCHAR
version

Version information about the application.

STRUCT(
    "application_id" VARCHAR,
    "creation_time" VARCHAR,
    "parameter_definitions" STRUCT(
        "allowed_pattern" VARCHAR,
        "allowed_values" VARCHAR[],
        "constraint_description" VARCHAR,
        "default_value" VARCHAR,
        "description" VARCHAR,
        "max_length" BIGINT,
        "max_value" BIGINT,
        "min_length" BIGINT,
        "min_value" BIGINT,
        "name" VARCHAR,
        "no_echo" BOOLEAN,
        "referenced_by_resources" VARCHAR[],
        "type" VARCHAR
    )[],
    "required_capabilities" VARCHAR[],
    "resources_supported" BOOLEAN,
    "semantic_version" VARCHAR,
    "source_code_archive_url" VARCHAR,
    "source_code_url" VARCHAR,
    "template_url" VARCHAR
)
Show child fields
version.application_id

The application Amazon Resource Name (ARN).

version.creation_time

The date and time this resource was created.

version.parameter_definitions[]
Show child fields
version.parameter_definitions[].allowed_pattern

A regular expression that represents the patterns to allow for String types.

version.parameter_definitions[].allowed_values[]
version.parameter_definitions[].constraint_description

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display the following customized error message:

Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.

version.parameter_definitions[].default_value

A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.

version.parameter_definitions[].description

A string of up to 4,000 characters that describes the parameter.

version.parameter_definitions[].max_length

An integer value that determines the largest number of characters that you want to allow for String types.

version.parameter_definitions[].max_value

A numeric value that determines the largest numeric value that you want to allow for Number types.

version.parameter_definitions[].min_length

An integer value that determines the smallest number of characters that you want to allow for String types.

version.parameter_definitions[].min_value

A numeric value that determines the smallest numeric value that you want to allow for Number types.

version.parameter_definitions[].name

The name of the parameter.

version.parameter_definitions[].no_echo

Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).

version.parameter_definitions[].referenced_by_resources[]
version.parameter_definitions[].type

The type of the parameter.

Valid values: String | Number | List<Number> | CommaDelimitedList

String: A literal string.

For example, users can specify "MyUserName".

Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the 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".

List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when 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"].

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. Also, each member string is space-trimmed.

For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

version.required_capabilities[]
version.resources_supported

Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.

version.semantic_version

The semantic version of the application:

https://semver.org/

version.source_code_archive_url

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

version.source_code_url

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

version.template_url

A link to the packaged AWS SAM template of your application.