AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.ServerlessApplicationRepository

Inherits:
AWS.Service
  • Object
show all
Identifier:
serverlessapplicationrepository
API Version:
2017-09-08
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find and deploy serverless applications in the AWS Cloud. For more information about serverless applications, see Serverless Computing and Applications on the AWS website.

The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of all levels can get started with serverless computing without needing to learn anything new. You can use category keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, configure any required fields, and deploy it with a few clicks.

You can also easily publish applications, sharing them publicly with the community at large, or privately within your team or across your organization. To publish a serverless application (or app), you can use the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template. For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs GitHub repository.

The AWS Serverless Application Repository Developer Guide contains more information about the two developer experiences available:

  • Consuming Applications – Browse for applications and view information about them, including source code and readme files. Also install, configure, and deploy applications of your choosing.

    Publishing Applications – Configure and upload applications to make them available to other developers, and publish new versions of applications.

Sending a Request Using ServerlessApplicationRepository

var serverlessapplicationrepository = new AWS.ServerlessApplicationRepository();
serverlessapplicationrepository.createApplication(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ServerlessApplicationRepository object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var serverlessapplicationrepository = new AWS.ServerlessApplicationRepository({apiVersion: '2017-09-08'});

You can also set the API version globally in AWS.config.apiVersions using the serverlessapplicationrepository service identifier:

AWS.config.apiVersions = {
  serverlessapplicationrepository: '2017-09-08',
  // other service API versions
};

var serverlessapplicationrepository = new AWS.ServerlessApplicationRepository();

Version:

  • 2017-09-08

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ServerlessApplicationRepository(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ServerlessApplicationRepository object

var serverlessapplicationrepository = new AWS.ServerlessApplicationRepository({apiVersion: '2017-09-08'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ServerlessApplicationRepository.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ServerlessApplicationRepository.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ServerlessApplicationRepository.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createApplication(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  Author: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  HomePageUrl: 'STRING_VALUE',
  Labels: [
    'STRING_VALUE',
    /* more items */
  ],
  LicenseBody: 'STRING_VALUE',
  LicenseUrl: 'STRING_VALUE',
  ReadmeBody: 'STRING_VALUE',
  ReadmeUrl: 'STRING_VALUE',
  SemanticVersion: 'STRING_VALUE',
  SourceCodeArchiveUrl: 'STRING_VALUE',
  SourceCodeUrl: 'STRING_VALUE',
  SpdxLicenseId: 'STRING_VALUE',
  TemplateBody: 'STRING_VALUE',
  TemplateUrl: 'STRING_VALUE'
};
serverlessapplicationrepository.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Author — (String)

      The name of the author publishing the app.

      Minimum length=1. Maximum length=127.

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

    • Description — (String)

      The description of the application.

      Minimum length=1. Maximum length=256

    • HomePageUrl — (String)

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

    • Labels — (Array<String>)

      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)

      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)

      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)

      The name of the application that you want to publish.

      Minimum length=1. Maximum length=140

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

    • ReadmeBody — (String)

      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)

      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)

      The semantic version of the application:

      https://semver.org/

    • SourceCodeArchiveUrl — (String)

      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)

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

    • SpdxLicenseId — (String)

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

    • TemplateBody — (String)

      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)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (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])?$";

      • CreationTime — (String)

        The date and time this resource was created.

      • Description — (String)

        The description of the application.

        Minimum length=1. Maximum length=256

      • HomePageUrl — (String)

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

      • Labels — (Array<String>)

        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)

        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\-]+";

      • ReadmeUrl — (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

      • SpdxLicenseId — (String)

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

      • Version — (map)

        Version information about the application.

        • ApplicationIdrequired — (String)

          The application Amazon Resource Name (ARN).

        • CreationTimerequired — (String)

          The date and time this resource was created.

        • ParameterDefinitionsrequired — (Array<map>)

          An array of parameter types supported by the application.

          • AllowedPattern — (String)

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

          • AllowedValues — (Array<String>)

            An array containing the list of values allowed for the parameter.

          • ConstraintDescription — (String)

            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.

          • DefaultValue — (String)

            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.

          • Description — (String)

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

          • MaxLength — (Integer)

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

          • MaxValue — (Integer)

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

          • MinLength — (Integer)

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

          • MinValue — (Integer)

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

          • Namerequired — (String)

            The name of the parameter.

          • NoEcho — (Boolean)

            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 (*****).

          • ReferencedByResourcesrequired — (Array<String>)

            A list of AWS SAM resources that use this parameter.

          • Type — (String)

            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"].

        • RequiredCapabilitiesrequired — (Array<String>)

          A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

          The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

          The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

          The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

          Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

          If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

        • ResourcesSupportedrequired — (Boolean)

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

        • SemanticVersionrequired — (String)

          The semantic version of the application:

          https://semver.org/

        • SourceCodeArchiveUrl — (String)

          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)

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

        • TemplateUrlrequired — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createApplicationVersion(params = {}, callback) ⇒ AWS.Request

