GetStageSession - Amazon IVS


Gets information for the specified stage session.

Request Syntax

POST /GetStageSession HTTP/1.1 Content-type: application/json { "sessionId": "string", "stageArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


ID of a session within the stage.

Type: String

Length Constraints: Fixed length of 16.

Pattern: ^st-[a-zA-Z0-9]+$

Required: Yes


ARN of the stage for which the information is to be retrieved.

Type: String

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

Pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "stageSession": { "endTime": "string", "sessionId": "string", "startTime": "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.


The stage session that is returned.

Type: StageSession object


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


HTTP Status Code: 403


HTTP Status Code: 404


HTTP Status Code: 400

See Also

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