com.amazonaws.services.mobile

Class AWSMobileClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mobile.AWSMobileClient

All Implemented Interfaces:

AWSMobile

Direct Known Subclasses:

AWSMobileAsyncClient

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

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

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.mobile.AWSMobile

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMobileClientBuilder	builder()
CreateProjectResult	createProject(CreateProjectRequest request) Creates an AWS Mobile Hub project.
DeleteProjectResult	deleteProject(DeleteProjectRequest request) Delets a project in AWS Mobile Hub.
DescribeBundleResult	describeBundle(DescribeBundleRequest request) Get the bundle details for the requested bundle id.
DescribeProjectResult	describeProject(DescribeProjectRequest request) Gets details about a project in AWS Mobile Hub.
ExportBundleResult	exportBundle(ExportBundleRequest request) 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 request) 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 request) List all available bundles.
ListProjectsResult	listProjects(ListProjectsRequest request) Lists projects in AWS Mobile Hub.
UpdateProjectResult	updateProject(UpdateProjectRequest request) Update an existing project.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.mobile.AWSMobile

shutdown

Method Detail

builder

public static AWSMobileClientBuilder builder()

createProject

public CreateProjectResult createProject(CreateProjectRequest request)

Creates an AWS Mobile Hub project.

Specified by:

createProject in interface AWSMobile

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

public DeleteProjectResult deleteProject(DeleteProjectRequest request)

Delets a project in AWS Mobile Hub.

Specified by:

deleteProject in interface AWSMobile

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

public DescribeBundleResult describeBundle(DescribeBundleRequest request)

Get the bundle details for the requested bundle id.

Specified by:

describeBundle in interface AWSMobile

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

public DescribeProjectResult describeProject(DescribeProjectRequest request)

Gets details about a project in AWS Mobile Hub.

Specified by:

describeProject in interface AWSMobile

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

public ExportBundleResult exportBundle(ExportBundleRequest request)

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

Specified by:

exportBundle in interface AWSMobile

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

public ExportProjectResult exportProject(ExportProjectRequest request)

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.

Specified by:

exportProject in interface AWSMobile

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

public ListBundlesResult listBundles(ListBundlesRequest request)

List all available bundles.

Specified by:

listBundles in interface AWSMobile

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

public ListProjectsResult listProjects(ListProjectsRequest request)

Lists projects in AWS Mobile Hub.

Specified by:

listProjects in interface AWSMobile

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

public UpdateProjectResult updateProject(UpdateProjectRequest request)

Update an existing project.

Specified by:

updateProject in interface AWSMobile

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

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 AWSMobile

Parameters:

request - The originally executed request

Returns:

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