Skip to content
AWS for Query.Farm

aws.iam.get_policy

Example SQL Queries

SELECT * FROM
aws.iam.get_policy
WHERE
"policy_arn" = 'VALUE';

Description

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 ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

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

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

Table Definition

Column NameColumn Data Type
policy_arn Required Input Column

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

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

policy

A structure containing details about the policy.

STRUCT(
    "policy_name" VARCHAR,
    "policy_id" VARCHAR,
    "arn" VARCHAR,
    "path" VARCHAR,
    "default_version_id" VARCHAR,
    "attachment_count" BIGINT,
    "permissions_boundary_usage_count" BIGINT,
    "is_attachable" BOOLEAN,
    "description" VARCHAR,
    "create_date" TIMESTAMP_S,
    "update_date" TIMESTAMP_S,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[]
)
Show child fields
policy.arn

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

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

policy.attachment_count

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

policy.create_date

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

policy.default_version_id

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

policy.description

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.

policy.is_attachable

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

policy.path

The path to the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

policy.permissions_boundary_usage_count

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

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

policy.policy_id

The stable and unique string identifying the policy.

For more information about IDs, see IAM identifiers in the IAM User Guide.

policy.policy_name

The friendly name (not ARN) identifying the policy.

policy.tags[]
Show child fields
policy.tags[].key

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

policy.tags[].value

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

policy.update_date

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.