API version 2017-09-08 of the Amazon ServerlessApplicationRepository SDK configuration.

The resource already exists.

The client is not authenticated.

The resource (for example, an access policy statement) specified in the request doesn't exist.

The client is sending more than the allowed number of requests per unit of time.

The AWS Serverless Application Repository service encountered an internal error.

One of the parameters in the request is invalid.

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

A nested application summary.

See: newApplicationDependencySummary smart constructor.

Create a value of ApplicationDependencySummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applicationId:ApplicationDependencySummary', applicationDependencySummary_applicationId - The Amazon Resource Name (ARN) of the nested application.

$sel:semanticVersion:ApplicationDependencySummary', applicationDependencySummary_semanticVersion - The semantic version of the nested application.

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

The semantic version of the nested application.

Policy statement applied to the application.

See: newApplicationPolicyStatement smart constructor.

Create a value of ApplicationPolicyStatement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:statementId:ApplicationPolicyStatement', applicationPolicyStatement_statementId - A unique ID for the statement.

$sel:principalOrgIDs:ApplicationPolicyStatement', applicationPolicyStatement_principalOrgIDs - An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.

$sel:principals:ApplicationPolicyStatement', applicationPolicyStatement_principals - An array of AWS account IDs, or * to make the application public.

$sel:actions:ApplicationPolicyStatement', applicationPolicyStatement_actions - For the list of actions supported for this operation, see Application Permissions.

A unique ID for the statement.

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

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

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

Summary of details about the application.

See: newApplicationSummary smart constructor.

Create a value of ApplicationSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:ApplicationSummary', applicationSummary_creationTime - The date and time this resource was created.

$sel:homePageUrl:ApplicationSummary', applicationSummary_homePageUrl - A URL with more information about the application, for example the location of your GitHub repository for the application.

$sel:labels:ApplicationSummary', applicationSummary_labels - Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

$sel:spdxLicenseId:ApplicationSummary', applicationSummary_spdxLicenseId - A valid identifier from https://spdx.org/licenses/.

$sel:description:ApplicationSummary', applicationSummary_description - The description of the application.

Minimum length=1. Maximum length=256

$sel:author:ApplicationSummary', applicationSummary_author - The name of the author publishing the app.

Minimum length=1. Maximum length=127.

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

$sel:applicationId:ApplicationSummary', applicationSummary_applicationId - The application Amazon Resource Name (ARN).

$sel:name:ApplicationSummary', applicationSummary_name - The name of the application.

Minimum length=1. Maximum length=140

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

The date and time this resource was created.

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

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

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

The description of the application.

Minimum length=1. Maximum length=256

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

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

The application Amazon Resource Name (ARN).

The name of the application.

Minimum length=1. Maximum length=140

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

Parameters supported by the application.

See: newParameterDefinition smart constructor.

Create a value of ParameterDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxValue:ParameterDefinition', parameterDefinition_maxValue - A numeric value that determines the largest numeric value that you want to allow for Number types.

$sel:maxLength:ParameterDefinition', parameterDefinition_maxLength - An integer value that determines the largest number of characters that you want to allow for String types.

$sel:constraintDescription:ParameterDefinition', parameterDefinition_constraintDescription - 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.

$sel:minLength:ParameterDefinition', parameterDefinition_minLength - An integer value that determines the smallest number of characters that you want to allow for String types.

$sel:defaultValue:ParameterDefinition', parameterDefinition_defaultValue - 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.

$sel:allowedPattern:ParameterDefinition', parameterDefinition_allowedPattern - A regular expression that represents the patterns to allow for String types.

$sel:noEcho:ParameterDefinition', parameterDefinition_noEcho - 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 (*****).

$sel:type':ParameterDefinition', parameterDefinition_type - The type of the parameter.

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

String: A literal string.

For example, users can specify "MyUserName".

Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

For example, users might specify "8888".

List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

For example, users might specify "80,20", and then Ref results in ["80","20"].

CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.

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

$sel:allowedValues:ParameterDefinition', parameterDefinition_allowedValues - An array containing the list of values allowed for the parameter.

