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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass ListPoliciesRequest data as a hash:

{
  scope: "All", # accepts All, AWS, Local
  only_attached: false,
  path_prefix: "policyPathType",
  policy_usage_filter: "PermissionsPolicy", # accepts PermissionsPolicy, PermissionsBoundary
  marker: "markerType",
  max_items: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#markerString

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)

6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
# File 'lib/aws-sdk-iam/types.rb', line 6813

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

#max_itemsInteger

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)

6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
# File 'lib/aws-sdk-iam/types.rb', line 6813

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

#only_attachedBoolean

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)

6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
# File 'lib/aws-sdk-iam/types.rb', line 6813

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

#path_prefixString

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)

6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
# File 'lib/aws-sdk-iam/types.rb', line 6813

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

#policy_usage_filterString

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)

6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
# File 'lib/aws-sdk-iam/types.rb', line 6813

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

#scopeString

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)

6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
# File 'lib/aws-sdk-iam/types.rb', line 6813

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