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

Inherits:

Struct

• Object
• Struct
• Aws::Organizations::Types::PolicySummary

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the policy.

• #aws_managed ⇒ Boolean

  A boolean value that indicates whether the specified policy is an AWS managed policy.

• #description ⇒ String

  The description of the policy.

• #id ⇒ String

  The unique identifier (ID) of the policy.

• #name ⇒ String

  The friendly name of the policy.

• #type ⇒ String

  The type of policy.

Instance Attribute Details

#arn ⇒ String

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

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2636

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

#aws_managed ⇒ Boolean

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)

# File 'lib/aws-sdk-organizations/types.rb', line 2636

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

#description ⇒ String

The description of the policy.

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2636

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

#id ⇒ String

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.

[1]: wikipedia.org/wiki/regex

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2636

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

#name ⇒ String

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.

[1]: wikipedia.org/wiki/regex

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2636

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

#type ⇒ String

The type of policy.

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2636

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