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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ String

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*.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html

Returns:

  • (String) 


2920
2921
2922
2923
2924
2925
2926
 
# File 'lib/aws-sdk-organizations/types.rb', line 2920

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

#description ⇒ String

If provided, the new description for the policy.

Returns:

  • (String) 


2920
2921
2922
2923
2924
2925
2926
 
# File 'lib/aws-sdk-organizations/types.rb', line 2920

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

#name ⇒ String

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2920
2921
2922
2923
2924
2925
2926
 
# File 'lib/aws-sdk-organizations/types.rb', line 2920

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

#policy_id ⇒ String

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2920
2921
2922
2923
2924
2925
2926
 
# File 'lib/aws-sdk-organizations/types.rb', line 2920

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