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

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

Errors

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ConflictException:

The resource already exists.

ForbiddenException:

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

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

Errors

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ConflictException:

The resource already exists.

ForbiddenException:

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

Result Syntax

[
    'ApplicationId' => '<string>',
    'ChangeSetId' => '<string>',
    'SemanticVersion' => '<string>',
    'StackId' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

Errors

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

The client is not authenticated.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

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

Errors

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

Errors

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

Errors

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

Result Syntax

[
    'Dependencies' => [
        [
            'ApplicationId' => '<string>',
            'SemanticVersion' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

Errors

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

Errors

NotFoundException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

Result Syntax

[
    'Statements' => [
        [
            'Actions' => ['<string>', ...],
            'PrincipalOrgIDs' => ['<string>', ...],
            'Principals' => ['<string>', ...],
            'StatementId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

NotFoundException:

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

TooManyRequestsException:

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

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

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

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

Errors

BadRequestException:

One of the parameters in the request is invalid.

InternalServerErrorException:

The AWS Serverless Application Repository service encountered an internal error.

ForbiddenException:

The client is not authenticated.

NotFoundException:

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

TooManyRequestsException:

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

ConflictException:

The resource already exists.