Package software.amazon.awssdk.services.mobile

Interface MobileClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MobileClient
extends AwsClient

Service client for accessing AWS Mobile. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MobileClientBuilder	builder()	Create a builder that can be used to configure and create a MobileClient.
static MobileClient	create()	Create a MobileClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateProjectResponse	createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)	Creates an AWS Mobile Hub project.
default CreateProjectResponse	createProject(CreateProjectRequest createProjectRequest)	Creates an AWS Mobile Hub project.
default DeleteProjectResponse	deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)	Delets a project in AWS Mobile Hub.
default DeleteProjectResponse	deleteProject(DeleteProjectRequest deleteProjectRequest)	Delets a project in AWS Mobile Hub.
default DescribeBundleResponse	describeBundle(Consumer<DescribeBundleRequest.Builder> describeBundleRequest)	Get the bundle details for the requested bundle id.
default DescribeBundleResponse	describeBundle(DescribeBundleRequest describeBundleRequest)	Get the bundle details for the requested bundle id.
default DescribeProjectResponse	describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)	Gets details about a project in AWS Mobile Hub.
default DescribeProjectResponse	describeProject(DescribeProjectRequest describeProjectRequest)	Gets details about a project in AWS Mobile Hub.
default ExportBundleResponse	exportBundle(Consumer<ExportBundleRequest.Builder> exportBundleRequest)	Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
default ExportBundleResponse	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.
default ExportProjectResponse	exportProject(Consumer<ExportProjectRequest.Builder> exportProjectRequest)	Exports project configuration to a snapshot which can be downloaded and shared.
default ExportProjectResponse	exportProject(ExportProjectRequest exportProjectRequest)	Exports project configuration to a snapshot which can be downloaded and shared.
default ListBundlesResponse	listBundles()	List all available bundles.
default ListBundlesResponse	listBundles(Consumer<ListBundlesRequest.Builder> listBundlesRequest)	List all available bundles.
default ListBundlesResponse	listBundles(ListBundlesRequest listBundlesRequest)	List all available bundles.
default ListBundlesIterable	listBundlesPaginator()	This is a variant of listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation.
default ListBundlesIterable	listBundlesPaginator(Consumer<ListBundlesRequest.Builder> listBundlesRequest)	This is a variant of listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation.
default ListBundlesIterable	listBundlesPaginator(ListBundlesRequest listBundlesRequest)	This is a variant of listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation.
default ListProjectsResponse	listProjects()	Lists projects in AWS Mobile Hub.
default ListProjectsResponse	listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	Lists projects in AWS Mobile Hub.
default ListProjectsResponse	listProjects(ListProjectsRequest listProjectsRequest)	Lists projects in AWS Mobile Hub.
default ListProjectsIterable	listProjectsPaginator()	This is a variant of listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation.
default ListProjectsIterable	listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation.
default ListProjectsIterable	listProjectsPaginator(ListProjectsRequest listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation.
default MobileServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateProjectResponse	updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)	Update an existing project.
default UpdateProjectResponse	updateProject(UpdateProjectRequest updateProjectRequest)	Update an existing project.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
LimitExceededException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

createProject

default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
LimitExceededException,
AwsServiceException,
SdkClientException,
MobileException

Creates an AWS Mobile Hub project.

This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to create one manually via CreateProjectRequest.builder()

Parameters:

createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request. Request structure used to request a project be created.

Returns:

Result of the CreateProject operation returned by the service.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

Delets a project in AWS Mobile Hub.

This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to create one manually via DeleteProjectRequest.builder()

Parameters:

deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request. Request structure used to request a project be deleted.

Returns:

Result of the DeleteProject operation returned by the service.

See Also:

• AWS API Documentation

describeBundle

default DescribeBundleResponse describeBundle(DescribeBundleRequest describeBundleRequest)
                                       throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

describeBundle

default DescribeBundleResponse describeBundle(Consumer<DescribeBundleRequest.Builder> describeBundleRequest)
                                       throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

Get the bundle details for the requested bundle id.

This is a convenience which creates an instance of the DescribeBundleRequest.Builder avoiding the need to create one manually via DescribeBundleRequest.builder()

Parameters:

describeBundleRequest - A Consumer that will call methods on DescribeBundleRequest.Builder to create a request. Request structure to request the details of a specific bundle.

Returns:

Result of the DescribeBundle operation returned by the service.

See Also:

• AWS API Documentation

describeProject

default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest)
                                         throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

describeProject

default DescribeProjectResponse describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)
                                         throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

Gets details about a project in AWS Mobile Hub.

This is a convenience which creates an instance of the DescribeProjectRequest.Builder avoiding the need to create one manually via DescribeProjectRequest.builder()

Parameters:

describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request. Request structure used to request details about a project.

Returns:

Result of the DescribeProject operation returned by the service.

See Also:

• AWS API Documentation

exportBundle

default ExportBundleResponse exportBundle(ExportBundleRequest exportBundleRequest)
                                   throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

