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

Class DescribeStreamProcessorResponse

    • Method Detail

      • name

        public final String name()

        Name of the stream processor.

        Returns:
        Name of the stream processor.

      • streamProcessorArn

        public final String streamProcessorArn()

        ARN of the stream processor.

        Returns:
        ARN of the stream processor.

      • statusMessage

        public final String statusMessage()

        Detailed status message about the stream processor.

        Returns:
        Detailed status message about the stream processor.

      • creationTimestamp

        public final Instant creationTimestamp()

        Date and time the stream processor was created

        Returns:
        Date and time the stream processor was created

      • lastUpdateTimestamp

        public final Instant lastUpdateTimestamp()

        The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

        Returns:
        The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

      • input

        public final StreamProcessorInput input()

        Kinesis video stream that provides the source streaming video.

        Returns:
        Kinesis video stream that provides the source streaming video.

      • output

        public final StreamProcessorOutput output()

        Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

        Returns:
        Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

      • roleArn

        public final String roleArn()

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

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

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

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

        Returns:
        The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.

      • 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. This is an optional parameter for label detection stream processors.

        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. This is an optional parameter for label detection stream processors.

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

      • 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