AWS Backup
Developer Guide

PutBackupVaultAccessPolicy

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

Request Syntax

PUT /backup-vaults/backupVaultName/access-policy HTTP/1.1 Content-type: application/json { "Policy": "string" }

URI Request Parameters

The request requires the following URI parameters.

backupVaultName

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Request Body

The request accepts the following data in JSON format.

Policy

The backup vault access policy document in JSON format.

Type: String

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: