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

Class: Aws::Organizations::Types::PolicySummary

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

Overview

Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the policy.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

Returns:

  • (String)


2622
2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2622

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  include Aws::Structure
end

#aws_managedBoolean

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

Returns:

  • (Boolean)


2622
2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2622

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  include Aws::Structure
end

#descriptionString

The description of the policy.

Returns:

  • (String)


2622
2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2622

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  include Aws::Structure
end

#idString

The unique identifier (ID) of the policy.

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

Returns:

  • (String)


2622
2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2622

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  include Aws::Structure
end

#nameString

The friendly name of 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)


2622
2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2622

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  include Aws::Structure
end

#typeString

The type of policy.

Returns:

  • (String)


2622
2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2622

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  include Aws::Structure
end