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.

Constant Summary collapse

SENSITIVE =
[]

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 Amazon Web Services Service Authorization Reference.

Returns:

  • (String)


4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 4454

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

#aws_managedBoolean

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

Returns:

  • (Boolean)


4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 4454

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

#descriptionString

The description of the policy.

Returns:

  • (String)


4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 4454

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  SENSITIVE = []
  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 lowercase or uppercase letters, digits, or the underscore character (_).

Returns:

  • (String)


4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 4454

class PolicySummary < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :type,
  :aws_managed)
  SENSITIVE = []
  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)


4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 4454

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

#typeString

The type of policy.

Returns:

  • (String)


4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 4454

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