Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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.

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

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

The current version of the application to update.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

definition

The application definition for this application. You can specify either inline JSON or an S3 bucket location.

Type: Definition object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

description

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

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 Errors.

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