Interface M2Client
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 M2ClientBuilder
builder()
Create a builder that can be used to configure and create aM2Client
.default CancelBatchJobExecutionResponse
cancelBatchJobExecution
(Consumer<CancelBatchJobExecutionRequest.Builder> cancelBatchJobExecutionRequest) Cancels the running of a specific batch job execution.default CancelBatchJobExecutionResponse
cancelBatchJobExecution
(CancelBatchJobExecutionRequest cancelBatchJobExecutionRequest) Cancels the running of a specific batch job execution.static M2Client
create()
Create aM2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateApplicationResponse
createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates a new application with given parameters.default CreateApplicationResponse
createApplication
(CreateApplicationRequest createApplicationRequest) Creates a new application with given parameters.default CreateDataSetImportTaskResponse
createDataSetImportTask
(Consumer<CreateDataSetImportTaskRequest.Builder> createDataSetImportTaskRequest) Starts a data set import task for a specific application.default CreateDataSetImportTaskResponse
createDataSetImportTask
(CreateDataSetImportTaskRequest createDataSetImportTaskRequest) Starts a data set import task for a specific application.default CreateDeploymentResponse
createDeployment
(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Creates and starts a deployment to deploy an application into a runtime environment.default CreateDeploymentResponse
createDeployment
(CreateDeploymentRequest createDeploymentRequest) Creates and starts a deployment to deploy an application into a runtime environment.default CreateEnvironmentResponse
createEnvironment
(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates a runtime environment for a given runtime engine.default CreateEnvironmentResponse
createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Creates a runtime environment for a given runtime engine.default DeleteApplicationResponse
deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes a specific application.default DeleteApplicationResponse
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.default DeleteEnvironmentResponse
deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes a specific runtime environment.default DeleteEnvironmentResponse
deleteEnvironment
(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes a specific runtime environment.default GetApplicationResponse
getApplication
(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Describes the details of a specific application.default GetApplicationResponse
getApplication
(GetApplicationRequest getApplicationRequest) Describes the details of a specific application.default GetApplicationVersionResponse
getApplicationVersion
(Consumer<GetApplicationVersionRequest.Builder> getApplicationVersionRequest) Returns details about a specific version of a specific application.default GetApplicationVersionResponse
getApplicationVersion
(GetApplicationVersionRequest getApplicationVersionRequest) Returns details about a specific version of a specific application.default GetBatchJobExecutionResponse
getBatchJobExecution
(Consumer<GetBatchJobExecutionRequest.Builder> getBatchJobExecutionRequest) Gets the details of a specific batch job execution for a specific application.default GetBatchJobExecutionResponse
getBatchJobExecution
(GetBatchJobExecutionRequest getBatchJobExecutionRequest) Gets the details of a specific batch job execution for a specific application.default GetDataSetDetailsResponse
getDataSetDetails
(Consumer<GetDataSetDetailsRequest.Builder> getDataSetDetailsRequest) Gets the details of a specific data set.default GetDataSetDetailsResponse
getDataSetDetails
(GetDataSetDetailsRequest getDataSetDetailsRequest) Gets the details of a specific data set.default GetDataSetImportTaskResponse
getDataSetImportTask
(Consumer<GetDataSetImportTaskRequest.Builder> getDataSetImportTaskRequest) Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.default GetDataSetImportTaskResponse
getDataSetImportTask
(GetDataSetImportTaskRequest getDataSetImportTaskRequest) Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.default GetDeploymentResponse
getDeployment
(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Gets details of a specific deployment with a given deployment identifier.default GetDeploymentResponse
getDeployment
(GetDeploymentRequest getDeploymentRequest) Gets details of a specific deployment with a given deployment identifier.default GetEnvironmentResponse
getEnvironment
(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Describes a specific runtime environment.default GetEnvironmentResponse
getEnvironment
(GetEnvironmentRequest getEnvironmentRequest) Describes a specific runtime environment.default GetSignedBluinsightsUrlResponse
getSignedBluinsightsUrl
(Consumer<GetSignedBluinsightsUrlRequest.Builder> getSignedBluinsightsUrlRequest) Gets a single sign-on URL that can be used to connect to AWS Blu Insights.default GetSignedBluinsightsUrlResponse
getSignedBluinsightsUrl
(GetSignedBluinsightsUrlRequest getSignedBluinsightsUrlRequest) Gets a single sign-on URL that can be used to connect to AWS Blu Insights.default ListApplicationsResponse
listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists the applications associated with a specific Amazon Web Services account.default ListApplicationsResponse
listApplications
(ListApplicationsRequest listApplicationsRequest) Lists the applications associated with a specific Amazon Web Services account.default ListApplicationsIterable
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation.default ListApplicationsIterable
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation.default ListApplicationVersionsResponse
listApplicationVersions
(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) Returns a list of the application versions for a specific application.default ListApplicationVersionsResponse
listApplicationVersions
(ListApplicationVersionsRequest listApplicationVersionsRequest) Returns a list of the application versions for a specific application.default ListApplicationVersionsIterable
listApplicationVersionsPaginator
(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) This is a variant oflistApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation.default ListApplicationVersionsIterable
listApplicationVersionsPaginator
(ListApplicationVersionsRequest listApplicationVersionsRequest) This is a variant oflistApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation.default ListBatchJobDefinitionsResponse
listBatchJobDefinitions
(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.default ListBatchJobDefinitionsResponse
listBatchJobDefinitions
(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.default ListBatchJobDefinitionsIterable
listBatchJobDefinitionsPaginator
(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) This is a variant oflistBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation.default ListBatchJobDefinitionsIterable
listBatchJobDefinitionsPaginator
(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) This is a variant oflistBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation.default ListBatchJobExecutionsResponse
listBatchJobExecutions
(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) Lists historical, current, and scheduled batch job executions for a specific application.default ListBatchJobExecutionsResponse
listBatchJobExecutions
(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest) Lists historical, current, and scheduled batch job executions for a specific application.default ListBatchJobExecutionsIterable
listBatchJobExecutionsPaginator
(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) This is a variant oflistBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation.default ListBatchJobExecutionsIterable
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.default ListDataSetImportHistoryResponse
listDataSetImportHistory
(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) Lists the data set imports for the specified application.default ListDataSetImportHistoryResponse
listDataSetImportHistory
(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) Lists the data set imports for the specified application.default ListDataSetImportHistoryIterable
listDataSetImportHistoryPaginator
(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) This is a variant oflistDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation.default ListDataSetImportHistoryIterable
listDataSetImportHistoryPaginator
(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) This is a variant oflistDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation.default ListDataSetsResponse
listDataSets
(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) Lists the data sets imported for a specific application.default ListDataSetsResponse
listDataSets
(ListDataSetsRequest listDataSetsRequest) Lists the data sets imported for a specific application.default ListDataSetsIterable
listDataSetsPaginator
(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) This is a variant oflistDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation.default ListDataSetsIterable
listDataSetsPaginator
(ListDataSetsRequest listDataSetsRequest) This is a variant oflistDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation.default ListDeploymentsResponse
listDeployments
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Returns a list of all deployments of a specific application.default ListDeploymentsResponse
listDeployments
(ListDeploymentsRequest listDeploymentsRequest) Returns a list of all deployments of a specific application.default ListDeploymentsIterable
listDeploymentsPaginator
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation.default ListDeploymentsIterable
listDeploymentsPaginator
(ListDeploymentsRequest listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation.default ListEngineVersionsResponse
listEngineVersions
(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) Lists the available engine versions.default ListEngineVersionsResponse
listEngineVersions
(ListEngineVersionsRequest listEngineVersionsRequest) Lists the available engine versions.default ListEngineVersionsIterable
listEngineVersionsPaginator
(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) This is a variant oflistEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation.default ListEngineVersionsIterable
listEngineVersionsPaginator
(ListEngineVersionsRequest listEngineVersionsRequest) This is a variant oflistEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation.default ListEnvironmentsResponse
listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists the runtime environments.default ListEnvironmentsResponse
listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) Lists the runtime environments.default ListEnvironmentsIterable
listEnvironmentsPaginator
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsIterable
listEnvironmentsPaginator
(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.default ListTagsForResourceResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default StartApplicationResponse
startApplication
(Consumer<StartApplicationRequest.Builder> startApplicationRequest) Starts an application that is currently stopped.default StartApplicationResponse
startApplication
(StartApplicationRequest startApplicationRequest) Starts an application that is currently stopped.default StartBatchJobResponse
startBatchJob
(Consumer<StartBatchJobRequest.Builder> startBatchJobRequest) Starts a batch job and returns the unique identifier of this execution of the batch job.default StartBatchJobResponse
startBatchJob
(StartBatchJobRequest startBatchJobRequest) Starts a batch job and returns the unique identifier of this execution of the batch job.default StopApplicationResponse
stopApplication
(Consumer<StopApplicationRequest.Builder> stopApplicationRequest) Stops a running application.default StopApplicationResponse
stopApplication
(StopApplicationRequest stopApplicationRequest) Stops a running application.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to the specified resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to the specified resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.default UpdateApplicationResponse
updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates an application and creates a new version.default UpdateApplicationResponse
updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates an application and creates a new version.default UpdateEnvironmentResponse
updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates the configuration details for a specific runtime environment.default UpdateEnvironmentResponse
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 CancelBatchJobExecutionResponse cancelBatchJobExecution(CancelBatchJobExecutionRequest cancelBatchJobExecutionRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Cancels the running of a specific batch job execution.
- Parameters:
cancelBatchJobExecutionRequest
-- Returns:
- Result of the CancelBatchJobExecution operation returned by the service.
- See Also:
-
cancelBatchJobExecution
default CancelBatchJobExecutionResponse cancelBatchJobExecution(Consumer<CancelBatchJobExecutionRequest.Builder> cancelBatchJobExecutionRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the CancelBatchJobExecution operation returned by the service.
- See Also:
-
createApplication
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
- Parameters:
createApplicationRequest
-- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
-
createApplication
default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the CreateApplication operation returned by the service.
- See Also:
-
createDataSetImportTask
default CreateDataSetImportTaskResponse createDataSetImportTask(CreateDataSetImportTaskRequest createDataSetImportTaskRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Starts a data set import task for a specific application.
- Parameters:
createDataSetImportTaskRequest
-- Returns:
- Result of the CreateDataSetImportTask operation returned by the service.
- See Also:
-
createDataSetImportTask
default CreateDataSetImportTaskResponse createDataSetImportTask(Consumer<CreateDataSetImportTaskRequest.Builder> createDataSetImportTaskRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the CreateDataSetImportTask operation returned by the service.
- See Also:
-
createDeployment
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Creates and starts a deployment to deploy an application into a runtime environment.
- Parameters:
createDeploymentRequest
-- Returns:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
createDeployment
default CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
createEnvironment
default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Creates a runtime environment for a given runtime engine.
- Parameters:
createEnvironmentRequest
-- Returns:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
createEnvironment
default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
deleteApplication
default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Deletes a specific application. You cannot delete a running application.
- Parameters:
deleteApplicationRequest
-- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
-
deleteApplication
default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the DeleteApplication operation returned by the service.
- See Also:
-
deleteApplicationFromEnvironment
default DeleteApplicationFromEnvironmentResponse deleteApplicationFromEnvironment(DeleteApplicationFromEnvironmentRequest deleteApplicationFromEnvironmentRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the DeleteApplicationFromEnvironment operation returned by the service.
- See Also:
-
deleteApplicationFromEnvironment
default DeleteApplicationFromEnvironmentResponse deleteApplicationFromEnvironment(Consumer<DeleteApplicationFromEnvironmentRequest.Builder> deleteApplicationFromEnvironmentRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the DeleteApplicationFromEnvironment operation returned by the service.
- See Also:
-
deleteEnvironment
default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) throws ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
deleteEnvironment
default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) throws ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
getApplication
default GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Describes the details of a specific application.
- Parameters:
getApplicationRequest
-- Returns:
- Result of the GetApplication operation returned by the service.
- See Also:
-
getApplication
default GetApplicationResponse getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetApplication operation returned by the service.
- See Also:
-
getApplicationVersion
default GetApplicationVersionResponse getApplicationVersion(GetApplicationVersionRequest getApplicationVersionRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Returns details about a specific version of a specific application.
- Parameters:
getApplicationVersionRequest
-- Returns:
- Result of the GetApplicationVersion operation returned by the service.
- See Also:
-
getApplicationVersion
default GetApplicationVersionResponse getApplicationVersion(Consumer<GetApplicationVersionRequest.Builder> getApplicationVersionRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetApplicationVersion operation returned by the service.
- See Also:
-
getBatchJobExecution
default GetBatchJobExecutionResponse getBatchJobExecution(GetBatchJobExecutionRequest getBatchJobExecutionRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Gets the details of a specific batch job execution for a specific application.
- Parameters:
getBatchJobExecutionRequest
-- Returns:
- Result of the GetBatchJobExecution operation returned by the service.
- See Also:
-
getBatchJobExecution
default GetBatchJobExecutionResponse getBatchJobExecution(Consumer<GetBatchJobExecutionRequest.Builder> getBatchJobExecutionRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetBatchJobExecution operation returned by the service.
- See Also:
-
getDataSetDetails
default GetDataSetDetailsResponse getDataSetDetails(GetDataSetDetailsRequest getDataSetDetailsRequest) throws ResourceNotFoundException, ExecutionTimeoutException, ServiceUnavailableException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Gets the details of a specific data set.
- Parameters:
getDataSetDetailsRequest
-- Returns:
- Result of the GetDataSetDetails operation returned by the service.
- See Also:
-
getDataSetDetails
default GetDataSetDetailsResponse getDataSetDetails(Consumer<GetDataSetDetailsRequest.Builder> getDataSetDetailsRequest) throws ResourceNotFoundException, ExecutionTimeoutException, ServiceUnavailableException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetDataSetDetails operation returned by the service.
- See Also:
-
getDataSetImportTask
default GetDataSetImportTaskResponse getDataSetImportTask(GetDataSetImportTaskRequest getDataSetImportTaskRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
- Parameters:
getDataSetImportTaskRequest
-- Returns:
- Result of the GetDataSetImportTask operation returned by the service.
- See Also:
-
getDataSetImportTask
default GetDataSetImportTaskResponse getDataSetImportTask(Consumer<GetDataSetImportTaskRequest.Builder> getDataSetImportTaskRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetDataSetImportTask operation returned by the service.
- See Also:
-
getDeployment
default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Gets details of a specific deployment with a given deployment identifier.
- Parameters:
getDeploymentRequest
-- Returns:
- Result of the GetDeployment operation returned by the service.
- See Also:
-
getDeployment
default GetDeploymentResponse getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetDeployment operation returned by the service.
- See Also:
-
getEnvironment
default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Describes a specific runtime environment.
- Parameters:
getEnvironmentRequest
-- Returns:
- Result of the GetEnvironment operation returned by the service.
- See Also:
-
getEnvironment
default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetEnvironment operation returned by the service.
- See Also:
-
getSignedBluinsightsUrl
default GetSignedBluinsightsUrlResponse getSignedBluinsightsUrl(GetSignedBluinsightsUrlRequest getSignedBluinsightsUrlRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
- Parameters:
getSignedBluinsightsUrlRequest
-- Returns:
- Result of the GetSignedBluinsightsUrl operation returned by the service.
- See Also:
-
getSignedBluinsightsUrl
default GetSignedBluinsightsUrlResponse getSignedBluinsightsUrl(Consumer<GetSignedBluinsightsUrlRequest.Builder> getSignedBluinsightsUrlRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the GetSignedBluinsightsUrl operation returned by the service.
- See Also:
-
listApplicationVersions
default ListApplicationVersionsResponse listApplicationVersions(ListApplicationVersionsRequest listApplicationVersionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Returns a list of the application versions for a specific application.
- Parameters:
listApplicationVersionsRequest
-- Returns:
- Result of the ListApplicationVersions operation returned by the service.
- See Also:
-
listApplicationVersions
default ListApplicationVersionsResponse listApplicationVersions(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListApplicationVersions operation returned by the service.
- See Also:
-
listApplicationVersionsPaginator
default ListApplicationVersionsIterable listApplicationVersionsPaginator(ListApplicationVersionsRequest listApplicationVersionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListApplicationVersionsIterable responses = client.listApplicationVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListApplicationVersionsIterable responses = client .listApplicationVersionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListApplicationVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListApplicationVersionsIterable responses = client.listApplicationVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation.- Parameters:
listApplicationVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listApplicationVersionsPaginator
default ListApplicationVersionsIterable listApplicationVersionsPaginator(Consumer<ListApplicationVersionsRequest.Builder> listApplicationVersionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listApplicationVersions(software.amazon.awssdk.services.m2.model.ListApplicationVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListApplicationVersionsIterable responses = client.listApplicationVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListApplicationVersionsIterable responses = client .listApplicationVersionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListApplicationVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListApplicationVersionsIterable responses = client.listApplicationVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listApplications
default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListApplications operation returned by the service.
- See Also:
-
listApplications
default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListApplications operation returned by the service.
- See Also:
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation.- Parameters:
listApplicationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listApplications(software.amazon.awssdk.services.m2.model.ListApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchJobDefinitions
default ListBatchJobDefinitionsResponse listBatchJobDefinitions(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListBatchJobDefinitions operation returned by the service.
- See Also:
-
listBatchJobDefinitions
default ListBatchJobDefinitionsResponse listBatchJobDefinitions(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListBatchJobDefinitions operation returned by the service.
- See Also:
-
listBatchJobDefinitionsPaginator
default ListBatchJobDefinitionsIterable listBatchJobDefinitionsPaginator(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsIterable responses = client.listBatchJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsIterable responses = client .listBatchJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsIterable responses = client.listBatchJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation.- Parameters:
listBatchJobDefinitionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchJobDefinitionsPaginator
default ListBatchJobDefinitionsIterable listBatchJobDefinitionsPaginator(Consumer<ListBatchJobDefinitionsRequest.Builder> listBatchJobDefinitionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listBatchJobDefinitions(software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsIterable responses = client.listBatchJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsIterable responses = client .listBatchJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListBatchJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListBatchJobDefinitionsIterable responses = client.listBatchJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchJobExecutions
default ListBatchJobExecutionsResponse listBatchJobExecutions(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Lists historical, current, and scheduled batch job executions for a specific application.
- Parameters:
listBatchJobExecutionsRequest
-- Returns:
- Result of the ListBatchJobExecutions operation returned by the service.
- See Also:
-
listBatchJobExecutions
default ListBatchJobExecutionsResponse listBatchJobExecutions(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListBatchJobExecutions operation returned by the service.
- See Also:
-
listBatchJobExecutionsPaginator
default ListBatchJobExecutionsIterable listBatchJobExecutionsPaginator(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsIterable responses = client.listBatchJobExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsIterable responses = client .listBatchJobExecutionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsIterable responses = client.listBatchJobExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation.- Parameters:
listBatchJobExecutionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchJobExecutionsPaginator
default ListBatchJobExecutionsIterable listBatchJobExecutionsPaginator(Consumer<ListBatchJobExecutionsRequest.Builder> listBatchJobExecutionsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listBatchJobExecutions(software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsIterable responses = client.listBatchJobExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsIterable responses = client .listBatchJobExecutionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListBatchJobExecutionsIterable responses = client.listBatchJobExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchJobRestartPoints
default ListBatchJobRestartPointsResponse listBatchJobRestartPoints(ListBatchJobRestartPointsRequest listBatchJobRestartPointsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListBatchJobRestartPoints operation returned by the service.
- See Also:
-
listBatchJobRestartPoints
default ListBatchJobRestartPointsResponse listBatchJobRestartPoints(Consumer<ListBatchJobRestartPointsRequest.Builder> listBatchJobRestartPointsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListBatchJobRestartPoints operation returned by the service.
- See Also:
-
listDataSetImportHistory
default ListDataSetImportHistoryResponse listDataSetImportHistory(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Lists the data set imports for the specified application.
- Parameters:
listDataSetImportHistoryRequest
-- Returns:
- Result of the ListDataSetImportHistory operation returned by the service.
- See Also:
-
listDataSetImportHistory
default ListDataSetImportHistoryResponse listDataSetImportHistory(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListDataSetImportHistory operation returned by the service.
- See Also:
-
listDataSetImportHistoryPaginator
default ListDataSetImportHistoryIterable listDataSetImportHistoryPaginator(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryIterable responses = client.listDataSetImportHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryIterable responses = client .listDataSetImportHistoryPaginator(request); for (software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryIterable responses = client.listDataSetImportHistoryPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation.- Parameters:
listDataSetImportHistoryRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSetImportHistoryPaginator
default ListDataSetImportHistoryIterable listDataSetImportHistoryPaginator(Consumer<ListDataSetImportHistoryRequest.Builder> listDataSetImportHistoryRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listDataSetImportHistory(software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryIterable responses = client.listDataSetImportHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryIterable responses = client .listDataSetImportHistoryPaginator(request); for (software.amazon.awssdk.services.m2.model.ListDataSetImportHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListDataSetImportHistoryIterable responses = client.listDataSetImportHistoryPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSets
default ListDataSetsResponse listDataSets(ListDataSetsRequest listDataSetsRequest) throws ResourceNotFoundException, ExecutionTimeoutException, ServiceUnavailableException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListDataSets operation returned by the service.
- See Also:
-
listDataSets
default ListDataSetsResponse listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws ResourceNotFoundException, ExecutionTimeoutException, ServiceUnavailableException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListDataSets operation returned by the service.
- See Also:
-
listDataSetsPaginator
default ListDataSetsIterable listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest) throws ResourceNotFoundException, ExecutionTimeoutException, ServiceUnavailableException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListDataSetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation.- Parameters:
listDataSetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSetsPaginator
default ListDataSetsIterable listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws ResourceNotFoundException, ExecutionTimeoutException, ServiceUnavailableException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listDataSets(software.amazon.awssdk.services.m2.model.ListDataSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListDataSetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listDeployments
default ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListDeployments operation returned by the service.
- See Also:
-
listDeployments
default ListDeploymentsResponse listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListDeployments operation returned by the service.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation.- Parameters:
listDeploymentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listDeployments(software.amazon.awssdk.services.m2.model.ListDeploymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listEngineVersions
default ListEngineVersionsResponse listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Lists the available engine versions.
- Parameters:
listEngineVersionsRequest
-- Returns:
- Result of the ListEngineVersions operation returned by the service.
- See Also:
-
listEngineVersions
default ListEngineVersionsResponse listEngineVersions(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListEngineVersions operation returned by the service.
- See Also:
-
listEngineVersionsPaginator
default ListEngineVersionsIterable listEngineVersionsPaginator(ListEngineVersionsRequest listEngineVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListEngineVersionsIterable responses = client .listEngineVersionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation.- Parameters:
listEngineVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEngineVersionsPaginator
default ListEngineVersionsIterable listEngineVersionsPaginator(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listEngineVersions(software.amazon.awssdk.services.m2.model.ListEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListEngineVersionsIterable responses = client .listEngineVersionsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironments
default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Lists the runtime environments.
- Parameters:
listEnvironmentsRequest
-- Returns:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironments
default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation.- Parameters:
listEnvironmentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception This is a variant of
listEnvironments(software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.m2.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.m2.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); for (software.amazon.awssdk.services.m2.model.ListEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.m2.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startApplication
default StartApplicationResponse startApplication(StartApplicationRequest startApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Starts an application that is currently stopped.
- Parameters:
startApplicationRequest
-- Returns:
- Result of the StartApplication operation returned by the service.
- See Also:
-
startApplication
default StartApplicationResponse startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the StartApplication operation returned by the service.
- See Also:
-
startBatchJob
default StartBatchJobResponse startBatchJob(StartBatchJobRequest startBatchJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the StartBatchJob operation returned by the service.
- See Also:
-
startBatchJob
default StartBatchJobResponse startBatchJob(Consumer<StartBatchJobRequest.Builder> startBatchJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the StartBatchJob operation returned by the service.
- See Also:
-
stopApplication
default StopApplicationResponse stopApplication(StopApplicationRequest stopApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Stops a running application.
- Parameters:
stopApplicationRequest
-- Returns:
- Result of the StopApplication operation returned by the service.
- See Also:
-
stopApplication
default StopApplicationResponse stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the StopApplication operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Adds one or more tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateApplication
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Updates an application and creates a new version.
- Parameters:
updateApplicationRequest
-- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
-
updateApplication
default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the UpdateApplication operation returned by the service.
- See Also:
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception Updates the configuration details for a specific runtime environment.
- Parameters:
updateEnvironmentRequest
-- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, M2Exception 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:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
create
Create aM2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aM2Client
. -
serviceMetadata
-
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
-