PutResourcePolicy (smaws-clients.Smaws_Client

Module Smaws_Client_SSM.PutResourcePolicy

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).

To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.

To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.

While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option.

For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InternalServerError of Types.internal_server_error
  | `MalformedResourcePolicyDocumentException of
    Types.malformed_resource_policy_document_exception
  | `ResourceNotFoundException of Types.resource_not_found_exception
  | `ResourcePolicyConflictException of
    Types.resource_policy_conflict_exception
  | `ResourcePolicyInvalidParameterException of
    Types.resource_policy_invalid_parameter_exception
  | `ResourcePolicyLimitExceededException of
    Types.resource_policy_limit_exceeded_exception
  | `ResourcePolicyNotFoundException of
    Types.resource_policy_not_found_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.put_resource_policy_request ->
  (Types.put_resource_policy_response,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServerError of Types.internal_server_error
    | `MalformedResourcePolicyDocumentException of
      Types.malformed_resource_policy_document_exception
    | `ResourceNotFoundException of Types.resource_not_found_exception
    | `ResourcePolicyConflictException of
      Types.resource_policy_conflict_exception
    | `ResourcePolicyInvalidParameterException of
      Types.resource_policy_invalid_parameter_exception
    | `ResourcePolicyLimitExceededException of
      Types.resource_policy_limit_exceeded_exception
    | `ResourcePolicyNotFoundException of
      Types.resource_policy_not_found_exception ])
    Stdlib.result