Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateStage

Updates a stage’s configuration.

Request Syntax


POST /UpdateStage HTTP/1.1
Content-type: application/json

{
   "arn": "string",
   "autoParticipantRecordingConfiguration": { 
      "hlsConfiguration": { 
         "targetSegmentDurationSeconds": number
      },
      "mediaTypes": [ "string" ],
      "recordingReconnectWindowSeconds": number,
      "recordParticipantReplicas": boolean,
      "storageConfigurationArn": "string",
      "thumbnailConfiguration": { 
         "recordingMode": "string",
         "storage": [ "string" ],
         "targetIntervalSeconds": number
      }
   },
   "name": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

ARN of the stage to be updated.

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

autoParticipantRecordingConfiguration

Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.

Type: AutoParticipantRecordingConfiguration object

Required: No

name

Name of the stage to be updated.

Type: String

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

Pattern: [a-zA-Z0-9-_]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "stage": { 
      "activeSessionId": "string",
      "arn": "string",
      "autoParticipantRecordingConfiguration": { 
         "hlsConfiguration": { 
            "targetSegmentDurationSeconds": number
         },
         "mediaTypes": [ "string" ],
         "recordingReconnectWindowSeconds": number,
         "recordParticipantReplicas": boolean,
         "storageConfigurationArn": "string",
         "thumbnailConfiguration": { 
            "recordingMode": "string",
            "storage": [ "string" ],
            "targetIntervalSeconds": number
         }
      },
      "endpoints": { 
         "events": "string",
         "rtmp": "string",
         "rtmps": "string",
         "whip": "string"
      },
      "name": "string",
      "tags": { 
         "string" : "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.

stage

The updated stage.

Type: Stage object

Errors

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

AccessDeniedException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: User does not have sufficient access to perform this action.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 403

ConflictException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: Updating or deleting a resource can cause an inconsistent state.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 409

PendingVerification

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: Your account is pending verification.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 403

ResourceNotFoundException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: Request references a resource which does not exist.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 404

ServiceQuotaExceededException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: Request would cause a service quota to be exceeded.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 402

ValidationException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: The input fails to satisfy the constraints specified by an AWS service.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 400