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

UpdateApplication

Updates an existing application with new attributes.

Request Syntax


PATCH /applications/application HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request uses the following URI parameters.

application

The name, ID, or ARN of the application that will be updated.

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

Pattern: ([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The new description of the application.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

name

Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates.

Type: String

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

Pattern: [-.\w]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "application": { 
      "arn": "string",
      "creationTime": "string",
      "description": "string",
      "id": "string",
      "lastUpdateTime": "string",
      "name": "string",
      "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.

application

The updated information of the application.

Type: Application object

Errors

ConflictException

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

HTTP Status Code: 409

InternalServerException

The service is experiencing internal problems.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The maximum number of API requests has been exceeded.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400