$sel:description:ParameterDefinition', parameterDefinition_description - A string of up to 4,000 characters that describes the parameter.

$sel:minValue:ParameterDefinition', parameterDefinition_minValue - A numeric value that determines the smallest numeric value that you want to allow for Number types.

$sel:referencedByResources:ParameterDefinition', parameterDefinition_referencedByResources - A list of AWS SAM resources that use this parameter.

$sel:name:ParameterDefinition', parameterDefinition_name - The name of the parameter.

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

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

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.

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

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.

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

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

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

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

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

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

A list of AWS SAM resources that use this parameter.

The name of the parameter.

Parameter value of the application.

See: newParameterValue smart constructor.

Create a value of ParameterValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:ParameterValue', parameterValue_value - The input value associated with the parameter.

$sel:name:ParameterValue', parameterValue_name - 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.

The input value associated with the parameter.

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.

This property corresponds to the /AWS CloudFormation RollbackConfiguration/ Data Type.

See: newRollbackConfiguration smart constructor.

Create a value of RollbackConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rollbackTriggers:RollbackConfiguration', rollbackConfiguration_rollbackTriggers - This property corresponds to the content of the same name for the /AWS CloudFormation RollbackConfiguration/ Data Type.

$sel:monitoringTimeInMinutes:RollbackConfiguration', rollbackConfiguration_monitoringTimeInMinutes - This property corresponds to the content of the same name for the /AWS CloudFormation RollbackConfiguration/ Data Type.

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

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

This property corresponds to the /AWS CloudFormation RollbackTrigger/ Data Type.

See: newRollbackTrigger smart constructor.

Create a value of RollbackTrigger with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:type':RollbackTrigger', rollbackTrigger_type - This property corresponds to the content of the same name for the /AWS CloudFormation RollbackTrigger/ Data Type.

$sel:arn:RollbackTrigger', rollbackTrigger_arn - This property corresponds to the content of the same name for the /AWS CloudFormation RollbackTrigger/ Data Type.

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

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

This property corresponds to the /AWS CloudFormation Tag/ Data Type.

See: newTag smart constructor.

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:Tag', tag_value - This property corresponds to the content of the same name for the /AWS CloudFormation Tag/ Data Type.

$sel:key:Tag', tag_key - This property corresponds to the content of the same name for the /AWS CloudFormation Tag/ Data Type.

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

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

Application version details.

See: newVersion smart constructor.

Create a value of Version with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceCodeUrl:Version', version_sourceCodeUrl - A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

$sel:sourceCodeArchiveUrl:Version', version_sourceCodeArchiveUrl - 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

$sel:templateUrl:Version', version_templateUrl - A link to the packaged AWS SAM template of your application.

$sel:parameterDefinitions:Version', version_parameterDefinitions - An array of parameter types supported by the application.

$sel:resourcesSupported:Version', version_resourcesSupported - Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.

$sel:creationTime:Version', version_creationTime - The date and time this resource was created.

$sel:requiredCapabilities:Version', version_requiredCapabilities - 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.

$sel:applicationId:Version', version_applicationId - The application Amazon Resource Name (ARN).

$sel:semanticVersion:Version', version_semanticVersion - The semantic version of the application:

https://semver.org/

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

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

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

An array of parameter types supported by the application.

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

The date and time this resource was created.

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.

The application Amazon Resource Name (ARN).

The semantic version of the application:

https://semver.org/

An application version summary.

See: newVersionSummary smart constructor.

Create a value of VersionSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceCodeUrl:VersionSummary', versionSummary_sourceCodeUrl - A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

$sel:creationTime:VersionSummary', versionSummary_creationTime - The date and time this resource was created.

$sel:applicationId:VersionSummary', versionSummary_applicationId - The application Amazon Resource Name (ARN).

$sel:semanticVersion:VersionSummary', versionSummary_semanticVersion - The semantic version of the application:

https://semver.org/

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

The date and time this resource was created.

The application Amazon Resource Name (ARN).

The semantic version of the application:

https://semver.org/