Package software.amazon.awssdk.services.rekognition.model

Interface CreateStreamProcessorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateStreamProcessorRequest.Builder,CreateStreamProcessorRequest>, RekognitionRequest.Builder, SdkBuilder<CreateStreamProcessorRequest.Builder,CreateStreamProcessorRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateStreamProcessorRequest
public static interface CreateStreamProcessorRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<CreateStreamProcessorRequest.Builder,CreateStreamProcessorRequest>

  • Method Details

    • input

      CreateStreamProcessorRequest.Builder input(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.

    • input

      default CreateStreamProcessorRequest.Builder input(Consumer<StreamProcessorInput.Builder> 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.

      This is a convenience method that creates an instance of the StreamProcessorInput.Builder avoiding the need to create one manually via StreamProcessorInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to input(StreamProcessorInput).

      Parameters:
      input - a consumer that will call methods on StreamProcessorInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • output

      CreateStreamProcessorRequest.Builder output(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.

    • output

      default CreateStreamProcessorRequest.Builder output(Consumer<StreamProcessorOutput.Builder> 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.

      This is a convenience method that creates an instance of the StreamProcessorOutput.Builder avoiding the need to create one manually via StreamProcessorOutput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to output(StreamProcessorOutput).

      Parameters:
      output - a consumer that will call methods on StreamProcessorOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      CreateStreamProcessorRequest.Builder name(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.

    • settings

      CreateStreamProcessorRequest.Builder settings(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.

    • settings

      default CreateStreamProcessorRequest.Builder settings(Consumer<StreamProcessorSettings.Builder> 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.

      This is a convenience method that creates an instance of the StreamProcessorSettings.Builder avoiding the need to create one manually via StreamProcessorSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(StreamProcessorSettings).

      Parameters:
      settings - a consumer that will call methods on StreamProcessorSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      CreateStreamProcessorRequest.Builder roleArn(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.

    • tags

      CreateStreamProcessorRequest.Builder tags(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.

    • notificationChannel

      CreateStreamProcessorRequest.Builder notificationChannel(StreamProcessorNotificationChannel notificationChannel)
      Sets the value of the NotificationChannel property for this object.
      Parameters:
      notificationChannel - The new value for the NotificationChannel property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationChannel

      default CreateStreamProcessorRequest.Builder notificationChannel(Consumer<StreamProcessorNotificationChannel.Builder> notificationChannel)
      Sets the value of the NotificationChannel property for this object. This is a convenience method that creates an instance of the StreamProcessorNotificationChannel.Builder avoiding the need to create one manually via StreamProcessorNotificationChannel.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationChannel(StreamProcessorNotificationChannel).

      Parameters:
      notificationChannel - a consumer that will call methods on StreamProcessorNotificationChannel.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyId

      CreateStreamProcessorRequest.Builder kmsKeyId(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.

    • regionsOfInterest

      CreateStreamProcessorRequest.Builder regionsOfInterest(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.

    • regionsOfInterest

      CreateStreamProcessorRequest.Builder regionsOfInterest(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.

    • regionsOfInterest

      CreateStreamProcessorRequest.Builder regionsOfInterest(Consumer<RegionOfInterest.Builder>... 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.

      This is a convenience method that creates an instance of the RegionOfInterest.Builder avoiding the need to create one manually via RegionOfInterest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to regionsOfInterest(List<RegionOfInterest>).

      Parameters:
      regionsOfInterest - a consumer that will call methods on RegionOfInterest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataSharingPreference

      CreateStreamProcessorRequest.Builder dataSharingPreference(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.

    • dataSharingPreference

      default CreateStreamProcessorRequest.Builder dataSharingPreference(Consumer<StreamProcessorDataSharingPreference.Builder> 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.

      This is a convenience method that creates an instance of the StreamProcessorDataSharingPreference.Builder avoiding the need to create one manually via StreamProcessorDataSharingPreference.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSharingPreference(StreamProcessorDataSharingPreference).

      Parameters:
      dataSharingPreference - a consumer that will call methods on StreamProcessorDataSharingPreference.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateStreamProcessorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateStreamProcessorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.