StopStreamProcessorCommand

Suggest an Edit

Stops a running stream processor that was created by CreateStreamProcessor.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RekognitionClient, StopStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
// const { RekognitionClient, StopStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
const client = new RekognitionClient(config);
const input = { // StopStreamProcessorRequest
  Name: "STRING_VALUE", // required
};
const command = new StopStreamProcessorCommand(input);
const response = await client.send(command);
// {};

StopStreamProcessorCommand Input

See StopStreamProcessorCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of a stream processor created by CreateStreamProcessor.

StopStreamProcessorCommand Output

See StopStreamProcessorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You are not authorized to perform the action.

InternalServerError
server

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

InvalidParameterException
client

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

ProvisionedThroughputExceededException
client

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

ResourceInUseException
client

The specified resource is already being used.

ResourceNotFoundException
client

The resource specified in the request cannot be found.

ThrottlingException
server

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

RekognitionServiceException
Base exception class for all service exceptions from Rekognition service.