UpdatePracticeRunConfiguration
Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
Request Syntax
PATCH /configuration/resourceIdentifier HTTP/1.1
Content-type: application/json
{
"blockedDates": [ "string" ],
"blockedWindows": [ "string" ],
"blockingAlarms": [
{
"alarmIdentifier": "string",
"type": "string"
}
],
"outcomeAlarms": [
{
"alarmIdentifier": "string",
"type": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- resourceIdentifier
-
The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
Length Constraints: Minimum length of 8. Maximum length of 1024.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- blockedDates
-
Add, change, or remove blocked dates for a practice run in zonal autoshift.
Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for
2024-05-01.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 15 items.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}$Required: No
- blockedWindows
-
Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example:
MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 15 items.
Length Constraints: Fixed length of 19.
Pattern:
^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}$Required: No
- blockingAlarms
-
Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.
Type: Array of ControlCondition objects
Array Members: Fixed number of 1 item.
Required: No
- outcomeAlarms
-
Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.
Type: Array of ControlCondition objects
Array Members: Fixed number of 1 item.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"name": "string",
"practiceRunConfiguration": {
"blockedDates": [ "string" ],
"blockedWindows": [ "string" ],
"blockingAlarms": [
{
"alarmIdentifier": "string",
"type": "string"
}
],
"outcomeAlarms": [
{
"alarmIdentifier": "string",
"type": "string"
}
]
},
"zonalAutoshiftStatus": "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.
- arn
-
The Amazon Resource Name (ARN) of the resource that you updated the practice run for.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 1024.
Pattern:
^arn:.*$ - name
-
The name of the resource that you updated the practice run for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- practiceRunConfiguration
-
The practice run configuration that was updated.
Type: PracticeRunConfiguration object
- zonalAutoshiftStatus
-
The zonal autoshift status for the resource that you updated the practice run for.
Type: String
Valid Values:
ENABLED | DISABLED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
There was an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The input requested a resource that was not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
