Class: AWS.ServerlessApplicationRepository

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.

      • Name — required — (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 (*****).

      • ReferencedByResources — required — (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.

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.

    • Name — required — (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.

    • Value — required — (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.

      • Arn — required — (String)

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

      • Type — required — (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.

    • Key — required — (String)

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

    • Value — required — (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.

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.

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.

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.

    • IsVerifiedAuthor — (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<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/.

    • VerifiedAuthorUrl — (String)

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

    • Version — (map)

      Version information about the application.

      • ApplicationId — required — (String)

        The application Amazon Resource Name (ARN).

      • CreationTime — required — (String)

        The date and time this resource was created.

      • ParameterDefinitions — required — (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.

        • Name — required — (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 (*****).

        • ReferencedByResources — required — (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 — required — (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 — required — (Boolean)

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

      • SemanticVersion — required — (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 — required — (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.

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.

      • Actions — required — (Array<String>)

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

      • PrincipalOrgIDs — (Array<String>)

        An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.

      • Principals — required — (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.

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.

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.

      • ApplicationId — required — (String)

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

      • SemanticVersion — required — (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.

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.

      • ApplicationId — required — (String)

        The application Amazon Resource Name (ARN).

      • Author — required — (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 — required — (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+\-_:\/@]+$";

      • Name — required — (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.

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.

      • ApplicationId — required — (String)

        The application Amazon Resource Name (ARN).

      • CreationTime — required — (String)

        The date and time this resource was created.

      • SemanticVersion — required — (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.

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Statements: [ /* required */
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principals: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      PrincipalOrgIDs: [
        '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.

    • Actions — required — (Array<String>)

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

    • PrincipalOrgIDs — (Array<String>)

      An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.

    • Principals — required — (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.

      • Actions — required — (Array<String>)

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

      • PrincipalOrgIDs — (Array<String>)

        An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.

      • Principals — required — (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.

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
serverlessapplicationrepository.unshareApplication(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.

  • OrganizationId — (String)

    The AWS Organization ID to unshare the application from.

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.

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.

    • IsVerifiedAuthor — (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<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/.

    • VerifiedAuthorUrl — (String)

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

    • Version — (map)

      Version information about the application.

      • ApplicationId — required — (String)

        The application Amazon Resource Name (ARN).

      • CreationTime — required — (String)

        The date and time this resource was created.

      • ParameterDefinitions — required — (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.

        • Name — required — (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 (*****).

        • ReferencedByResources — required — (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 — required — (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 — required — (Boolean)

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

      • SemanticVersion — required — (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 — required — (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.