WorkSpaces / Client / create_account_link_invitation

create_account_link_invitation

WorkSpaces.Client.create_account_link_invitation(**kwargs)

Creates the account link invitation.

See also: AWS API Documentation

Request Syntax

response = client.create_account_link_invitation(
    TargetAccountId='string',
    ClientToken='string'
)

Parameters:

• TargetAccountId (string) –

  [REQUIRED]

  The identifier of the target account.

• ClientToken (string) – A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation.

Return type:

dict

Returns:

Response Syntax

{
    'AccountLink': {
        'AccountLinkId': 'string',
        'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
        'SourceAccountId': 'string',
        'TargetAccountId': 'string'
    }
}

Response Structure

• (dict) –

  • AccountLink (dict) –

    Information about the account link.

    • AccountLinkId (string) –

      The identifier of the account link.

    • AccountLinkStatus (string) –

      The status of the account link.

    • SourceAccountId (string) –

      The identifier of the source account.

    • TargetAccountId (string) –

      The identifier of the target account.

Exceptions

• WorkSpaces.Client.exceptions.ValidationException

• WorkSpaces.Client.exceptions.AccessDeniedException

• WorkSpaces.Client.exceptions.ConflictException

• WorkSpaces.Client.exceptions.InternalServerException