Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

PutResourcePolicy

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an AWS account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems).

Request Syntax


{
   "Policy": "string",
   "PolicyHash": "string",
   "PolicyId": "string",
   "ResourceArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Policy

A policy you want to associate with a resource.

Type: String

Pattern: \S+

Required: Yes

PolicyHash

ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.

Type: String

Required: No

PolicyId

The policy ID.

Type: String

Required: No

ResourceArn

Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Response Syntax


{
   "PolicyHash": "string",
   "PolicyId": "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.

PolicyHash

ID of the current policy version.

Type: String

PolicyId

The policy ID. To update a policy, you must specify PolicyId and PolicyHash.

Type: String

Errors

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

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ResourcePolicyConflictException

The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.

HTTP Status Code: 400

ResourcePolicyInvalidParameterException

One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.

HTTP Status Code: 400

ResourcePolicyLimitExceededException

The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. Verify these limits and try again.

HTTP Status Code: 400