WorkSpaces / Paginator / DescribeWorkspacesConnectionStatus


class WorkSpaces.Paginator.DescribeWorkspacesConnectionStatus#
paginator = client.get_paginator('describe_workspaces_connection_status')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'StartingToken': 'string'
  • WorkspaceIds (list) –

    The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

    • (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.

    • StartingToken (string) –

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

Return type:



Response Syntax

    'WorkspacesConnectionStatus': [
            'WorkspaceId': 'string',
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'UNKNOWN',
            'ConnectionStateCheckTimestamp': datetime(2015, 1, 1),
            'LastKnownUserConnectionTimestamp': datetime(2015, 1, 1)


Response Structure

  • (dict) –

    • WorkspacesConnectionStatus (list) –

      Information about the connection status of the WorkSpace.

      • (dict) –

        Describes the connection status of a WorkSpace.

        • WorkspaceId (string) –

          The identifier of the WorkSpace.

        • ConnectionState (string) –

          The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

        • ConnectionStateCheckTimestamp (datetime) –

          The timestamp of the connection status check.

        • LastKnownUserConnectionTimestamp (datetime) –

          The timestamp of the last known user connection.