Class: Aws::Comprehend::Types::PutResourcePolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass PutResourcePolicyRequest data as a hash:

{
  resource_arn: "ComprehendModelArn", # required
  resource_policy: "Policy", # required
  policy_revision_id: "PolicyRevisionId",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#policy_revision_id ⇒ String

The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don't use this parameter. Amazon Comprehend creates the revision ID for you.

Returns:

  • (String) 


5352
5353
5354
5355
5356
5357
5358
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5352

class PutResourcePolicyRequest < Struct.new(
  :resource_arn,
  :resource_policy,
  :policy_revision_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

The Amazon Resource Name (ARN) of the custom model to attach the policy to.

Returns:

  • (String) 


5352
5353
5354
5355
5356
5357
5358
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5352

class PutResourcePolicyRequest < Struct.new(
  :resource_arn,
  :resource_policy,
  :policy_revision_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_policy ⇒ String

The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"\{"attribute": "value", "attribute": ["value"]\}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'\{"attribute": "value", "attribute": ["value"]\}'

Returns:

  • (String) 


5352
5353
5354
5355
5356
5357
5358
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5352

class PutResourcePolicyRequest < Struct.new(
  :resource_arn,
  :resource_policy,
  :policy_revision_id)
  SENSITIVE = []
  include Aws::Structure
end