Creates an application version.

Service Reference:

Examples:

Calling the createApplicationVersion operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SemanticVersion: 'STRING_VALUE', /* required */
  SourceCodeArchiveUrl: 'STRING_VALUE',
  SourceCodeUrl: 'STRING_VALUE',
  TemplateBody: 'STRING_VALUE',
  TemplateUrl: 'STRING_VALUE'
};
serverlessapplicationrepository.createApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • SemanticVersion — (String)

      The semantic version of the new version.

    • SourceCodeArchiveUrl — (String)

      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)

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

    • TemplateBody — (String)

      The raw packaged AWS SAM template of your application.

    • TemplateUrl — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application Amazon Resource Name (ARN).

      • CreationTime — (String)

        The date and time this resource was created.

      • ParameterDefinitions — (Array<map>)

        An array of parameter types supported by the application.

        • AllowedPattern — (String)

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

        • AllowedValues — (Array<String>)

          An array containing the list of values allowed for the parameter.

        • ConstraintDescription — (String)

          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.

        • DefaultValue — (String)

          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.

        • Description — (String)

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

        • MaxLength — (Integer)

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

        • MaxValue — (Integer)

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

        • MinLength — (Integer)

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

        • MinValue — (Integer)

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

        • Namerequired — (String)

          The name of the parameter.

        • NoEcho — (Boolean)

          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 (*****).

        • ReferencedByResourcesrequired — (Array<String>)

          A list of AWS SAM resources that use this parameter.

        • Type — (String)

          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"].

      • RequiredCapabilities — (Array<String>)

        A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

        The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

        The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

        The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

        Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

        If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

      • ResourcesSupported — (Boolean)

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

      • SemanticVersion — (String)

        The semantic version of the application:

        https://semver.org/

      • SourceCodeArchiveUrl — (String)

        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)

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

      • TemplateUrl — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCloudFormationChangeSet(params = {}, callback) ⇒ AWS.Request

Creates an AWS CloudFormation change set for the given application.

Service Reference:

Examples:

