com.amazonaws.services.rekognition.model

Class CreateStreamProcessorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.CreateStreamProcessorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateStreamProcessorRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateStreamProcessorRequest()

Method Summary

Modifier and Type	Method and Description
CreateStreamProcessorRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateStreamProcessorRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateStreamProcessorRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
StreamProcessorDataSharingPreference	getDataSharingPreference() Shows whether you are sharing data with Rekognition to improve model performance.
StreamProcessorInput	getInput() Kinesis video stream stream that provides the source streaming video.
String	getKmsKeyId() The identifier for your AWS Key Management Service key (AWS KMS key).
String	getName() An identifier you assign to the stream processor.
StreamProcessorNotificationChannel	getNotificationChannel()
StreamProcessorOutput	getOutput() Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results.
List<RegionOfInterest>	getRegionsOfInterest() Specifies locations in the frames where Amazon Rekognition checks for objects or people.
String	getRoleArn() The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor.
StreamProcessorSettings	getSettings() Input parameters used in a streaming video analyzed by a stream processor.
Map<String,String>	getTags() A set of tags (key-value pairs) that you want to attach to the stream processor.
int	hashCode()
void	setDataSharingPreference(StreamProcessorDataSharingPreference dataSharingPreference) Shows whether you are sharing data with Rekognition to improve model performance.
void	setInput(StreamProcessorInput input) Kinesis video stream stream that provides the source streaming video.
void	setKmsKeyId(String kmsKeyId) The identifier for your AWS Key Management Service key (AWS KMS key).
void	setName(String name) An identifier you assign to the stream processor.
void	setNotificationChannel(StreamProcessorNotificationChannel notificationChannel)
void	setOutput(StreamProcessorOutput output) Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results.
void	setRegionsOfInterest(Collection<RegionOfInterest> regionsOfInterest) Specifies locations in the frames where Amazon Rekognition checks for objects or people.
void	setRoleArn(String roleArn) The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor.
void	setSettings(StreamProcessorSettings settings) Input parameters used in a streaming video analyzed by a stream processor.
void	setTags(Map<String,String> tags) A set of tags (key-value pairs) that you want to attach to the stream processor.
String	toString() Returns a string representation of this object.
CreateStreamProcessorRequest	withDataSharingPreference(StreamProcessorDataSharingPreference dataSharingPreference) Shows whether you are sharing data with Rekognition to improve model performance.
CreateStreamProcessorRequest	withInput(StreamProcessorInput input) Kinesis video stream stream that provides the source streaming video.
CreateStreamProcessorRequest	withKmsKeyId(String kmsKeyId) The identifier for your AWS Key Management Service key (AWS KMS key).
CreateStreamProcessorRequest	withName(String name) An identifier you assign to the stream processor.
CreateStreamProcessorRequest	withNotificationChannel(StreamProcessorNotificationChannel notificationChannel)
CreateStreamProcessorRequest	withOutput(StreamProcessorOutput output) Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results.
CreateStreamProcessorRequest	withRegionsOfInterest(Collection<RegionOfInterest> regionsOfInterest) Specifies locations in the frames where Amazon Rekognition checks for objects or people.
CreateStreamProcessorRequest	withRegionsOfInterest(RegionOfInterest... regionsOfInterest) Specifies locations in the frames where Amazon Rekognition checks for objects or people.
CreateStreamProcessorRequest	withRoleArn(String roleArn) The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor.
CreateStreamProcessorRequest	withSettings(StreamProcessorSettings settings) Input parameters used in a streaming video analyzed by a stream processor.
CreateStreamProcessorRequest	withTags(Map<String,String> tags) A set of tags (key-value pairs) that you want to attach to the stream processor.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateStreamProcessorRequest

public CreateStreamProcessorRequest()

Method Detail

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. This is required for both face search and label detection stream processors.

Parameters:

input - Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

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. This is required for both face search and label detection stream processors.

Returns:

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

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. This is required for both face search and label detection stream processors.

