@Generated(value="software.amazon.awssdk:codegen") public interface MobileClient extends SdkClient
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and 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()
List all available bundles.
|
default ListBundlesIterable |
listBundlesPaginator(Consumer<ListBundlesRequest.Builder> listBundlesRequest)
List all available bundles.
|
default ListBundlesIterable |
listBundlesPaginator(ListBundlesRequest listBundlesRequest)
List all available bundles.
|
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()
Lists projects in AWS Mobile Hub.
|
default ListProjectsIterable |
listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
Lists projects in AWS Mobile Hub.
|
default ListProjectsIterable |
listProjectsPaginator(ListProjectsRequest listProjectsRequest)
Lists projects in AWS Mobile Hub.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateProjectResponse |
updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
Update an existing project.
|
default UpdateProjectResponse |
updateProject(UpdateProjectRequest updateProjectRequest)
Update an existing project.
|
serviceName
close
static final String SERVICE_NAME
static MobileClient create()
MobileClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static MobileClientBuilder builder()
MobileClient
.default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, MobileException
Creates an AWS Mobile Hub project.
createProjectRequest
- Request structure used to request a project be created.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
createProjectRequest
- A Consumer
that will call methods on CreateProjectRequest.Builder
to create a request.
Request structure used to request a project be created.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, MobileException
Delets a project in AWS Mobile Hub.
deleteProjectRequest
- Request structure used to request a project be deleted.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
deleteProjectRequest
- A Consumer
that will call methods on DeleteProjectRequest.Builder
to create a request.
Request structure used to request a project be deleted.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeBundleResponse describeBundle(DescribeBundleRequest describeBundleRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, MobileException
Get the bundle details for the requested bundle id.
describeBundleRequest
- Request structure to request the details of a specific bundle.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
describeBundleRequest
- A Consumer
that will call methods on DescribeBundleRequest.Builder
to create a request.
Request structure to request the details of a specific bundle.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, MobileException
Gets details about a project in AWS Mobile Hub.
describeProjectRequest
- Request structure used to request details about a project.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
describeProjectRequest
- A Consumer
that will call methods on DescribeProjectRequest.Builder
to create a request.
Request structure used to request details about a project.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
exportProjectRequest
- Request structure used in requests to export project configuration details.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
exportProjectRequest
- A Consumer
that will call methods on ExportProjectRequest.Builder
to create a request.
Request structure used in requests to export project configuration details.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBundlesResponse listBundles() throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
List all available bundles.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listBundles(ListBundlesRequest)
,
AWS API
Documentationdefault ListBundlesResponse listBundles(ListBundlesRequest listBundlesRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
List all available bundles.
listBundlesRequest
- Request structure to request all available bundles.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
listBundlesRequest
- A Consumer
that will call methods on ListBundlesRequest.Builder
to create a request.
Request structure to request all available bundles.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBundlesIterable listBundlesPaginator() throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
List all available bundles.
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(....);
Note: If you prefer to have control on service calls, use the
listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest)
operation.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listBundlesPaginator(ListBundlesRequest)
,
AWS API
Documentationdefault ListBundlesIterable listBundlesPaginator(ListBundlesRequest listBundlesRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
List all available bundles.
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(....);
Note: If you prefer to have control on service calls, use the
listBundles(software.amazon.awssdk.services.mobile.model.ListBundlesRequest)
operation.
listBundlesRequest
- Request structure to request all available bundles.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBundlesIterable listBundlesPaginator(Consumer<ListBundlesRequest.Builder> listBundlesRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
List all available bundles.
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(....);
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()
listBundlesRequest
- A Consumer
that will call methods on ListBundlesRequest.Builder
to create a request.
Request structure to request all available bundles.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProjectsResponse listProjects() throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
Lists projects in AWS Mobile Hub.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listProjects(ListProjectsRequest)
,
AWS API
Documentationdefault ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
Lists projects in AWS Mobile Hub.
listProjectsRequest
- Request structure used to request projects list in AWS Mobile Hub.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProjectsIterable listProjectsPaginator() throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
Lists projects in AWS Mobile Hub.
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(....);
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest)
operation.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listProjectsPaginator(ListProjectsRequest)
,
AWS API
Documentationdefault ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
Lists projects in AWS Mobile Hub.
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(....);
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.mobile.model.ListProjectsRequest)
operation.
listProjectsRequest
- Request structure used to request projects list in AWS Mobile Hub.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, MobileException
Lists projects in AWS Mobile Hub.
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(....);
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()
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest) throws InternalFailureException, ServiceUnavailableException, UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AccountActionRequiredException, LimitExceededException, AwsServiceException, SdkClientException, MobileException
Update an existing project.
updateProjectRequest
- Request structure used for requests to update project configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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()
updateProjectRequest
- A Consumer
that will call methods on UpdateProjectRequest.Builder
to create a request.
Request structure used for requests to update project configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MobileException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.