PutResourcePolicy
Use this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM.
Request Syntax
PUT /appmonitor/Name/policy HTTP/1.1
Content-type: application/json
{
"PolicyDocument": "string",
"PolicyRevisionId": "string"
}URI Request Parameters
The request uses the following URI parameters.
- Name
-
The name of the app monitor that you want to apply this resource-based policy to. To find the names of your app monitors, you can use the ListAppMonitors operation.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(?!\.)[\.\-_#A-Za-z0-9]+$Required: Yes
Request Body
The request accepts the following data in JSON format.
- PolicyDocument
-
The JSON to use as the resource policy. The document can be up to 4 KB in size. For more information about the contents and syntax for this policy, see Using resource-based policies with CloudWatch RUM.
Type: String
Required: Yes
- PolicyRevisionId
-
A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.
When you assign a policy revision ID, then later requests about that policy will be rejected with an
InvalidPolicyRevisionIdExceptionerror if they don't provide the correct current revision ID.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"PolicyDocument": "string",
"PolicyRevisionId": "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.
- PolicyDocument
-
The JSON policy document that you specified.
Type: String
- PolicyRevisionId
-
The policy revision ID information that you specified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permissions to perform this action.
HTTP Status Code: 403
- ConflictException
-
This operation attempted to create a resource that already exists.
HTTP Status Code: 409
- InternalServerException
-
Internal service exception.
HTTP Status Code: 500
- InvalidPolicyRevisionIdException
-
The policy revision ID that you provided doeesn't match the latest policy revision ID.
HTTP Status Code: 400
- MalformedPolicyDocumentException
-
The policy document that you specified is not formatted correctly.
HTTP Status Code: 400
- PolicySizeLimitExceededException
-
The policy document is too large. The limit is 4 KB.
HTTP Status Code: 400
- ResourceNotFoundException
-
Resource not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was throttled because of quota limits.
HTTP Status Code: 429
- ValidationException
-
One of the arguments for the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
