com.amazonaws.services.serverlessapplicationrepository

Interface AWSServerlessApplicationRepository

All Known Subinterfaces:

AWSServerlessApplicationRepositoryAsync

All Known Implementing Classes:

AbstractAWSServerlessApplicationRepository, AbstractAWSServerlessApplicationRepositoryAsync, AWSServerlessApplicationRepositoryAsyncClient, AWSServerlessApplicationRepositoryClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSServerlessApplicationRepository

Interface for accessing AWSServerlessApplicationRepository.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSServerlessApplicationRepository instead.

The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find and deploy serverless applications in the AWS Cloud. For more information about serverless applications, see Serverless Computing and Applications on the AWS website.

The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of all levels can get started with serverless computing without needing to learn anything new. You can use category keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, configure any required fields, and deploy it with a few clicks.

You can also easily publish applications, sharing them publicly with the community at large, or privately within your team or across your organization. To publish a serverless application (or app), you can use the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template. For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs GitHub repository.

The AWS Serverless Application Repository Developer Guide contains more information about the two developer experiences available:

• Consuming Applications – Browse for applications and view information about them, including source code and readme files. Also install, configure, and deploy applications of your choosing.

  Publishing Applications – Configure and upload applications to make them available to other developers, and publish new versions of applications.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
CreateApplicationVersionResult	createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) Creates an application version.
CreateCloudFormationChangeSetResult	createCloudFormationChangeSet(CreateCloudFormationChangeSetRequest createCloudFormationChangeSetRequest) Creates an AWS CloudFormation change set for the given application.
CreateCloudFormationTemplateResult	createCloudFormationTemplate(CreateCloudFormationTemplateRequest createCloudFormationTemplateRequest) Creates an AWS CloudFormation template.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes the specified application.
GetApplicationResult	getApplication(GetApplicationRequest getApplicationRequest) Gets the specified application.
GetApplicationPolicyResult	getApplicationPolicy(GetApplicationPolicyRequest getApplicationPolicyRequest) Retrieves the policy for the application.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetCloudFormationTemplateResult	getCloudFormationTemplate(GetCloudFormationTemplateRequest getCloudFormationTemplateRequest) Gets the specified AWS CloudFormation template.
ListApplicationDependenciesResult	listApplicationDependencies(ListApplicationDependenciesRequest listApplicationDependenciesRequest) Retrieves the list of applications nested in the containing application.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Lists applications owned by the requester.
ListApplicationVersionsResult	listApplicationVersions(ListApplicationVersionsRequest listApplicationVersionsRequest) Lists versions for the specified application.
PutApplicationPolicyResult	putApplicationPolicy(PutApplicationPolicyRequest putApplicationPolicyRequest) Sets the permission policy for an application.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UnshareApplicationResult	unshareApplication(UnshareApplicationRequest unshareApplicationRequest) Unshares an application from an AWS Organization.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates the specified application.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createApplicationVersion

CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)

Creates an application version.

Parameters:

createApplicationVersionRequest -

Returns:

Result of the CreateApplicationVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createCloudFormationChangeSet

CreateCloudFormationChangeSetResult createCloudFormationChangeSet(CreateCloudFormationChangeSetRequest createCloudFormationChangeSetRequest)

Creates an AWS CloudFormation change set for the given application.

Parameters:

createCloudFormationChangeSetRequest -

Returns:

Result of the CreateCloudFormationChangeSet operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createCloudFormationTemplate

CreateCloudFormationTemplateResult createCloudFormationTemplate(CreateCloudFormationTemplateRequest createCloudFormationTemplateRequest)

Creates an AWS CloudFormation template.

Parameters:

createCloudFormationTemplateRequest -

Returns:

Result of the CreateCloudFormationTemplate operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteApplication

DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

Deletes the specified application.

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getApplication

GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)

Gets the specified application.

Parameters:

getApplicationRequest -

Returns:

Result of the GetApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getApplicationPolicy

GetApplicationPolicyResult getApplicationPolicy(GetApplicationPolicyRequest getApplicationPolicyRequest)

Retrieves the policy for the application.

Parameters:

getApplicationPolicyRequest -

Returns:

Result of the GetApplicationPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCloudFormationTemplate

GetCloudFormationTemplateResult getCloudFormationTemplate(GetCloudFormationTemplateRequest getCloudFormationTemplateRequest)

Gets the specified AWS CloudFormation template.

Parameters:

getCloudFormationTemplateRequest -

Returns:

Result of the GetCloudFormationTemplate operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApplicationDependencies

ListApplicationDependenciesResult listApplicationDependencies(ListApplicationDependenciesRequest listApplicationDependenciesRequest)

Retrieves the list of applications nested in the containing application.

Parameters:

listApplicationDependenciesRequest -

Returns:

Result of the ListApplicationDependencies operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApplicationVersions

ListApplicationVersionsResult listApplicationVersions(ListApplicationVersionsRequest listApplicationVersionsRequest)

Lists versions for the specified application.

Parameters:

listApplicationVersionsRequest -

Returns:

Result of the ListApplicationVersions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApplications

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

Lists applications owned by the requester.

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putApplicationPolicy

PutApplicationPolicyResult putApplicationPolicy(PutApplicationPolicyRequest putApplicationPolicyRequest)

Sets the permission policy for an application. For the list of actions supported for this operation, see Application Permissions .

Parameters:

putApplicationPolicyRequest -

Returns:

Result of the PutApplicationPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

unshareApplication

UnshareApplicationResult unshareApplication(UnshareApplicationRequest unshareApplicationRequest)

Unshares an application from an AWS Organization.

This operation can be called only from the organization's master account.

Parameters:

unshareApplicationRequest -

Returns:

Result of the UnshareApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateApplication

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

Updates the specified application.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.