Skip to content

DelegationRequest

Source code in docs_src/capo_iam/types/delegation_request.py
class DelegationRequest(TypedDict, closed=True):
    delegation_request_id: NotRequired[
        "capo_iam.types.delegation_request_id_type.delegationRequestIdType"
    ]
    """<p>The unique identifier for the delegation request.</p>"""
    owner_account_id: NotRequired["capo_iam.types.account_id_type.accountIdType"]
    """<p>Amazon Web Services account ID of the owner of the delegation request.</p>"""
    description: NotRequired[
        "capo_iam.types.delegation_request_description_type.delegationRequestDescriptionType"
    ]
    """<p>Description of the delegation request. This is a message that is provided by the Amazon Web Services partner that filed the delegation request.</p>"""
    request_message: NotRequired[
        "capo_iam.types.request_message_type.requestMessageType"
    ]
    """<p>A custom message that is added to the delegation request by the partner.</p> <p>This element is different from the <code>Description</code> element such that this is a request specific message injected by the partner. The <code>Description</code> is typically a generic explanation of what the delegation request is targeted to do.</p>"""
    permissions: NotRequired[
        "capo_iam.types.delegation_permission.DelegationPermission"
    ]
    permission_policy: NotRequired["capo_iam.types.permission_type.permissionType"]
    """<p>JSON content of the associated permission policy of this delegation request.</p>"""
    role_permission_restriction_arns: NotRequired[
        "capo_iam.types.role_permission_restriction_arn_list_type.rolePermissionRestrictionArnListType"
    ]
    """<p>If the <code>PermissionPolicy</code> includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html">Permissions boundaries for IAM entities</a> for more details about IAM permission boundaries. </p>"""
    owner_id: NotRequired["capo_iam.types.owner_id_type.ownerIdType"]
    """<p>ARN of the owner of this delegation request.</p>"""
    approver_id: NotRequired["capo_iam.types.arn_type.arnType"]
    state: NotRequired["capo_iam.types.state_type.stateType"]
    """<p>The state of this delegation request.</p> <p>See the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/temporary-delegation-building-integration.html#temporary-delegation-request-lifecycle">Understanding the Request Lifecycle</a> for an explanation of how these states are transitioned. </p>"""
    expiration_time: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>The expiry time of this delegation request</p> <p>See the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/temporary-delegation-building-integration.html#temporary-delegation-request-lifecycle">Understanding the Request Lifecycle</a> for details on the life time of a delegation request at each state.</p>"""
    requestor_id: NotRequired["capo_iam.types.account_id_type.accountIdType"]
    """<p>Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.</p>"""
    requestor_name: NotRequired["capo_iam.types.requestor_name_type.requestorNameType"]
    """<p>A friendly name of the requestor.</p>"""
    create_date: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>Creation date (timestamp) of this delegation request.</p>"""
    session_duration: NotRequired[
        "capo_iam.types.session_duration_type.sessionDurationType"
    ]
    """<p>The life-time of the requested session credential.</p>"""
    redirect_url: NotRequired["capo_iam.types.redirect_url_type.redirectUrlType"]
    """<p>A URL to be redirected to once the delegation request is approved. Partners provide this URL when creating the delegation request.</p>"""
    notes: NotRequired["capo_iam.types.notes_type.notesType"]
    """<p>Notes added to this delegation request, if this request was updated via the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateDelegationRequest.html">UpdateDelegationRequest</a> API.</p>"""
    rejection_reason: NotRequired["capo_iam.types.notes_type.notesType"]
    """<p>Reasons for rejecting this delegation request, if this request was rejected. See also <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_RejectDelegationRequest.html">RejectDelegationRequest</a> API documentation. </p>"""
    only_send_by_owner: "capo_iam.types.boolean_type.booleanType"
    """<p>A flag indicating whether the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_SendDelegationToken.html">SendDelegationToken</a> must be called by the owner of this delegation request. This is set by the requesting partner.</p>"""
    updated_time: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>Last updated timestamp of the request.</p>"""

approver_id instance-attribute

approver_id: NotRequired[arnType]

create_date instance-attribute

create_date: NotRequired[dateType]

Creation date (timestamp) of this delegation request.

delegation_request_id instance-attribute

delegation_request_id: NotRequired[delegationRequestIdType]

The unique identifier for the delegation request.

description instance-attribute

description: NotRequired[delegationRequestDescriptionType]

Description of the delegation request. This is a message that is provided by the Amazon Web Services partner that filed the delegation request.

expiration_time instance-attribute

expiration_time: NotRequired[dateType]

The expiry time of this delegation request

See the Understanding the Request Lifecycle for details on the life time of a delegation request at each state.

notes instance-attribute

notes: NotRequired[notesType]

Notes added to this delegation request, if this request was updated via the UpdateDelegationRequest API.

only_send_by_owner instance-attribute

only_send_by_owner: booleanType

A flag indicating whether the SendDelegationToken must be called by the owner of this delegation request. This is set by the requesting partner.

owner_account_id instance-attribute

owner_account_id: NotRequired[accountIdType]

Amazon Web Services account ID of the owner of the delegation request.

owner_id instance-attribute

owner_id: NotRequired[ownerIdType]

ARN of the owner of this delegation request.

permission_policy instance-attribute

permission_policy: NotRequired[permissionType]

JSON content of the associated permission policy of this delegation request.

permissions instance-attribute

permissions: NotRequired[DelegationPermission]

redirect_url instance-attribute

redirect_url: NotRequired[redirectUrlType]

A URL to be redirected to once the delegation request is approved. Partners provide this URL when creating the delegation request.

rejection_reason instance-attribute

rejection_reason: NotRequired[notesType]

Reasons for rejecting this delegation request, if this request was rejected. See also RejectDelegationRequest API documentation.

request_message instance-attribute

request_message: NotRequired[requestMessageType]

A custom message that is added to the delegation request by the partner.

This element is different from the Description element such that this is a request specific message injected by the partner. The Description is typically a generic explanation of what the delegation request is targeted to do.

requestor_id instance-attribute

requestor_id: NotRequired[accountIdType]

Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.

requestor_name instance-attribute

requestor_name: NotRequired[requestorNameType]

A friendly name of the requestor.

role_permission_restriction_arns instance-attribute

role_permission_restriction_arns: NotRequired[rolePermissionRestrictionArnListType]

If the PermissionPolicy includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation. See Permissions boundaries for IAM entities for more details about IAM permission boundaries.

session_duration instance-attribute

session_duration: NotRequired[sessionDurationType]

The life-time of the requested session credential.

state instance-attribute

state: NotRequired[stateType]

The state of this delegation request.

See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

updated_time instance-attribute

updated_time: NotRequired[dateType]

Last updated timestamp of the request.