Table of Contents
A low-level client representing AWSServerlessApplicationRepository:
import boto3
client = boto3.client('serverlessrepo')
These are the available methods:
Check if an operation can be paginated.
Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
See also: AWS API Documentation
Request Syntax
response = client.create_application(
Author='string',
Description='string',
HomePageUrl='string',
Labels=[
'string',
],
LicenseBody='string',
LicenseUrl='string',
Name='string',
ReadmeBody='string',
ReadmeUrl='string',
SemanticVersion='string',
SourceCodeUrl='string',
SpdxLicenseId='string',
TemplateBody='string',
TemplateUrl='string'
)
[REQUIRED]
The name of the author publishing the app.
Minimum length=1. Maximum length=127.
Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
[REQUIRED]
The description of the application.
Minimum length=1. Maximum length=256
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 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.
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.
[REQUIRED]
The name of the application that you want to publish.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\-]+";
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.
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.
The semantic version of the application:
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.
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.
dict
Response Syntax
{
'ApplicationId': 'string',
'Author': 'string',
'CreationTime': 'string',
'Description': 'string',
'HomePageUrl': 'string',
'Labels': [
'string',
],
'LicenseUrl': 'string',
'Name': 'string',
'ReadmeUrl': 'string',
'SpdxLicenseId': 'string',
'Version': {
'ApplicationId': 'string',
'CreationTime': 'string',
'ParameterDefinitions': [
{
'AllowedPattern': 'string',
'AllowedValues': [
'string',
],
'ConstraintDescription': 'string',
'DefaultValue': 'string',
'Description': 'string',
'MaxLength': 123,
'MaxValue': 123,
'MinLength': 123,
'MinValue': 123,
'Name': 'string',
'NoEcho': True|False,
'ReferencedByResources': [
'string',
],
'Type': 'string'
},
],
'RequiredCapabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND'|'CAPABILITY_RESOURCE_POLICY',
],
'ResourcesSupported': True|False,
'SemanticVersion': 'string',
'SourceCodeUrl': 'string',
'TemplateUrl': 'string'
}
}
Response Structure
(dict) --
Success
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]|-(?!-))*[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 (list) --
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 (dict) --
Version information about the application.
ApplicationId (string) --
The application Amazon Resource Name (ARN).
CreationTime (string) --
The date and time this resource was created.
ParameterDefinitions (list) --
An array of parameter types supported by the application.
(dict) --
Parameters supported by the application.
AllowedPattern (string) --
A regular expression that represents the patterns to allow for String types.
AllowedValues (list) --
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 (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 (list) --
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 (list) --
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, and CAPABILITY_RESOURCE_POLICY.
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::ApplicationAutoScaling::ScalingPolicy , AWS::S3::BucketPolicy , AWS::SQS::QueuePolicy , and AWS::SNS:TopicPolicy .
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.
Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY
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:
SourceCodeUrl (string) --
A link to a public repository for the source code of your application.
TemplateUrl (string) --
A link to the packaged AWS SAM template of your application.
Creates an application version.
See also: AWS API Documentation
Request Syntax
response = client.create_application_version(
ApplicationId='string',
SemanticVersion='string',
SourceCodeUrl='string',
TemplateBody='string',
TemplateUrl='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
[REQUIRED]
The semantic version of the new version.
dict
Response Syntax
{
'ApplicationId': 'string',
'CreationTime': 'string',
'ParameterDefinitions': [
{
'AllowedPattern': 'string',
'AllowedValues': [
'string',
],
'ConstraintDescription': 'string',
'DefaultValue': 'string',
'Description': 'string',
'MaxLength': 123,
'MaxValue': 123,
'MinLength': 123,
'MinValue': 123,
'Name': 'string',
'NoEcho': True|False,
'ReferencedByResources': [
'string',
],
'Type': 'string'
},
],
'RequiredCapabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND'|'CAPABILITY_RESOURCE_POLICY',
],
'ResourcesSupported': True|False,
'SemanticVersion': 'string',
'SourceCodeUrl': 'string',
'TemplateUrl': 'string'
}
Response Structure
(dict) --
Success
ApplicationId (string) --
The application Amazon Resource Name (ARN).
CreationTime (string) --
The date and time this resource was created.
ParameterDefinitions (list) --
An array of parameter types supported by the application.
(dict) --
Parameters supported by the application.
AllowedPattern (string) --
A regular expression that represents the patterns to allow for String types.
AllowedValues (list) --
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 (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 (list) --
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 (list) --
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, and CAPABILITY_RESOURCE_POLICY.
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::ApplicationAutoScaling::ScalingPolicy , AWS::S3::BucketPolicy , AWS::SQS::QueuePolicy , and AWS::SNS:TopicPolicy .
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.
Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY
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:
SourceCodeUrl (string) --
A link to a public repository for the source code of your application.
TemplateUrl (string) --
A link to the packaged AWS SAM template of your application.
Creates an AWS CloudFormation change set for the given application.
See also: AWS API Documentation
Request Syntax
response = client.create_cloud_formation_change_set(
ApplicationId='string',
Capabilities=[
'string',
],
ChangeSetName='string',
ClientToken='string',
Description='string',
NotificationArns=[
'string',
],
ParameterOverrides=[
{
'Name': 'string',
'Value': 'string'
},
],
ResourceTypes=[
'string',
],
RollbackConfiguration={
'MonitoringTimeInMinutes': 123,
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
]
},
SemanticVersion='string',
StackName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
TemplateId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
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, and CAPABILITY_RESOURCE_POLICY.
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::ApplicationAutoScaling::ScalingPolicy , AWS::S3::BucketPolicy , AWS::SQS::QueuePolicy , and AWS::SNS:TopicPolicy .
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.
Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY
This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.
A list of parameter values for the parameters of the application.
Parameter value of the application.
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.
This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.
This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.
This property corresponds to the content of the same name for the AWS CloudFormation `RollbackConfiguration <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration>`__ Data Type.
This property corresponds to the content of the same name for the AWS CloudFormation `RollbackConfiguration <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration>`__ Data Type.
This property corresponds to the AWS CloudFormation `RollbackTrigger <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger>`__ Data Type.
This property corresponds to the content of the same name for the AWS CloudFormation `RollbackTrigger <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger>`__ Data Type.
This property corresponds to the content of the same name for the AWS CloudFormation `RollbackTrigger <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger>`__ Data Type.
The semantic version of the application:
[REQUIRED]
This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.
This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.
This property corresponds to the AWS CloudFormation `Tag <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag>`__ Data Type.
This property corresponds to the content of the same name for the AWS CloudFormation `Tag <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag>`__ Data Type.
This property corresponds to the content of the same name for the AWS CloudFormation `Tag <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag>`__ Data Type.
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}
dict
Response Syntax
{
'ApplicationId': 'string',
'ChangeSetId': 'string',
'SemanticVersion': 'string',
'StackId': 'string'
}
Response Structure
(dict) --
Success
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:
StackId (string) --
The unique ID of the stack.
Creates an AWS CloudFormation template.
See also: AWS API Documentation
Request Syntax
response = client.create_cloud_formation_template(
ApplicationId='string',
SemanticVersion='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
The semantic version of the application:
dict
Response Syntax
{
'ApplicationId': 'string',
'CreationTime': 'string',
'ExpirationTime': 'string',
'SemanticVersion': 'string',
'Status': 'PREPARING'|'ACTIVE'|'EXPIRED',
'TemplateId': 'string',
'TemplateUrl': 'string'
}
Response Structure
(dict) --
Success
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:
Status (string) --
Status of the template creation workflow.
Possible values: 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.
Deletes the specified application.
See also: AWS API Documentation
Request Syntax
response = client.delete_application(
ApplicationId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets the specified application.
See also: AWS API Documentation
Request Syntax
response = client.get_application(
ApplicationId='string',
SemanticVersion='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
dict
Response Syntax
{
'ApplicationId': 'string',
'Author': 'string',
'CreationTime': 'string',
'Description': 'string',
'HomePageUrl': 'string',
'Labels': [
'string',
],
'LicenseUrl': 'string',
'Name': 'string',
'ReadmeUrl': 'string',
'SpdxLicenseId': 'string',
'Version': {
'ApplicationId': 'string',
'CreationTime': 'string',
'ParameterDefinitions': [
{
'AllowedPattern': 'string',
'AllowedValues': [
'string',
],
'ConstraintDescription': 'string',
'DefaultValue': 'string',
'Description': 'string',
'MaxLength': 123,
'MaxValue': 123,
'MinLength': 123,
'MinValue': 123,
'Name': 'string',
'NoEcho': True|False,
'ReferencedByResources': [
'string',
],
'Type': 'string'
},
],
'RequiredCapabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND'|'CAPABILITY_RESOURCE_POLICY',
],
'ResourcesSupported': True|False,
'SemanticVersion': 'string',
'SourceCodeUrl': 'string',
'TemplateUrl': 'string'
}
}
Response Structure
(dict) --
Success
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]|-(?!-))*[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 (list) --
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 (dict) --
Version information about the application.
ApplicationId (string) --
The application Amazon Resource Name (ARN).
CreationTime (string) --
The date and time this resource was created.
ParameterDefinitions (list) --
An array of parameter types supported by the application.
(dict) --
Parameters supported by the application.
AllowedPattern (string) --
A regular expression that represents the patterns to allow for String types.
AllowedValues (list) --
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 (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 (list) --
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 (list) --
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, and CAPABILITY_RESOURCE_POLICY.
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::ApplicationAutoScaling::ScalingPolicy , AWS::S3::BucketPolicy , AWS::SQS::QueuePolicy , and AWS::SNS:TopicPolicy .
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.
Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY
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:
SourceCodeUrl (string) --
A link to a public repository for the source code of your application.
TemplateUrl (string) --
A link to the packaged AWS SAM template of your application.
Retrieves the policy for the application.
See also: AWS API Documentation
Request Syntax
response = client.get_application_policy(
ApplicationId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
{
'Statements': [
{
'Actions': [
'string',
],
'Principals': [
'string',
],
'StatementId': 'string'
},
]
}
Response Structure
Success
An array of policy statements applied to the application.
Policy statement applied to the application.
For the list of actions supported for this operation, see Application Permissions .
An AWS account ID, or * to make the application public.
A unique ID for the statement.
Gets the specified AWS CloudFormation template.
See also: AWS API Documentation
Request Syntax
response = client.get_cloud_formation_template(
ApplicationId='string',
TemplateId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
[REQUIRED]
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}
dict
Response Syntax
{
'ApplicationId': 'string',
'CreationTime': 'string',
'ExpirationTime': 'string',
'SemanticVersion': 'string',
'Status': 'PREPARING'|'ACTIVE'|'EXPIRED',
'TemplateId': 'string',
'TemplateUrl': 'string'
}
Response Structure
(dict) --
Success
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:
Status (string) --
Status of the template creation workflow.
Possible values: 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.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists versions for the specified application.
See also: AWS API Documentation
Request Syntax
response = client.list_application_versions(
ApplicationId='string',
MaxItems=123,
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
dict
Response Syntax
{
'NextToken': 'string',
'Versions': [
{
'ApplicationId': 'string',
'CreationTime': 'string',
'SemanticVersion': 'string',
'SourceCodeUrl': 'string'
},
]
}
Response Structure
(dict) --
Success
NextToken (string) --
The token to request the next page of results.
Versions (list) --
An array of version summaries for the application.
(dict) --
An application version summary.
ApplicationId (string) --
The application Amazon Resource Name (ARN).
CreationTime (string) --
The date and time this resource was created.
SemanticVersion (string) --
The semantic version of the application:
SourceCodeUrl (string) --
A link to a public repository for the source code of your application.
Lists applications owned by the requester.
See also: AWS API Documentation
Request Syntax
response = client.list_applications(
MaxItems=123,
NextToken='string'
)
dict
Response Syntax
{
'Applications': [
{
'ApplicationId': 'string',
'Author': 'string',
'CreationTime': 'string',
'Description': 'string',
'HomePageUrl': 'string',
'Labels': [
'string',
],
'Name': 'string',
'SpdxLicenseId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Applications (list) --
An array of application summaries.
(dict) --
Summary of details about the application.
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]|-(?!-))*[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 (list) --
Labels to improve discovery of apps in search results.
Minimum length=1. Maximum length=127. Maximum number of labels: 10
Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";
Name (string) --
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\-]+";
SpdxLicenseId (string) --
A valid identifier from https://spdx.org/licenses/ .
NextToken (string) --
The token to request the next page of results.
Sets the permission policy for an application. For the list of actions supported for this operation, see Application Permissions .
See also: AWS API Documentation
Request Syntax
response = client.put_application_policy(
ApplicationId='string',
Statements=[
{
'Actions': [
'string',
],
'Principals': [
'string',
],
'StatementId': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
[REQUIRED]
An array of policy statements applied to the application.
Policy statement applied to the application.
For the list of actions supported for this operation, see Application Permissions .
An AWS account ID, or * to make the application public.
A unique ID for the statement.
dict
Response Syntax
{
'Statements': [
{
'Actions': [
'string',
],
'Principals': [
'string',
],
'StatementId': 'string'
},
]
}
Response Structure
(dict) --
Success
Statements (list) --
An array of policy statements applied to the application.
(dict) --
Policy statement applied to the application.
Actions (list) --
For the list of actions supported for this operation, see Application Permissions .
Principals (list) --
An AWS account ID, or * to make the application public.
StatementId (string) --
A unique ID for the statement.
Updates the specified application.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
ApplicationId='string',
Author='string',
Description='string',
HomePageUrl='string',
Labels=[
'string',
],
ReadmeBody='string',
ReadmeUrl='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application.
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 description of the application.
Minimum length=1. Maximum length=256
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 text readme file in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
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
dict
Response Syntax
{
'ApplicationId': 'string',
'Author': 'string',
'CreationTime': 'string',
'Description': 'string',
'HomePageUrl': 'string',
'Labels': [
'string',
],
'LicenseUrl': 'string',
'Name': 'string',
'ReadmeUrl': 'string',
'SpdxLicenseId': 'string',
'Version': {
'ApplicationId': 'string',
'CreationTime': 'string',
'ParameterDefinitions': [
{
'AllowedPattern': 'string',
'AllowedValues': [
'string',
],
'ConstraintDescription': 'string',
'DefaultValue': 'string',
'Description': 'string',
'MaxLength': 123,
'MaxValue': 123,
'MinLength': 123,
'MinValue': 123,
'Name': 'string',
'NoEcho': True|False,
'ReferencedByResources': [
'string',
],
'Type': 'string'
},
],
'RequiredCapabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND'|'CAPABILITY_RESOURCE_POLICY',
],
'ResourcesSupported': True|False,
'SemanticVersion': 'string',
'SourceCodeUrl': 'string',
'TemplateUrl': 'string'
}
}
Response Structure
(dict) --
Success
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]|-(?!-))*[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 (list) --
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 (dict) --
Version information about the application.
ApplicationId (string) --
The application Amazon Resource Name (ARN).
CreationTime (string) --
The date and time this resource was created.
ParameterDefinitions (list) --
An array of parameter types supported by the application.
(dict) --
Parameters supported by the application.
AllowedPattern (string) --
A regular expression that represents the patterns to allow for String types.
AllowedValues (list) --
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 (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 (list) --
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 (list) --
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, and CAPABILITY_RESOURCE_POLICY.
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::ApplicationAutoScaling::ScalingPolicy , AWS::S3::BucketPolicy , AWS::SQS::QueuePolicy , and AWS::SNS:TopicPolicy .
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.
Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY
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:
SourceCodeUrl (string) --
A link to a public repository for the source code of your application.
TemplateUrl (string) --
A link to the packaged AWS SAM template of your application.
The available paginators are: