# GetStreamSession


Gets metadata on a specified stream.

## Request Syntax


```
POST /GetStreamSession HTTP/1.1
Content-type: application/json

{
   "channelArn": "string",
   "streamId": "string"
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [channelArn](#API_GetStreamSession_RequestSyntax) **   <a name="ivs-GetStreamSession-request-channelArn"></a>
ARN of the channel resource  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+`   
Required: Yes

 ** [streamId](#API_GetStreamSession_RequestSyntax) **   <a name="ivs-GetStreamSession-request-streamId"></a>
Unique identifier for a live or previously live stream in the specified channel. If no `streamId` is provided, this returns the most recent stream session for the channel, if it exists.  
Type: String  
Length Constraints: Fixed length of 26.  
Pattern: `st-[a-zA-Z0-9]+`   
Required: No

## Response Syntax


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

{
   "streamSession": { 
      "channel": { 
         "arn": "string",
         "authorized": boolean,
         "containerFormat": "string",
         "ingestEndpoint": "string",
         "insecureIngest": boolean,
         "latencyMode": "string",
         "multitrackInputConfiguration": { 
            "enabled": boolean,
            "maximumResolution": "string",
            "policy": "string"
         },
         "name": "string",
         "playbackRestrictionPolicyArn": "string",
         "playbackUrl": "string",
         "preset": "string",
         "recordingConfigurationArn": "string",
         "srt": { 
            "endpoint": "string",
            "passphrase": "string"
         },
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      },
      "endTime": "string",
      "ingestConfiguration": { 
         "audio": { 
            "channels": number,
            "codec": "string",
            "sampleRate": number,
            "targetBitrate": number,
            "track": "string"
         },
         "video": { 
            "avcLevel": "string",
            "avcProfile": "string",
            "codec": "string",
            "encoder": "string",
            "level": "string",
            "profile": "string",
            "targetBitrate": number,
            "targetFramerate": number,
            "track": "string",
            "videoHeight": number,
            "videoWidth": number
         }
      },
      "ingestConfigurations": { 
         "audioConfigurations": [ 
            { 
               "channels": number,
               "codec": "string",
               "sampleRate": number,
               "targetBitrate": number,
               "track": "string"
            }
         ],
         "videoConfigurations": [ 
            { 
               "avcLevel": "string",
               "avcProfile": "string",
               "codec": "string",
               "encoder": "string",
               "level": "string",
               "profile": "string",
               "targetBitrate": number,
               "targetFramerate": number,
               "track": "string",
               "videoHeight": number,
               "videoWidth": number
            }
         ]
      },
      "recordingConfiguration": { 
         "arn": "string",
         "destinationConfiguration": { 
            "s3": { 
               "bucketName": "string"
            }
         },
         "name": "string",
         "recordingReconnectWindowSeconds": number,
         "renditionConfiguration": { 
            "renditions": [ "string" ],
            "renditionSelection": "string"
         },
         "state": "string",
         "tags": { 
            "string" : "string" 
         },
         "thumbnailConfiguration": { 
            "recordingMode": "string",
            "resolution": "string",
            "storage": [ "string" ],
            "targetIntervalSeconds": number
         }
      },
      "startTime": "string",
      "streamId": "string",
      "truncatedEvents": [ 
         { 
            "code": "string",
            "eventTime": "string",
            "name": "string",
            "type": "string"
         }
      ]
   }
}
```

## Response Elements


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

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

 ** [streamSession](#API_GetStreamSession_ResponseSyntax) **   <a name="ivs-GetStreamSession-response-streamSession"></a>
List of stream details.  
Type: [StreamSession](API_StreamSession.md) object

## Errors


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

 ** AccessDeniedException **   
    
 ** exceptionMessage **   
User does not have sufficient access to perform this action.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
    
 ** exceptionMessage **   
Request references a resource which does not exist.
HTTP Status Code: 404

 ** ValidationException **   
    
 ** exceptionMessage **   
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400

## See Also


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/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ivs-2020-07-14/GetStreamSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ivs-2020-07-14/GetStreamSession)