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

UpdateProject

Important

End of support notice: On October 16, 2025, AWS will discontinue support for CloudWatch Evidently. After October 16, 2025, you will no longer be able to access the Evidently console or CloudWatch Evidently resources.

Updates the description of an existing project.

To create a new project, use CreateProject.

Don't use this operation to update the data storage options of a project. Instead, use UpdateProjectDataDelivery.

Don't use this operation to update the tags of a project. Instead, use TagResource.

Request Syntax


PATCH /projects/project HTTP/1.1
Content-type: application/json

{
   "appConfigResource": { 
      "applicationId": "string",
      "environmentId": "string"
   },
   "description": "string"
}

URI Request Parameters

The request uses the following URI parameters.

project

The name or ARN of the project to update.

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

Pattern: (^[a-zA-Z0-9._-]*$)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[a-zA-Z0-9._-]*)

Required: Yes

Request Body

The request accepts the following data in JSON format.

appConfigResource

Use this parameter if the project will use client-side evaluation powered by AWS AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. allows you to

This parameter is a structure that contains information about the AWS AppConfig application that will be used for client-side evaluation.

Type: ProjectAppConfigResourceConfig object

Required: No

description

An optional description of the project.

Type: String

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

Pattern: .*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "project": { 
      "activeExperimentCount": number,
      "activeLaunchCount": number,
      "appConfigResource": { 
         "applicationId": "string",
         "configurationProfileId": "string",
         "environmentId": "string"
      },
      "arn": "string",
      "createdTime": number,
      "dataDelivery": { 
         "cloudWatchLogs": { 
            "logGroup": "string"
         },
         "s3Destination": { 
            "bucket": "string",
            "prefix": "string"
         }
      },
      "description": "string",
      "experimentCount": number,
      "featureCount": number,
      "lastUpdatedTime": number,
      "launchCount": number,
      "name": "string",
      "status": "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.

project

A structure containing information about the updated project.

Type: Project object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

A resource was in an inconsistent state during an update or a deletion.

HTTP Status Code: 409

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ValidationException

The value of a parameter in the request caused an error.

HTTP Status Code: 400