exportBundle

default ExportBundleResponse exportBundle(Consumer<ExportBundleRequest.Builder> exportBundleRequest)
                                   throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

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

This is a convenience which creates an instance of the ExportBundleRequest.Builder avoiding the need to create one manually via ExportBundleRequest.builder()

Parameters:

exportBundleRequest - A Consumer that will call methods on ExportBundleRequest.Builder to create a request. 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.

See Also:

• AWS API Documentation

exportProject

default ExportProjectResponse exportProject(ExportProjectRequest exportProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

exportProject

default ExportProjectResponse exportProject(Consumer<ExportProjectRequest.Builder> exportProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AwsServiceException,
SdkClientException,
MobileException

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.

This is a convenience which creates an instance of the ExportProjectRequest.Builder avoiding the need to create one manually via ExportProjectRequest.builder()

Parameters:

exportProjectRequest - A Consumer that will call methods on ExportProjectRequest.Builder to create a request. Request structure used in requests to export project configuration details.

Returns:

Result of the ExportProject operation returned by the service.

See Also:

• AWS API Documentation

listBundles

default ListBundlesResponse listBundles(ListBundlesRequest listBundlesRequest)
                                 throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

List all available bundles.

Parameters:

listBundlesRequest - Request structure to request all available bundles.

Returns:

Result of the ListBundles operation returned by the service.

See Also:

• AWS API Documentation

listBundles

default ListBundlesResponse listBundles(Consumer<ListBundlesRequest.Builder> listBundlesRequest)
                                 throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

List all available bundles.

This is a convenience which creates an instance of the ListBundlesRequest.Builder avoiding the need to create one manually via ListBundlesRequest.builder()

Parameters:

listBundlesRequest - A Consumer that will call methods on ListBundlesRequest.Builder to create a request. Request structure to request all available bundles.

Returns:

Result of the ListBundles operation returned by the service.

See Also:

• AWS API Documentation

listBundles

default ListBundlesResponse listBundles()
                                 throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

List all available bundles.

Returns:

Result of the ListBundles operation returned by the service.

See Also:

• listBundles(ListBundlesRequest)
• AWS API Documentation

listBundlesPaginator

default ListBundlesIterable listBundlesPaginator()
                                          throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

This is a variant of listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
     for (software.amazon.awssdk.services.mobile.model.ListBundlesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listBundlesPaginator(ListBundlesRequest)
• AWS API Documentation

listBundlesPaginator

default ListBundlesIterable listBundlesPaginator(ListBundlesRequest listBundlesRequest)
                                          throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

This is a variant of listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
     for (software.amazon.awssdk.services.mobile.model.ListBundlesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation.

Parameters:

listBundlesRequest - Request structure to request all available bundles.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBundlesPaginator

default ListBundlesIterable listBundlesPaginator(Consumer<ListBundlesRequest.Builder> listBundlesRequest)
                                          throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

This is a variant of listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
     for (software.amazon.awssdk.services.mobile.model.ListBundlesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mobile.paginators.ListBundlesIterable responses = client.listBundlesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest) operation.

This is a convenience which creates an instance of the ListBundlesRequest.Builder avoiding the need to create one manually via ListBundlesRequest.builder()

Parameters:

listBundlesRequest - A Consumer that will call methods on ListBundlesRequest.Builder to create a request. Request structure to request all available bundles.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest)
                                   throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                   throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

Lists projects in AWS Mobile Hub.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request. Request structure used to request projects list in AWS Mobile Hub.

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects()
                                   throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

Lists projects in AWS Mobile Hub.

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• listProjects(ListProjectsRequest)
• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator()
                                            throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

This is a variant of listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
     for (software.amazon.awssdk.services.mobile.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listProjectsPaginator(ListProjectsRequest)
• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest)
                                            throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

This is a variant of listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
     for (software.amazon.awssdk.services.mobile.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation.

Parameters:

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

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                            throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
MobileException

This is a variant of listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
     for (software.amazon.awssdk.services.mobile.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mobile.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest) operation.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request. Request structure used to request projects list in AWS Mobile Hub.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AccountActionRequiredException,
LimitExceededException,
AwsServiceException,
SdkClientException,
MobileException

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.

See Also:

• AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
                                     throws InternalFailureException,
ServiceUnavailableException,
UnauthorizedException,
TooManyRequestsException,
BadRequestException,
NotFoundException,
AccountActionRequiredException,
LimitExceededException,
AwsServiceException,
SdkClientException,
MobileException

Update an existing project.

This is a convenience which creates an instance of the UpdateProjectRequest.Builder avoiding the need to create one manually via UpdateProjectRequest.builder()

Parameters:

updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request. Request structure used for requests to update project configuration.

Returns:

Result of the UpdateProject operation returned by the service.

See Also:

• AWS API Documentation

create

static MobileClient create()

Create a MobileClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MobileClientBuilder builder()

Create a builder that can be used to configure and create a MobileClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MobileServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration