com.amazonaws.services.serverlessapplicationrepository

Class AWSServerlessApplicationRepositoryClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.serverlessapplicationrepository.AWSServerlessApplicationRepositoryClient

All Implemented Interfaces:

AWSServerlessApplicationRepository

Direct Known Subclasses:

AWSServerlessApplicationRepositoryAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSServerlessApplicationRepositoryClient
extends AmazonWebServiceClient
implements AWSServerlessApplicationRepository

Client for accessing AWSServerlessApplicationRepository. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.serverlessapplicationrepository.AWSServerlessApplicationRepository

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSServerlessApplicationRepositoryClientBuilder	builder()
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
CreateApplicationVersionResult	createApplicationVersion(CreateApplicationVersionRequest request) Creates an application version.
CreateCloudFormationChangeSetResult	createCloudFormationChangeSet(CreateCloudFormationChangeSetRequest request) Creates an AWS CloudFormation change set for the given application.
CreateCloudFormationTemplateResult	createCloudFormationTemplate(CreateCloudFormationTemplateRequest request) Creates an AWS CloudFormation template.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes the specified application.
GetApplicationResult	getApplication(GetApplicationRequest request) Gets the specified application.
GetApplicationPolicyResult	getApplicationPolicy(GetApplicationPolicyRequest request) 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 request) Gets the specified AWS CloudFormation template.
ListApplicationDependenciesResult	listApplicationDependencies(ListApplicationDependenciesRequest request) Retrieves the list of applications nested in the containing application.
ListApplicationsResult	listApplications(ListApplicationsRequest request) Lists applications owned by the requester.
ListApplicationVersionsResult	listApplicationVersions(ListApplicationVersionsRequest request) Lists versions for the specified application.
PutApplicationPolicyResult	putApplicationPolicy(PutApplicationPolicyRequest request) 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 request) Unshares an application from an AWS Organization.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates the specified application.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSServerlessApplicationRepositoryClientBuilder builder()

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

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

Specified by:

createApplication in interface AWSServerlessApplicationRepository

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

public CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest request)

Creates an application version.

Specified by:

createApplicationVersion in interface AWSServerlessApplicationRepository

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

public CreateCloudFormationChangeSetResult createCloudFormationChangeSet(CreateCloudFormationChangeSetRequest request)

Creates an AWS CloudFormation change set for the given application.

Specified by:

createCloudFormationChangeSet in interface AWSServerlessApplicationRepository

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

public CreateCloudFormationTemplateResult createCloudFormationTemplate(CreateCloudFormationTemplateRequest request)

Creates an AWS CloudFormation template.

Specified by:

createCloudFormationTemplate in interface AWSServerlessApplicationRepository

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

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

Deletes the specified application.

Specified by:

deleteApplication in interface AWSServerlessApplicationRepository

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

public GetApplicationResult getApplication(GetApplicationRequest request)

Gets the specified application.

Specified by:

getApplication in interface AWSServerlessApplicationRepository

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

public GetApplicationPolicyResult getApplicationPolicy(GetApplicationPolicyRequest request)

Retrieves the policy for the application.

Specified by:

getApplicationPolicy in interface AWSServerlessApplicationRepository

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

public GetCloudFormationTemplateResult getCloudFormationTemplate(GetCloudFormationTemplateRequest request)

Gets the specified AWS CloudFormation template.

Specified by:

getCloudFormationTemplate in interface AWSServerlessApplicationRepository

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

public ListApplicationDependenciesResult listApplicationDependencies(ListApplicationDependenciesRequest request)

Retrieves the list of applications nested in the containing application.

Specified by:

listApplicationDependencies in interface AWSServerlessApplicationRepository

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

public ListApplicationVersionsResult listApplicationVersions(ListApplicationVersionsRequest request)

Lists versions for the specified application.

Specified by:

listApplicationVersions in interface AWSServerlessApplicationRepository

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

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Lists applications owned by the requester.

Specified by:

listApplications in interface AWSServerlessApplicationRepository

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

public PutApplicationPolicyResult putApplicationPolicy(PutApplicationPolicyRequest request)

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

Specified by:

putApplicationPolicy in interface AWSServerlessApplicationRepository

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

public UnshareApplicationResult unshareApplication(UnshareApplicationRequest request)

Unshares an application from an AWS Organization.

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

Specified by:

unshareApplication in interface AWSServerlessApplicationRepository

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

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Updates the specified application.

Specified by:

updateApplication in interface AWSServerlessApplicationRepository

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSServerlessApplicationRepository

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AWSServerlessApplicationRepository

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.

Specified by:

shutdown in interface AWSServerlessApplicationRepository

Overrides:

shutdown in class AmazonWebServiceClient