public class CreateStreamProcessorRequest extends AmazonWebServiceRequest implements java.io.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 StartStreamProcessor with the Name
field.
After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.
Constructor and Description |
---|
CreateStreamProcessorRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
StreamProcessorInput |
getInput()
Kinesis video stream stream that provides the source streaming video.
|
java.lang.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.
|
java.lang.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(java.lang.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(java.lang.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.
|
java.lang.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(java.lang.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(java.lang.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.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
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
.
Kinesis video stream stream that provides the source streaming
video. If you are using the AWS CLI, the parameter name is
StreamProcessorInput
.
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
.
input
-
Kinesis video stream stream that provides the source streaming
video. If you are using the AWS CLI, the parameter name is
StreamProcessorInput
.
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.
input
-
Kinesis video stream stream that provides the source streaming
video. If you are using the AWS CLI, the parameter name is
StreamProcessorInput
.
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
.
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
.
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
.
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
.
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.
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
.
public java.lang.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
DescribeStreamProcessor. Name
is idempotent.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+
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
DescribeStreamProcessor. Name
is idempotent.
public void setName(java.lang.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
DescribeStreamProcessor. Name
is idempotent.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+
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 DescribeStreamProcessor. Name
is
idempotent.
public CreateStreamProcessorRequest withName(java.lang.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
DescribeStreamProcessor. 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_.\-]+
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 DescribeStreamProcessor. Name
is
idempotent.
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.
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.
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.
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.
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.
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.
public java.lang.String getRoleArn()
ARN of the IAM role that allows access to the stream processor.
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
ARN of the IAM role that allows access to the stream processor.
public void setRoleArn(java.lang.String roleArn)
ARN of the IAM role that allows access to the stream processor.
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
roleArn
- ARN of the IAM role that allows access to the stream processor.
public CreateStreamProcessorRequest withRoleArn(java.lang.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:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
roleArn
- ARN of the IAM role that allows access to the stream processor.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.