Request Syntax Request Parameters Response Elements Errors See Also

UpdateStreamProcessor

Important

Amazon Rekognition Streaming Video Analysis will no longer be open to new customers starting April 30, 2026. If you would like to use Streaming Video Analysis, sign up prior to that date. Existing customers for accounts that have used this feature within the last 12 months can continue to use the service as normal. For more information, see Amazon Rekognition Streaming Video Analysis availability change.

Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.

Request Syntax


{
   "DataSharingPreferenceForUpdate": { 
      "OptIn": boolean
   },
   "Name": "string",
   "ParametersToDelete": [ "string" ],
   "RegionsOfInterestForUpdate": [ 
      { 
         "BoundingBox": { 
            "Height": number,
            "Left": number,
            "Top": number,
            "Width": number
         },
         "Polygon": [ 
            { 
               "X": number,
               "Y": number
            }
         ]
      }
   ],
   "SettingsForUpdate": { 
      "ConnectedHomeForUpdate": { 
         "Labels": [ "string" ],
         "MinConfidence": number
      }
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DataSharingPreferenceForUpdate

Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

Type: StreamProcessorDataSharingPreference object

Required: No

Name

Name of the stream processor that you want to update.

Type: String

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

Pattern: [a-zA-Z0-9_.\-]+

Required: Yes

ParametersToDelete

A list of parameters you want to delete from the stream processor.

Type: Array of strings

Valid Values: ConnectedHomeMinConfidence | RegionsOfInterest

Required: No

RegionsOfInterestForUpdate

Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

Type: Array of RegionOfInterest objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

SettingsForUpdate

The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.

Type: StreamProcessorSettingsForUpdate object

Required: No

Response Elements

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

Errors

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

AccessDeniedException

You are not authorized to perform the action.

HTTP Status Code: 400

InternalServerError

Amazon Rekognition experienced a service issue. Try your call again.

HTTP Status Code: 500

InvalidParameterException

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

HTTP Status Code: 400

ProvisionedThroughputExceededException

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

HTTP Status Code: 400

ResourceInUseException

The specified resource is already being used.

HTTP Status Code: 400

ResourceNotFoundException

The resource specified in the request cannot be found.

HTTP Status Code: 400

ThrottlingException

Amazon Rekognition is temporarily unable to process the request. Try your call again.

HTTP Status Code: 500