Request Syntax Request Parameters Response Elements Errors Examples See Also

UpdateApplication

Updates metadata about an application.

Request Syntax


{
   "configurationId": "string",
   "description": "string",
   "name": "string",
   "wave": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

configurationId

Configuration ID of the application to be updated.

Type: String

Length Constraints: Maximum length of 200.

Pattern: \S+

Required: Yes

description

New description of the application to be updated.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: (^$|[\s\S]*\S[\s\S]*)

Required: No

name

New name of the application to be updated.

Type: String

Length Constraints: Maximum length of 127.

Pattern: [\s\S]*\S[\s\S]*

Required: No

wave

The new migration wave of the application that you want to update.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^($|[^\s\x00]( *[^\s\x00])*$)

Required: No

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

AuthorizationErrorException

The user does not have permission to perform the action. Check the IAM policy associated with this user.

HTTP Status Code: 400

HomeRegionNotSetException

The home Region is not set. Set the home Region to continue.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid. Verify the parameters and try again.

HTTP Status Code: 400

InvalidParameterValueException

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

HTTP Status Code: 400

ServerInternalErrorException

The server experienced an internal error. Try again.

HTTP Status Code: 500

Examples

Update application name and description

In the following example, both the name and the description are changed (updated) of an existing application. The application is identified by passing the application id to the required parameter configurationId.

Sample Request



{
   "configurationId": "d-application-03767f7bddd6c0531",
   "description": "PSoft financials db migration",
   "name": "payroll_db_migration"
}