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

PutDomainPermissionsPolicy

Sets a resource policy on a domain that specifies permissions to access it.

When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

Request Syntax


PUT /v1/domain/permissions/policy HTTP/1.1
Content-type: application/json

{
   "domain": "string",
   "domainOwner": "string",
   "policyDocument": "string",
   "policyRevision": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

domain

The name of the domain on which to set the resource policy.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Required: Yes

domainOwner

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

policyDocument

A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 7168.

Pattern: [\P{C}\s]+

Required: Yes

policyRevision

The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: \S+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "policy": { 
      "document": "string",
      "resourceArn": "string",
      "revision": "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.

policy

The resource policy that was set after processing the request.

Type: ResourcePolicy object

Errors

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

AccessDeniedException

The operation did not succeed because of an unauthorized access attempt.

HTTP Status Code: 403

ConflictException

The operation did not succeed because prerequisites are not met.

resourceId: The ID of the resource.
resourceType: The type of AWS resource.

HTTP Status Code: 409

InternalServerException

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

HTTP Status Code: 500

ResourceNotFoundException

The operation did not succeed because the resource requested is not found in the service.

resourceId: The ID of the resource.
resourceType: The type of AWS resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The operation did not succeed because it would have exceeded a service limit for your account.

resourceId: The ID of the resource.
resourceType: The type of AWS resource.

HTTP Status Code: 402

ThrottlingException

The operation did not succeed because too many requests are sent to the service.

retryAfterSeconds: The time period, in seconds, to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The operation did not succeed because a parameter in the request was sent with an invalid value.

reason

HTTP Status Code: 400