Skip to content

CreateDelegationRequestRequest

Source code in docs_src/capo_iam/types/create_delegation_request_request.py
class CreateDelegationRequestRequest(TypedDict, closed=True):
    owner_account_id: NotRequired["capo_iam.types.account_id_type.accountIdType"]
    """<p>The Amazon Web Services account ID this delegation request is targeted to.</p> <p>If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.</p>"""
    description: "capo_iam.types.delegation_request_description_type.delegationRequestDescriptionType"
    """<p>A description of the delegation request.</p>"""
    permissions: "capo_iam.types.delegation_permission.DelegationPermission"
    """<p>The permissions to be delegated in this delegation request.</p>"""
    request_message: NotRequired[
        "capo_iam.types.request_message_type.requestMessageType"
    ]
    """<p>A message explaining the reason for the delegation request.</p> <p>Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.</p> <p>For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.</p>"""
    requestor_workflow_id: (
        "capo_iam.types.requestor_workflow_id_type.requestorWorkflowIdType"
    )
    """<p>The workflow ID associated with the requestor.</p> <p>This is the unique identifier on the partner side that can be used to track the progress of the request.</p> <p>IAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request is passed, this API call will fail.</p>"""
    redirect_url: NotRequired["capo_iam.types.redirect_url_type.redirectUrlType"]
    """<p>The URL to redirect to after the delegation request is processed.</p> <p>This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.</p>"""
    notification_channel: (
        "capo_iam.types.notification_channel_type.notificationChannelType"
    )
    """<p>The notification channel for updates about the delegation request.</p> <p>At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting <code>SNS:Publish</code> permission to the IAM service principal (<code>iam.amazonaws.com</code>). See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation-partner-guide.html">partner onboarding documentation</a> for more details. </p>"""
    session_duration: "capo_iam.types.session_duration_type.sessionDurationType"
    """<p>The duration for which the delegated session should remain active, in seconds.</p> <p>The active time window for the session starts when the customer calls the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_SendDelegationToken.html">SendDelegationToken</a> API.</p>"""
    only_send_by_owner: "capo_iam.types.boolean_type.booleanType"
    """<p>Specifies whether the delegation token should only be sent by the owner.</p> <p>This flag prevents any party other than the owner from calling <code>SendDelegationToken</code> API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions. </p>"""

description instance-attribute

A description of the delegation request.

notification_channel instance-attribute

notification_channel: notificationChannelType

The notification channel for updates about the delegation request.

At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting SNS:Publish permission to the IAM service principal (iam.amazonaws.com). See partner onboarding documentation for more details.

only_send_by_owner instance-attribute

only_send_by_owner: booleanType

Specifies whether the delegation token should only be sent by the owner.

This flag prevents any party other than the owner from calling SendDelegationToken API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions.

owner_account_id instance-attribute

owner_account_id: NotRequired[accountIdType]

The Amazon Web Services account ID this delegation request is targeted to.

If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.

permissions instance-attribute

permissions: DelegationPermission

The permissions to be delegated in this delegation request.

redirect_url instance-attribute

redirect_url: NotRequired[redirectUrlType]

The URL to redirect to after the delegation request is processed.

This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.

request_message instance-attribute

request_message: NotRequired[requestMessageType]

A message explaining the reason for the delegation request.

Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.

For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.

requestor_workflow_id instance-attribute

requestor_workflow_id: requestorWorkflowIdType

The workflow ID associated with the requestor.

This is the unique identifier on the partner side that can be used to track the progress of the request.

IAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request is passed, this API call will fail.

session_duration instance-attribute

session_duration: sessionDurationType

The duration for which the delegated session should remain active, in seconds.

The active time window for the session starts when the customer calls the SendDelegationToken API.