Skip to content

create_account_link_invitation async

create_account_link_invitation(
    target_account_id: AwsAccount,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateAccountLinkInvitationResult

Creates the account link invitation.

Parameters:

  • target_account_id (AwsAccount) –

    The identifier of the target account.

  • client_token (Optional[ClientToken], default: None ) –

    A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation.

Raises:

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py
async def create_account_link_invitation(
    self,
    target_account_id: "capo_workspaces.types.aws_account.AwsAccount",
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    client_token: Optional["capo_workspaces.types.client_token.ClientToken"] = None,
) -> "capo_workspaces.types.create_account_link_invitation_result.CreateAccountLinkInvitationResult":
    """<p>Creates the account link invitation.</p>

    Args:
        target_account_id: <p>The identifier of the target account.</p>
        client_token: <p>A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.conflict_exception.ConflictException: <p>The <code>TargetAccountId</code> is already linked or invited.</p>
        capo_workspaces.errors.internal_server_exception.InternalServerException: <p>Unexpected server error occured.</p>
        capo_workspaces.errors.validation_exception.ValidationException: <p>You either haven't provided a <code>TargetAccountId</code> or are using the same value for <code>TargetAccountId</code> and <code>SourceAccountId</code>.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces.types.create_account_link_invitation_request.CreateAccountLinkInvitationRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.create_account_link_invitation_result.CreateAccountLinkInvitationResult"
    ]:
        import capo_workspaces._operations.workspaces_service.create_account_link_invitation

        (
            output,
            http_response,
        ) = await capo_workspaces._operations.workspaces_service.create_account_link_invitation.async_create_account_link_invitation(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAccountLinkInvitation")
    )
    input_: capo_workspaces.types.create_account_link_invitation_request.CreateAccountLinkInvitationRequest = {
        "target_account_id": target_account_id
    }
    if client_token is not None:
        input_["client_token"] = client_token

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