* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.mobile.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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSMobile { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "mobile"; /** ** Creates an AWS Mobile Hub project. *
* * @param createProjectRequest * Request structure used to request a project be created. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @throws NotFoundException * No entity can be found with the specified identifier. * @throws 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. * @sample AWSMobile.CreateProject * @see AWS API * Documentation */ CreateProjectResult createProject(CreateProjectRequest createProjectRequest); /** ** Delets a project in AWS Mobile Hub. *
* * @param deleteProjectRequest * Request structure used to request a project be deleted. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws NotFoundException * No entity can be found with the specified identifier. * @sample AWSMobile.DeleteProject * @see AWS API * Documentation */ DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest); /** ** Get the bundle details for the requested bundle id. *
* * @param describeBundleRequest * Request structure to request the details of a specific bundle. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @throws NotFoundException * No entity can be found with the specified identifier. * @sample AWSMobile.DescribeBundle * @see AWS API * Documentation */ DescribeBundleResult describeBundle(DescribeBundleRequest describeBundleRequest); /** ** Gets details about a project in AWS Mobile Hub. *
* * @param describeProjectRequest * Request structure used to request details about a project. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @throws NotFoundException * No entity can be found with the specified identifier. * @sample AWSMobile.DescribeProject * @see AWS API * Documentation */ DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest); /** ** Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile * app clients with backend AWS resources. *
* * @param 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. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @throws NotFoundException * No entity can be found with the specified identifier. * @sample AWSMobile.ExportBundle * @see AWS API * Documentation */ ExportBundleResult exportBundle(ExportBundleRequest exportBundleRequest); /** ** 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. *
* * @param exportProjectRequest * Request structure used in requests to export project configuration details. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @throws NotFoundException * No entity can be found with the specified identifier. * @sample AWSMobile.ExportProject * @see AWS API * Documentation */ ExportProjectResult exportProject(ExportProjectRequest exportProjectRequest); /** ** List all available bundles. *
* * @param listBundlesRequest * Request structure to request all available bundles. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @sample AWSMobile.ListBundles * @see AWS API * Documentation */ ListBundlesResult listBundles(ListBundlesRequest listBundlesRequest); /** ** Lists projects in AWS Mobile Hub. *
* * @param listProjectsRequest * Request structure used to request projects list in AWS Mobile Hub. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @sample AWSMobile.ListProjects * @see AWS API * Documentation */ ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest); /** ** Update an existing project. *
* * @param updateProjectRequest * Request structure used for requests to update project configuration. * @return 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. * @throws ServiceUnavailableException * The service is temporarily unavailable. The request should be retried after some time delay. * @throws UnauthorizedException * Credentials of the caller are insufficient to authorize the request. * @throws 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. * @throws BadRequestException * The request cannot be processed because some parameter is not valid or the project state prevents the * operation from being performed. * @throws NotFoundException * No entity can be found with the specified identifier. * @throws AccountActionRequiredException * Account Action is required in order to continue the request. * @throws 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. * @sample AWSMobile.UpdateProject * @see AWS API * Documentation */ UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }