AWSMainframeModernization (AWS SDK for Java

All Known Subinterfaces:

AWSMainframeModernizationAsync

All Known Implementing Classes:

AbstractAWSMainframeModernization, AbstractAWSMainframeModernizationAsync, AWSMainframeModernizationAsyncClient, AWSMainframeModernizationClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMainframeModernization
```
Interface for accessing AWSMainframeModernization.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMainframeModernization instead.

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

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelBatchJobExecutionResult`	`cancelBatchJobExecution(CancelBatchJobExecutionRequest cancelBatchJobExecutionRequest)` Cancels the running of a specific batch job execution.
`CreateApplicationResult`	`createApplication(CreateApplicationRequest createApplicationRequest)` Creates a new application with given parameters.
`CreateDataSetImportTaskResult`	`createDataSetImportTask(CreateDataSetImportTaskRequest createDataSetImportTaskRequest)` Starts a data set import task for a specific application.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest createDeploymentRequest)` Creates and starts a deployment to deploy an application into an environment.
`CreateEnvironmentResult`	`createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)` Creates a runtime environment for a given runtime engine.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest deleteApplicationRequest)` Deletes a specific application.
`DeleteApplicationFromEnvironmentResult`	`deleteApplicationFromEnvironment(DeleteApplicationFromEnvironmentRequest deleteApplicationFromEnvironmentRequest)` Deletes a specific application from a specified environment where it has been previously deployed.
`DeleteEnvironmentResult`	`deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)` Deletes a specific environment.
`GetApplicationResult`	`getApplication(GetApplicationRequest getApplicationRequest)` Describes the details of a specific application.
`GetApplicationVersionResult`	`getApplicationVersion(GetApplicationVersionRequest getApplicationVersionRequest)` Returns details about a specific version of a specific application.
`GetBatchJobExecutionResult`	`getBatchJobExecution(GetBatchJobExecutionRequest getBatchJobExecutionRequest)` 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 getDataSetDetailsRequest)` Gets the details of a specific data set.
`GetDataSetImportTaskResult`	`getDataSetImportTask(GetDataSetImportTaskRequest getDataSetImportTaskRequest)` Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
`GetDeploymentResult`	`getDeployment(GetDeploymentRequest getDeploymentRequest)` Gets details of a specific deployment with a given deployment identifier.
`GetEnvironmentResult`	`getEnvironment(GetEnvironmentRequest getEnvironmentRequest)` Describes a specific runtime environment.
`ListApplicationsResult`	`listApplications(ListApplicationsRequest listApplicationsRequest)` Lists the applications associated with a specific Amazon Web Services account.
`ListApplicationVersionsResult`	`listApplicationVersions(ListApplicationVersionsRequest listApplicationVersionsRequest)` Returns a list of the application versions for a specific application.
`ListBatchJobDefinitionsResult`	`listBatchJobDefinitions(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest)` Lists all the available batch job definitions based on the batch job resources uploaded during the application creation.
`ListBatchJobExecutionsResult`	`listBatchJobExecutions(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest)` Lists historical, current, and scheduled batch job executions for a specific application.
`ListDataSetImportHistoryResult`	`listDataSetImportHistory(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest)` Lists the data set imports for the specified application.
`ListDataSetsResult`	`listDataSets(ListDataSetsRequest listDataSetsRequest)` Lists the data sets imported for a specific application.
`ListDeploymentsResult`	`listDeployments(ListDeploymentsRequest listDeploymentsRequest)` Returns a list of all deployments of a specific application.
`ListEngineVersionsResult`	`listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest)` Lists the available engine versions.
`ListEnvironmentsResult`	`listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)` Lists the runtime environments.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` 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 startApplicationRequest)` Starts an application that is currently stopped.
`StartBatchJobResult`	`startBatchJob(StartBatchJobRequest startBatchJobRequest)` Starts a batch job and returns the unique identifier of this execution of the batch job.
`StopApplicationResult`	`stopApplication(StopApplicationRequest stopApplicationRequest)` Stops a running application.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds one or more tags to the specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags from the specified resource.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest updateApplicationRequest)` Updates an application and creates a new version.
`UpdateEnvironmentResult`	`updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)` Updates the configuration details for a specific environment.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - cancelBatchJobExecution
```
CancelBatchJobExecutionResult cancelBatchJobExecution(CancelBatchJobExecutionRequest cancelBatchJobExecutionRequest)
```
    Cancels the running of a specific batch job execution.
    
    Parameters:
    
    cancelBatchJobExecutionRequest -
    
    Returns:
    
    Result of the CancelBatchJobExecution operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
