WorkSpaces / Client / describe_workspaces_connection_status

describe_workspaces_connection_status#

WorkSpaces.Client.describe_workspaces_connection_status(**kwargs)#

Describes the connection status of the specified WorkSpaces.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspaces_connection_status(
    WorkspaceIds=[
        'string',
    ],
    NextToken='string'
)
Parameters:

  • WorkspaceIds (list) –

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

    • (string) –

  • NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Return type:

dict

Returns:

Response Syntax

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

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.

    • 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