# GetSession
<a name="API_GetSession"></a>

Gets a session.

## Request Syntax
<a name="API_GetSession_RequestSyntax"></a>

```
GET /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/sessions/sessionId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [farmId](#API_GetSession_RequestSyntax) **   <a name="deadlinecloud-GetSession-request-uri-farmId"></a>
The farm ID for the session.  
Pattern: `farm-[0-9a-f]{32}`   
Required: Yes

 ** [jobId](#API_GetSession_RequestSyntax) **   <a name="deadlinecloud-GetSession-request-uri-jobId"></a>
The job ID for the session.  
Pattern: `job-[0-9a-f]{32}`   
Required: Yes

 ** [queueId](#API_GetSession_RequestSyntax) **   <a name="deadlinecloud-GetSession-request-uri-queueId"></a>
The queue ID for the session.  
Pattern: `queue-[0-9a-f]{32}`   
Required: Yes

 ** [sessionId](#API_GetSession_RequestSyntax) **   <a name="deadlinecloud-GetSession-request-uri-sessionId"></a>
The session ID.  
Pattern: `session-[0-9a-f]{32}`   
Required: Yes

## Request Body
<a name="API_GetSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "endedAt": "string",
   "fleetId": "string",
   "hostProperties": { 
      "ec2InstanceArn": "string",
      "ec2InstanceType": "string",
      "hostName": "string",
      "ipAddresses": { 
         "ipV4Addresses": [ "string" ],
         "ipV6Addresses": [ "string" ]
      }
   },
   "lifecycleStatus": "string",
   "log": { 
      "error": "string",
      "logDriver": "string",
      "options": { 
         "string" : "string" 
      },
      "parameters": { 
         "string" : "string" 
      }
   },
   "sessionId": "string",
   "startedAt": "string",
   "targetLifecycleStatus": "string",
   "updatedAt": "string",
   "updatedBy": "string",
   "workerId": "string",
   "workerLog": { 
      "error": "string",
      "logDriver": "string",
      "options": { 
         "string" : "string" 
      },
      "parameters": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_GetSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endedAt](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-endedAt"></a>
The date and time the resource ended running.  
Type: Timestamp

 ** [fleetId](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-fleetId"></a>
The fleet ID for the session.  
Type: String  
Pattern: `fleet-[0-9a-f]{32}` 

 ** [hostProperties](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-hostProperties"></a>
Provides the Amazon EC2 properties of the host.  
Type: [HostPropertiesResponse](API_HostPropertiesResponse.md) object

 ** [lifecycleStatus](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-lifecycleStatus"></a>
The life cycle status of the session.  
Type: String  
Valid Values: `STARTED | UPDATE_IN_PROGRESS | UPDATE_SUCCEEDED | UPDATE_FAILED | ENDED` 

 ** [log](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-log"></a>
The session log.  
Type: [LogConfiguration](API_LogConfiguration.md) object

 ** [sessionId](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-sessionId"></a>
The session ID.  
Type: String  
Pattern: `session-[0-9a-f]{32}` 

 ** [startedAt](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-startedAt"></a>
The date and time the resource started running.  
Type: Timestamp

 ** [targetLifecycleStatus](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-targetLifecycleStatus"></a>
The life cycle status with which the session started.  
Type: String  
Valid Values: `ENDED` 

 ** [updatedAt](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-updatedAt"></a>
The date and time the resource was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-updatedBy"></a>
The user or system that updated this resource.  
Type: String

 ** [workerId](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-workerId"></a>
The worker ID for the session.  
Type: String  
Pattern: `worker-[0-9a-f]{32}` 

 ** [workerLog](#API_GetSession_ResponseSyntax) **   <a name="deadlinecloud-GetSession-response-workerLog"></a>
The worker log for the session.  
Type: [LogConfiguration](API_LogConfiguration.md) object

## Errors
<a name="API_GetSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have permission to perform the action.    
 ** context **   
Information about the resources in use when the exception was thrown.
HTTP Status Code: 403

 ** InternalServerErrorException **   
Deadline Cloud can't process your request right now. Try again later.    
 ** retryAfterSeconds **   
The number of seconds a client should wait before retrying the request.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource can't be found.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** resourceId **   
The identifier of the resource that couldn't be found.  
 ** resourceType **   
The type of the resource that couldn't be found.
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a request rate quota.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** quotaCode **   
Identifies the quota that is being throttled.  
 ** retryAfterSeconds **   
The number of seconds a client should wait before retrying the request.  
 ** serviceCode **   
Identifies the service that is being throttled.
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason that the request failed validation.
HTTP Status Code: 400

## See Also
<a name="API_GetSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/deadline-2023-10-12/GetSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/deadline-2023-10-12/GetSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/deadline-2023-10-12/GetSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/deadline-2023-10-12/GetSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/deadline-2023-10-12/GetSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/deadline-2023-10-12/GetSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/deadline-2023-10-12/GetSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/deadline-2023-10-12/GetSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/deadline-2023-10-12/GetSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/deadline-2023-10-12/GetSession)