```
    Creates a new application with given parameters. Requires an existing environment and application definition file.
    
    Parameters:
    
    createApplicationRequest -
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDataSetImportTask
```
CreateDataSetImportTaskResult createDataSetImportTask(CreateDataSetImportTaskRequest createDataSetImportTaskRequest)
```
    Starts a data set import task for a specific application.
    
    Parameters:
    
    createDataSetImportTaskRequest -
    
    Returns:
    
    Result of the CreateDataSetImportTask operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDeployment
```
CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
```
    Creates and starts a deployment to deploy an application into an environment.
    
    Parameters:
    
    createDeploymentRequest -
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createEnvironment
```
CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
```
    Creates a runtime environment for a given runtime engine.
    
    Parameters:
    
    createEnvironmentRequest -
    
    Returns:
    
    Result of the CreateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteApplication
```
DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
```
    Deletes a specific application. You cannot delete a running application.
    
    Parameters:
    
    deleteApplicationRequest -
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteApplicationFromEnvironment
```
DeleteApplicationFromEnvironmentResult deleteApplicationFromEnvironment(DeleteApplicationFromEnvironmentRequest deleteApplicationFromEnvironmentRequest)
```
    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.
    
    Parameters:
    
    deleteApplicationFromEnvironmentRequest -
    
    Returns:
    
    Result of the DeleteApplicationFromEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironment
```
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
```
    Deletes a specific 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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getApplication
```
GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
```
    Describes the details of a specific application.
    
    Parameters:
    
    getApplicationRequest -
    
    Returns:
    
    Result of the GetApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getApplicationVersion
```
GetApplicationVersionResult getApplicationVersion(GetApplicationVersionRequest getApplicationVersionRequest)
```
    Returns details about a specific version of a specific application.
    
    Parameters:
    
    getApplicationVersionRequest -
    
    Returns:
    
    Result of the GetApplicationVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBatchJobExecution
```
GetBatchJobExecutionResult getBatchJobExecution(GetBatchJobExecutionRequest getBatchJobExecutionRequest)
```
    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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getDataSetDetails
```
GetDataSetDetailsResult getDataSetDetails(GetDataSetDetailsRequest getDataSetDetailsRequest)
```
    Gets the details of a specific data set.
    
    Parameters:
    
    getDataSetDetailsRequest -
    
    Returns:
    
    Result of the GetDataSetDetails operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getDataSetImportTask
```
GetDataSetImportTaskResult getDataSetImportTask(GetDataSetImportTaskRequest getDataSetImportTaskRequest)
```
    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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getDeployment
```
GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
```
    Gets details of a specific deployment with a given deployment identifier.
    
    Parameters:
    
    getDeploymentRequest -
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnvironment
```
GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
```
    Describes a specific runtime environment.
    
    Parameters:
    
    getEnvironmentRequest -
    
    Returns:
    
    Result of the GetEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listApplicationVersions
```
ListApplicationVersionsResult listApplicationVersions(ListApplicationVersionsRequest listApplicationVersionsRequest)
```
    Returns a list of the application versions for a specific application.
    
    Parameters:
    
    listApplicationVersionsRequest -
    
    Returns:
    
    Result of the ListApplicationVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listApplications
```
ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
```
    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.
    
    Parameters:
    
    listApplicationsRequest -
    
    Returns:
    
    Result of the ListApplications operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listBatchJobDefinitions
```
ListBatchJobDefinitionsResult listBatchJobDefinitions(ListBatchJobDefinitionsRequest listBatchJobDefinitionsRequest)
```
    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.
    
    Parameters:
    
    listBatchJobDefinitionsRequest -
    
    Returns:
    
    Result of the ListBatchJobDefinitions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listBatchJobExecutions
```
ListBatchJobExecutionsResult listBatchJobExecutions(ListBatchJobExecutionsRequest listBatchJobExecutionsRequest)
```
    Lists historical, current, and scheduled batch job executions for a specific application.
    
    Parameters:
    
    listBatchJobExecutionsRequest -
    
    Returns:
    
    Result of the ListBatchJobExecutions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDataSetImportHistory
```
ListDataSetImportHistoryResult listDataSetImportHistory(ListDataSetImportHistoryRequest listDataSetImportHistoryRequest)
```
    Lists the data set imports for the specified application.
    
    Parameters:
    
    listDataSetImportHistoryRequest -
    
    Returns:
    
    Result of the ListDataSetImportHistory operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDataSets
```
ListDataSetsResult listDataSets(ListDataSetsRequest listDataSetsRequest)
```
    Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on 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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDeployments
```
ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)
```
    Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
    
    Parameters:
    
    listDeploymentsRequest -
    
    Returns:
    
    Result of the ListDeployments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEngineVersions
```
ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest)
```
    Lists the available engine versions.
    
    Parameters:
    
    listEngineVersionsRequest -
    
    Returns:
    
    Result of the ListEngineVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnvironments
```
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
```
    Lists the runtime environments.
    
    Parameters:
    
    listEnvironmentsRequest -
    
    Returns:
    
    Result of the ListEnvironments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists the tags for the specified resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startApplication
```
StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest)
```
    Starts an application that is currently stopped.
    
    Parameters:
    
    startApplicationRequest -
    
    Returns:
    
    Result of the StartApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startBatchJob
```
StartBatchJobResult startBatchJob(StartBatchJobRequest startBatchJobRequest)
```
    Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
    
    Parameters:
    
    startBatchJobRequest -
    
    Returns:
    
    Result of the StartBatchJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopApplication
```
StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest)
```
    Stops a running application.
    
    Parameters:
    
    stopApplicationRequest -
    
    Returns:
    
    Result of the StopApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds one or more tags to the specified resource.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes one or more tags from the specified resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
```
    Updates an application and creates a new version.
    
    Parameters:
    
    updateApplicationRequest -
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironment
```
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
```
    Updates the configuration details for a specific environment.
    
    Parameters:
    
    updateEnvironmentRequest -
    
    Returns:
    
    Result of the UpdateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSMainframeModernization

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

cancelBatchJobExecution

createApplication

createDataSetImportTask

createDeployment

createEnvironment

deleteApplication

deleteApplicationFromEnvironment

deleteEnvironment

getApplication

getApplicationVersion

getBatchJobExecution

getDataSetDetails

getDataSetImportTask

getDeployment

getEnvironment

listApplicationVersions

listApplications

listBatchJobDefinitions

listBatchJobExecutions

listDataSetImportHistory

listDataSets

listDeployments

listEngineVersions

listEnvironments

listTagsForResource

startApplication

startBatchJob

stopApplication

tagResource

untagResource

updateApplication

updateEnvironment

shutdown

getCachedResponseMetadata