software.amazon.awssdk.services.rekognition.model

Class CreateStreamProcessorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rekognition.model.RekognitionRequest

software.amazon.awssdk.services.rekognition.model.CreateStreamProcessorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStreamProcessorRequest.Builder,CreateStreamProcessorRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStreamProcessorRequest
extends RekognitionRequest
implements ToCopyableBuilder<CreateStreamProcessorRequest.Builder,CreateStreamProcessorRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateStreamProcessorRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateStreamProcessorRequest.Builder	builder()
StreamProcessorDataSharingPreference	dataSharingPreference() Shows whether you are sharing data with Rekognition to improve model performance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegionsOfInterest() For responses, this returns true if the service returned a value for the RegionsOfInterest property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
StreamProcessorInput	input() Kinesis video stream stream that provides the source streaming video.
String	kmsKeyId() The identifier for your AWS Key Management Service key (AWS KMS key).
String	name() An identifier you assign to the stream processor.
StreamProcessorNotificationChannel	notificationChannel() Returns the value of the NotificationChannel property for this object.
StreamProcessorOutput	output() Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results.
List<RegionOfInterest>	regionsOfInterest() Specifies locations in the frames where Amazon Rekognition checks for objects or people.
String	roleArn() The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateStreamProcessorRequest.Builder>	serializableBuilderClass()
StreamProcessorSettings	settings() Input parameters used in a streaming video analyzed by a stream processor.
Map<String,String>	tags() A set of tags (key-value pairs) that you want to attach to the stream processor.
CreateStreamProcessorRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

input

public final 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.

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.

output

public final 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.

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.

name

public final 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.

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.

settings

public final 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.

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.

roleArn

public final 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.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

notificationChannel

public final StreamProcessorNotificationChannel notificationChannel()

Returns the value of the NotificationChannel property for this object.

Returns:

The value of the NotificationChannel property for this object.

kmsKeyId

public final 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.

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.

hasRegionsOfInterest

public final boolean hasRegionsOfInterest()

For responses, this returns true if the service returned a value for the RegionsOfInterest property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

regionsOfInterest

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegionsOfInterest() method.

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.

dataSharingPreference

public final 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.

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.

toBuilder

public CreateStreamProcessorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStreamProcessorRequest.Builder,CreateStreamProcessorRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static CreateStreamProcessorRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateStreamProcessorRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo