AWSServerlessApplicationRepository 2017-09-08
- Client: Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
- Service ID: serverlessrepo
- Version: 2017-09-08
This page describes the parameters and results for the operations of the AWSServerlessApplicationRepository (2017-09-08), and shows how to use the Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient object to call the described operations. This documentation is specific to the 2017-09-08 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateApplication ( array $params = [] )
Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
- CreateApplicationVersion ( array $params = [] )
Creates an application version.
- CreateCloudFormationChangeSet ( array $params = [] )
Creates an AWS CloudFormation change set for the given application.
- CreateCloudFormationTemplate ( array $params = [] )
Creates an AWS CloudFormation template.
- DeleteApplication ( array $params = [] )
Deletes the specified application.
- GetApplication ( array $params = [] )
Gets the specified application.
- GetApplicationPolicy ( array $params = [] )
Retrieves the policy for the application.
- GetCloudFormationTemplate ( array $params = [] )
Gets the specified AWS CloudFormation template.
- ListApplicationDependencies ( array $params = [] )
Retrieves the list of applications nested in the containing application.
- ListApplicationVersions ( array $params = [] )
Lists versions for the specified application.
- ListApplications ( array $params = [] )
Lists applications owned by the requester.
- PutApplicationPolicy ( array $params = [] )
Sets the permission policy for an application.
- UnshareApplication ( array $params = [] )
Unshares an application from an AWS Organization.
- UpdateApplication ( array $params = [] )
Updates the specified application.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateApplication
$result = $client->createApplication([/* ... */]); $promise = $client->createApplicationAsync([/* ... */]);
Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
Parameter Syntax
$result = $client->createApplication([
'Author' => '<string>', // REQUIRED
'Description' => '<string>', // REQUIRED
'HomePageUrl' => '<string>',
'Labels' => ['<string>', ...],
'LicenseBody' => '<string>',
'LicenseUrl' => '<string>',
'Name' => '<string>', // REQUIRED
'ReadmeBody' => '<string>',
'ReadmeUrl' => '<string>',
'SemanticVersion' => '<string>',
'SourceCodeArchiveUrl' => '<string>',
'SourceCodeUrl' => '<string>',
'SpdxLicenseId' => '<string>',
'TemplateBody' => '<string>',
'TemplateUrl' => '<string>',
]);
Parameter Details
Members
- Author
-
- Required: Yes
- Type: string
- Description
-
- Required: Yes
- Type: string
- HomePageUrl
-
- Type: string
- Labels
-
- Type: Array of strings
- LicenseBody
-
- Type: string
- LicenseUrl
-
- Type: string
- Name
-
- Required: Yes
- Type: string
- ReadmeBody
-
- Type: string
- ReadmeUrl
-
- Type: string
- SemanticVersion
-
- Type: string
- SourceCodeArchiveUrl
-
- Type: string
- SourceCodeUrl
-
- Type: string
- SpdxLicenseId
-
- Type: string
- TemplateBody
-
- Type: string
- TemplateUrl
-
- Type: string
Result Syntax
[
'ApplicationId' => '<string>',
'Author' => '<string>',
'CreationTime' => '<string>',
'Description' => '<string>',
'HomePageUrl' => '<string>',
'IsVerifiedAuthor' => true || false,
'Labels' => ['<string>', ...],
'LicenseUrl' => '<string>',
'Name' => '<string>',
'ReadmeUrl' => '<string>',
'SpdxLicenseId' => '<string>',
'VerifiedAuthorUrl' => '<string>',
'Version' => [
'ApplicationId' => '<string>',
'CreationTime' => '<string>',
'ParameterDefinitions' => [
[
'AllowedPattern' => '<string>',
'AllowedValues' => ['<string>', ...],
'ConstraintDescription' => '<string>',
'DefaultValue' => '<string>',
'Description' => '<string>',
'MaxLength' => <integer>,
'MaxValue' => <integer>,
'MinLength' => <integer>,
'MinValue' => <integer>,
'Name' => '<string>',
'NoEcho' => true || false,
'ReferencedByResources' => ['<string>', ...],
'Type' => '<string>',
],
// ...
],
'RequiredCapabilities' => ['<string>', ...],
'ResourcesSupported' => true || false,
'SemanticVersion' => '<string>',
'SourceCodeArchiveUrl' => '<string>',
'SourceCodeUrl' => '<string>',
'TemplateUrl' => '<string>',
],
]
Result Details
Members
- ApplicationId
-
- Type: string
- Author
-
- Type: string
- CreationTime
-
- Type: string
- Description
-
- Type: string
- HomePageUrl
-
- Type: string
- IsVerifiedAuthor
-
- Type: boolean
- Labels
-
- Type: Array of strings
- LicenseUrl
-
- Type: string
- Name
-
- Type: string
- ReadmeUrl
-
- Type: string
- SpdxLicenseId
-
- Type: string
- VerifiedAuthorUrl
-
- Type: string
- Version
-
- Type: Version structure
Application version details.
Errors
-
The client is sending more than the allowed number of requests per unit of time.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The resource already exists.
-
The client is not authenticated.
CreateApplicationVersion
$result = $client->createApplicationVersion([/* ... */]); $promise = $client->createApplicationVersionAsync([/* ... */]);
Creates an application version.
Parameter Syntax
$result = $client->createApplicationVersion([
'ApplicationId' => '<string>', // REQUIRED
'SemanticVersion' => '<string>', // REQUIRED
'SourceCodeArchiveUrl' => '<string>',
'SourceCodeUrl' => '<string>',
'TemplateBody' => '<string>',
'TemplateUrl' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ApplicationId' => '<string>',
'CreationTime' => '<string>',
'ParameterDefinitions' => [
[
'AllowedPattern' => '<string>',
'AllowedValues' => ['<string>', ...],
'ConstraintDescription' => '<string>',
'DefaultValue' => '<string>',
'Description' => '<string>',
'MaxLength' => <integer>,
'MaxValue' => <integer>,
'MinLength' => <integer>,
'MinValue' => <integer>,
'Name' => '<string>',
'NoEcho' => true || false,
'ReferencedByResources' => ['<string>', ...],
'Type' => '<string>',
],
// ...
],
'RequiredCapabilities' => ['<string>', ...],
'ResourcesSupported' => true || false,
'SemanticVersion' => '<string>',
'SourceCodeArchiveUrl' => '<string>',
'SourceCodeUrl' => '<string>',
'TemplateUrl' => '<string>',
]
Result Details
Members
- ApplicationId
-
- Type: string
- CreationTime
-
- Type: string
- ParameterDefinitions
-
- Type: Array of ParameterDefinition structures
- RequiredCapabilities
-
- Type: Array of strings
- ResourcesSupported
-
- Type: boolean
- SemanticVersion
-
- Type: string
- SourceCodeArchiveUrl
-
- Type: string
- SourceCodeUrl
-
- Type: string
- TemplateUrl
-
- Type: string
Errors
-
The client is sending more than the allowed number of requests per unit of time.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The resource already exists.
-
The client is not authenticated.
CreateCloudFormationChangeSet
$result = $client->createCloudFormationChangeSet([/* ... */]); $promise = $client->createCloudFormationChangeSetAsync([/* ... */]);
Creates an AWS CloudFormation change set for the given application.
Parameter Syntax
$result = $client->createCloudFormationChangeSet([
'ApplicationId' => '<string>', // REQUIRED
'Capabilities' => ['<string>', ...],
'ChangeSetName' => '<string>',
'ClientToken' => '<string>',
'Description' => '<string>',
'NotificationArns' => ['<string>', ...],
'ParameterOverrides' => [
[
'Name' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'ResourceTypes' => ['<string>', ...],
'RollbackConfiguration' => [
'MonitoringTimeInMinutes' => <integer>,
'RollbackTriggers' => [
[
'Arn' => '<string>', // REQUIRED
'Type' => '<string>', // REQUIRED
],
// ...
],
],
'SemanticVersion' => '<string>',
'StackName' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'TemplateId' => '<string>',
]);
Parameter Details
Members
- ApplicationId
-
- Required: Yes
- Type: string
- Capabilities
-
- Type: Array of strings
- ChangeSetName
-
- Type: string
- ClientToken
-
- Type: string
- Description
-
- Type: string
- NotificationArns
-
- Type: Array of strings
- ParameterOverrides
-
- Type: Array of ParameterValue structures
- ResourceTypes
-
- Type: Array of strings
- RollbackConfiguration
-
- Type: RollbackConfiguration structure
This property corresponds to the AWS CloudFormation RollbackConfiguration Data Type.
- SemanticVersion
-
- Type: string
- StackName
-
- Required: Yes
- Type: string
- Tags
-
- Type: Array of Tag structures
- TemplateId
-
- Type: string
Result Syntax
[
'ApplicationId' => '<string>',
'ChangeSetId' => '<string>',
'SemanticVersion' => '<string>',
'StackId' => '<string>',
]
Result Details
Members
Errors
-
The client is sending more than the allowed number of requests per unit of time.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
CreateCloudFormationTemplate
$result = $client->createCloudFormationTemplate([/* ... */]); $promise = $client->createCloudFormationTemplateAsync([/* ... */]);
Creates an AWS CloudFormation template.
Parameter Syntax
$result = $client->createCloudFormationTemplate([
'ApplicationId' => '<string>', // REQUIRED
'SemanticVersion' => '<string>',
]);
Parameter Details
Result Syntax
[
'ApplicationId' => '<string>',
'CreationTime' => '<string>',
'ExpirationTime' => '<string>',
'SemanticVersion' => '<string>',
'Status' => 'PREPARING|ACTIVE|EXPIRED',
'TemplateId' => '<string>',
'TemplateUrl' => '<string>',
]
Result Details
Members
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
DeleteApplication
$result = $client->deleteApplication([/* ... */]); $promise = $client->deleteApplicationAsync([/* ... */]);
Deletes the specified application.
Parameter Syntax
$result = $client->deleteApplication([
'ApplicationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
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 resource already exists.
GetApplication
$result = $client->getApplication([/* ... */]); $promise = $client->getApplicationAsync([/* ... */]);
Gets the specified application.
Parameter Syntax
$result = $client->getApplication([
'ApplicationId' => '<string>', // REQUIRED
'SemanticVersion' => '<string>',
]);
Parameter Details
Result Syntax
[
'ApplicationId' => '<string>',
'Author' => '<string>',
'CreationTime' => '<string>',
'Description' => '<string>',
'HomePageUrl' => '<string>',
'IsVerifiedAuthor' => true || false,
'Labels' => ['<string>', ...],
'LicenseUrl' => '<string>',
'Name' => '<string>',
'ReadmeUrl' => '<string>',
'SpdxLicenseId' => '<string>',
'VerifiedAuthorUrl' => '<string>',
'Version' => [
'ApplicationId' => '<string>',
'CreationTime' => '<string>',
'ParameterDefinitions' => [
[
'AllowedPattern' => '<string>',
'AllowedValues' => ['<string>', ...],
'ConstraintDescription' => '<string>',
'DefaultValue' => '<string>',
'Description' => '<string>',
'MaxLength' => <integer>,
'MaxValue' => <integer>,
'MinLength' => <integer>,
'MinValue' => <integer>,
'Name' => '<string>',
'NoEcho' => true || false,
'ReferencedByResources' => ['<string>', ...],
'Type' => '<string>',
],
// ...
],
'RequiredCapabilities' => ['<string>', ...],
'ResourcesSupported' => true || false,
'SemanticVersion' => '<string>',
'SourceCodeArchiveUrl' => '<string>',
'SourceCodeUrl' => '<string>',
'TemplateUrl' => '<string>',
],
]
Result Details
Members
- ApplicationId
-
- Type: string
- Author
-
- Type: string
- CreationTime
-
- Type: string
- Description
-
- Type: string
- HomePageUrl
-
- Type: string
- IsVerifiedAuthor
-
- Type: boolean
- Labels
-
- Type: Array of strings
- LicenseUrl
-
- Type: string
- Name
-
- Type: string
- ReadmeUrl
-
- Type: string
- SpdxLicenseId
-
- Type: string
- VerifiedAuthorUrl
-
- Type: string
- Version
-
- Type: Version structure
Application version details.
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
GetApplicationPolicy
$result = $client->getApplicationPolicy([/* ... */]); $promise = $client->getApplicationPolicyAsync([/* ... */]);
Retrieves the policy for the application.
Parameter Syntax
$result = $client->getApplicationPolicy([
'ApplicationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Statements' => [
[
'Actions' => ['<string>', ...],
'PrincipalOrgIDs' => ['<string>', ...],
'Principals' => ['<string>', ...],
'StatementId' => '<string>',
],
// ...
],
]
Result Details
Members
- Statements
-
- Type: Array of ApplicationPolicyStatement structures
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
GetCloudFormationTemplate
$result = $client->getCloudFormationTemplate([/* ... */]); $promise = $client->getCloudFormationTemplateAsync([/* ... */]);
Gets the specified AWS CloudFormation template.
Parameter Syntax
$result = $client->getCloudFormationTemplate([
'ApplicationId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ApplicationId' => '<string>',
'CreationTime' => '<string>',
'ExpirationTime' => '<string>',
'SemanticVersion' => '<string>',
'Status' => 'PREPARING|ACTIVE|EXPIRED',
'TemplateId' => '<string>',
'TemplateUrl' => '<string>',
]
Result Details
Members
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
ListApplicationDependencies
$result = $client->listApplicationDependencies([/* ... */]); $promise = $client->listApplicationDependenciesAsync([/* ... */]);
Retrieves the list of applications nested in the containing application.
Parameter Syntax
$result = $client->listApplicationDependencies([
'ApplicationId' => '<string>', // REQUIRED
'MaxItems' => <integer>,
'NextToken' => '<string>',
'SemanticVersion' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Dependencies' => [
[
'ApplicationId' => '<string>',
'SemanticVersion' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Dependencies
-
- Type: Array of ApplicationDependencySummary structures
- NextToken
-
- Type: string
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
ListApplicationVersions
$result = $client->listApplicationVersions([/* ... */]); $promise = $client->listApplicationVersionsAsync([/* ... */]);
Lists versions for the specified application.
Parameter Syntax
$result = $client->listApplicationVersions([
'ApplicationId' => '<string>', // REQUIRED
'MaxItems' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'NextToken' => '<string>',
'Versions' => [
[
'ApplicationId' => '<string>',
'CreationTime' => '<string>',
'SemanticVersion' => '<string>',
'SourceCodeUrl' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionSummary structures
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
ListApplications
$result = $client->listApplications([/* ... */]); $promise = $client->listApplicationsAsync([/* ... */]);
Lists applications owned by the requester.
Parameter Syntax
$result = $client->listApplications([
'MaxItems' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Applications' => [
[
'ApplicationId' => '<string>',
'Author' => '<string>',
'CreationTime' => '<string>',
'Description' => '<string>',
'HomePageUrl' => '<string>',
'Labels' => ['<string>', ...],
'Name' => '<string>',
'SpdxLicenseId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Applications
-
- Type: Array of ApplicationSummary structures
- NextToken
-
- Type: string
Errors
-
The resource (for example, an access policy statement) specified in the request doesn't exist.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
PutApplicationPolicy
$result = $client->putApplicationPolicy([/* ... */]); $promise = $client->putApplicationPolicyAsync([/* ... */]);
Sets the permission policy for an application. For the list of actions supported for this operation, see Application Permissions .
Parameter Syntax
$result = $client->putApplicationPolicy([
'ApplicationId' => '<string>', // REQUIRED
'Statements' => [ // REQUIRED
[
'Actions' => ['<string>', ...], // REQUIRED
'PrincipalOrgIDs' => ['<string>', ...],
'Principals' => ['<string>', ...], // REQUIRED
'StatementId' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- ApplicationId
-
- Required: Yes
- Type: string
- Statements
-
- Required: Yes
- Type: Array of ApplicationPolicyStatement structures
Result Syntax
[
'Statements' => [
[
'Actions' => ['<string>', ...],
'PrincipalOrgIDs' => ['<string>', ...],
'Principals' => ['<string>', ...],
'StatementId' => '<string>',
],
// ...
],
]
Result Details
Members
- Statements
-
- Type: Array of ApplicationPolicyStatement structures
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
UnshareApplication
$result = $client->unshareApplication([/* ... */]); $promise = $client->unshareApplicationAsync([/* ... */]);
Unshares an application from an AWS Organization.
This operation can be called only from the organization's master account.
Parameter Syntax
$result = $client->unshareApplication([
'ApplicationId' => '<string>', // REQUIRED
'OrganizationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
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.
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
The client is not authenticated.
UpdateApplication
$result = $client->updateApplication([/* ... */]); $promise = $client->updateApplicationAsync([/* ... */]);
Updates the specified application.
Parameter Syntax
$result = $client->updateApplication([
'ApplicationId' => '<string>', // REQUIRED
'Author' => '<string>',
'Description' => '<string>',
'HomePageUrl' => '<string>',
'Labels' => ['<string>', ...],
'ReadmeBody' => '<string>',
'ReadmeUrl' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ApplicationId' => '<string>',
'Author' => '<string>',
'CreationTime' => '<string>',
'Description' => '<string>',
'HomePageUrl' => '<string>',
'IsVerifiedAuthor' => true || false,
'Labels' => ['<string>', ...],
'LicenseUrl' => '<string>',
'Name' => '<string>',
'ReadmeUrl' => '<string>',
'SpdxLicenseId' => '<string>',
'VerifiedAuthorUrl' => '<string>',
'Version' => [
'ApplicationId' => '<string>',
'CreationTime' => '<string>',
'ParameterDefinitions' => [
[
'AllowedPattern' => '<string>',
'AllowedValues' => ['<string>', ...],
'ConstraintDescription' => '<string>',
'DefaultValue' => '<string>',
'Description' => '<string>',
'MaxLength' => <integer>,
'MaxValue' => <integer>,
'MinLength' => <integer>,
'MinValue' => <integer>,
'Name' => '<string>',
'NoEcho' => true || false,
'ReferencedByResources' => ['<string>', ...],
'Type' => '<string>',
],
// ...
],
'RequiredCapabilities' => ['<string>', ...],
'ResourcesSupported' => true || false,
'SemanticVersion' => '<string>',
'SourceCodeArchiveUrl' => '<string>',
'SourceCodeUrl' => '<string>',
'TemplateUrl' => '<string>',
],
]
Result Details
Members
- ApplicationId
-
- Type: string
- Author
-
- Type: string
- CreationTime
-
- Type: string
- Description
-
- Type: string
- HomePageUrl
-
- Type: string
- IsVerifiedAuthor
-
- Type: boolean
- Labels
-
- Type: Array of strings
- LicenseUrl
-
- Type: string
- Name
-
- Type: string
- ReadmeUrl
-
- Type: string
- SpdxLicenseId
-
- Type: string
- VerifiedAuthorUrl
-
- Type: string
- Version
-
- Type: Version structure
Application version details.
Errors
-
One of the parameters in the request is invalid.
-
The AWS Serverless Application Repository service encountered an internal error.
-
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 resource already exists.
Shapes
Application
Description
Details about the application.
Members
- ApplicationId
-
- Required: Yes
- Type: string
The application Amazon Resource Name (ARN).
- Author
-
- Required: Yes
- Type: 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
-
- Type: string
The date and time this resource was created.
- Description
-
- Required: Yes
- Type: string
The description of the application.
Minimum length=1. Maximum length=256
- HomePageUrl
-
- Type: string
A URL with more information about the application, for example the location of your GitHub repository for the application.
- IsVerifiedAuthor
-
- Type: 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
-
- Type: Array of strings
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
-
- Type: string
A link to a license file of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
- Name
-
- Required: Yes
- Type: string
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
- ReadmeUrl
-
- Type: 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
-
- Type: string
A valid identifier from https://spdx.org/licenses/.
- VerifiedAuthorUrl
-
- Type: string
The URL to the public profile of a verified author. This URL is submitted by the author.
- Version
-
- Type: Version structure
Version information about the application.
ApplicationDependencyPage
Description
A list of application summaries nested in the application.
Members
- Dependencies
-
- Required: Yes
- Type: Array of ApplicationDependencySummary structures
An array of application summaries nested in the application.
- NextToken
-
- Type: string
The token to request the next page of results.
ApplicationDependencySummary
Description
A nested application summary.
Members
ApplicationPage
Description
A list of application details.
Members
- Applications
-
- Required: Yes
- Type: Array of ApplicationSummary structures
An array of application summaries.
- NextToken
-
- Type: string
The token to request the next page of results.
ApplicationPolicy
Description
Policy statements applied to the application.
Members
- Statements
-
- Required: Yes
- Type: Array of ApplicationPolicyStatement structures
An array of policy statements applied to the application.
ApplicationPolicyStatement
Description
Policy statement applied to the application.
Members
- Actions
-
- Required: Yes
- Type: Array of strings
For the list of actions supported for this operation, see Application Permissions.
- PrincipalOrgIDs
-
- Type: Array of strings
An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.
- Principals
-
- Required: Yes
- Type: Array of strings
An array of AWS account IDs, or * to make the application public.
- StatementId
-
- Type: string
A unique ID for the statement.
ApplicationSummary
Description
Summary of details about the application.
Members
- ApplicationId
-
- Required: Yes
- Type: string
The application Amazon Resource Name (ARN).
- Author
-
- Required: Yes
- Type: 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
-
- Type: string
The date and time this resource was created.
- Description
-
- Required: Yes
- Type: string
The description of the application.
Minimum length=1. Maximum length=256
- HomePageUrl
-
- Type: string
A URL with more information about the application, for example the location of your GitHub repository for the application.
- Labels
-
- Type: Array of strings
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: Yes
- Type: string
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
- SpdxLicenseId
-
- Type: string
A valid identifier from https://spdx.org/licenses/.
ApplicationVersionPage
Description
A list of version summaries for the application.
Members
- NextToken
-
- Type: string
The token to request the next page of results.
- Versions
-
- Required: Yes
- Type: Array of VersionSummary structures
An array of version summaries for the application.
BadRequestException
Description
One of the parameters in the request is invalid.
Members
ChangeSetDetails
Description
Details of the change set.
Members
- ApplicationId
-
- Required: Yes
- Type: string
The application Amazon Resource Name (ARN).
- ChangeSetId
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the change set.
Length constraints: Minimum length of 1.
Pattern: ARN:[-a-zA-Z0-9:/]*
- SemanticVersion
-
- Required: Yes
- Type: string
The semantic version of the application:
- StackId
-
- Required: Yes
- Type: string
The unique ID of the stack.
ConflictException
Description
The resource already exists.
Members
CreateApplicationInput
Description
Create an application request.
Members
- Author
-
- Required: Yes
- Type: 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])?$";
- Description
-
- Required: Yes
- Type: string
The description of the application.
Minimum length=1. Maximum length=256
- HomePageUrl
-
- Type: string
A URL with more information about the application, for example the location of your GitHub repository for the application.
- Labels
-
- Type: Array of strings
Labels to improve discovery of apps in search results.
Minimum length=1. Maximum length=127. Maximum number of labels: 10
Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
- LicenseBody
-
- Type: string
A local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file has the format file://<path>/<filename>.
Maximum size 5 MB
You can specify only one of licenseBody and licenseUrl; otherwise, an error results.
- LicenseUrl
-
- Type: string
A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
You can specify only one of licenseBody and licenseUrl; otherwise, an error results.
- Name
-
- Required: Yes
- Type: string
The name of the application that you want to publish.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
- ReadmeBody
-
- Type: string
A local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file has the format file://<path>/<filename>.
Maximum size 5 MB
You can specify only one of readmeBody and readmeUrl; otherwise, an error results.
- ReadmeUrl
-
- Type: string
A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
You can specify only one of readmeBody and readmeUrl; otherwise, an error results.
- SemanticVersion
-
- Type: string
The semantic version of the application:
- SourceCodeArchiveUrl
-
- Type: 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
-
- Type: string
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
- SpdxLicenseId
-
- Type: string
A valid identifier from https://spdx.org/licenses/.
- TemplateBody
-
- Type: string
The local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.
You can specify only one of templateBody and templateUrl; otherwise an error results.
- TemplateUrl
-
- Type: string
A link to the S3 object containing the packaged AWS SAM template of your application.
You can specify only one of templateBody and templateUrl; otherwise an error results.
CreateApplicationVersionInput
Description
Create a version request.
Members
- SourceCodeArchiveUrl
-
- Type: 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
-
- Type: string
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
- TemplateBody
-
- Type: string
The raw packaged AWS SAM template of your application.
- TemplateUrl
-
- Type: string
A link to the packaged AWS SAM template of your application.
CreateCloudFormationChangeSetInput
Description
Create an application change set request.
Members
- Capabilities
-
- Type: Array of strings
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
-
- Type: string
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- ClientToken
-
- Type: string
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- Description
-
- Type: string
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- NotificationArns
-
- Type: Array of strings
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- ParameterOverrides
-
- Type: Array of ParameterValue structures
A list of parameter values for the parameters of the application.
- ResourceTypes
-
- Type: Array of strings
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- RollbackConfiguration
-
- Type: RollbackConfiguration structure
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- SemanticVersion
-
- Type: string
The semantic version of the application:
- StackName
-
- Required: Yes
- Type: string
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- Tags
-
- Type: Array of Tag structures
This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
- TemplateId
-
- Type: 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}
ForbiddenException
Description
The client is not authenticated.
Members
InternalServerErrorException
Description
The AWS Serverless Application Repository service encountered an internal error.
Members
NotFoundException
Description
The resource (for example, an access policy statement) specified in the request doesn't exist.
Members
ParameterDefinition
Description
Parameters supported by the application.
Members
- AllowedPattern
-
- Type: string
A regular expression that represents the patterns to allow for String types.
- AllowedValues
-
- Type: Array of strings
An array containing the list of values allowed for the parameter.
- ConstraintDescription
-
- Type: 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
-
- Type: 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
-
- Type: string
A string of up to 4,000 characters that describes the parameter.
- MaxLength
-
- Type: int
An integer value that determines the largest number of characters that you want to allow for String types.
- MaxValue
-
- Type: int
A numeric value that determines the largest numeric value that you want to allow for Number types.
- MinLength
-
- Type: int
An integer value that determines the smallest number of characters that you want to allow for String types.
- MinValue
-
- Type: int
A numeric value that determines the smallest numeric value that you want to allow for Number types.
- Name
-
- Required: Yes
- Type: string
The name of the parameter.
- NoEcho
-
- Type: 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: Yes
- Type: Array of strings
A list of AWS SAM resources that use this parameter.
- Type
-
- 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"].
ParameterValue
Description
Parameter value of the application.
Members
RollbackConfiguration
Description
This property corresponds to the AWS CloudFormation RollbackConfiguration Data Type.
Members
- MonitoringTimeInMinutes
-
- Type: int
This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.
- RollbackTriggers
-
- Type: Array of RollbackTrigger structures
This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.
RollbackTrigger
Description
This property corresponds to the AWS CloudFormation RollbackTrigger Data Type.
Members
- Arn
-
- Required: Yes
- Type: string
This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.
- Type
-
- Required: Yes
- Type: string
This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.
Tag
TemplateDetails
Description
Details of the template.
Members
- ApplicationId
-
- Required: Yes
- Type: string
The application Amazon Resource Name (ARN).
- CreationTime
-
- Required: Yes
- Type: string
The date and time this resource was created.
- ExpirationTime
-
- Required: Yes
- Type: string
The date and time this template expires. Templates expire 1 hour after creation.
- SemanticVersion
-
- Required: Yes
- Type: string
The semantic version of the application:
- Status
-
- Required: Yes
- Type: string
Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
- TemplateId
-
- Required: Yes
- Type: 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
-
- Required: Yes
- Type: string
A link to the template that can be used to deploy the application using AWS CloudFormation.
TooManyRequestsException
Description
The client is sending more than the allowed number of requests per unit of time.
Members
UnshareApplicationInput
Description
Unshare application request.
Members
UpdateApplicationInput
Description
Update the application request.
Members
- Author
-
- Type: 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])?$";
- Description
-
- Type: string
The description of the application.
Minimum length=1. Maximum length=256
- HomePageUrl
-
- Type: string
A URL with more information about the application, for example the location of your GitHub repository for the application.
- Labels
-
- Type: Array of strings
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
-
- Type: 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
-
- Type: 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
Version
Description
Application version details.
Members
- ApplicationId
-
- Required: Yes
- Type: string
The application Amazon Resource Name (ARN).
- CreationTime
-
- Required: Yes
- Type: string
The date and time this resource was created.
- ParameterDefinitions
-
- Required: Yes
- Type: Array of ParameterDefinition structures
An array of parameter types supported by the application.
- RequiredCapabilities
-
- Required: Yes
- Type: Array of strings
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: Yes
- Type: boolean
Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.
- SemanticVersion
-
- Required: Yes
- Type: string
The semantic version of the application:
- SourceCodeArchiveUrl
-
- Type: 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
-
- Type: 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: Yes
- Type: string
A link to the packaged AWS SAM template of your application.
VersionSummary
Description
An application version summary.
Members
- ApplicationId
-
- Required: Yes
- Type: string
The application Amazon Resource Name (ARN).
- CreationTime
-
- Required: Yes
- Type: string
The date and time this resource was created.
- SemanticVersion
-
- Required: Yes
- Type: string
The semantic version of the application:
- SourceCodeUrl
-
- Type: string
A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.