Calling the createCloudFormationChangeSet operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  Capabilities: [
    'STRING_VALUE',
    /* more items */
  ],
  ChangeSetName: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  NotificationArns: [
    'STRING_VALUE',
    /* more items */
  ],
  ParameterOverrides: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  RollbackConfiguration: {
    MonitoringTimeInMinutes: 'NUMBER_VALUE',
    RollbackTriggers: [
      {
        Arn: 'STRING_VALUE', /* required */
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  SemanticVersion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TemplateId: 'STRING_VALUE'
};
serverlessapplicationrepository.createCloudFormationChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • Capabilities — (Array<String>)

      A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

      The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

      The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

      The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

      Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

      If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

    • ChangeSetName — (String)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

    • ClientToken — (String)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

    • Description — (String)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

    • NotificationArns — (Array<String>)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

    • ParameterOverrides — (Array<map>)

      A list of parameter values for the parameters of the application.

      • Namerequired — (String)

        The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

      • Valuerequired — (String)

        The input value associated with the parameter.

    • ResourceTypes — (Array<String>)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

    • RollbackConfiguration — (map)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

      • MonitoringTimeInMinutes — (Integer)

        This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.

      • RollbackTriggers — (Array<map>)

        This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.

        • Arnrequired — (String)

          This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.

        • Typerequired — (String)

          This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.

    • SemanticVersion — (String)

      The semantic version of the application:

      https://semver.org/

    • StackName — (String)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

    • Tags — (Array<map>)

      This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

      • Keyrequired — (String)

        This property corresponds to the content of the same name for the AWS CloudFormation Tag Data Type.

      • Valuerequired — (String)

        This property corresponds to the content of the same name for the AWS CloudFormation Tag Data Type.

    • TemplateId — (String)

      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}

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application Amazon Resource Name (ARN).

      • ChangeSetId — (String)

        The Amazon Resource Name (ARN) of the change set.

        Length constraints: Minimum length of 1.

        Pattern: ARN:[-a-zA-Z0-9:/]*

      • SemanticVersion — (String)

        The semantic version of the application:

        https://semver.org/

      • StackId — (String)

        The unique ID of the stack.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCloudFormationTemplate(params = {}, callback) ⇒ AWS.Request

Creates an AWS CloudFormation template.

Service Reference:

Examples:

Calling the createCloudFormationTemplate operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SemanticVersion: 'STRING_VALUE'
};
serverlessapplicationrepository.createCloudFormationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • SemanticVersion — (String)

      The semantic version of the application:

      https://semver.org/

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application Amazon Resource Name (ARN).

      • CreationTime — (String)

        The date and time this resource was created.

      • ExpirationTime — (String)

        The date and time this template expires. Templates expire 1 hour after creation.

      • SemanticVersion — (String)

        The semantic version of the application:

        https://semver.org/

      • Status — (String)

        Status of the template creation workflow.

        Possible values: PREPARING | ACTIVE | EXPIRED

        Possible values include:
        • "PREPARING"
        • "ACTIVE"
        • "EXPIRED"
      • TemplateId — (String)

        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}

      • TemplateUrl — (String)

        A link to the template that can be used to deploy the application using AWS CloudFormation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteApplication(params = {}, callback) ⇒ AWS.Request

Deletes the specified application.

Service Reference:

Examples:

Calling the deleteApplication operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
serverlessapplicationrepository.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getApplication(params = {}, callback) ⇒ AWS.Request

Gets the specified application.

Service Reference:

Examples:

Calling the getApplication operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SemanticVersion: 'STRING_VALUE'
};
serverlessapplicationrepository.getApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • SemanticVersion — (String)

      The semantic version of the application to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (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])?$";

      • CreationTime — (String)

        The date and time this resource was created.

      • Description — (String)

        The description of the application.

        Minimum length=1. Maximum length=256

      • HomePageUrl — (String)

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

      • Labels — (Array<String>)

        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)

        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\-]+";

      • ReadmeUrl — (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

      • SpdxLicenseId — (String)

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

      • Version — (map)

        Version information about the application.

        • ApplicationIdrequired — (String)

          The application Amazon Resource Name (ARN).

        • CreationTimerequired — (String)

          The date and time this resource was created.

        • ParameterDefinitionsrequired — (Array<map>)

          An array of parameter types supported by the application.

          • AllowedPattern — (String)

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

          • AllowedValues — (Array<String>)

            An array containing the list of values allowed for the parameter.

          • ConstraintDescription — (String)

            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.

          • DefaultValue — (String)

            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.

          • Description — (String)

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

          • MaxLength — (Integer)

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

          • MaxValue — (Integer)

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

          • MinLength — (Integer)

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

          • MinValue — (Integer)

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

          • Namerequired — (String)

            The name of the parameter.

          • NoEcho — (Boolean)

            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 (*****).

          • ReferencedByResourcesrequired — (Array<String>)

            A list of AWS SAM resources that use this parameter.

          • Type — (String)

            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"].

        • RequiredCapabilitiesrequired — (Array<String>)

          A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

          The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

          The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

          The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

          Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

          If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

        • ResourcesSupportedrequired — (Boolean)

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

        • SemanticVersionrequired — (String)

          The semantic version of the application:

          https://semver.org/

        • SourceCodeArchiveUrl — (String)

          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)

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

        • TemplateUrlrequired — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getApplicationPolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the policy for the application.

