Skip to content

Role

Source code in docs_src/capo_iam/types/role.py
class Role(TypedDict, closed=True):
    path: "capo_iam.types.path_type.pathType"
    """<p> The path to the role. 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>"""
    role_name: "capo_iam.types.role_name_type.roleNameType"
    """<p>The friendly name that identifies the role.</p>"""
    role_id: "capo_iam.types.id_type.idType"
    """<p> The stable and unique string identifying the role. 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: "capo_iam.types.arn_type.arnType"
    """<p> The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i> guide. </p>"""
    create_date: "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 role was created.</p>"""
    assume_role_policy_document: NotRequired[
        "capo_iam.types.policy_document_type.policyDocumentType"
    ]
    """<p>The policy that grants an entity permission to assume the role.</p>"""
    description: NotRequired["capo_iam.types.role_description_type.roleDescriptionType"]
    """<p>A description of the role that you provide.</p>"""
    max_session_duration: NotRequired[
        "capo_iam.types.role_max_session_duration_type.roleMaxSessionDurationType"
    ]
    """<p>The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional <code>DurationSeconds</code> API parameter or <code>duration-seconds</code> CLI parameter.</p>"""
    permissions_boundary: NotRequired[
        "capo_iam.types.attached_permissions_boundary.AttachedPermissionsBoundary"
    ]
    """<p>The ARN of the policy used to set the permissions boundary for the role.</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>"""
    tags: NotRequired["capo_iam.types.tag_list_type.tagListType"]
    """<p>A list of tags that are attached to the role. 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>"""
    role_last_used: NotRequired["capo_iam.types.role_last_used.RoleLastUsed"]
    """<p>Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period">Regions where data is tracked</a> in the <i>IAM user Guide</i>.</p>"""
    source_role_template: NotRequired[
        "capo_iam.types.source_role_template.SourceRoleTemplate"
    ]
    """<p>Contains information about the role template that this role was created from. This member is present only for roles created with <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_AcquireRole.html">AcquireRole</a>.</p>"""

arn instance-attribute

arn: arnType

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.

assume_role_policy_document instance-attribute

assume_role_policy_document: NotRequired[policyDocumentType]

The policy that grants an entity permission to assume the role.

create_date instance-attribute

create_date: dateType

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

description instance-attribute

description: NotRequired[roleDescriptionType]

A description of the role that you provide.

max_session_duration instance-attribute

max_session_duration: NotRequired[roleMaxSessionDurationType]

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

path instance-attribute

path: pathType

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

permissions_boundary instance-attribute

permissions_boundary: NotRequired[AttachedPermissionsBoundary]

The ARN of the policy used to set the permissions boundary for the role.

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

role_id instance-attribute

role_id: idType

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

role_last_used instance-attribute

role_last_used: NotRequired[RoleLastUsed]

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

role_name instance-attribute

role_name: roleNameType

The friendly name that identifies the role.

source_role_template instance-attribute

source_role_template: NotRequired[SourceRoleTemplate]

Contains information about the role template that this role was created from. This member is present only for roles created with AcquireRole.

tags instance-attribute

tags: NotRequired[tagListType]

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