DeadlineCloud / Client / get_session

get_session

DeadlineCloud.Client.get_session(**kwargs)

Gets a session.

See also: AWS API Documentation

Request Syntax

response = client.get_session(
    farmId='string',
    queueId='string',
    jobId='string',
    sessionId='string'
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID for the session.

• queueId (string) –

  [REQUIRED]

  The queue ID for the session.

• jobId (string) –

  [REQUIRED]

  The job ID for the session.

• sessionId (string) –

  [REQUIRED]

  The session ID.

Return type:

dict

Returns:

Response Syntax

{
    'sessionId': 'string',
    'fleetId': 'string',
    'workerId': 'string',
    'startedAt': datetime(2015, 1, 1),
    'log': {
        'logDriver': 'string',
        'options': {
            'string': 'string'
        },
        'parameters': {
            'string': 'string'
        },
        'error': 'string'
    },
    'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
    'endedAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'targetLifecycleStatus': 'ENDED',
    'hostProperties': {
        'ipAddresses': {
            'ipV4Addresses': [
                'string',
            ],
            'ipV6Addresses': [
                'string',
            ]
        },
        'hostName': 'string',
        'ec2InstanceArn': 'string',
        'ec2InstanceType': 'string'
    },
    'workerLog': {
        'logDriver': 'string',
        'options': {
            'string': 'string'
        },
        'parameters': {
            'string': 'string'
        },
        'error': 'string'
    }
}

Response Structure

• (dict) –

  • sessionId (string) –

    The session ID.

  • fleetId (string) –

    The fleet ID for the session.

  • workerId (string) –

    The worker ID for the session.

  • startedAt (datetime) –

    The date and time the resource started running.

  • log (dict) –

    The session log.

    • logDriver (string) –

      The log drivers for worker related logs.

    • options (dict) –

      The options for a log driver.

      • (string) –

        • (string) –

    • parameters (dict) –

      The parameters for the log configuration.

      • (string) –

        • (string) –

    • error (string) –

      The log configuration error details.

  • lifecycleStatus (string) –

    The life cycle status of the session.

  • endedAt (datetime) –

    The date and time the resource ended running.

  • updatedAt (datetime) –

    The date and time the resource was updated.

  • updatedBy (string) –

    The user or system that updated this resource.

  • targetLifecycleStatus (string) –

    The life cycle status with which the session started.

  • hostProperties (dict) –

    Provides the Amazon EC2 properties of the host.

    • ipAddresses (dict) –

      The IP address of the host.

      • ipV4Addresses (list) –

        The IpV4 address of the network.

        • (string) –

      • ipV6Addresses (list) –

        The IpV6 address for the network and node component.

        • (string) –

    • hostName (string) –

      The host name.

    • ec2InstanceArn (string) –

      The ARN of the host EC2 instance.

    • ec2InstanceType (string) –

      The instance type of the host EC2 instance.

  • workerLog (dict) –

    The worker log for the session.

    • logDriver (string) –

      The log drivers for worker related logs.

    • options (dict) –

      The options for a log driver.

      • (string) –

        • (string) –

    • parameters (dict) –

      The parameters for the log configuration.

      • (string) –

        • (string) –

    • error (string) –

      The log configuration error details.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException