com.amazonaws.services.rekognition.model

Class CreateStreamProcessorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.CreateStreamProcessorRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreateStreamProcessorRequest
extends AmazonWebServiceRequest
implements Serializable

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.

You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling with the Name field.

After you have finished analyzing a streaming video, use to stop processing. You can delete the stream processor by calling .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateStreamProcessorRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
StreamProcessorInput	getInput() Kinesis video stream stream that provides the source streaming video.
String	getName() An identifier you assign to the stream processor.
StreamProcessorOutput	getOutput() Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results.
String	getRoleArn() ARN of the IAM role that allows access to the stream processor.
StreamProcessorSettings	getSettings() Face recognition input parameters to be used by the stream processor.
int	hashCode()
void	setInput(StreamProcessorInput input) Kinesis video stream stream that provides the source streaming video.
void	setName(String name) An identifier you assign to the stream processor.
void	setOutput(StreamProcessorOutput output) Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results.
void	setRoleArn(String roleArn) ARN of the IAM role that allows access to the stream processor.
void	setSettings(StreamProcessorSettings settings) Face recognition input parameters to be used by the stream processor.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateStreamProcessorRequest	withInput(StreamProcessorInput input) Kinesis video stream stream that provides the source streaming video.
CreateStreamProcessorRequest	withName(String name) An identifier you assign to the stream processor.
CreateStreamProcessorRequest	withOutput(StreamProcessorOutput output) Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results.
CreateStreamProcessorRequest	withRoleArn(String roleArn) ARN of the IAM role that allows access to the stream processor.
CreateStreamProcessorRequest	withSettings(StreamProcessorSettings settings) Face recognition input parameters to be used by the stream processor.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateStreamProcessorRequest

public CreateStreamProcessorRequest()

Method Detail

getInput

public StreamProcessorInput getInput()

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

Returns:

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

setInput

public void setInput(StreamProcessorInput input)

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

Parameters:

input -

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

withInput

public CreateStreamProcessorRequest withInput(StreamProcessorInput input)

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

Returns a reference to this object so that method calls can be chained together.

Parameters:

input -

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

Returns:

A reference to this updated object so that method calls can be chained together.

getOutput

public StreamProcessorOutput getOutput()

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

Returns:

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

setOutput

public void setOutput(StreamProcessorOutput output)

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

Parameters:

output -

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

withOutput

public CreateStreamProcessorRequest withOutput(StreamProcessorOutput output)

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

Returns a reference to this object so that method calls can be chained together.

Parameters:

output -

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public String getName()

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name is idempotent.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

Returns:

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name is idempotent.

setName

public void setName(String name)

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name is idempotent.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

name -

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name is idempotent.

withName

public CreateStreamProcessorRequest withName(String name)

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name is idempotent.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

name -

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name is idempotent.

Returns:

A reference to this updated object so that method calls can be chained together.

getSettings

public StreamProcessorSettings getSettings()

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

Returns:

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

setSettings

public void setSettings(StreamProcessorSettings settings)

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

Parameters:

settings -

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

withSettings

public CreateStreamProcessorRequest withSettings(StreamProcessorSettings settings)

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

Returns a reference to this object so that method calls can be chained together.

Parameters:

settings -

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public String getRoleArn()

ARN of the IAM role that allows access to the stream processor.

Constraints:
Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Returns:

ARN of the IAM role that allows access to the stream processor.

setRoleArn

public void setRoleArn(String roleArn)

ARN of the IAM role that allows access to the stream processor.

Constraints:
Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Parameters:

roleArn -

ARN of the IAM role that allows access to the stream processor.

withRoleArn

public CreateStreamProcessorRequest withRoleArn(String roleArn)

ARN of the IAM role that allows access to the stream processor.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Parameters:

roleArn -

ARN of the IAM role that allows access to the stream processor.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object