get-policy

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 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 GetGroupPolicy or GetRolePolicy API.

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

Refer to AWS API Documentation.

Synopsis

get-policy
--policy-arn <value>

Options

--policy-arn (string)

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

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

Refer to AWS help for descriptions of global parameters.

Examples

To retrieve information about the specified managed policy

This example returns details about the managed policy whose ARN is arn:aws:iam::123456789012:policy/MySamplePolicy

aws iam --endpoint-url https://iam.<base-domain-name> \
get-policy --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy

Output example:

{
 "Policy": {
      "PolicyName": "MySamplePolicy",
      "CreateDate": "2015-06-17T19:23;32Z",
      "AttachmentCount": "0",
      "IsAttachable": "true",
             "PolicyId": "Z27SI6FQMGNQ2EXAMPLE1",
      "DefaultVersionId": "v1",
             "Path": "/",
             "Arn": "arn:aws:iam::123456789012:policy/MySamplePolicy",
             "UpdateDate": "2015-06-17T19:23:32Z"
  }
}

For more information, refer to Overview of IAM Policies in the Using IAM guide.

Output

Policy -> (structure)

A structure containing details about the policy.

PolicyName -> (string)

The friendly name (not ARN) identifying the policy.

PolicyId -> (string)

The stable and unique string identifying the policy.

For more information about IDs, refer to the AWS IAM Identifiers documentation.

Arn -> (string)

The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

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

Path -> (string)

The path to the policy.

For more information about paths, refer to the AWS IAM Identifiers documentation.

DefaultVersionId -> (string)

The identifier for the version of the policy that is set as the default version.

AttachmentCount -> (integer)

The number of entities (users, groups, and roles) that the policy is attached to.

PermissionsBoundaryUsageCount -> (integer)

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, refer to Permissions Boundaries for IAM Identities in the IAM User Guide.

IsAttachable -> (boolean)

Specifies whether the policy can be attached to an IAM user, group, or role.

Description -> (string)

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

CreateDate -> (timestamp)

The date and time, in ISO 8601 date-time format, when the policy was created.

UpdateDate -> (timestamp)

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.