create_delegation_request async ¶

async def create_delegation_request(
    self,
    description: "capo_iam.types.delegation_request_description_type.delegationRequestDescriptionType",
    permissions: "capo_iam.types.delegation_permission.DelegationPermission",
    requestor_workflow_id: "capo_iam.types.requestor_workflow_id_type.requestorWorkflowIdType",
    notification_channel: "capo_iam.types.notification_channel_type.notificationChannelType",
    session_duration: "capo_iam.types.session_duration_type.sessionDurationType",
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
    owner_account_id: Optional[
        "capo_iam.types.account_id_type.accountIdType"
    ] = None,
    request_message: Optional[
        "capo_iam.types.request_message_type.requestMessageType"
    ] = None,
    redirect_url: Optional[
        "capo_iam.types.redirect_url_type.redirectUrlType"
    ] = None,
    only_send_by_owner: Optional["capo_iam.types.boolean_type.booleanType"] = None,
) -> "capo_iam.types.create_delegation_request_response.CreateDelegationRequestResponse":
    """<p>Creates an IAM delegation request for temporary access delegation.</p> <p>This API is not available for general use. In order to use this API, a caller first need to go through an onboarding process described in the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation-partner-guide.html">partner onboarding documentation</a>. </p>

    Args:
        owner_account_id: <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: <p>A description of the delegation request.</p>
        permissions: <p>The permissions to be delegated in this delegation request.</p>
        request_message: <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: <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: <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: <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: <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: <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>

    Raises:
        capo_iam.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.</p>
        capo_iam.errors.entity_already_exists_exception.EntityAlreadyExistsException: <p>The request was rejected because it attempted to create a resource that already exists.</p>
        capo_iam.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_iam.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iam.types.create_delegation_request_request.CreateDelegationRequestRequest]",
    ) -> AsyncOperationResponse[
        "capo_iam.types.create_delegation_request_response.CreateDelegationRequestResponse"
    ]:
        import capo_iam._operations.aws_identity_management_v20100508.create_delegation_request

        (
            output,
            http_response,
        ) = await capo_iam._operations.aws_identity_management_v20100508.create_delegation_request.async_create_delegation_request(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDelegationRequest")
    )
    input_: capo_iam.types.create_delegation_request_request.CreateDelegationRequestRequest = {
        "description": description,
        "permissions": permissions,
        "requestor_workflow_id": requestor_workflow_id,
        "notification_channel": notification_channel,
        "session_duration": session_duration,
    }
    if owner_account_id is not None:
        input_["owner_account_id"] = owner_account_id
    if request_message is not None:
        input_["request_message"] = request_message
    if redirect_url is not None:
        input_["redirect_url"] = redirect_url
    if only_send_by_owner is not None:
        input_["only_send_by_owner"] = only_send_by_owner

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output