Skip to content

Policy

Source code in docs_src/capo_iam/types/policy.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class Policy(TypedDict, closed=True):
    policy_name: NotRequired["capo_iam.types.policy_name_type.policyNameType"]
    """<p>The friendly name (not ARN) identifying the policy.</p>"""
    policy_id: NotRequired["capo_iam.types.id_type.idType"]
    """<p>The stable and unique string identifying the policy.</p> <p>For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>.</p>"""
    arn: NotRequired["capo_iam.types.arn_type.arnType"]
    path: NotRequired["capo_iam.types.policy_path_type.policyPathType"]
    """<p>The path to the policy.</p> <p>For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>.</p>"""
    default_version_id: NotRequired[
        "capo_iam.types.policy_version_id_type.policyVersionIdType"
    ]
    """<p>The identifier for the version of the policy that is set as the default version.</p>"""
    attachment_count: NotRequired[
        "capo_iam.types.attachment_count_type.attachmentCountType"
    ]
    """<p>The number of entities (users, groups, and roles) that the policy is attached to.</p>"""
    permissions_boundary_usage_count: NotRequired[
        "capo_iam.types.attachment_count_type.attachmentCountType"
    ]
    """<p>The number of entities (users and roles) for which the policy is used to set the permissions boundary. </p> <p>For more information about permissions boundaries, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html">Permissions boundaries for IAM identities </a> in the <i>IAM User Guide</i>.</p>"""
    is_attachable: "capo_iam.types.boolean_type.booleanType"
    """<p>Specifies whether the policy can be attached to an IAM user, group, or role.</p>"""
    description: NotRequired[
        "capo_iam.types.policy_description_type.policyDescriptionType"
    ]
    """<p>A friendly description of the policy.</p> <p>This element is included in the response to the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html">GetPolicy</a> operation. It is not included in the response to the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicies.html">ListPolicies</a> operation. </p>"""
    create_date: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the policy was created.</p>"""
    update_date: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the policy was last updated.</p> <p>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.</p>"""
    tags: NotRequired["capo_iam.types.tag_list_type.tagListType"]
    """<p>A list of tags that are attached to the instance profile. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p>"""

arn instance-attribute 

arn: NotRequired[arnType]

attachment_count instance-attribute 

attachment_count: NotRequired[attachmentCountType]

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

create_date instance-attribute 

create_date: NotRequired[dateType]

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

default_version_id instance-attribute 

default_version_id: NotRequired[policyVersionIdType]

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

description instance-attribute 

description: NotRequired[policyDescriptionType]

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.

is_attachable instance-attribute 

is_attachable: booleanType

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

path instance-attribute 

path: NotRequired[policyPathType]

The path to the policy.

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

permissions_boundary_usage_count instance-attribute 

permissions_boundary_usage_count: NotRequired[attachmentCountType]

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_id instance-attribute 

policy_id: NotRequired[idType]

The stable and unique string identifying the policy.

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

policy_name instance-attribute 

policy_name: NotRequired[policyNameType]

The friendly name (not ARN) identifying the policy.

tags instance-attribute 

tags: NotRequired[tagListType]

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

update_date instance-attribute 

update_date: NotRequired[dateType]

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.