listAttachedRolePolicies method

Future<ListAttachedRolePoliciesResponse> listAttachedRolePolicies({ required String roleName, String? marker, int? maxItems, String? pathPrefix, })

Lists all managed policies that are attached to the specified IAM role.

An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

May throw NoSuchEntityException. May throw InvalidInputException. May throw ServiceFailureException.

Parameter roleName : The name (friendly name, not ARN) of the role to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

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

Implementation

Future<ListAttachedRolePoliciesResponse> listAttachedRolePolicies({
  required String roleName,
  String? marker,
  int? maxItems,
  String? pathPrefix,
}) async {
  ArgumentError.checkNotNull(roleName, 'roleName');
  _s.validateStringLength(
    'roleName',
    roleName,
    1,
    64,
    isRequired: true,
  );
  _s.validateStringLength(
    'marker',
    marker,
    1,
    320,
  );
  _s.validateNumRange(
    'maxItems',
    maxItems,
    1,
    1000,
  );
  _s.validateStringLength(
    'pathPrefix',
    pathPrefix,
    1,
    512,
  );
  final $request = <String, dynamic>{};
  $request['RoleName'] = roleName;
  marker?.also((arg) => $request['Marker'] = arg);
  maxItems?.also((arg) => $request['MaxItems'] = arg);
  pathPrefix?.also((arg) => $request['PathPrefix'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListAttachedRolePolicies',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListAttachedRolePoliciesRequest'],
    shapes: shapes,
    resultWrapper: 'ListAttachedRolePoliciesResult',
  );
  return ListAttachedRolePoliciesResponse.fromXml($result);
}