Service Reference:

Examples:

Calling the getApplicationPolicy operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
serverlessapplicationrepository.getApplicationPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Statements — (Array<map>)

        An array of policy statements applied to the application.

        • Actionsrequired — (Array<String>)

          For the list of actions supported for this operation, see Application Permissions.

        • Principalsrequired — (Array<String>)

          An array of AWS account IDs, or * to make the application public.

        • StatementId — (String)

          A unique ID for the statement.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCloudFormationTemplate(params = {}, callback) ⇒ AWS.Request

Gets the specified AWS CloudFormation template.

Service Reference:

Examples:

Calling the getCloudFormationTemplate operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE' /* required */
};
serverlessapplicationrepository.getCloudFormationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • TemplateId — (String)

      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}

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application Amazon Resource Name (ARN).

      • CreationTime — (String)

        The date and time this resource was created.

      • ExpirationTime — (String)

        The date and time this template expires. Templates expire 1 hour after creation.

      • SemanticVersion — (String)

        The semantic version of the application:

        https://semver.org/

      • Status — (String)

        Status of the template creation workflow.

        Possible values: PREPARING | ACTIVE | EXPIRED

        Possible values include:
        • "PREPARING"
        • "ACTIVE"
        • "EXPIRED"
      • TemplateId — (String)

        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}

      • TemplateUrl — (String)

        A link to the template that can be used to deploy the application using AWS CloudFormation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApplicationDependencies(params = {}, callback) ⇒ AWS.Request

Retrieves the list of applications nested in the containing application.

Service Reference:

Examples:

Calling the listApplicationDependencies operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SemanticVersion: 'STRING_VALUE'
};
serverlessapplicationrepository.listApplicationDependencies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Dependencies — (Array<map>)

        An array of application summaries nested in the application.

        • ApplicationIdrequired — (String)

          The Amazon Resource Name (ARN) of the nested application.

        • SemanticVersionrequired — (String)

          The semantic version of the nested application.

      • NextToken — (String)

        The token to request the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApplications(params = {}, callback) ⇒ AWS.Request

Lists applications owned by the requester.

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
serverlessapplicationrepository.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxItems — (Integer)

      The total number of items to return.

    • NextToken — (String)

      A token to specify where to start paginating.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Applications — (Array<map>)

        An array of application summaries.

        • ApplicationIdrequired — (String)

          The application Amazon Resource Name (ARN).

        • Authorrequired — (String)

          The name of the author publishing the app.

          Minimum length=1. Maximum length=127.

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

        • CreationTime — (String)

          The date and time this resource was created.

        • Descriptionrequired — (String)

          The description of the application.

          Minimum length=1. Maximum length=256

        • HomePageUrl — (String)

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

        • Labels — (Array<String>)

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

        • Namerequired — (String)

          The name of the application.

          Minimum length=1. Maximum length=140

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

        • SpdxLicenseId — (String)

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

      • NextToken — (String)

        The token to request the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApplicationVersions(params = {}, callback) ⇒ AWS.Request

Lists versions for the specified application.

Service Reference:

Examples:

