List<E> actions
For the list of actions supported for this operation, see Application Permissions.
List<E> principalOrgIDs
An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.
List<E> principals
An array of AWS account IDs, or * to make the application public.
String statementId
A unique ID for the statement.
String applicationId
The application Amazon Resource Name (ARN).
String 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])?$";
String creationTime
The date and time this resource was created.
String description
The description of the application.
Minimum length=1. Maximum length=256
String homePageUrl
A URL with more information about the application, for example the location of your GitHub repository for the application.
List<E> 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+\\-_:\\/@]+$";
String name
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
String spdxLicenseId
A valid identifier from https://spdx.org/licenses/.
String errorCode
400
String errorCode
409
String 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])?$";
String description
The description of the application.
Minimum length=1. Maximum length=256
String homePageUrl
A URL with more information about the application, for example the location of your GitHub repository for the application.
List<E> 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+\\-_:\\/@]+$";
String licenseBody
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.
String licenseUrl
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.
String name
The name of the application that you want to publish.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
String readmeBody
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.
String readmeUrl
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.
String semanticVersion
The semantic version of the application:
String 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
String sourceCodeUrl
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
String spdxLicenseId
A valid identifier from https://spdx.org/licenses/.
String templateBody
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.
String templateUrl
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.
String applicationId
The application Amazon Resource Name (ARN).
String 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])?$";
String creationTime
The date and time this resource was created.
String description
The description of the application.
Minimum length=1. Maximum length=256
String homePageUrl
A URL with more information about the application, for example the location of your GitHub repository for the application.
Boolean isVerifiedAuthor
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.
List<E> 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+\\-_:\\/@]+$";
String licenseUrl
A link to a license file of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
String name
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
String readmeUrl
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
String spdxLicenseId
A valid identifier from https://spdx.org/licenses/.
String verifiedAuthorUrl
The URL to the public profile of a verified author. This URL is submitted by the author.
Version version
Version information about the application.
String applicationId
The Amazon Resource Name (ARN) of the application.
String semanticVersion
The semantic version of the new version.
String 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
String sourceCodeUrl
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
String templateBody
The raw packaged AWS SAM template of your application.
String templateUrl
A link to the packaged AWS SAM template of your application.
String applicationId
The application Amazon Resource Name (ARN).
String creationTime
The date and time this resource was created.
List<E> parameterDefinitions
An array of parameter types supported by the application.
List<E> 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.
Boolean resourcesSupported
Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.
String semanticVersion
The semantic version of the application:
String 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
String sourceCodeUrl
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
String templateUrl
A link to the packaged AWS SAM template of your application.
String applicationId
The Amazon Resource Name (ARN) of the application.
List<E> capabilities
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.
String changeSetName
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
String clientToken
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
String description
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
List<E> notificationArns
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
List<E> parameterOverrides
A list of parameter values for the parameters of the application.
List<E> resourceTypes
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
RollbackConfiguration rollbackConfiguration
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
String semanticVersion
The semantic version of the application:
String stackName
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
List<E> tags
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
String templateId
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}
String applicationId
The application Amazon Resource Name (ARN).
String changeSetId
The Amazon Resource Name (ARN) of the change set.
Length constraints: Minimum length of 1.
Pattern: ARN:[-a-zA-Z0-9:/]*
String semanticVersion
The semantic version of the application:
String stackId
The unique ID of the stack.
String applicationId
The application Amazon Resource Name (ARN).
String creationTime
The date and time this resource was created.
String expirationTime
The date and time this template expires. Templates expire 1 hour after creation.
String semanticVersion
The semantic version of the application:
String status
Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
String templateId
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}
String templateUrl
A link to the template that can be used to deploy the application using AWS CloudFormation.
String applicationId
The Amazon Resource Name (ARN) of the application.
String errorCode
403
String applicationId
The Amazon Resource Name (ARN) of the application.
String applicationId
The application Amazon Resource Name (ARN).
String 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])?$";
String creationTime
The date and time this resource was created.
String description
The description of the application.
Minimum length=1. Maximum length=256
String homePageUrl
A URL with more information about the application, for example the location of your GitHub repository for the application.
Boolean isVerifiedAuthor
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.
List<E> 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+\\-_:\\/@]+$";
String licenseUrl
A link to a license file of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
String name
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
String readmeUrl
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
String spdxLicenseId
A valid identifier from https://spdx.org/licenses/.
String verifiedAuthorUrl
The URL to the public profile of a verified author. This URL is submitted by the author.
Version version
Version information about the application.
String applicationId
The application Amazon Resource Name (ARN).
String creationTime
The date and time this resource was created.
String expirationTime
The date and time this template expires. Templates expire 1 hour after creation.
String semanticVersion
The semantic version of the application:
String status
Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
String templateId
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}
String templateUrl
A link to the template that can be used to deploy the application using AWS CloudFormation.
String errorCode
500
String applicationId
The Amazon Resource Name (ARN) of the application.
Integer maxItems
The total number of items to return.
String nextToken
A token to specify where to start paginating.
String semanticVersion
The semantic version of the application to get.
String errorCode
404
String allowedPattern
A regular expression that represents the patterns to allow for String types.
List<E> allowedValues
An array containing the list of values allowed for the parameter.
String 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.
String 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.
String description
A string of up to 4,000 characters that describes the parameter.
Integer maxLength
An integer value that determines the largest number of characters that you want to allow for String types.
Integer maxValue
A numeric value that determines the largest numeric value that you want to allow for Number types.
Integer minLength
An integer value that determines the smallest number of characters that you want to allow for String types.
Integer minValue
A numeric value that determines the smallest numeric value that you want to allow for Number types.
String name
The name of the parameter.
Boolean 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 (*****).
List<E> referencedByResources
A list of AWS SAM resources that use this parameter.
String 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"].
Integer monitoringTimeInMinutes
This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.
List<E> rollbackTriggers
This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.
String arn
This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.
String type
This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.
String errorCode
429
String applicationId
The Amazon Resource Name (ARN) of the application.
String 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])?$";
String description
The description of the application.
Minimum length=1. Maximum length=256
String homePageUrl
A URL with more information about the application, for example the location of your GitHub repository for the application.
List<E> 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+\\-_:\\/@]+$";
String readmeBody
A text readme file in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
String readmeUrl
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
String applicationId
The application Amazon Resource Name (ARN).
String 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])?$";
String creationTime
The date and time this resource was created.
String description
The description of the application.
Minimum length=1. Maximum length=256
String homePageUrl
A URL with more information about the application, for example the location of your GitHub repository for the application.
Boolean isVerifiedAuthor
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.
List<E> 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+\\-_:\\/@]+$";
String licenseUrl
A link to a license file of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
String name
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
String readmeUrl
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
String spdxLicenseId
A valid identifier from https://spdx.org/licenses/.
String verifiedAuthorUrl
The URL to the public profile of a verified author. This URL is submitted by the author.
Version version
Version information about the application.
String applicationId
The application Amazon Resource Name (ARN).
String creationTime
The date and time this resource was created.
List<E> parameterDefinitions
An array of parameter types supported by the application.
List<E> 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.
Boolean resourcesSupported
Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.
String semanticVersion
The semantic version of the application:
String 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
String sourceCodeUrl
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
String templateUrl
A link to the packaged AWS SAM template of your application.
String applicationId
The application Amazon Resource Name (ARN).
String creationTime
The date and time this resource was created.
String semanticVersion
The semantic version of the application:
String sourceCodeUrl
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
Copyright © 2024. All rights reserved.