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

UpdatePolicy

Updates an existing resilience policy.

Request Syntax


POST /v2/update-policy HTTP/1.1
Content-type: application/json

{
   "availabilitySlo": { 
      "target": number
   },
   "dataRecovery": { 
      "timeBetweenBackupsInMinutes": number
   },
   "description": "string",
   "multiAz": { 
      "disasterRecoveryApproach": "string",
      "rpoInMinutes": number,
      "rtoInMinutes": number
   },
   "multiRegion": { 
      "disasterRecoveryApproach": "string",
      "rpoInMinutes": number,
      "rtoInMinutes": number
   },
   "policyArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

availabilitySlo

The updated availability SLO for the policy.

Type: AvailabilitySlo object

Required: No

dataRecovery

The updated data recovery targets for the policy.

Type: DataRecoveryTargets object

Required: No

description

Resource description for services and policies.

Type: String

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

Required: No

multiAz

The updated multi-AZ disaster recovery targets for the policy.

Type: MultiAzTargets object

Required: No

multiRegion

The updated multi-Region disaster recovery targets for the policy.

Type: MultiRegionTargets object

Required: No

policyArn

ARN identifier.

Type: String

Length Constraints: Minimum length of 31.

Pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "policy": { 
      "associatedServiceCount": number,
      "availabilitySlo": { 
         "target": number
      },
      "createdAt": number,
      "dataRecovery": { 
         "timeBetweenBackupsInMinutes": number
      },
      "description": "string",
      "kmsKeyId": "string",
      "multiAz": { 
         "disasterRecoveryApproach": "string",
         "rpoInMinutes": number,
         "rtoInMinutes": number
      },
      "multiRegion": { 
         "disasterRecoveryApproach": "string",
         "rpoInMinutes": number,
         "rtoInMinutes": number
      },
      "name": "string",
      "policyArn": "string",
      "tags": { 
         "string" : "string" 
      },
      "updatedAt": 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.

policy

The updated policy.

Type: Policy object

Errors

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

AccessDeniedException

Access denied — caller lacks required permissions.

HTTP Status Code: 403

ConflictException

Conflict — resource already exists.

HTTP Status Code: 409

InternalServerException

Internal service error.

HTTP Status Code: 500

ResourceNotFoundException

Resource not found.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 404

ValidationException

Validation error — invalid input parameters.

fieldList: The list of fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400