getPolicy method

Future<GetPolicyResponse> getPolicy({ required String policyArn, })

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

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

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

Parameter policyArn : The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Implementation

Future<GetPolicyResponse> getPolicy({
  required String policyArn,
}) async {
  ArgumentError.checkNotNull(policyArn, 'policyArn');
  _s.validateStringLength(
    'policyArn',
    policyArn,
    20,
    2048,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['PolicyArn'] = policyArn;
  final $result = await _protocol.send(
    $request,
    action: 'GetPolicy',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['GetPolicyRequest'],
    shapes: shapes,
    resultWrapper: 'GetPolicyResult',
  );
  return GetPolicyResponse.fromXml($result);
}