listPolicies method

Future<ListPoliciesResponse> listPolicies({ String? marker, int? maxItems, bool? onlyAttached, String? pathPrefix, PolicyUsageType? policyUsageFilter, PolicyScopeType? scope, })

Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

May throw ServiceFailureException.

Parameter marker : 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.

Parameter maxItems : 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.

Parameter onlyAttached : 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.

Parameter pathPrefix : 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.

Parameter policyUsageFilter : 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.

Parameter scope : The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

Implementation

Future<ListPoliciesResponse> listPolicies({
  String? marker,
  int? maxItems,
  bool? onlyAttached,
  String? pathPrefix,
  PolicyUsageType? policyUsageFilter,
  PolicyScopeType? scope,
}) async {
  _s.validateStringLength(
    'marker',
    marker,
    1,
    320,
  );
  _s.validateNumRange(
    'maxItems',
    maxItems,
    1,
    1000,
  );
  _s.validateStringLength(
    'pathPrefix',
    pathPrefix,
    1,
    512,
  );
  final $request = <String, dynamic>{};
  marker?.also((arg) => $request['Marker'] = arg);
  maxItems?.also((arg) => $request['MaxItems'] = arg);
  onlyAttached?.also((arg) => $request['OnlyAttached'] = arg);
  pathPrefix?.also((arg) => $request['PathPrefix'] = arg);
  policyUsageFilter
      ?.also((arg) => $request['PolicyUsageFilter'] = arg.toValue());
  scope?.also((arg) => $request['Scope'] = arg.toValue());
  final $result = await _protocol.send(
    $request,
    action: 'ListPolicies',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListPoliciesRequest'],
    shapes: shapes,
    resultWrapper: 'ListPoliciesResult',
  );
  return ListPoliciesResponse.fromXml($result);
}