Skip to content

list_account_links

list_account_links(
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    link_status_filter: Optional[LinkStatusFilterList] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[Limit] = None,
) -> ListAccountLinksResult

Lists all account links.

Parameters:

  • link_status_filter (Optional[LinkStatusFilterList], default: None ) –

    Filters the account based on their link status.

  • next_token (Optional[PaginationToken], default: None ) –

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

  • max_results (Optional[Limit], default: None ) –

    The maximum number of accounts to return.

Raises:

Source code in docs_src/capo_workspaces/_services/work_spaces.py
def list_account_links(
    self,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    link_status_filter: Optional[
        "capo_workspaces.types.link_status_filter_list.LinkStatusFilterList"
    ] = None,
    next_token: Optional[
        "capo_workspaces.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_workspaces.types.limit.Limit"] = None,
) -> "capo_workspaces.types.list_account_links_result.ListAccountLinksResult":
    """<p>Lists all account links.</p>

    Args:
        link_status_filter: <p>Filters the account based on their link status.</p>
        next_token: <p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>
        max_results: <p>The maximum number of accounts to return.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</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.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.list_account_links_request.ListAccountLinksRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.list_account_links_result.ListAccountLinksResult"
    ]:
        import capo_workspaces._operations.workspaces_service.list_account_links

        output, http_response = (
            capo_workspaces._operations.workspaces_service.list_account_links.list_account_links(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAccountLinks")
    )
    input_: capo_workspaces.types.list_account_links_request.ListAccountLinksRequest = {}
    if link_status_filter is not None:
        input_["link_status_filter"] = link_status_filter
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output