WorkSpaces / Client / list_account_links

list_account_links

WorkSpaces.Client.list_account_links(**kwargs)

Lists all account links.

See also: AWS API Documentation

Request Syntax

response = client.list_account_links(
    LinkStatusFilter=[
        'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

• LinkStatusFilter (list) –

  Filters the account based on their link status.

  • (string) –

• NextToken (string) – The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• MaxResults (integer) – The maximum number of accounts to return.

Return type:

dict

Returns:

Response Syntax

{
    'AccountLinks': [
        {
            'AccountLinkId': 'string',
            'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
            'SourceAccountId': 'string',
            'TargetAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • AccountLinks (list) –

    Information about the account links.

    • (dict) –

      Information about 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.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• WorkSpaces.Client.exceptions.AccessDeniedException

• WorkSpaces.Client.exceptions.ValidationException

• WorkSpaces.Client.exceptions.InternalServerException