describe_workspaces_connection_status `async` ¶

describe_workspaces_connection_status(
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    workspace_ids: Optional[WorkspaceIdList] = None,
    next_token: Optional[PaginationToken] = None,
) -> DescribeWorkspacesConnectionStatusResult

Describes the connection status of the specified WorkSpaces.

Parameters:

workspace_ids (Optional[WorkspaceIdList], default: None ) –

The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
next_token (Optional[PaginationToken], default: None ) –

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

Raises:

InvalidParameterValuesException –

One or more parameter values are not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py

async def describe_workspaces_connection_status(
    self,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    workspace_ids: Optional[
        "capo_workspaces.types.workspace_id_list.WorkspaceIdList"
    ] = None,
    next_token: Optional[
        "capo_workspaces.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_workspaces.types.describe_workspaces_connection_status_result.DescribeWorkspacesConnectionStatusResult":
    """<p>Describes the connection status of the specified WorkSpaces.</p>

    Args:
        workspace_ids: <p>The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.</p>
        next_token: <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>

    Raises:
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces.types.describe_workspaces_connection_status_request.DescribeWorkspacesConnectionStatusRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.describe_workspaces_connection_status_result.DescribeWorkspacesConnectionStatusResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_workspaces_connection_status

        (
            output,
            http_response,
        ) = await capo_workspaces._operations.workspaces_service.describe_workspaces_connection_status.async_describe_workspaces_connection_status(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkspacesConnectionStatus")
    )
    input_: capo_workspaces.types.describe_workspaces_connection_status_request.DescribeWorkspacesConnectionStatusRequest = {}
    if workspace_ids is not None:
        input_["workspace_ids"] = workspace_ids
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_workspaces_connection_status async ¶

describe_workspaces_connection_status `async` ¶