Parameters:

input - Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

Returns:

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

setOutput

public void setOutput(StreamProcessorOutput output)

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

Parameters:

output - Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

getOutput

public StreamProcessorOutput getOutput()

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

Returns:

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

withOutput

public CreateStreamProcessorRequest withOutput(StreamProcessorOutput output)

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

Parameters:

output - Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

Returns:

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

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 DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

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 DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

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 DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

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 DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

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 DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

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 DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

Returns:

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

setSettings

public void setSettings(StreamProcessorSettings settings)

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

Parameters:

settings - Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

getSettings

public StreamProcessorSettings getSettings()

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

Returns:

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

withSettings

public CreateStreamProcessorRequest withSettings(StreamProcessorSettings settings)

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

Parameters:

settings - Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

Parameters:

roleArn - The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

getRoleArn

public String getRoleArn()

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

Returns:

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

withRoleArn

public CreateStreamProcessorRequest withRoleArn(String roleArn)

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

Parameters:

roleArn - The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

Returns:

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

getTags

public Map<String,String> getTags()

A set of tags (key-value pairs) that you want to attach to the stream processor.

Returns:

A set of tags (key-value pairs) that you want to attach to the stream processor.

setTags

public void setTags(Map<String,String> tags)

A set of tags (key-value pairs) that you want to attach to the stream processor.

Parameters:

tags - A set of tags (key-value pairs) that you want to attach to the stream processor.

withTags

public CreateStreamProcessorRequest withTags(Map<String,String> tags)

A set of tags (key-value pairs) that you want to attach to the stream processor.

Parameters:

tags - A set of tags (key-value pairs) that you want to attach to the stream processor.

Returns:

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

addTagsEntry

public CreateStreamProcessorRequest addTagsEntry(String key,
                                                 String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateStreamProcessorRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setNotificationChannel

public void setNotificationChannel(StreamProcessorNotificationChannel notificationChannel)

Parameters:

notificationChannel -

getNotificationChannel

public StreamProcessorNotificationChannel getNotificationChannel()

Returns:

withNotificationChannel

public CreateStreamProcessorRequest withNotificationChannel(StreamProcessorNotificationChannel notificationChannel)

Parameters:

notificationChannel -

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

Parameters:

kmsKeyId - The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

getKmsKeyId

public String getKmsKeyId()

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

Returns:

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

withKmsKeyId

public CreateStreamProcessorRequest withKmsKeyId(String kmsKeyId)

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

Parameters:

kmsKeyId - The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

Returns:

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

getRegionsOfInterest

public List<RegionOfInterest> getRegionsOfInterest()

Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

Returns:

Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

setRegionsOfInterest

public void setRegionsOfInterest(Collection<RegionOfInterest> regionsOfInterest)

Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

Parameters:

regionsOfInterest - Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

withRegionsOfInterest

public CreateStreamProcessorRequest withRegionsOfInterest(RegionOfInterest... regionsOfInterest)

Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

NOTE: This method appends the values to the existing list (if any). Use setRegionsOfInterest(java.util.Collection) or withRegionsOfInterest(java.util.Collection) if you want to override the existing values.

Parameters:

regionsOfInterest - Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

Returns:

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

withRegionsOfInterest

public CreateStreamProcessorRequest withRegionsOfInterest(Collection<RegionOfInterest> regionsOfInterest)

Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

Parameters:

regionsOfInterest - Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

Returns:

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

setDataSharingPreference

public void setDataSharingPreference(StreamProcessorDataSharingPreference dataSharingPreference)

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.

Parameters:

dataSharingPreference - 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.

getDataSharingPreference

public StreamProcessorDataSharingPreference getDataSharingPreference()

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.

Returns:

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.

withDataSharingPreference

public CreateStreamProcessorRequest withDataSharingPreference(StreamProcessorDataSharingPreference dataSharingPreference)

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.

Parameters:

dataSharingPreference - 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.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateStreamProcessorRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()