Calling the listApplicationVersions operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
serverlessapplicationrepository.listApplicationVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • MaxItems — (Integer)

      The total number of items to return.

    • NextToken — (String)

      A token to specify where to start paginating.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The token to request the next page of results.

      • Versions — (Array<map>)

        An array of version summaries for the application.

        • ApplicationIdrequired — (String)

          The application Amazon Resource Name (ARN).

        • CreationTimerequired — (String)

          The date and time this resource was created.

        • SemanticVersionrequired — (String)

          The semantic version of the application:

          https://semver.org/

        • SourceCodeUrl — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putApplicationPolicy(params = {}, callback) ⇒ AWS.Request

Sets the permission policy for an application. For the list of actions supported for this operation, see Application Permissions .

Service Reference:

Examples:

Calling the putApplicationPolicy operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Statements: [ /* required */
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principals: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      StatementId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
serverlessapplicationrepository.putApplicationPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • Statements — (Array<map>)

      An array of policy statements applied to the application.

      • Actionsrequired — (Array<String>)

        For the list of actions supported for this operation, see Application Permissions.

      • Principalsrequired — (Array<String>)

        An array of AWS account IDs, or * to make the application public.

      • StatementId — (String)

        A unique ID for the statement.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Statements — (Array<map>)

        An array of policy statements applied to the application.

        • Actionsrequired — (Array<String>)

          For the list of actions supported for this operation, see Application Permissions.

        • Principalsrequired — (Array<String>)

          An array of AWS account IDs, or * to make the application public.

        • StatementId — (String)

          A unique ID for the statement.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateApplication(params = {}, callback) ⇒ AWS.Request

Updates the specified application.

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Author: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  HomePageUrl: 'STRING_VALUE',
  Labels: [
    'STRING_VALUE',
    /* more items */
  ],
  ReadmeBody: 'STRING_VALUE',
  ReadmeUrl: 'STRING_VALUE'
};
serverlessapplicationrepository.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The Amazon Resource Name (ARN) of the application.

    • Author — (String)

      The name of the author publishing the app.

      Minimum length=1. Maximum length=127.

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

    • Description — (String)

      The description of the application.

      Minimum length=1. Maximum length=256

    • HomePageUrl — (String)

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

    • Labels — (Array<String>)

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

    • ReadmeBody — (String)

      A text readme file in Markdown language that contains a more detailed description of the application and how it works.

      Maximum size 5 MB

    • ReadmeUrl — (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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (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])?$";

      • CreationTime — (String)

        The date and time this resource was created.

      • Description — (String)

        The description of the application.

        Minimum length=1. Maximum length=256

      • HomePageUrl — (String)

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

      • Labels — (Array<String>)

        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)

        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\-]+";

      • ReadmeUrl — (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

      • SpdxLicenseId — (String)

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

      • Version — (map)

        Version information about the application.

        • ApplicationIdrequired — (String)

          The application Amazon Resource Name (ARN).

        • CreationTimerequired — (String)

          The date and time this resource was created.

        • ParameterDefinitionsrequired — (Array<map>)

          An array of parameter types supported by the application.

          • AllowedPattern — (String)

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

          • AllowedValues — (Array<String>)

            An array containing the list of values allowed for the parameter.

          • ConstraintDescription — (String)

            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.

          • DefaultValue — (String)

            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.

          • Description — (String)

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

          • MaxLength — (Integer)

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

          • MaxValue — (Integer)

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

          • MinLength — (Integer)

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

          • MinValue — (Integer)

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

          • Namerequired — (String)

            The name of the parameter.

          • NoEcho — (Boolean)

            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 (*****).

          • ReferencedByResourcesrequired — (Array<String>)

            A list of AWS SAM resources that use this parameter.

          • Type — (String)

            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"].

        • RequiredCapabilitiesrequired — (Array<String>)

          A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

          The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

          The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

          The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

          Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

          If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

        • ResourcesSupportedrequired — (Boolean)

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

        • SemanticVersionrequired — (String)

          The semantic version of the application:

          https://semver.org/

        • SourceCodeArchiveUrl — (String)

          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)

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

        • TemplateUrlrequired — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.