Class: Aws::IAM::Types::ListPoliciesRequest

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::ListPoliciesRequest

Defined in:

gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #marker ⇒ String

  Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.

• #max_items ⇒ Integer

  Use this only when paginating results to indicate the maximum number of items you want in the response.

• #only_attached ⇒ Boolean

  A flag to filter the results to only the attached policies.

• #path_prefix ⇒ String

  The path prefix for filtering the results.

• #policy_usage_filter ⇒ String

  The policy usage method to use for filtering the results.

• #scope ⇒ String

  The scope to use for filtering the results.

Instance Attribute Details

#marker ⇒ String

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6133

class ListPoliciesRequest < Struct.new(
  :scope,
  :only_attached,
  :path_prefix,
  :policy_usage_filter,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#max_items ⇒ Integer

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Returns:

• (Integer)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6133

class ListPoliciesRequest < Struct.new(
  :scope,
  :only_attached,
  :path_prefix,
  :policy_usage_filter,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#only_attached ⇒ Boolean

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6133

class ListPoliciesRequest < Struct.new(
  :scope,
  :only_attached,
  :path_prefix,
  :policy_usage_filter,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#path_prefix ⇒ String

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6133

class ListPoliciesRequest < Struct.new(
  :scope,
  :only_attached,
  :path_prefix,
  :policy_usage_filter,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#policy_usage_filter ⇒ String

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6133

class ListPoliciesRequest < Struct.new(
  :scope,
  :only_attached,
  :path_prefix,
  :policy_usage_filter,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6133

class ListPoliciesRequest < Struct.new(
  :scope,
  :only_attached,
  :path_prefix,
  :policy_usage_filter,
  :marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end