You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Organizations::Types::UpdatePolicyRequest

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

Overview

Note:

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

{
  policy_id: "PolicyId", # required
  name: "PolicyName",
  description: "PolicyDescription",
  content: "PolicyContent",
}

Instance Attribute Summary collapse

Instance Attribute Details

#contentString

If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide.

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
2905
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2899

class UpdatePolicyRequest < Struct.new(
  :policy_id,
  :name,
  :description,
  :content)
  include Aws::Structure
end

#descriptionString

If provided, the new description for the policy.

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
2905
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2899

class UpdatePolicyRequest < Struct.new(
  :policy_id,
  :name,
  :description,
  :content)
  include Aws::Structure
end

#nameString

If provided, the new name for the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
2905
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2899

class UpdatePolicyRequest < Struct.new(
  :policy_id,
  :name,
  :description,
  :content)
  include Aws::Structure
end

#policy_idString

The unique identifier (ID) of the policy that you want to update.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
2905
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2899

class UpdatePolicyRequest < Struct.new(
  :policy_id,
  :name,
  :description,
  :content)
  include Aws::Structure
end