OpenServers - NICE DCV Session Manager
Request parametersResponse parametersExample
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

OpenServers

Opens one or more NICE DCV servers. Before you can create NICE DCV sessions on a NICE DCV server, you must change the server's state to open. After the NICE DCV server is open, you can create NICE DCV sessions on the server.

Request parameters

ServerId

The ID of the server to open.

Type: String

Required: Yes

Response parameters

RequestId

The unique ID of the request.

SuccessfulList

Information about the NICE DCV servers that were successfully opened. This data structure includes the following nested response parameter:

ServerId

The ID of the server that was successfully opened.

UnsuccessfulList

Information about the NICE DCV servers that could not be opened. This data structure includes the following nested response parameters:

OpenServerRequestData

Information about the original request that failed. This data structure includes the following nested response parameter:

ServerId

The ID of the NICE DCV server that could not be opened.

FailureCode

The code of the failure.

FailureReason

The reason for the failure.

Example

Python
Request

The following example opens two NICE DCV servers (serverId1 and serverId2).

from swagger_client.models import OpenServerRequestData


def get_servers_api():
    api_instance = swagger_client.ServersApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def open_servers(server_ids):
    request = [OpenServerRequestData(server_id=server_id) for server_id in server_ids]
    print('Open Servers Request:', request)
    api_instance = get_servers_api()
    api_response = api_instance.open_servers(body=request)
    print('Open Servers Response:', api_response)

def main():
    open_servers(["serverId1", "serverId2"])
Response

The following is the sample output.

{
    "RequestId": "1e64830f-0a27-41bf-8147-0f3411791b64",
    "SuccessfulList": [
        {
            "ServerId": "serverId1"
        }
    ],
    "UnsuccessfulList": [
        {
            "OpenServerRequestData": {
                "ServerId": "serverId2"
            },
            "FailureCode": "DCV_SERVER_NOT_FOUND",
            "FailureReason": "Dcv server not found."
        }
    ]
}