WorkSpaces / Paginator / ListAccountLinks

ListAccountLinks

class WorkSpaces.Paginator.ListAccountLinks

paginator = client.get_paginator('list_account_links')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkSpaces.Client.list_account_links().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    LinkStatusFilter=[
        'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• LinkStatusFilter (list) –

  Filters the account based on their link status.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.