# Actions The following actions are supported: + [CancelBatchJobExecution](API_CancelBatchJobExecution.md) + [CreateApplication](API_CreateApplication.md) + [CreateDataSetExportTask](API_CreateDataSetExportTask.md) + [CreateDataSetImportTask](API_CreateDataSetImportTask.md) + [CreateDeployment](API_CreateDeployment.md) + [CreateEnvironment](API_CreateEnvironment.md) + [DeleteApplication](API_DeleteApplication.md) + [DeleteApplicationFromEnvironment](API_DeleteApplicationFromEnvironment.md) + [DeleteEnvironment](API_DeleteEnvironment.md) + [GetApplication](API_GetApplication.md) + [GetApplicationVersion](API_GetApplicationVersion.md) + [GetBatchJobExecution](API_GetBatchJobExecution.md) + [GetDataSetDetails](API_GetDataSetDetails.md) + [GetDataSetExportTask](API_GetDataSetExportTask.md) + [GetDataSetImportTask](API_GetDataSetImportTask.md) + [GetDeployment](API_GetDeployment.md) + [GetEnvironment](API_GetEnvironment.md) + [GetSignedBluinsightsUrl](API_GetSignedBluinsightsUrl.md) + [ListApplications](API_ListApplications.md) + [ListApplicationVersions](API_ListApplicationVersions.md) + [ListBatchJobDefinitions](API_ListBatchJobDefinitions.md) + [ListBatchJobExecutions](API_ListBatchJobExecutions.md) + [ListBatchJobRestartPoints](API_ListBatchJobRestartPoints.md) + [ListDataSetExportHistory](API_ListDataSetExportHistory.md) + [ListDataSetImportHistory](API_ListDataSetImportHistory.md) + [ListDataSets](API_ListDataSets.md) + [ListDeployments](API_ListDeployments.md) + [ListEngineVersions](API_ListEngineVersions.md) + [ListEnvironments](API_ListEnvironments.md) + [ListTagsForResource](API_ListTagsForResource.md) + [StartApplication](API_StartApplication.md) + [StartBatchJob](API_StartBatchJob.md) + [StopApplication](API_StopApplication.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateApplication](API_UpdateApplication.md) + [UpdateEnvironment](API_UpdateEnvironment.md) # CancelBatchJobExecution **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Cancels the running of a specific batch job execution. ## Request Syntax ``` POST /applications/applicationId/batch-job-executions/executionId/cancel HTTP/1.1 Content-type: application/json { "authSecretsManagerArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_CancelBatchJobExecution_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [executionId](#API_CancelBatchJobExecution_RequestSyntax) ** The unique identifier of the batch job execution. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [authSecretsManagerArn](#API_CancelBatchJobExecution_RequestSyntax) ** The AWS Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/CancelBatchJobExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/CancelBatchJobExecution) # CreateApplication **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Creates a new application with given parameters. Requires an existing runtime environment and application definition file. ## Request Syntax ``` POST /applications HTTP/1.1 Content-type: application/json { "clientToken": "string", "definition": { ... }, "description": "string", "engineType": "string", "kmsKeyId": "string", "name": "string", "roleArn": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_CreateApplication_RequestSyntax) ** A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive. It's generated by the client to ensure idempotent operations, allowing for safe retries without unintended side effects. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[!-~]+` Required: No ** [definition](#API_CreateApplication_RequestSyntax) ** The application definition for this application. You can specify either inline JSON or an S3 bucket location. Type: [Definition](API_Definition.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [description](#API_CreateApplication_RequestSyntax) ** The description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: No ** [engineType](#API_CreateApplication_RequestSyntax) ** The type of the target platform for this application. Type: String Valid Values: `microfocus | bluage` Required: Yes ** [kmsKeyId](#API_CreateApplication_RequestSyntax) ** The identifier of a customer managed key. Type: String Required: No ** [name](#API_CreateApplication_RequestSyntax) ** The unique identifier of the application. Type: String Pattern: `[A-Za-z0-9][A-Za-z0-9_\-]{1,59}` Required: Yes ** [roleArn](#API_CreateApplication_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies a role that the application uses to access AWS resources that are not part of the application or are in a different AWS account. Type: String Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` Required: No ** [tags](#API_CreateApplication_RequestSyntax) ** A list of tags to apply to the application. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `(?!aws:).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationArn": "string", "applicationId": "string", "applicationVersion": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationArn](#API_CreateApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the application. Type: String Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` ** [applicationId](#API_CreateApplication_ResponseSyntax) ** The unique application identifier. Type: String Pattern: `\S{1,80}` ** [applicationVersion](#API_CreateApplication_ResponseSyntax) ** The version number of the application. Type: Integer Valid Range: Minimum value of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ServiceQuotaExceededException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). One or more quotas for AWS Mainframe Modernization exceeds the limit. ** quotaCode ** The identifier of the exceeded quota. ** resourceId ** The ID of the resource that is exceeding the quota limit. ** resourceType ** The type of resource that is exceeding the quota limit for AWS Mainframe Modernization. ** serviceCode ** A code that identifies the service that the exceeded quota belongs to. HTTP Status Code: 402 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/CreateApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/CreateApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/CreateApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/CreateApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/CreateApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/CreateApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/CreateApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/CreateApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/CreateApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/CreateApplication) # CreateDataSetExportTask **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Starts a data set export task for a specific application. ## Request Syntax ``` POST /applications/applicationId/dataset-export-task HTTP/1.1 Content-type: application/json { "clientToken": "string", "exportConfig": { ... }, "kmsKeyId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_CreateDataSetExportTask_RequestSyntax) ** The unique identifier of the application for which you want to export data sets. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_CreateDataSetExportTask_RequestSyntax) ** Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set export. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[!-~]+` Required: No ** [exportConfig](#API_CreateDataSetExportTask_RequestSyntax) ** The data set export task configuration. Type: [DataSetExportConfig](API_DataSetExportConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [kmsKeyId](#API_CreateDataSetExportTask_RequestSyntax) ** The identifier of a customer managed key. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9:/_-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "taskId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [taskId](#API_CreateDataSetExportTask_ResponseSyntax) ** The task identifier. This operation is asynchronous. Use this identifier with the [GetDataSetExportTask](API_GetDataSetExportTask.md) operation to obtain the status of this task. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). One or more quotas for AWS Mainframe Modernization exceeds the limit. ** quotaCode ** The identifier of the exceeded quota. ** resourceId ** The ID of the resource that is exceeding the quota limit. ** resourceType ** The type of resource that is exceeding the quota limit for AWS Mainframe Modernization. ** serviceCode ** A code that identifies the service that the exceeded quota belongs to. HTTP Status Code: 402 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/CreateDataSetExportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/CreateDataSetExportTask) # CreateDataSetImportTask **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Starts a data set import task for a specific application. ## Request Syntax ``` POST /applications/applicationId/dataset-import-task HTTP/1.1 Content-type: application/json { "clientToken": "string", "importConfig": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_CreateDataSetImportTask_RequestSyntax) ** The unique identifier of the application for which you want to import data sets. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_CreateDataSetImportTask_RequestSyntax) ** Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set import. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[!-~]+` Required: No ** [importConfig](#API_CreateDataSetImportTask_RequestSyntax) ** The data set import task configuration. Type: [DataSetImportConfig](API_DataSetImportConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "taskId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [taskId](#API_CreateDataSetImportTask_ResponseSyntax) ** The task identifier. This operation is asynchronous. Use this identifier with the [GetDataSetImportTask](API_GetDataSetImportTask.md) operation to obtain the status of this task. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). One or more quotas for AWS Mainframe Modernization exceeds the limit. ** quotaCode ** The identifier of the exceeded quota. ** resourceId ** The ID of the resource that is exceeding the quota limit. ** resourceType ** The type of resource that is exceeding the quota limit for AWS Mainframe Modernization. ** serviceCode ** A code that identifies the service that the exceeded quota belongs to. HTTP Status Code: 402 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/CreateDataSetImportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/CreateDataSetImportTask) # CreateDeployment **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Creates and starts a deployment to deploy an application into a runtime environment. ## Request Syntax ``` POST /applications/applicationId/deployments HTTP/1.1 Content-type: application/json { "applicationVersion": number, "clientToken": "string", "environmentId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_CreateDeployment_RequestSyntax) ** The application identifier. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [applicationVersion](#API_CreateDeployment_RequestSyntax) ** The version of the application to deploy. Type: Integer Valid Range: Minimum value of 1. Required: Yes ** [clientToken](#API_CreateDeployment_RequestSyntax) ** Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a deployment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[!-~]+` Required: No ** [environmentId](#API_CreateDeployment_RequestSyntax) ** The identifier of the runtime environment where you want to deploy this application. Type: String Pattern: `\S{1,80}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "deploymentId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [deploymentId](#API_CreateDeployment_ResponseSyntax) ** The unique identifier of the deployment. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). One or more quotas for AWS Mainframe Modernization exceeds the limit. ** quotaCode ** The identifier of the exceeded quota. ** resourceId ** The ID of the resource that is exceeding the quota limit. ** resourceType ** The type of resource that is exceeding the quota limit for AWS Mainframe Modernization. ** serviceCode ** A code that identifies the service that the exceeded quota belongs to. HTTP Status Code: 402 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/CreateDeployment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/CreateDeployment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/CreateDeployment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/CreateDeployment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/CreateDeployment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/CreateDeployment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/CreateDeployment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/CreateDeployment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/CreateDeployment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/CreateDeployment) # CreateEnvironment **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Creates a runtime environment for a given runtime engine. ## Request Syntax ``` POST /environments HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "engineType": "string", "engineVersion": "string", "highAvailabilityConfig": { "desiredCapacity": number }, "instanceType": "string", "kmsKeyId": "string", "name": "string", "networkType": "string", "preferredMaintenanceWindow": "string", "publiclyAccessible": boolean, "securityGroupIds": [ "string" ], "storageConfigurations": [ { ... } ], "subnetIds": [ "string" ], "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_CreateEnvironment_RequestSyntax) ** Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[!-~]+` Required: No ** [description](#API_CreateEnvironment_RequestSyntax) ** The description of the runtime environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: No ** [engineType](#API_CreateEnvironment_RequestSyntax) ** The engine type for the runtime environment. Type: String Valid Values: `microfocus | bluage` Required: Yes ** [engineVersion](#API_CreateEnvironment_RequestSyntax) ** The version of the engine type for the runtime environment. Type: String Pattern: `\S{1,10}` Required: No ** [highAvailabilityConfig](#API_CreateEnvironment_RequestSyntax) ** The details of a high availability configuration for this runtime environment. Type: [HighAvailabilityConfig](API_HighAvailabilityConfig.md) object Required: No ** [instanceType](#API_CreateEnvironment_RequestSyntax) ** The type of instance for the runtime environment. Type: String Pattern: `\S{1,20}` Required: Yes ** [kmsKeyId](#API_CreateEnvironment_RequestSyntax) ** The identifier of a customer managed key. Type: String Required: No ** [name](#API_CreateEnvironment_RequestSyntax) ** The name of the runtime environment. Must be unique within the account. Type: String Pattern: `[A-Za-z0-9][A-Za-z0-9_\-]{1,59}` Required: Yes ** [networkType](#API_CreateEnvironment_RequestSyntax) ** The network type required for the runtime environment. Type: String Valid Values: `ipv4 | dual` Required: No ** [preferredMaintenanceWindow](#API_CreateEnvironment_RequestSyntax) ** Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format `ddd:hh24:mi-ddd:hh24:mi` and must be less than 24 hours. The following two examples are valid maintenance windows: `sun:23:45-mon:00:15` or `sat:01:00-sat:03:00`. If you do not provide a value, a random system-generated value will be assigned. Type: String Pattern: `\S{1,50}` Required: No ** [publiclyAccessible](#API_CreateEnvironment_RequestSyntax) ** Specifies whether the runtime environment is publicly accessible. Type: Boolean Required: No ** [securityGroupIds](#API_CreateEnvironment_RequestSyntax) ** The list of security groups for the VPC associated with this runtime environment. Type: Array of strings Pattern: `\S{1,50}` Required: No ** [storageConfigurations](#API_CreateEnvironment_RequestSyntax) ** Optional. The storage configurations for this runtime environment. Type: Array of [StorageConfiguration](API_StorageConfiguration.md) objects Required: No ** [subnetIds](#API_CreateEnvironment_RequestSyntax) ** The list of subnets associated with the VPC for this runtime environment. Type: Array of strings Pattern: `\S{1,50}` Required: No ** [tags](#API_CreateEnvironment_RequestSyntax) ** The tags for the runtime environment. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `(?!aws:).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "environmentId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [environmentId](#API_CreateEnvironment_ResponseSyntax) ** The unique identifier of the runtime environment. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ServiceQuotaExceededException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). One or more quotas for AWS Mainframe Modernization exceeds the limit. ** quotaCode ** The identifier of the exceeded quota. ** resourceId ** The ID of the resource that is exceeding the quota limit. ** resourceType ** The type of resource that is exceeding the quota limit for AWS Mainframe Modernization. ** serviceCode ** A code that identifies the service that the exceeded quota belongs to. HTTP Status Code: 402 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/CreateEnvironment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/CreateEnvironment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/CreateEnvironment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/CreateEnvironment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/CreateEnvironment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/CreateEnvironment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/CreateEnvironment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/CreateEnvironment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/CreateEnvironment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/CreateEnvironment) # DeleteApplication **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Deletes a specific application. You cannot delete a running application. ## Request Syntax ``` DELETE /applications/applicationId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_DeleteApplication_RequestSyntax) ** The unique identifier of the application you want to delete. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/DeleteApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/DeleteApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/DeleteApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/DeleteApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/DeleteApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/DeleteApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/DeleteApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/DeleteApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/DeleteApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/DeleteApplication) # DeleteApplicationFromEnvironment **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). 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. ## Request Syntax ``` DELETE /applications/applicationId/environment/environmentId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_DeleteApplicationFromEnvironment_RequestSyntax) ** The unique identifier of the application you want to delete. Pattern: `\S{1,80}` Required: Yes ** [environmentId](#API_DeleteApplicationFromEnvironment_RequestSyntax) ** The unique identifier of the runtime environment where the application was previously deployed. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/DeleteApplicationFromEnvironment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/DeleteApplicationFromEnvironment) # DeleteEnvironment **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment. ## Request Syntax ``` DELETE /environments/environmentId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [environmentId](#API_DeleteEnvironment_RequestSyntax) ** The unique identifier of the runtime environment you want to delete. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/DeleteEnvironment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/DeleteEnvironment) # GetApplication **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Describes the details of a specific application. ## Request Syntax ``` GET /applications/applicationId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_GetApplication_RequestSyntax) ** The identifier of the application. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationArn": "string", "applicationId": "string", "creationTime": number, "deployedVersion": { "applicationVersion": number, "status": "string", "statusReason": "string" }, "description": "string", "engineType": "string", "environmentId": "string", "kmsKeyId": "string", "lastStartTime": number, "latestVersion": { "applicationVersion": number, "creationTime": number, "status": "string", "statusReason": "string" }, "listenerArns": [ "string" ], "listenerPorts": [ number ], "loadBalancerDnsName": "string", "logGroups": [ { "logGroupName": "string", "logType": "string" } ], "name": "string", "roleArn": "string", "status": "string", "statusReason": "string", "tags": { "string" : "string" }, "targetGroupArns": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationArn](#API_GetApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the application. Type: String Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` ** [applicationId](#API_GetApplication_ResponseSyntax) ** The identifier of the application. Type: String Pattern: `\S{1,80}` ** [creationTime](#API_GetApplication_ResponseSyntax) ** The timestamp when this application was created. Type: Timestamp ** [deployedVersion](#API_GetApplication_ResponseSyntax) ** The version of the application that is deployed. Type: [DeployedVersionSummary](API_DeployedVersionSummary.md) object ** [description](#API_GetApplication_ResponseSyntax) ** The description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. ** [engineType](#API_GetApplication_ResponseSyntax) ** The type of the target platform for the application. Type: String Valid Values: `microfocus | bluage` ** [environmentId](#API_GetApplication_ResponseSyntax) ** The identifier of the runtime environment where you want to deploy the application. Type: String Pattern: `\S{1,80}` ** [kmsKeyId](#API_GetApplication_ResponseSyntax) ** The identifier of a customer managed key. Type: String ** [lastStartTime](#API_GetApplication_ResponseSyntax) ** The timestamp when you last started the application. Null until the application runs for the first time. Type: Timestamp ** [latestVersion](#API_GetApplication_ResponseSyntax) ** The latest version of the application. Type: [ApplicationVersionSummary](API_ApplicationVersionSummary.md) object ** [listenerArns](#API_GetApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) for the network load balancer listener created in your AWS account. AWS Mainframe Modernization creates this listener for you the first time you deploy an application. Type: Array of strings Array Members: Minimum number of 1 item. Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` ** [listenerPorts](#API_GetApplication_ResponseSyntax) ** The port associated with the network load balancer listener created in your AWS account. Type: Array of integers Array Members: Minimum number of 1 item. ** [loadBalancerDnsName](#API_GetApplication_ResponseSyntax) ** The public DNS name of the load balancer created in your AWS account. Type: String Pattern: `\S{1,100}` ** [logGroups](#API_GetApplication_ResponseSyntax) ** The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. AWS Mainframe Modernization pushes the application log to CloudWatch under the customer's account. Type: Array of [LogGroupSummary](API_LogGroupSummary.md) objects ** [name](#API_GetApplication_ResponseSyntax) ** The unique identifier of the application. Type: String Pattern: `[A-Za-z0-9][A-Za-z0-9_\-]{1,59}` ** [roleArn](#API_GetApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the role associated with the application. Type: String Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` ** [status](#API_GetApplication_ResponseSyntax) ** The status of the application. Type: String Valid Values: `Creating | Created | Available | Ready | Starting | Running | Stopping | Stopped | Failed | Deleting | Deleting From Environment` ** [statusReason](#API_GetApplication_ResponseSyntax) ** The reason for the reported status. Type: String ** [tags](#API_GetApplication_ResponseSyntax) ** A list of tags associated with the application. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `(?!aws:).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. ** [targetGroupArns](#API_GetApplication_ResponseSyntax) ** Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer. Type: Array of strings Array Members: Minimum number of 1 item. Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetApplication) # GetApplicationVersion **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Returns details about a specific version of a specific application. ## Request Syntax ``` GET /applications/applicationId/versions/applicationVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_GetApplicationVersion_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [applicationVersion](#API_GetApplicationVersion_RequestSyntax) ** The specific version of the application. Valid Range: Minimum value of 1. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationVersion": number, "creationTime": number, "definitionContent": "string", "description": "string", "name": "string", "status": "string", "statusReason": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationVersion](#API_GetApplicationVersion_ResponseSyntax) ** The specific version of the application. Type: Integer Valid Range: Minimum value of 1. ** [creationTime](#API_GetApplicationVersion_ResponseSyntax) ** The timestamp when the application version was created. Type: Timestamp ** [definitionContent](#API_GetApplicationVersion_ResponseSyntax) ** The content of the application definition. This is a JSON object that contains the resource configuration and definitions that identify an application. Type: String Length Constraints: Minimum length of 1. Maximum length of 65000. ** [description](#API_GetApplicationVersion_ResponseSyntax) ** The application description. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. ** [name](#API_GetApplicationVersion_ResponseSyntax) ** The name of the application version. Type: String Pattern: `[A-Za-z0-9][A-Za-z0-9_\-]{1,59}` ** [status](#API_GetApplicationVersion_ResponseSyntax) ** The status of the application version. Type: String Valid Values: `Creating | Available | Failed` ** [statusReason](#API_GetApplicationVersion_ResponseSyntax) ** The reason for the reported status. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetApplicationVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetApplicationVersion) # GetBatchJobExecution **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Gets the details of a specific batch job execution for a specific application. ## Request Syntax ``` GET /applications/applicationId/batch-job-executions/executionId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_GetBatchJobExecution_RequestSyntax) ** The identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [executionId](#API_GetBatchJobExecution_RequestSyntax) ** The unique identifier of the batch job execution. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationId": "string", "batchJobIdentifier": { ... }, "endTime": number, "executionId": "string", "jobId": "string", "jobName": "string", "jobStepRestartMarker": { "fromProcStep": "string", "fromStep": "string", "skip": boolean, "stepCheckpoint": number, "toProcStep": "string", "toStep": "string" }, "jobType": "string", "jobUser": "string", "returnCode": "string", "startTime": number, "status": "string", "statusReason": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationId](#API_GetBatchJobExecution_ResponseSyntax) ** The identifier of the application. Type: String Pattern: `\S{1,80}` ** [batchJobIdentifier](#API_GetBatchJobExecution_ResponseSyntax) ** The unique identifier of this batch job. Type: [BatchJobIdentifier](API_BatchJobIdentifier.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [endTime](#API_GetBatchJobExecution_ResponseSyntax) ** The timestamp when the batch job execution ended. Type: Timestamp ** [executionId](#API_GetBatchJobExecution_ResponseSyntax) ** The unique identifier for this batch job execution. Type: String Pattern: `\S{1,80}` ** [jobId](#API_GetBatchJobExecution_ResponseSyntax) ** The unique identifier for this batch job. Type: String Pattern: `\S{1,100}` ** [jobName](#API_GetBatchJobExecution_ResponseSyntax) ** The name of this batch job. Type: String Pattern: `\S{1,100}` ** [jobStepRestartMarker](#API_GetBatchJobExecution_ResponseSyntax) ** The step/procedure step information for the restart batch job operation. Type: [JobStepRestartMarker](API_JobStepRestartMarker.md) object ** [jobType](#API_GetBatchJobExecution_ResponseSyntax) ** The type of job. Type: String Valid Values: `VSE | JES2 | JES3` ** [jobUser](#API_GetBatchJobExecution_ResponseSyntax) ** The user for the job. Type: String Pattern: `\S{1,100}` ** [returnCode](#API_GetBatchJobExecution_ResponseSyntax) ** The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see [Batch return codes](https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes) in the *IBM WebSphere Application Server* documentation. Type: String ** [startTime](#API_GetBatchJobExecution_ResponseSyntax) ** The timestamp when the batch job execution started. Type: Timestamp ** [status](#API_GetBatchJobExecution_ResponseSyntax) ** The status of the batch job execution. Type: String Valid Values: `Submitting | Holding | Dispatching | Running | Cancelling | Cancelled | Succeeded | Failed | Purged | Succeeded With Warning` ** [statusReason](#API_GetBatchJobExecution_ResponseSyntax) ** The reason for the reported status. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetBatchJobExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetBatchJobExecution) # GetDataSetDetails **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Gets the details of a specific data set. ## Request Syntax ``` GET /applications/applicationId/datasets/dataSetName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_GetDataSetDetails_RequestSyntax) ** The unique identifier of the application that this data set is associated with. Pattern: `\S{1,80}` Required: Yes ** [dataSetName](#API_GetDataSetDetails_RequestSyntax) ** The name of the data set. Pattern: `\S{1,200}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "blocksize": number, "creationTime": number, "dataSetName": "string", "dataSetOrg": { ... }, "fileSize": number, "lastReferencedTime": number, "lastUpdatedTime": number, "location": "string", "recordLength": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [blocksize](#API_GetDataSetDetails_ResponseSyntax) ** The size of the block on disk. Type: Integer ** [creationTime](#API_GetDataSetDetails_ResponseSyntax) ** The timestamp when the data set was created. Type: Timestamp ** [dataSetName](#API_GetDataSetDetails_ResponseSyntax) ** The name of the data set. Type: String Pattern: `\S{1,200}` ** [dataSetOrg](#API_GetDataSetDetails_ResponseSyntax) ** The type of data set. The only supported value is VSAM. Type: [DatasetDetailOrgAttributes](API_DatasetDetailOrgAttributes.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [fileSize](#API_GetDataSetDetails_ResponseSyntax) ** File size of the dataset. Type: Long ** [lastReferencedTime](#API_GetDataSetDetails_ResponseSyntax) ** The last time the data set was referenced. Type: Timestamp ** [lastUpdatedTime](#API_GetDataSetDetails_ResponseSyntax) ** The last time the data set was updated. Type: Timestamp ** [location](#API_GetDataSetDetails_ResponseSyntax) ** The location where the data set is stored. Type: String Pattern: `\S{1,2000}` ** [recordLength](#API_GetDataSetDetails_ResponseSyntax) ** The length of records in the data set. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** ExecutionTimeoutException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Failed to connect to server, or didn’t receive response within expected time period. HTTP Status Code: 504 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceUnavailableException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Server cannot process the request at the moment. HTTP Status Code: 503 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetDataSetDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetDataSetDetails) # GetDataSetExportTask **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Gets the status of a data set import task initiated with the [CreateDataSetExportTask](API_CreateDataSetExportTask.md) operation. ## Request Syntax ``` GET /applications/applicationId/dataset-export-tasks/taskId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_GetDataSetExportTask_RequestSyntax) ** The application identifier. Pattern: `\S{1,80}` Required: Yes ** [taskId](#API_GetDataSetExportTask_RequestSyntax) ** The task identifier returned by the [CreateDataSetExportTask](API_CreateDataSetExportTask.md) operation. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "kmsKeyArn": "string", "status": "string", "statusReason": "string", "summary": { "failed": number, "inProgress": number, "pending": number, "succeeded": number, "total": number }, "taskId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [kmsKeyArn](#API_GetDataSetExportTask_ResponseSyntax) ** The identifier of a customer managed key used for exported data set encryption. Type: String ** [status](#API_GetDataSetExportTask_ResponseSyntax) ** The status of the task. Type: String Valid Values: `Creating | Running | Completed | Failed` ** [statusReason](#API_GetDataSetExportTask_ResponseSyntax) ** If dataset export failed, the failure reason will show here. Type: String ** [summary](#API_GetDataSetExportTask_ResponseSyntax) ** A summary of the status of the task. Type: [DataSetExportSummary](API_DataSetExportSummary.md) object ** [taskId](#API_GetDataSetExportTask_ResponseSyntax) ** The task identifier. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetDataSetExportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetDataSetExportTask) # GetDataSetImportTask **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Gets the status of a data set import task initiated with the [CreateDataSetImportTask](API_CreateDataSetImportTask.md) operation. ## Request Syntax ``` GET /applications/applicationId/dataset-import-tasks/taskId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_GetDataSetImportTask_RequestSyntax) ** The application identifier. Pattern: `\S{1,80}` Required: Yes ** [taskId](#API_GetDataSetImportTask_RequestSyntax) ** The task identifier returned by the [CreateDataSetImportTask](API_CreateDataSetImportTask.md) operation. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "status": "string", "summary": { "failed": number, "inProgress": number, "pending": number, "succeeded": number, "total": number }, "taskId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [status](#API_GetDataSetImportTask_ResponseSyntax) ** The status of the task. Type: String Valid Values: `Creating | Running | Completed | Failed` ** [summary](#API_GetDataSetImportTask_ResponseSyntax) ** A summary of the status of the task. Type: [DataSetImportSummary](API_DataSetImportSummary.md) object ** [taskId](#API_GetDataSetImportTask_ResponseSyntax) ** The task identifier. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetDataSetImportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetDataSetImportTask) # GetDeployment **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Gets details of a specific deployment with a given deployment identifier. ## Request Syntax ``` GET /applications/applicationId/deployments/deploymentId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_GetDeployment_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [deploymentId](#API_GetDeployment_RequestSyntax) ** The unique identifier for the deployment. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationId": "string", "applicationVersion": number, "creationTime": number, "deploymentId": "string", "environmentId": "string", "status": "string", "statusReason": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationId](#API_GetDeployment_ResponseSyntax) ** The unique identifier of the application. Type: String Pattern: `\S{1,80}` ** [applicationVersion](#API_GetDeployment_ResponseSyntax) ** The application version. Type: Integer Valid Range: Minimum value of 1. ** [creationTime](#API_GetDeployment_ResponseSyntax) ** The timestamp when the deployment was created. Type: Timestamp ** [deploymentId](#API_GetDeployment_ResponseSyntax) ** The unique identifier of the deployment. Type: String Pattern: `\S{1,80}` ** [environmentId](#API_GetDeployment_ResponseSyntax) ** The unique identifier of the runtime environment. Type: String Pattern: `\S{1,80}` ** [status](#API_GetDeployment_ResponseSyntax) ** The status of the deployment. Type: String Valid Values: `Deploying | Succeeded | Failed | Updating Deployment` ** [statusReason](#API_GetDeployment_ResponseSyntax) ** The reason for the reported status. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetDeployment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetDeployment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetDeployment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetDeployment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetDeployment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetDeployment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetDeployment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetDeployment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetDeployment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetDeployment) # GetEnvironment **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Describes a specific runtime environment. ## Request Syntax ``` GET /environments/environmentId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [environmentId](#API_GetEnvironment_RequestSyntax) ** The unique identifier of the runtime environment. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "actualCapacity": number, "creationTime": number, "description": "string", "engineType": "string", "engineVersion": "string", "environmentArn": "string", "environmentId": "string", "highAvailabilityConfig": { "desiredCapacity": number }, "instanceType": "string", "kmsKeyId": "string", "loadBalancerArn": "string", "name": "string", "networkType": "string", "pendingMaintenance": { "engineVersion": "string", "schedule": { "endTime": number, "startTime": number } }, "preferredMaintenanceWindow": "string", "publiclyAccessible": boolean, "securityGroupIds": [ "string" ], "status": "string", "statusReason": "string", "storageConfigurations": [ { ... } ], "subnetIds": [ "string" ], "tags": { "string" : "string" }, "vpcId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [actualCapacity](#API_GetEnvironment_ResponseSyntax) ** The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances. Type: Integer ** [creationTime](#API_GetEnvironment_ResponseSyntax) ** The timestamp when the runtime environment was created. Type: Timestamp ** [description](#API_GetEnvironment_ResponseSyntax) ** The description of the runtime environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. ** [engineType](#API_GetEnvironment_ResponseSyntax) ** The target platform for the runtime environment. Type: String Valid Values: `microfocus | bluage` ** [engineVersion](#API_GetEnvironment_ResponseSyntax) ** The version of the runtime engine. Type: String Pattern: `\S{1,10}` ** [environmentArn](#API_GetEnvironment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the runtime environment. Type: String Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` ** [environmentId](#API_GetEnvironment_ResponseSyntax) ** The unique identifier of the runtime environment. Type: String Pattern: `\S{1,80}` ** [highAvailabilityConfig](#API_GetEnvironment_ResponseSyntax) ** The desired capacity of the high availability configuration for the runtime environment. Type: [HighAvailabilityConfig](API_HighAvailabilityConfig.md) object ** [instanceType](#API_GetEnvironment_ResponseSyntax) ** The type of instance underlying the runtime environment. Type: String Pattern: `\S{1,20}` ** [kmsKeyId](#API_GetEnvironment_ResponseSyntax) ** The identifier of a customer managed key. Type: String ** [loadBalancerArn](#API_GetEnvironment_ResponseSyntax) ** The Amazon Resource Name (ARN) for the load balancer used with the runtime environment. Type: String ** [name](#API_GetEnvironment_ResponseSyntax) ** The name of the runtime environment. Must be unique within the account. Type: String Pattern: `[A-Za-z0-9][A-Za-z0-9_\-]{1,59}` ** [networkType](#API_GetEnvironment_ResponseSyntax) ** The network type supported by the runtime environment. Type: String Valid Values: `ipv4 | dual` ** [pendingMaintenance](#API_GetEnvironment_ResponseSyntax) ** Indicates the pending maintenance scheduled on this environment. Type: [PendingMaintenance](API_PendingMaintenance.md) object ** [preferredMaintenanceWindow](#API_GetEnvironment_ResponseSyntax) ** The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value. Type: String Pattern: `\S{1,50}` ** [publiclyAccessible](#API_GetEnvironment_ResponseSyntax) ** Whether applications running in this runtime environment are publicly accessible. Type: Boolean ** [securityGroupIds](#API_GetEnvironment_ResponseSyntax) ** The unique identifiers of the security groups assigned to this runtime environment. Type: Array of strings Pattern: `\S{1,50}` ** [status](#API_GetEnvironment_ResponseSyntax) ** The status of the runtime environment. If the AWS Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be `Unhealthy`. Type: String Valid Values: `Creating | Available | Updating | Deleting | Failed | UnHealthy` ** [statusReason](#API_GetEnvironment_ResponseSyntax) ** The reason for the reported status. Type: String ** [storageConfigurations](#API_GetEnvironment_ResponseSyntax) ** The storage configurations defined for the runtime environment. Type: Array of [StorageConfiguration](API_StorageConfiguration.md) objects ** [subnetIds](#API_GetEnvironment_ResponseSyntax) ** The unique identifiers of the subnets assigned to this runtime environment. Type: Array of strings Pattern: `\S{1,50}` ** [tags](#API_GetEnvironment_ResponseSyntax) ** The tags defined for this runtime environment. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `(?!aws:).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. ** [vpcId](#API_GetEnvironment_ResponseSyntax) ** The unique identifier for the VPC used with this runtime environment. Type: String Pattern: `\S{1,50}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetEnvironment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetEnvironment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetEnvironment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetEnvironment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetEnvironment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetEnvironment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetEnvironment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetEnvironment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetEnvironment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetEnvironment) # GetSignedBluinsightsUrl **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Gets a single sign-on URL that can be used to connect to AWS Blu Insights. ## Request Syntax ``` GET /signed-bi-url HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "signedBiUrl": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [signedBiUrl](#API_GetSignedBluinsightsUrl_ResponseSyntax) ** Single sign-on AWS Blu Insights URL. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/GetSignedBluinsightsUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/GetSignedBluinsightsUrl) # ListApplications **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists the applications associated with a specific AWS account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment. ## Request Syntax ``` GET /applications?environmentId=environmentId&maxResults=maxResults&names=names&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [environmentId](#API_ListApplications_RequestSyntax) ** The unique identifier of the runtime environment where the applications are deployed. Pattern: `\S{1,80}` ** [maxResults](#API_ListApplications_RequestSyntax) ** The maximum number of applications to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [names](#API_ListApplications_RequestSyntax) ** The names of the applications. Array Members: Minimum number of 1 item. Maximum number of 10 items. Pattern: `[A-Za-z0-9][A-Za-z0-9_\-]{1,59}` ** [nextToken](#API_ListApplications_RequestSyntax) ** A pagination token to control the number of applications displayed in the list. Pattern: `\S{1,2000}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applications": [ { "applicationArn": "string", "applicationId": "string", "applicationVersion": number, "creationTime": number, "deploymentStatus": "string", "description": "string", "engineType": "string", "environmentId": "string", "lastStartTime": number, "name": "string", "roleArn": "string", "status": "string", "versionStatus": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applications](#API_ListApplications_ResponseSyntax) ** Returns a list of summary details for all the applications in a runtime environment. Type: Array of [ApplicationSummary](API_ApplicationSummary.md) objects ** [nextToken](#API_ListApplications_ResponseSyntax) ** A pagination token that's returned when the response doesn't contain all applications. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListApplications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListApplications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListApplications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListApplications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListApplications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListApplications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListApplications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListApplications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListApplications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListApplications) # ListApplicationVersions **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Returns a list of the application versions for a specific application. ## Request Syntax ``` GET /applications/applicationId/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListApplicationVersions_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [maxResults](#API_ListApplicationVersions_RequestSyntax) ** The maximum number of application versions to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nextToken](#API_ListApplicationVersions_RequestSyntax) ** A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter. Pattern: `\S{1,2000}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationVersions": [ { "applicationVersion": number, "creationTime": number, "status": "string", "statusReason": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationVersions](#API_ListApplicationVersions_ResponseSyntax) ** The list of application versions. Type: Array of [ApplicationVersionSummary](API_ApplicationVersionSummary.md) objects ** [nextToken](#API_ListApplicationVersions_ResponseSyntax) ** If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListApplicationVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListApplicationVersions) # ListBatchJobDefinitions **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). 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. ## Request Syntax ``` GET /applications/applicationId/batch-job-definitions?maxResults=maxResults&nextToken=nextToken&prefix=prefix HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListBatchJobDefinitions_RequestSyntax) ** The identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [maxResults](#API_ListBatchJobDefinitions_RequestSyntax) ** The maximum number of batch job definitions to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nextToken](#API_ListBatchJobDefinitions_RequestSyntax) ** A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter. Pattern: `\S{1,2000}` ** [prefix](#API_ListBatchJobDefinitions_RequestSyntax) ** If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "batchJobDefinitions": [ { ... } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [batchJobDefinitions](#API_ListBatchJobDefinitions_ResponseSyntax) ** The list of batch job definitions. Type: Array of [BatchJobDefinition](API_BatchJobDefinition.md) objects ** [nextToken](#API_ListBatchJobDefinitions_ResponseSyntax) ** If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListBatchJobDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListBatchJobDefinitions) # ListBatchJobExecutions **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists historical, current, and scheduled batch job executions for a specific application. ## Request Syntax ``` GET /applications/applicationId/batch-job-executions?executionIds=executionIds&jobName=jobName&maxResults=maxResults&nextToken=nextToken&startedAfter=startedAfter&startedBefore=startedBefore&status=status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListBatchJobExecutions_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [executionIds](#API_ListBatchJobExecutions_RequestSyntax) ** The unique identifier of each batch job execution. Array Members: Minimum number of 1 item. Maximum number of 10 items. Pattern: `\S{1,80}` ** [jobName](#API_ListBatchJobExecutions_RequestSyntax) ** The name of each batch job execution. Pattern: `\S{1,100}` ** [maxResults](#API_ListBatchJobExecutions_RequestSyntax) ** The maximum number of batch job executions to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nextToken](#API_ListBatchJobExecutions_RequestSyntax) ** A pagination token to control the number of batch job executions displayed in the list. Pattern: `\S{1,2000}` ** [startedAfter](#API_ListBatchJobExecutions_RequestSyntax) ** The time after which the batch job executions started. ** [startedBefore](#API_ListBatchJobExecutions_RequestSyntax) ** The time before the batch job executions started. ** [status](#API_ListBatchJobExecutions_RequestSyntax) ** The status of the batch job executions. Valid Values: `Submitting | Holding | Dispatching | Running | Cancelling | Cancelled | Succeeded | Failed | Purged | Succeeded With Warning` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "batchJobExecutions": [ { "applicationId": "string", "batchJobIdentifier": { ... }, "endTime": number, "executionId": "string", "jobId": "string", "jobName": "string", "jobType": "string", "returnCode": "string", "startTime": number, "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [batchJobExecutions](#API_ListBatchJobExecutions_ResponseSyntax) ** Returns a list of batch job executions for an application. Type: Array of [BatchJobExecutionSummary](API_BatchJobExecutionSummary.md) objects ** [nextToken](#API_ListBatchJobExecutions_ResponseSyntax) ** A pagination token that's returned when the response doesn't contain all batch job executions. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListBatchJobExecutions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListBatchJobExecutions) # ListBatchJobRestartPoints **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists all the job steps for a JCL file to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above. ## Request Syntax ``` GET /applications/applicationId/batch-job-executions/executionId/steps?authSecretsManagerArn=authSecretsManagerArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListBatchJobRestartPoints_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [authSecretsManagerArn](#API_ListBatchJobRestartPoints_RequestSyntax) ** The AWS Secrets Manager containing user's credentials for authentication and authorization for List Batch Job Restart Points operation. Length Constraints: Minimum length of 20. Maximum length of 2048. ** [executionId](#API_ListBatchJobRestartPoints_RequestSyntax) ** The unique identifier of the batch job execution. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "batchJobSteps": [ { "procStepName": "string", "procStepNumber": number, "stepCheckpoint": number, "stepCheckpointStatus": "string", "stepCheckpointTime": number, "stepCondCode": "string", "stepName": "string", "stepNumber": number, "stepRestartable": boolean } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [batchJobSteps](#API_ListBatchJobRestartPoints_ResponseSyntax) ** Returns all the batch job steps and related information for a batch job that previously ran. Type: Array of [JobStep](API_JobStep.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListBatchJobRestartPoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListBatchJobRestartPoints) # ListDataSetExportHistory **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists the data set exports for the specified application. ## Request Syntax ``` GET /applications/applicationId/dataset-export-tasks?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListDataSetExportHistory_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [maxResults](#API_ListDataSetExportHistory_RequestSyntax) ** The maximum number of objects to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nextToken](#API_ListDataSetExportHistory_RequestSyntax) ** A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter. Pattern: `\S{1,2000}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "dataSetExportTasks": [ { "status": "string", "statusReason": "string", "summary": { "failed": number, "inProgress": number, "pending": number, "succeeded": number, "total": number }, "taskId": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [dataSetExportTasks](#API_ListDataSetExportHistory_ResponseSyntax) ** The data set export tasks. Type: Array of [DataSetExportTask](API_DataSetExportTask.md) objects ** [nextToken](#API_ListDataSetExportHistory_ResponseSyntax) ** If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListDataSetExportHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListDataSetExportHistory) # ListDataSetImportHistory **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists the data set imports for the specified application. ## Request Syntax ``` GET /applications/applicationId/dataset-import-tasks?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListDataSetImportHistory_RequestSyntax) ** The unique identifier of the application. Pattern: `\S{1,80}` Required: Yes ** [maxResults](#API_ListDataSetImportHistory_RequestSyntax) ** The maximum number of objects to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nextToken](#API_ListDataSetImportHistory_RequestSyntax) ** A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter. Pattern: `\S{1,2000}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "dataSetImportTasks": [ { "status": "string", "statusReason": "string", "summary": { "failed": number, "inProgress": number, "pending": number, "succeeded": number, "total": number }, "taskId": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [dataSetImportTasks](#API_ListDataSetImportHistory_ResponseSyntax) ** The data set import tasks. Type: Array of [DataSetImportTask](API_DataSetImportTask.md) objects ** [nextToken](#API_ListDataSetImportHistory_ResponseSyntax) ** If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListDataSetImportHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListDataSetImportHistory) # ListDataSets **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists the data sets imported for a specific application. In AWS Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, AWS Mainframe Modernization can import data sets into catalogs using [CreateDataSetImportTask](https://docs.aws.amazon.com/m2/latest/APIReference/API_CreateDataSetImportTask.html). ## Request Syntax ``` GET /applications/applicationId/datasets?maxResults=maxResults&nameFilter=nameFilter&nextToken=nextToken&prefix=prefix HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListDataSets_RequestSyntax) ** The unique identifier of the application for which you want to list the associated data sets. Pattern: `\S{1,80}` Required: Yes ** [maxResults](#API_ListDataSets_RequestSyntax) ** The maximum number of objects to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nameFilter](#API_ListDataSets_RequestSyntax) ** Filter dataset name matching the specified pattern. Can use \$1 and % as wild cards. Pattern: `\S{1,200}` ** [nextToken](#API_ListDataSets_RequestSyntax) ** A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter. Pattern: `\S{1,2000}` ** [prefix](#API_ListDataSets_RequestSyntax) ** The prefix of the data set name, which you can use to filter the list of data sets. Pattern: `\S{1,200}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "dataSets": [ { "creationTime": number, "dataSetName": "string", "dataSetOrg": "string", "format": "string", "lastReferencedTime": number, "lastUpdatedTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [dataSets](#API_ListDataSets_ResponseSyntax) ** The list of data sets, containing information including the creation time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated. Type: Array of [DataSetSummary](API_DataSetSummary.md) objects ** [nextToken](#API_ListDataSets_ResponseSyntax) ** If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** ExecutionTimeoutException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Failed to connect to server, or didn’t receive response within expected time period. HTTP Status Code: 504 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceUnavailableException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Server cannot process the request at the moment. HTTP Status Code: 503 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListDataSets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListDataSets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListDataSets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListDataSets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListDataSets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListDataSets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListDataSets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListDataSets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListDataSets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListDataSets) # ListDeployments **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). 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. ## Request Syntax ``` GET /applications/applicationId/deployments?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_ListDeployments_RequestSyntax) ** The application identifier. Pattern: `\S{1,80}` Required: Yes ** [maxResults](#API_ListDeployments_RequestSyntax) ** The maximum number of objects to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nextToken](#API_ListDeployments_RequestSyntax) ** A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter. Pattern: `\S{1,2000}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "deployments": [ { "applicationId": "string", "applicationVersion": number, "creationTime": number, "deploymentId": "string", "environmentId": "string", "status": "string", "statusReason": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [deployments](#API_ListDeployments_ResponseSyntax) ** The list of deployments that is returned. Type: Array of [DeploymentSummary](API_DeploymentSummary.md) objects ** [nextToken](#API_ListDeployments_ResponseSyntax) ** If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListDeployments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListDeployments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListDeployments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListDeployments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListDeployments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListDeployments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListDeployments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListDeployments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListDeployments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListDeployments) # ListEngineVersions **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists the available engine versions. ## Request Syntax ``` GET /engine-versions?engineType=engineType&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [engineType](#API_ListEngineVersions_RequestSyntax) ** The type of target platform. Valid Values: `microfocus | bluage` ** [maxResults](#API_ListEngineVersions_RequestSyntax) ** The maximum number of objects to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [nextToken](#API_ListEngineVersions_RequestSyntax) ** A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter. Pattern: `\S{1,2000}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "engineVersions": [ { "engineType": "string", "engineVersion": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [engineVersions](#API_ListEngineVersions_ResponseSyntax) ** Returns the engine versions. Type: Array of [EngineVersionsSummary](API_EngineVersionsSummary.md) objects ** [nextToken](#API_ListEngineVersions_ResponseSyntax) ** If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListEngineVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListEngineVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListEngineVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListEngineVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListEngineVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListEngineVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListEngineVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListEngineVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListEngineVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListEngineVersions) # ListEnvironments **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists the runtime environments. ## Request Syntax ``` GET /environments?engineType=engineType&maxResults=maxResults&names=names&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [engineType](#API_ListEnvironments_RequestSyntax) ** The engine type for the runtime environment. Valid Values: `microfocus | bluage` ** [maxResults](#API_ListEnvironments_RequestSyntax) ** The maximum number of runtime environments to return. Valid Range: Minimum value of 1. Maximum value of 2000. ** [names](#API_ListEnvironments_RequestSyntax) ** The names of the runtime environments. Must be unique within the account. Array Members: Minimum number of 1 item. Maximum number of 10 items. Pattern: `[A-Za-z0-9][A-Za-z0-9_\-]{1,59}` ** [nextToken](#API_ListEnvironments_RequestSyntax) ** A pagination token to control the number of runtime environments displayed in the list. Pattern: `\S{1,2000}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "environments": [ { "creationTime": number, "engineType": "string", "engineVersion": "string", "environmentArn": "string", "environmentId": "string", "instanceType": "string", "name": "string", "networkType": "string", "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [environments](#API_ListEnvironments_ResponseSyntax) ** Returns a list of summary details for all the runtime environments in your account. Type: Array of [EnvironmentSummary](API_EnvironmentSummary.md) objects ** [nextToken](#API_ListEnvironments_ResponseSyntax) ** A pagination token that's returned when the response doesn't contain all the runtime environments. Type: String Pattern: `\S{1,2000}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListEnvironments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListEnvironments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListEnvironments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListEnvironments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListEnvironments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListEnvironments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListEnvironments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListEnvironments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListEnvironments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListEnvironments) # ListTagsForResource **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Lists the tags for the specified resource. ## Request Syntax ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource. Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** The tags for the resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `(?!aws:).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/ListTagsForResource) # StartApplication **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Starts an application that is currently stopped. ## Request Syntax ``` POST /applications/applicationId/start HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_StartApplication_RequestSyntax) ** The unique identifier of the application you want to start. Pattern: `\S{1,80}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/StartApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/StartApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/StartApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/StartApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/StartApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/StartApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/StartApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/StartApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/StartApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/StartApplication) # StartBatchJob **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). 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. ## Request Syntax ``` POST /applications/applicationId/batch-job HTTP/1.1 Content-type: application/json { "authSecretsManagerArn": "string", "batchJobIdentifier": { ... }, "jobParams": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_StartBatchJob_RequestSyntax) ** The unique identifier of the application associated with this batch job. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [authSecretsManagerArn](#API_StartBatchJob_RequestSyntax) ** The AWS Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No ** [batchJobIdentifier](#API_StartBatchJob_RequestSyntax) ** The unique identifier of the batch job. Type: [BatchJobIdentifier](API_BatchJobIdentifier.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [jobParams](#API_StartBatchJob_RequestSyntax) ** The collection of batch job parameters. For details about limits for keys and values, see [Coding variables in JCL](https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl). Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 500 items. Key Length Constraints: Minimum length of 1. Maximum length of 32. Key Pattern: `[A-Za-z][A-Za-z0-9]{1,31}` Value Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "executionId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [executionId](#API_StartBatchJob_ResponseSyntax) ** The unique identifier of this execution of the batch job. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/StartBatchJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/StartBatchJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/StartBatchJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/StartBatchJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/StartBatchJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/StartBatchJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/StartBatchJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/StartBatchJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/StartBatchJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/StartBatchJob) # StopApplication **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Stops a running application. ## Request Syntax ``` POST /applications/applicationId/stop HTTP/1.1 Content-type: application/json { "forceStop": boolean } ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_StopApplication_RequestSyntax) ** The unique identifier of the application you want to stop. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [forceStop](#API_StopApplication_RequestSyntax) ** Stopping an application process can take a long time. Setting this parameter to true lets you force stop the application so you don't need to wait until the process finishes to apply another action on the application. The default value is false. Type: Boolean Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/StopApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/StopApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/StopApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/StopApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/StopApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/StopApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/StopApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/StopApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/StopApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/StopApplication) # TagResource **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Adds one or more tags to the specified resource. ## Request Syntax ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource. Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [tags](#API_TagResource_RequestSyntax) ** The tags to add to the resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `(?!aws:).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). One or more quotas for AWS Mainframe Modernization exceeds the limit. ** quotaCode ** The identifier of the exceeded quota. ** resourceId ** The ID of the resource that is exceeding the quota limit. ** resourceType ** The type of resource that is exceeding the quota limit for AWS Mainframe Modernization. ** serviceCode ** A code that identifies the service that the exceeded quota belongs to. HTTP Status Code: 402 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/TagResource) # UntagResource **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Removes one or more tags from the specified resource. ## Request Syntax ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource. Pattern: `arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}` Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** The keys of the tags to remove. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!aws:).+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/UntagResource) # UpdateApplication **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Updates an application and creates a new version. ## Request Syntax ``` PATCH /applications/applicationId HTTP/1.1 Content-type: application/json { "currentApplicationVersion": number, "definition": { ... }, "description": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationId](#API_UpdateApplication_RequestSyntax) ** The unique identifier of the application you want to update. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [currentApplicationVersion](#API_UpdateApplication_RequestSyntax) ** The current version of the application to update. Type: Integer Valid Range: Minimum value of 1. Required: Yes ** [definition](#API_UpdateApplication_RequestSyntax) ** The application definition for this application. You can specify either inline JSON or an S3 bucket location. Type: [Definition](API_Definition.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [description](#API_UpdateApplication_RequestSyntax) ** The description of the application to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationVersion": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationVersion](#API_UpdateApplication_ResponseSyntax) ** The new version of the application. Type: Integer Valid Range: Minimum value of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/UpdateApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/UpdateApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/UpdateApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/UpdateApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/UpdateApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/UpdateApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/UpdateApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/UpdateApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/UpdateApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/UpdateApplication) # UpdateEnvironment **Important** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Updates the configuration details for a specific runtime environment. ## Request Syntax ``` PATCH /environments/environmentId HTTP/1.1 Content-type: application/json { "applyDuringMaintenanceWindow": boolean, "desiredCapacity": number, "engineVersion": "string", "forceUpdate": boolean, "instanceType": "string", "preferredMaintenanceWindow": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [environmentId](#API_UpdateEnvironment_RequestSyntax) ** The unique identifier of the runtime environment that you want to update. Pattern: `\S{1,80}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [applyDuringMaintenanceWindow](#API_UpdateEnvironment_RequestSyntax) ** Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, AWS Mainframe Modernization accepts the `engineVersion` parameter only if `applyDuringMaintenanceWindow` is true. If any parameter other than `engineVersion` is provided in `UpdateEnvironmentRequest`, it will fail if `applyDuringMaintenanceWindow` is set to true. Type: Boolean Required: No ** [desiredCapacity](#API_UpdateEnvironment_RequestSyntax) ** The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100. Type: Integer Required: No ** [engineVersion](#API_UpdateEnvironment_RequestSyntax) ** The version of the runtime engine for the runtime environment. Type: String Pattern: `\S{1,10}` Required: No ** [forceUpdate](#API_UpdateEnvironment_RequestSyntax) ** Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment. If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications. This option is not needed if the attribute being updated is `preferredMaintenanceWindow`. Type: Boolean Required: No ** [instanceType](#API_UpdateEnvironment_RequestSyntax) ** The instance type for the runtime environment to update. Type: String Pattern: `\S{1,20}` Required: No ** [preferredMaintenanceWindow](#API_UpdateEnvironment_RequestSyntax) ** Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format `ddd:hh24:mi-ddd:hh24:mi` and must be less than 24 hours. The following two examples are valid maintenance windows: `sun:23:45-mon:00:15` or `sat:01:00-sat:03:00`. If you do not provide a value, a random system-generated value will be assigned. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "environmentId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [environmentId](#API_UpdateEnvironment_ResponseSyntax) ** The unique identifier of the runtime environment that was updated. Type: String Pattern: `\S{1,80}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The account or role doesn't have the right permissions to make the request. HTTP Status Code: 403 ** ConflictException ** The parameters provided in the request conflict with existing resources. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** An unexpected error occurred during the processing of the request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource was not found. ** resourceId ** The ID of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). One or more quotas for AWS Mainframe Modernization exceeds the limit. ** quotaCode ** The identifier of the exceeded quota. ** resourceId ** The ID of the resource that is exceeding the quota limit. ** resourceType ** The type of resource that is exceeding the quota limit for AWS Mainframe Modernization. ** serviceCode ** A code that identifies the service that the exceeded quota belongs to. HTTP Status Code: 402 ** ThrottlingException ** The number of requests made exceeds the limit. ** quotaCode ** The identifier of the throttled request. ** retryAfterSeconds ** The number of seconds to wait before retrying the request. ** serviceCode ** The identifier of the service that the throttled request was made to. HTTP Status Code: 429 ** ValidationException ** One or more parameters provided in the request is not valid. ** fieldList ** The list of fields that failed service validation. ** reason ** The reason why it failed service validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/m2-2021-04-28/UpdateEnvironment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/m2-2021-04-28/UpdateEnvironment)