GetStreamSession - Amazon IVS

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

ARN of the channel resource

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$

Required: Yes

streamId

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, "ingestEndpoint": "string", "latencyMode": "string", "name": "string", "playbackUrl": "string", "recordingConfigurationArn": "string", "tags": { "string" : "string" }, "type": "string" }, "endTime": number, "ingestConfiguration": { "audio": { "channels": number, "codec": "string", "sampleRate": number, "targetBitrate": number }, "video": { "avcLevel": "string", "avcProfile": "string", "codec": "string", "encoder": "string", "targetBitrate": number, "targetFramerate": number, "videoHeight": number, "videoWidth": number } }, "recordingConfiguration": { "arn": "string", "destinationConfiguration": { "s3": { "bucketName": "string" } }, "name": "string", "state": "string", "tags": { "string" : "string" }, "thumbnailConfiguration": { "recordingMode": "string", "targetIntervalSeconds": number } }, "startTime": number, "streamId": "string", "truncatedEvents": [ { "eventTime": number, "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

List of stream details.

Type: StreamSession object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

ResourceNotFoundException

HTTP Status Code: 404

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: