Interface M2AsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for analyzing existing mainframe applications, developing or updating mainframe applications using COBOL or PL/I, and implementing an automated pipeline for continuous integration and continuous delivery (CI/CD) of the applications.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic M2AsyncClientBuilder
builder()
Create a builder that can be used to configure and create aM2AsyncClient
.cancelBatchJobExecution
(Consumer<CancelBatchJobExecutionRequest.Builder> cancelBatchJobExecutionRequest) Cancels the running of a specific batch job execution.cancelBatchJobExecution
(CancelBatchJobExecutionRequest cancelBatchJobExecutionRequest) Cancels the running of a specific batch job execution.static M2AsyncClient
create()
Create aM2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates a new application with given parameters.createApplication
(CreateApplicationRequest createApplicationRequest) Creates a new application with given parameters.createDataSetImportTask
(Consumer<CreateDataSetImportTaskRequest.Builder> createDataSetImportTaskRequest) Starts a data set import task for a specific application.createDataSetImportTask
(CreateDataSetImportTaskRequest createDataSetImportTaskRequest) Starts a data set import task for a specific application.createDeployment
(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Creates and starts a deployment to deploy an application into a runtime environment.createDeployment
(CreateDeploymentRequest createDeploymentRequest) Creates and starts a deployment to deploy an application into a runtime environment.createEnvironment
(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates a runtime environment for a given runtime engine.createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Creates a runtime environment for a given runtime engine.deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes a specific application.deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes a specific application.deleteApplicationFromEnvironment
(Consumer<DeleteApplicationFromEnvironmentRequest.Builder> deleteApplicationFromEnvironmentRequest) Deletes a specific application from the specific runtime environment where it was previously deployed.deleteApplicationFromEnvironment
(DeleteApplicationFromEnvironmentRequest deleteApplicationFromEnvironmentRequest) Deletes a specific application from the specific runtime environment where it was previously deployed.deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes a specific runtime environment.deleteEnvironment
(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes a specific runtime environment.default CompletableFuture
<GetApplicationResponse> getApplication
(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Describes the details of a specific application.default CompletableFuture
<GetApplicationResponse> getApplication
(GetApplicationRequest getApplicationRequest) Describes the details of a specific application.getApplicationVersion
(Consumer<GetApplicationVersionRequest.Builder> getApplicationVersionRequest) Returns details about a specific version of a specific application.getApplicationVersion
(GetApplicationVersionRequest getApplicationVersionRequest) Returns details about a specific version of a specific application.getBatchJobExecution
(Consumer<GetBatchJobExecutionRequest.Builder> getBatchJobExecutionRequest) Gets the details of a specific batch job execution for a specific application.getBatchJobExecution
(GetBatchJobExecutionRequest getBatchJobExecutionRequest) Gets the details of a specific batch job execution for a specific application.getDataSetDetails
(Consumer<GetDataSetDetailsRequest.Builder> getDataSetDetailsRequest) Gets the details of a specific data set.getDataSetDetails
(GetDataSetDetailsRequest getDataSetDetailsRequest) Gets the details of a specific data set.getDataSetImportTask
(Consumer<GetDataSetImportTaskRequest.Builder> getDataSetImportTaskRequest) Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.getDataSetImportTask
(GetDataSetImportTaskRequest getDataSetImportTaskRequest) Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.default CompletableFuture
<GetDeploymentResponse> getDeployment
(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Gets details of a specific deployment with a given deployment identifier.default CompletableFuture
<GetDeploymentResponse> getDeployment
(GetDeploymentRequest getDeploymentRequest) Gets details of a specific deployment with a given deployment identifier.default CompletableFuture
<GetEnvironmentResponse> getEnvironment
(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Describes a specific runtime environment.default CompletableFuture
<GetEnvironmentResponse> getEnvironment
(GetEnvironmentRequest getEnvironmentRequest) Describes a specific runtime environment.getSignedBluinsightsUrl
(Consumer<GetSignedBluinsightsUrlRequest.Builder> getSignedBluinsightsUrlRequest) Gets a single sign-on URL that can be used to connect to AWS Blu Insights.getSignedBluinsightsUrl
(GetSignedBluinsightsUrlRequest getSignedBluinsightsUrlRequest) Gets a single sign-on URL that can be used to connect to AWS Blu Insights.listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists the applications associated with a specific Amazon Web Services account.listApplications
(ListApplicationsRequest listApplicationsRequest) Lists the applications associated with a specific Amazon Web Services account.default ListApplicationsPublisher
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation.default ListApplicationsPublisher
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation.listApplicationVersions
(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) Returns a list of the application versions for a specific application.listApplicationVersions
(ListApplicationVersionsRequest listApplicationVersionsRequest) Returns a list of the application versions for a specific application.default ListApplicationVersionsPublisher
listApplicationVersionsPaginator
(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) This is a variant oflistApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation.default ListApplicationVersionsPublisher
listApplicationVersionsPaginator
(ListApplicationVersionsRequest listApplicationVersionsRequest) This is a variant oflistApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation.listBatchJobDefinitions
(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.listBatchJobDefinitions
(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.default ListBatchJobDefinitionsPublisher
listBatchJobDefinitionsPaginator
(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) This is a variant oflistBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation.default ListBatchJobDefinitionsPublisher
listBatchJobDefinitionsPaginator
(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) This is a variant oflistBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation.listBatchJobExecutions
(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) Lists historical, current, and scheduled batch job executions for a specific application.listBatchJobExecutions
(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest) Lists historical, current, and scheduled batch job executions for a specific application.default ListBatchJobExecutionsPublisher
listBatchJobExecutionsPaginator
(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) This is a variant oflistBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation.default ListBatchJobExecutionsPublisher
listBatchJobExecutionsPaginator
(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest) This is a variant oflistBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation.listBatchJobRestartPoints
(Consumer<ListBatchJobRestartPointsRequest.Builder> listBatchJobRestartPointsRequest) Lists all the job steps for JCL files to restart a batch job.listBatchJobRestartPoints
(ListBatchJobRestartPointsRequest listBatchJobRestartPointsRequest) Lists all the job steps for JCL files to restart a batch job.listDataSetImportHistory
(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) Lists the data set imports for the specified application.listDataSetImportHistory
(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) Lists the data set imports for the specified application.listDataSetImportHistoryPaginator
(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) This is a variant oflistDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation.listDataSetImportHistoryPaginator
(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) This is a variant oflistDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation.default CompletableFuture
<ListDataSetsResponse> listDataSets
(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) Lists the data sets imported for a specific application.default CompletableFuture
<ListDataSetsResponse> listDataSets
(ListDataSetsRequest listDataSetsRequest) Lists the data sets imported for a specific application.default ListDataSetsPublisher
listDataSetsPaginator
(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) This is a variant oflistDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation.default ListDataSetsPublisher
listDataSetsPaginator
(ListDataSetsRequest listDataSetsRequest) This is a variant oflistDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation.default CompletableFuture
<ListDeploymentsResponse> listDeployments
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Returns a list of all deployments of a specific application.default CompletableFuture
<ListDeploymentsResponse> listDeployments
(ListDeploymentsRequest listDeploymentsRequest) Returns a list of all deployments of a specific application.default ListDeploymentsPublisher
listDeploymentsPaginator
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation.default ListDeploymentsPublisher
listDeploymentsPaginator
(ListDeploymentsRequest listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation.listEngineVersions
(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) Lists the available engine versions.listEngineVersions
(ListEngineVersionsRequest listEngineVersionsRequest) Lists the available engine versions.default ListEngineVersionsPublisher
listEngineVersionsPaginator
(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) This is a variant oflistEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation.default ListEngineVersionsPublisher
listEngineVersionsPaginator
(ListEngineVersionsRequest listEngineVersionsRequest) This is a variant oflistEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation.listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists the runtime environments.listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) Lists the runtime environments.default ListEnvironmentsPublisher
listEnvironmentsPaginator
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsPublisher
listEnvironmentsPaginator
(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.default M2ServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartApplication
(Consumer<StartApplicationRequest.Builder> startApplicationRequest) Starts an application that is currently stopped.startApplication
(StartApplicationRequest startApplicationRequest) Starts an application that is currently stopped.default CompletableFuture
<StartBatchJobResponse> startBatchJob
(Consumer<StartBatchJobRequest.Builder> startBatchJobRequest) Starts a batch job and returns the unique identifier of this execution of the batch job.default CompletableFuture
<StartBatchJobResponse> startBatchJob
(StartBatchJobRequest startBatchJobRequest) Starts a batch job and returns the unique identifier of this execution of the batch job.default CompletableFuture
<StopApplicationResponse> stopApplication
(Consumer<StopApplicationRequest.Builder> stopApplicationRequest) Stops a running application.default CompletableFuture
<StopApplicationResponse> stopApplication
(StopApplicationRequest stopApplicationRequest) Stops a running application.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates an application and creates a new version.updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates an application and creates a new version.updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates the configuration details for a specific runtime environment.updateEnvironment
(UpdateEnvironmentRequest updateEnvironmentRequest) Updates the configuration details for a specific runtime environment.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelBatchJobExecution
default CompletableFuture<CancelBatchJobExecutionResponse> cancelBatchJobExecution(CancelBatchJobExecutionRequest cancelBatchJobExecutionRequest) Cancels the running of a specific batch job execution.
- Parameters:
cancelBatchJobExecutionRequest
-- Returns:
- A Java Future containing the result of the CancelBatchJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelBatchJobExecution
default CompletableFuture<CancelBatchJobExecutionResponse> cancelBatchJobExecution(Consumer<CancelBatchJobExecutionRequest.Builder> cancelBatchJobExecutionRequest) Cancels the running of a specific batch job execution.
This is a convenience which creates an instance of the
CancelBatchJobExecutionRequest.Builder
avoiding the need to create one manually viaCancelBatchJobExecutionRequest.builder()
- Parameters:
cancelBatchJobExecutionRequest
- AConsumer
that will call methods onCancelBatchJobExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelBatchJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest) Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
- Parameters:
createApplicationRequest
-- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataSetImportTask
default CompletableFuture<CreateDataSetImportTaskResponse> createDataSetImportTask(CreateDataSetImportTaskRequest createDataSetImportTaskRequest) Starts a data set import task for a specific application.
- Parameters:
createDataSetImportTaskRequest
-- Returns:
- A Java Future containing the result of the CreateDataSetImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataSetImportTask
default CompletableFuture<CreateDataSetImportTaskResponse> createDataSetImportTask(Consumer<CreateDataSetImportTaskRequest.Builder> createDataSetImportTaskRequest) Starts a data set import task for a specific application.
This is a convenience which creates an instance of the
CreateDataSetImportTaskRequest.Builder
avoiding the need to create one manually viaCreateDataSetImportTaskRequest.builder()
- Parameters:
createDataSetImportTaskRequest
- AConsumer
that will call methods onCreateDataSetImportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDataSetImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeployment
default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest) Creates and starts a deployment to deploy an application into a runtime environment.
- Parameters:
createDeploymentRequest
-- Returns:
- A Java Future containing the result of the CreateDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeployment
default CompletableFuture<CreateDeploymentResponse> createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Creates and starts a deployment to deploy an application into a runtime environment.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builder
avoiding the need to create one manually viaCreateDeploymentRequest.builder()
- Parameters:
createDeploymentRequest
- AConsumer
that will call methods onCreateDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Creates a runtime environment for a given runtime engine.
- Parameters:
createEnvironmentRequest
-- Returns:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates a runtime environment for a given runtime engine.
This is a convenience which creates an instance of the
CreateEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentRequest.builder()
- Parameters:
createEnvironmentRequest
- AConsumer
that will call methods onCreateEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes a specific application. You cannot delete a running application.
- Parameters:
deleteApplicationRequest
-- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes a specific application. You cannot delete a running application.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplicationFromEnvironment
default CompletableFuture<DeleteApplicationFromEnvironmentResponse> deleteApplicationFromEnvironment(DeleteApplicationFromEnvironmentRequest deleteApplicationFromEnvironmentRequest) Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.
- Parameters:
deleteApplicationFromEnvironmentRequest
-- Returns:
- A Java Future containing the result of the DeleteApplicationFromEnvironment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplicationFromEnvironment
default CompletableFuture<DeleteApplicationFromEnvironmentResponse> deleteApplicationFromEnvironment(Consumer<DeleteApplicationFromEnvironmentRequest.Builder> deleteApplicationFromEnvironmentRequest) Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.
This is a convenience which creates an instance of the
DeleteApplicationFromEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteApplicationFromEnvironmentRequest.builder()
- Parameters:
deleteApplicationFromEnvironmentRequest
- AConsumer
that will call methods onDeleteApplicationFromEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplicationFromEnvironment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
- Parameters:
deleteEnvironmentRequest
-- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
This is a convenience which creates an instance of the
DeleteEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentRequest.builder()
- Parameters:
deleteEnvironmentRequest
- AConsumer
that will call methods onDeleteEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest) Describes the details of a specific application.
- Parameters:
getApplicationRequest
-- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Describes the details of a specific application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builder
avoiding the need to create one manually viaGetApplicationRequest.builder()
- Parameters:
getApplicationRequest
- AConsumer
that will call methods onGetApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplicationVersion
default CompletableFuture<GetApplicationVersionResponse> getApplicationVersion(GetApplicationVersionRequest getApplicationVersionRequest) Returns details about a specific version of a specific application.
- Parameters:
getApplicationVersionRequest
-- Returns:
- A Java Future containing the result of the GetApplicationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplicationVersion
default CompletableFuture<GetApplicationVersionResponse> getApplicationVersion(Consumer<GetApplicationVersionRequest.Builder> getApplicationVersionRequest) Returns details about a specific version of a specific application.
This is a convenience which creates an instance of the
GetApplicationVersionRequest.Builder
avoiding the need to create one manually viaGetApplicationVersionRequest.builder()
- Parameters:
getApplicationVersionRequest
- AConsumer
that will call methods onGetApplicationVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplicationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBatchJobExecution
default CompletableFuture<GetBatchJobExecutionResponse> getBatchJobExecution(GetBatchJobExecutionRequest getBatchJobExecutionRequest) Gets the details of a specific batch job execution for a specific application.
- Parameters:
getBatchJobExecutionRequest
-- Returns:
- A Java Future containing the result of the GetBatchJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBatchJobExecution
default CompletableFuture<GetBatchJobExecutionResponse> getBatchJobExecution(Consumer<GetBatchJobExecutionRequest.Builder> getBatchJobExecutionRequest) Gets the details of a specific batch job execution for a specific application.
This is a convenience which creates an instance of the
GetBatchJobExecutionRequest.Builder
avoiding the need to create one manually viaGetBatchJobExecutionRequest.builder()
- Parameters:
getBatchJobExecutionRequest
- AConsumer
that will call methods onGetBatchJobExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBatchJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataSetDetails
default CompletableFuture<GetDataSetDetailsResponse> getDataSetDetails(GetDataSetDetailsRequest getDataSetDetailsRequest) Gets the details of a specific data set.
- Parameters:
getDataSetDetailsRequest
-- Returns:
- A Java Future containing the result of the GetDataSetDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ExecutionTimeoutException Failed to connect to server, or didn’t receive response within expected time period.
- ServiceUnavailableException Server cannot process the request at the moment.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataSetDetails
default CompletableFuture<GetDataSetDetailsResponse> getDataSetDetails(Consumer<GetDataSetDetailsRequest.Builder> getDataSetDetailsRequest) Gets the details of a specific data set.
This is a convenience which creates an instance of the
GetDataSetDetailsRequest.Builder
avoiding the need to create one manually viaGetDataSetDetailsRequest.builder()
- Parameters:
getDataSetDetailsRequest
- AConsumer
that will call methods onGetDataSetDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDataSetDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ExecutionTimeoutException Failed to connect to server, or didn’t receive response within expected time period.
- ServiceUnavailableException Server cannot process the request at the moment.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataSetImportTask
default CompletableFuture<GetDataSetImportTaskResponse> getDataSetImportTask(GetDataSetImportTaskRequest getDataSetImportTaskRequest) Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
- Parameters:
getDataSetImportTaskRequest
-- Returns:
- A Java Future containing the result of the GetDataSetImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataSetImportTask
default CompletableFuture<GetDataSetImportTaskResponse> getDataSetImportTask(Consumer<GetDataSetImportTaskRequest.Builder> getDataSetImportTaskRequest) Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
This is a convenience which creates an instance of the
GetDataSetImportTaskRequest.Builder
avoiding the need to create one manually viaGetDataSetImportTaskRequest.builder()
- Parameters:
getDataSetImportTaskRequest
- AConsumer
that will call methods onGetDataSetImportTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDataSetImportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeployment
default CompletableFuture<GetDeploymentResponse> getDeployment(GetDeploymentRequest getDeploymentRequest) Gets details of a specific deployment with a given deployment identifier.
- Parameters:
getDeploymentRequest
-- Returns:
- A Java Future containing the result of the GetDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeployment
default CompletableFuture<GetDeploymentResponse> getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Gets details of a specific deployment with a given deployment identifier.
This is a convenience which creates an instance of the
GetDeploymentRequest.Builder
avoiding the need to create one manually viaGetDeploymentRequest.builder()
- Parameters:
getDeploymentRequest
- AConsumer
that will call methods onGetDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Describes a specific runtime environment.
- Parameters:
getEnvironmentRequest
-- Returns:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Describes a specific runtime environment.
This is a convenience which creates an instance of the
GetEnvironmentRequest.Builder
avoiding the need to create one manually viaGetEnvironmentRequest.builder()
- Parameters:
getEnvironmentRequest
- AConsumer
that will call methods onGetEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSignedBluinsightsUrl
default CompletableFuture<GetSignedBluinsightsUrlResponse> getSignedBluinsightsUrl(GetSignedBluinsightsUrlRequest getSignedBluinsightsUrlRequest) Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
- Parameters:
getSignedBluinsightsUrlRequest
-- Returns:
- A Java Future containing the result of the GetSignedBluinsightsUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSignedBluinsightsUrl
default CompletableFuture<GetSignedBluinsightsUrlResponse> getSignedBluinsightsUrl(Consumer<GetSignedBluinsightsUrlRequest.Builder> getSignedBluinsightsUrlRequest) Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
This is a convenience which creates an instance of the
GetSignedBluinsightsUrlRequest.Builder
avoiding the need to create one manually viaGetSignedBluinsightsUrlRequest.builder()
- Parameters:
getSignedBluinsightsUrlRequest
- AConsumer
that will call methods onGetSignedBluinsightsUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSignedBluinsightsUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationVersions
default CompletableFuture<ListApplicationVersionsResponse> listApplicationVersions(ListApplicationVersionsRequest listApplicationVersionsRequest) Returns a list of the application versions for a specific application.
- Parameters:
listApplicationVersionsRequest
-- Returns:
- A Java Future containing the result of the ListApplicationVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationVersions
default CompletableFuture<ListApplicationVersionsResponse> listApplicationVersions(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) Returns a list of the application versions for a specific application.
This is a convenience which creates an instance of the
ListApplicationVersionsRequest.Builder
avoiding the need to create one manually viaListApplicationVersionsRequest.builder()
- Parameters:
listApplicationVersionsRequest
- AConsumer
that will call methods onListApplicationVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationVersionsPaginator
default ListApplicationVersionsPublisher listApplicationVersionsPaginator(ListApplicationVersionsRequest listApplicationVersionsRequest) This is a variant of
listApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListApplicationVersionsPublisher publisher = client.listApplicationVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListApplicationVersionsPublisher publisher = client.listApplicationVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListApplicationVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListApplicationVersionsResponse response) { //... }; });
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
listApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation.- Parameters:
listApplicationVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationVersionsPaginator
default ListApplicationVersionsPublisher listApplicationVersionsPaginator(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) This is a variant of
listApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListApplicationVersionsPublisher publisher = client.listApplicationVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListApplicationVersionsPublisher publisher = client.listApplicationVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListApplicationVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListApplicationVersionsResponse response) { //... }; });
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
listApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationVersionsRequest.Builder
avoiding the need to create one manually viaListApplicationVersionsRequest.builder()
- Parameters:
listApplicationVersionsRequest
- AConsumer
that will call methods onListApplicationVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest) Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.
- Parameters:
listApplicationsRequest
-- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListApplicationsResponse response) { //... }; });
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
listApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation.- Parameters:
listApplicationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListApplicationsResponse response) { //... }; });
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
listApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobDefinitions
default CompletableFuture<ListBatchJobDefinitionsResponse> listBatchJobDefinitions(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
- Parameters:
listBatchJobDefinitionsRequest
-- Returns:
- A Java Future containing the result of the ListBatchJobDefinitions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobDefinitions
default CompletableFuture<ListBatchJobDefinitionsResponse> listBatchJobDefinitions(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
This is a convenience which creates an instance of the
ListBatchJobDefinitionsRequest.Builder
avoiding the need to create one manually viaListBatchJobDefinitionsRequest.builder()
- Parameters:
listBatchJobDefinitionsRequest
- AConsumer
that will call methods onListBatchJobDefinitionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBatchJobDefinitions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobDefinitionsPaginator
default ListBatchJobDefinitionsPublisher listBatchJobDefinitionsPaginator(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) This is a variant of
listBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsPublisher publisher = client.listBatchJobDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsPublisher publisher = client.listBatchJobDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsResponse response) { //... }; });
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
listBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation.- Parameters:
listBatchJobDefinitionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobDefinitionsPaginator
default ListBatchJobDefinitionsPublisher listBatchJobDefinitionsPaginator(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) This is a variant of
listBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsPublisher publisher = client.listBatchJobDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsPublisher publisher = client.listBatchJobDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsResponse response) { //... }; });
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
listBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
ListBatchJobDefinitionsRequest.Builder
avoiding the need to create one manually viaListBatchJobDefinitionsRequest.builder()
- Parameters:
listBatchJobDefinitionsRequest
- AConsumer
that will call methods onListBatchJobDefinitionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobExecutions
default CompletableFuture<ListBatchJobExecutionsResponse> listBatchJobExecutions(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest) Lists historical, current, and scheduled batch job executions for a specific application.
- Parameters:
listBatchJobExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListBatchJobExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobExecutions
default CompletableFuture<ListBatchJobExecutionsResponse> listBatchJobExecutions(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) Lists historical, current, and scheduled batch job executions for a specific application.
This is a convenience which creates an instance of the
ListBatchJobExecutionsRequest.Builder
avoiding the need to create one manually viaListBatchJobExecutionsRequest.builder()
- Parameters:
listBatchJobExecutionsRequest
- AConsumer
that will call methods onListBatchJobExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBatchJobExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobExecutionsPaginator
default ListBatchJobExecutionsPublisher listBatchJobExecutionsPaginator(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest) This is a variant of
listBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsPublisher publisher = client.listBatchJobExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsPublisher publisher = client.listBatchJobExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsResponse response) { //... }; });
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
listBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation.- Parameters:
listBatchJobExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobExecutionsPaginator
default ListBatchJobExecutionsPublisher listBatchJobExecutionsPaginator(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) This is a variant of
listBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsPublisher publisher = client.listBatchJobExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsPublisher publisher = client.listBatchJobExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsResponse response) { //... }; });
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
listBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListBatchJobExecutionsRequest.Builder
avoiding the need to create one manually viaListBatchJobExecutionsRequest.builder()
- Parameters:
listBatchJobExecutionsRequest
- AConsumer
that will call methods onListBatchJobExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobRestartPoints
default CompletableFuture<ListBatchJobRestartPointsResponse> listBatchJobRestartPoints(ListBatchJobRestartPointsRequest listBatchJobRestartPointsRequest) Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
- Parameters:
listBatchJobRestartPointsRequest
-- Returns:
- A Java Future containing the result of the ListBatchJobRestartPoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchJobRestartPoints
default CompletableFuture<ListBatchJobRestartPointsResponse> listBatchJobRestartPoints(Consumer<ListBatchJobRestartPointsRequest.Builder> listBatchJobRestartPointsRequest) Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.
This is a convenience which creates an instance of the
ListBatchJobRestartPointsRequest.Builder
avoiding the need to create one manually viaListBatchJobRestartPointsRequest.builder()
- Parameters:
listBatchJobRestartPointsRequest
- AConsumer
that will call methods onListBatchJobRestartPointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBatchJobRestartPoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetImportHistory
default CompletableFuture<ListDataSetImportHistoryResponse> listDataSetImportHistory(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) Lists the data set imports for the specified application.
- Parameters:
listDataSetImportHistoryRequest
-- Returns:
- A Java Future containing the result of the ListDataSetImportHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetImportHistory
default CompletableFuture<ListDataSetImportHistoryResponse> listDataSetImportHistory(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) Lists the data set imports for the specified application.
This is a convenience which creates an instance of the
ListDataSetImportHistoryRequest.Builder
avoiding the need to create one manually viaListDataSetImportHistoryRequest.builder()
- Parameters:
listDataSetImportHistoryRequest
- AConsumer
that will call methods onListDataSetImportHistoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDataSetImportHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetImportHistoryPaginator
default ListDataSetImportHistoryPublisher listDataSetImportHistoryPaginator(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) This is a variant of
listDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryPublisher publisher = client.listDataSetImportHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryPublisher publisher = client.listDataSetImportHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryResponse response) { //... }; });
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
listDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation.- Parameters:
listDataSetImportHistoryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetImportHistoryPaginator
default ListDataSetImportHistoryPublisher listDataSetImportHistoryPaginator(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) This is a variant of
listDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryPublisher publisher = client.listDataSetImportHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryPublisher publisher = client.listDataSetImportHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryResponse response) { //... }; });
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
listDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation.
This is a convenience which creates an instance of the
ListDataSetImportHistoryRequest.Builder
avoiding the need to create one manually viaListDataSetImportHistoryRequest.builder()
- Parameters:
listDataSetImportHistoryRequest
- AConsumer
that will call methods onListDataSetImportHistoryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSets
default CompletableFuture<ListDataSetsResponse> listDataSets(ListDataSetsRequest listDataSetsRequest) Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.
- Parameters:
listDataSetsRequest
-- Returns:
- A Java Future containing the result of the ListDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ExecutionTimeoutException Failed to connect to server, or didn’t receive response within expected time period.
- ServiceUnavailableException Server cannot process the request at the moment.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSets
default CompletableFuture<ListDataSetsResponse> listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.
This is a convenience which creates an instance of the
ListDataSetsRequest.Builder
avoiding the need to create one manually viaListDataSetsRequest.builder()
- Parameters:
listDataSetsRequest
- AConsumer
that will call methods onListDataSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ExecutionTimeoutException Failed to connect to server, or didn’t receive response within expected time period.
- ServiceUnavailableException Server cannot process the request at the moment.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetsPaginator
This is a variant of
listDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListDataSetsResponse response) { //... }; });
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
listDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation.- Parameters:
listDataSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ExecutionTimeoutException Failed to connect to server, or didn’t receive response within expected time period.
- ServiceUnavailableException Server cannot process the request at the moment.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetsPaginator
default ListDataSetsPublisher listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) This is a variant of
listDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListDataSetsResponse response) { //... }; });
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
listDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation.
This is a convenience which creates an instance of the
ListDataSetsRequest.Builder
avoiding the need to create one manually viaListDataSetsRequest.builder()
- Parameters:
listDataSetsRequest
- AConsumer
that will call methods onListDataSetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ExecutionTimeoutException Failed to connect to server, or didn’t receive response within expected time period.
- ServiceUnavailableException Server cannot process the request at the moment.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeployments
default CompletableFuture<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest listDeploymentsRequest) Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
- Parameters:
listDeploymentsRequest
-- Returns:
- A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeployments
default CompletableFuture<ListDeploymentsResponse> listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsPublisher listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) This is a variant of
listDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListDeploymentsResponse response) { //... }; });
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
listDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation.- Parameters:
listDeploymentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsPublisher listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant of
listDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListDeploymentsResponse response) { //... }; });
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
listDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersions
default CompletableFuture<ListEngineVersionsResponse> listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest) Lists the available engine versions.
- Parameters:
listEngineVersionsRequest
-- Returns:
- A Java Future containing the result of the ListEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersions
default CompletableFuture<ListEngineVersionsResponse> listEngineVersions(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) Lists the available engine versions.
This is a convenience which creates an instance of the
ListEngineVersionsRequest.Builder
avoiding the need to create one manually viaListEngineVersionsRequest.builder()
- Parameters:
listEngineVersionsRequest
- AConsumer
that will call methods onListEngineVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersionsPaginator
default ListEngineVersionsPublisher listEngineVersionsPaginator(ListEngineVersionsRequest listEngineVersionsRequest) This is a variant of
listEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListEngineVersionsResponse response) { //... }; });
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
listEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation.- Parameters:
listEngineVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersionsPaginator
default ListEngineVersionsPublisher listEngineVersionsPaginator(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) This is a variant of
listEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListEngineVersionsResponse response) { //... }; });
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
listEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListEngineVersionsRequest.Builder
avoiding the need to create one manually viaListEngineVersionsRequest.builder()
- Parameters:
listEngineVersionsRequest
- AConsumer
that will call methods onListEngineVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Lists the runtime environments.
- Parameters:
listEnvironmentsRequest
-- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists the runtime environments.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListEnvironmentsResponse response) { //... }; });
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
listEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation.- Parameters:
listEnvironmentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.m2.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.m2.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.m2.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.m2.model.ListEnvironmentsResponse response) { //... }; });
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
listEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startApplication
default CompletableFuture<StartApplicationResponse> startApplication(StartApplicationRequest startApplicationRequest) Starts an application that is currently stopped.
- Parameters:
startApplicationRequest
-- Returns:
- A Java Future containing the result of the StartApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startApplication
default CompletableFuture<StartApplicationResponse> startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest) Starts an application that is currently stopped.
This is a convenience which creates an instance of the
StartApplicationRequest.Builder
avoiding the need to create one manually viaStartApplicationRequest.builder()
- Parameters:
startApplicationRequest
- AConsumer
that will call methods onStartApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startBatchJob
default CompletableFuture<StartBatchJobResponse> startBatchJob(StartBatchJobRequest startBatchJobRequest) Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
- Parameters:
startBatchJobRequest
-- Returns:
- A Java Future containing the result of the StartBatchJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startBatchJob
default CompletableFuture<StartBatchJobResponse> startBatchJob(Consumer<StartBatchJobRequest.Builder> startBatchJobRequest) Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
This is a convenience which creates an instance of the
StartBatchJobRequest.Builder
avoiding the need to create one manually viaStartBatchJobRequest.builder()
- Parameters:
startBatchJobRequest
- AConsumer
that will call methods onStartBatchJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartBatchJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopApplication
default CompletableFuture<StopApplicationResponse> stopApplication(StopApplicationRequest stopApplicationRequest) Stops a running application.
- Parameters:
stopApplicationRequest
-- Returns:
- A Java Future containing the result of the StopApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopApplication
default CompletableFuture<StopApplicationResponse> stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest) Stops a running application.
This is a convenience which creates an instance of the
StopApplicationRequest.Builder
avoiding the need to create one manually viaStopApplicationRequest.builder()
- Parameters:
stopApplicationRequest
- AConsumer
that will call methods onStopApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds one or more tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates an application and creates a new version.
- Parameters:
updateApplicationRequest
-- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates an application and creates a new version.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Updates the configuration details for a specific runtime environment.
- Parameters:
updateEnvironmentRequest
-- Returns:
- A Java Future containing the result of the UpdateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates the configuration details for a specific runtime environment.
This is a convenience which creates an instance of the
UpdateEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentRequest.builder()
- Parameters:
updateEnvironmentRequest
- AConsumer
that will call methods onUpdateEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.
- ThrottlingException The number of requests made exceeds the limit.
- AccessDeniedException The account or role doesn't have the right permissions to make the request.
- ConflictException The parameters provided in the request conflict with existing resources.
- ValidationException One or more parameters provided in the request is not valid.
- InternalServerException An unexpected error occurred during the processing of the 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.
- M2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aM2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aM2AsyncClient
.
-