com.amazonaws.services.mobile

Interface AWSMobile

All Known Subinterfaces:

AWSMobileAsync

All Known Implementing Classes:

AbstractAWSMobile, AbstractAWSMobileAsync, AWSMobileAsyncClient, AWSMobileClient

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

Interface for accessing AWS Mobile.

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

AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.

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
CreateProjectResult	createProject(CreateProjectRequest createProjectRequest) Creates an AWS Mobile Hub project.
DeleteProjectResult	deleteProject(DeleteProjectRequest deleteProjectRequest) Delets a project in AWS Mobile Hub.
DescribeBundleResult	describeBundle(DescribeBundleRequest describeBundleRequest) Get the bundle details for the requested bundle id.
DescribeProjectResult	describeProject(DescribeProjectRequest describeProjectRequest) Gets details about a project in AWS Mobile Hub.
ExportBundleResult	exportBundle(ExportBundleRequest exportBundleRequest) Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
ExportProjectResult	exportProject(ExportProjectRequest exportProjectRequest) Exports project configuration to a snapshot which can be downloaded and shared.
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.
ListBundlesResult	listBundles(ListBundlesRequest listBundlesRequest) List all available bundles.
ListProjectsResult	listProjects(ListProjectsRequest listProjectsRequest) Lists projects in AWS Mobile Hub.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateProjectResult	updateProject(UpdateProjectRequest updateProjectRequest) Update an existing project.

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

createProject

CreateProjectResult createProject(CreateProjectRequest createProjectRequest)

Creates an AWS Mobile Hub project.

Parameters:

createProjectRequest - Request structure used to request a project be created.

Returns:

Result of the CreateProject operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

NotFoundException - No entity can be found with the specified identifier.

LimitExceededException - There are too many AWS Mobile Hub projects in the account or the account has exceeded the maximum number of resources in some AWS service. You should create another sub-account using AWS Organizations or remove some resources and retry your request.

See Also:

AWS API Documentation

deleteProject

DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)

Delets a project in AWS Mobile Hub.

Parameters:

deleteProjectRequest - Request structure used to request a project be deleted.

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

NotFoundException - No entity can be found with the specified identifier.

See Also:

AWS API Documentation

describeBundle

DescribeBundleResult describeBundle(DescribeBundleRequest describeBundleRequest)

Get the bundle details for the requested bundle id.

Parameters:

describeBundleRequest - Request structure to request the details of a specific bundle.

Returns:

Result of the DescribeBundle operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

NotFoundException - No entity can be found with the specified identifier.

See Also:

AWS API Documentation

describeProject

DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest)

Gets details about a project in AWS Mobile Hub.

Parameters:

describeProjectRequest - Request structure used to request details about a project.

Returns:

Result of the DescribeProject operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

NotFoundException - No entity can be found with the specified identifier.

See Also:

AWS API Documentation

exportBundle

ExportBundleResult exportBundle(ExportBundleRequest exportBundleRequest)

Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.

Parameters:

exportBundleRequest - Request structure used to request generation of custom SDK and tool packages required to integrate mobile web or app clients with backed AWS resources.

Returns:

Result of the ExportBundle operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

NotFoundException - No entity can be found with the specified identifier.

See Also:

AWS API Documentation

exportProject

ExportProjectResult exportProject(ExportProjectRequest exportProjectRequest)

Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.

Parameters:

exportProjectRequest - Request structure used in requests to export project configuration details.

Returns:

Result of the ExportProject operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

NotFoundException - No entity can be found with the specified identifier.

See Also:

AWS API Documentation

listBundles

ListBundlesResult listBundles(ListBundlesRequest listBundlesRequest)

List all available bundles.

Parameters:

listBundlesRequest - Request structure to request all available bundles.

Returns:

Result of the ListBundles operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

See Also:

AWS API Documentation

listProjects

ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)

Lists projects in AWS Mobile Hub.

Parameters:

listProjectsRequest - Request structure used to request projects list in AWS Mobile Hub.

Returns:

Result of the ListProjects operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

See Also:

AWS API Documentation

updateProject

UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)

Update an existing project.

Parameters:

updateProjectRequest - Request structure used for requests to update project configuration.

Returns:

Result of the UpdateProject operation returned by the service.

Throws:

InternalFailureException - The service has encountered an unexpected error condition which prevents it from servicing the request.

ServiceUnavailableException - The service is temporarily unavailable. The request should be retried after some time delay.

UnauthorizedException - Credentials of the caller are insufficient to authorize the request.

TooManyRequestsException - Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

BadRequestException - The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

NotFoundException - No entity can be found with the specified identifier.

AccountActionRequiredException - Account Action is required in order to continue the request.

LimitExceededException - There are too many AWS Mobile Hub projects in the account or the account has exceeded the maximum number of resources in some AWS service. You should create another sub-account using AWS Organizations or remove some resources and retry your request.

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.