@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSMainframeModernizationClient extends AmazonWebServiceClient implements AWSMainframeModernization
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSMainframeModernizationClientBuilder |
builder() |
CancelBatchJobExecutionResult |
cancelBatchJobExecution(CancelBatchJobExecutionRequest request)
Cancels the running of a specific batch job execution.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest request)
Creates a new application with given parameters.
|
CreateDataSetImportTaskResult |
createDataSetImportTask(CreateDataSetImportTaskRequest request)
Starts a data set import task for a specific application.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest request)
Creates and starts a deployment to deploy an application into an environment.
|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest request)
Creates a runtime environment for a given runtime engine.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest request)
Deletes a specific application.
|
DeleteApplicationFromEnvironmentResult |
deleteApplicationFromEnvironment(DeleteApplicationFromEnvironmentRequest request)
Deletes a specific application from a specified environment where it has been previously deployed.
|
DeleteEnvironmentResult |
deleteEnvironment(DeleteEnvironmentRequest request)
Deletes a specific environment.
|
GetApplicationResult |
getApplication(GetApplicationRequest request)
Describes the details of a specific application.
|
GetApplicationVersionResult |
getApplicationVersion(GetApplicationVersionRequest request)
Returns details about a specific version of a specific application.
|
GetBatchJobExecutionResult |
getBatchJobExecution(GetBatchJobExecutionRequest request)
Gets the details of a specific batch job execution for a specific application.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataSetDetailsResult |
getDataSetDetails(GetDataSetDetailsRequest request)
Gets the details of a specific data set.
|
GetDataSetImportTaskResult |
getDataSetImportTask(GetDataSetImportTaskRequest request)
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest request)
Gets details of a specific deployment with a given deployment identifier.
|
GetEnvironmentResult |
getEnvironment(GetEnvironmentRequest request)
Describes a specific runtime environment.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest request)
Lists the applications associated with a specific Amazon Web Services account.
|
ListApplicationVersionsResult |
listApplicationVersions(ListApplicationVersionsRequest request)
Returns a list of the application versions for a specific application.
|
ListBatchJobDefinitionsResult |
listBatchJobDefinitions(ListBatchJobDefinitionsRequest request)
Lists all the available batch job definitions based on the batch job resources uploaded during the application
creation.
|
ListBatchJobExecutionsResult |
listBatchJobExecutions(ListBatchJobExecutionsRequest request)
Lists historical, current, and scheduled batch job executions for a specific application.
|
ListDataSetImportHistoryResult |
listDataSetImportHistory(ListDataSetImportHistoryRequest request)
Lists the data set imports for the specified application.
|
ListDataSetsResult |
listDataSets(ListDataSetsRequest request)
Lists the data sets imported for a specific application.
|
ListDeploymentsResult |
listDeployments(ListDeploymentsRequest request)
Returns a list of all deployments of a specific application.
|
ListEngineVersionsResult |
listEngineVersions(ListEngineVersionsRequest request)
Lists the available engine versions.
|
ListEnvironmentsResult |
listEnvironments(ListEnvironmentsRequest request)
Lists the runtime environments.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartApplicationResult |
startApplication(StartApplicationRequest request)
Starts an application that is currently stopped.
|
StartBatchJobResult |
startBatchJob(StartBatchJobRequest request)
Starts a batch job and returns the unique identifier of this execution of the batch job.
|
StopApplicationResult |
stopApplication(StopApplicationRequest request)
Stops a running application.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest request)
Updates an application and creates a new version.
|
UpdateEnvironmentResult |
updateEnvironment(UpdateEnvironmentRequest request)
Updates the configuration details for a specific environment.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSMainframeModernizationClientBuilder builder()
public CancelBatchJobExecutionResult cancelBatchJobExecution(CancelBatchJobExecutionRequest request)
Cancels the running of a specific batch job execution.
cancelBatchJobExecution
in interface AWSMainframeModernization
cancelBatchJobExecutionRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public CreateApplicationResult createApplication(CreateApplicationRequest request)
Creates a new application with given parameters. Requires an existing environment and application definition file.
createApplication
in interface AWSMainframeModernization
createApplicationRequest
- ValidationException
- One or more parameters provided in the request is not valid.ServiceQuotaExceededException
- One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.public CreateDataSetImportTaskResult createDataSetImportTask(CreateDataSetImportTaskRequest request)
Starts a data set import task for a specific application.
createDataSetImportTask
in interface AWSMainframeModernization
createDataSetImportTaskRequest
- ValidationException
- One or more parameters provided in the request is not valid.ServiceQuotaExceededException
- One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
Creates and starts a deployment to deploy an application into an environment.
createDeployment
in interface AWSMainframeModernization
createDeploymentRequest
- ValidationException
- One or more parameters provided in the request is not valid.ServiceQuotaExceededException
- One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
Creates a runtime environment for a given runtime engine.
createEnvironment
in interface AWSMainframeModernization
createEnvironmentRequest
- ValidationException
- One or more parameters provided in the request is not valid.ServiceQuotaExceededException
- One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
Deletes a specific application. You cannot delete a running application.
deleteApplication
in interface AWSMainframeModernization
deleteApplicationRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.public DeleteApplicationFromEnvironmentResult deleteApplicationFromEnvironment(DeleteApplicationFromEnvironmentRequest request)
Deletes a specific application from a specified environment where it has been previously deployed. You cannot delete an environment using DeleteEnvironment, if any application has ever been deployed to it. This API removes the association of the application with the environment so you can delete the environment smoothly.
deleteApplicationFromEnvironment
in interface AWSMainframeModernization
deleteApplicationFromEnvironmentRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
Deletes a specific environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
deleteEnvironment
in interface AWSMainframeModernization
deleteEnvironmentRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.public GetApplicationResult getApplication(GetApplicationRequest request)
Describes the details of a specific application.
getApplication
in interface AWSMainframeModernization
getApplicationRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public GetApplicationVersionResult getApplicationVersion(GetApplicationVersionRequest request)
Returns details about a specific version of a specific application.
getApplicationVersion
in interface AWSMainframeModernization
getApplicationVersionRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public GetBatchJobExecutionResult getBatchJobExecution(GetBatchJobExecutionRequest request)
Gets the details of a specific batch job execution for a specific application.
getBatchJobExecution
in interface AWSMainframeModernization
getBatchJobExecutionRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public GetDataSetDetailsResult getDataSetDetails(GetDataSetDetailsRequest request)
Gets the details of a specific data set.
getDataSetDetails
in interface AWSMainframeModernization
getDataSetDetailsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public GetDataSetImportTaskResult getDataSetImportTask(GetDataSetImportTaskRequest request)
Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
getDataSetImportTask
in interface AWSMainframeModernization
getDataSetImportTaskRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public GetDeploymentResult getDeployment(GetDeploymentRequest request)
Gets details of a specific deployment with a given deployment identifier.
getDeployment
in interface AWSMainframeModernization
getDeploymentRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
Describes a specific runtime environment.
getEnvironment
in interface AWSMainframeModernization
getEnvironmentRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ListApplicationVersionsResult listApplicationVersions(ListApplicationVersionsRequest request)
Returns a list of the application versions for a specific application.
listApplicationVersions
in interface AWSMainframeModernization
listApplicationVersionsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ListApplicationsResult listApplications(ListApplicationsRequest request)
Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific environment in a query parameter to see all applications associated with that environment.
listApplications
in interface AWSMainframeModernization
listApplicationsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.public ListBatchJobDefinitionsResult listBatchJobDefinitions(ListBatchJobDefinitionsRequest request)
Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. The listed batch job definitions can then be used to start a batch job.
listBatchJobDefinitions
in interface AWSMainframeModernization
listBatchJobDefinitionsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ListBatchJobExecutionsResult listBatchJobExecutions(ListBatchJobExecutionsRequest request)
Lists historical, current, and scheduled batch job executions for a specific application.
listBatchJobExecutions
in interface AWSMainframeModernization
listBatchJobExecutionsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ListDataSetImportHistoryResult listDataSetImportHistory(ListDataSetImportHistoryRequest request)
Lists the data set imports for the specified application.
listDataSetImportHistory
in interface AWSMainframeModernization
listDataSetImportHistoryRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ListDataSetsResult listDataSets(ListDataSetsRequest request)
Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.
listDataSets
in interface AWSMainframeModernization
listDataSetsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
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.
listDeployments
in interface AWSMainframeModernization
listDeploymentsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest request)
Lists the available engine versions.
listEngineVersions
in interface AWSMainframeModernization
listEngineVersionsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
Lists the runtime environments.
listEnvironments
in interface AWSMainframeModernization
listEnvironmentsRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
listTagsForResource
in interface AWSMainframeModernization
listTagsForResourceRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public StartApplicationResult startApplication(StartApplicationRequest request)
Starts an application that is currently stopped.
startApplication
in interface AWSMainframeModernization
startApplicationRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public StartBatchJobResult startBatchJob(StartBatchJobRequest request)
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.
startBatchJob
in interface AWSMainframeModernization
startBatchJobRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public StopApplicationResult stopApplication(StopApplicationRequest request)
Stops a running application.
stopApplication
in interface AWSMainframeModernization
stopApplicationRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to the specified resource.
tagResource
in interface AWSMainframeModernization
tagResourceRequest
- ValidationException
- One or more parameters provided in the request is not valid.ServiceQuotaExceededException
- One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
untagResource
in interface AWSMainframeModernization
untagResourceRequest
- ValidationException
- One or more parameters provided in the request is not valid.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
Updates an application and creates a new version.
updateApplication
in interface AWSMainframeModernization
updateApplicationRequest
- ValidationException
- One or more parameters provided in the request is not valid.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
Updates the configuration details for a specific environment.
updateEnvironment
in interface AWSMainframeModernization
updateEnvironmentRequest
- ValidationException
- One or more parameters provided in the request is not valid.ServiceQuotaExceededException
- One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.ConflictException
- The parameters provided in the request conflict with existing resources.InternalServerException
- An unexpected error occurred during the processing of the request.AccessDeniedException
- The account or role doesn't have the right permissions to make the request.ThrottlingException
- The number of requests made exceeds the limit.ResourceNotFoundException
- The specified resource was not found.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSMainframeModernization
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSMainframeModernization
shutdown
in class AmazonWebServiceClient