ActivateEvaluationForm
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
Request Syntax
POST /evaluation-forms/InstanceId/EvaluationFormId/activate HTTP/1.1
Content-type: application/json
{
"EvaluationFormVersion": number
}URI Request Parameters
The request uses the following URI parameters.
- EvaluationFormId
-
The unique identifier for the evaluation form.
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- EvaluationFormVersion
-
The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EvaluationFormArn": "string",
"EvaluationFormId": "string",
"EvaluationFormVersion": 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.
- EvaluationFormArn
-
The Amazon Resource Name (ARN) for the evaluation form resource.
Type: String
- EvaluationFormId
-
The unique identifier for the evaluation form.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
- EvaluationFormVersion
-
A version of the evaluation form.
Type: Integer
Valid Range: Minimum value of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- ResourceConflictException
-
A resource already has that name.
HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
Examples
Example
The following example activates version 3 of an evaluation form.
Sample Request
{
"InstanceId": "[instance_id]",
"EvaluationFormId": "[evaluation_form_id]",
"EvaluationFormVersion": 3
}Sample Response
{
"EvaluationFormId": "[evaluation_form_id]",
"EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
"EvaluationFormVersion": 3
} See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
