#[non_exhaustive]pub struct CreateStreamProcessorInputBuilder { /* private fields */ }
Expand description
A builder for CreateStreamProcessorInput
.
Implementations§
Source§impl CreateStreamProcessorInputBuilder
impl CreateStreamProcessorInputBuilder
Sourcepub fn input(self, input: StreamProcessorInput) -> Self
pub fn input(self, input: StreamProcessorInput) -> Self
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.
Sourcepub fn set_input(self, input: Option<StreamProcessorInput>) -> Self
pub fn set_input(self, input: Option<StreamProcessorInput>) -> Self
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.
Sourcepub fn get_input(&self) -> &Option<StreamProcessorInput>
pub fn get_input(&self) -> &Option<StreamProcessorInput>
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.
Sourcepub fn output(self, input: StreamProcessorOutput) -> Self
pub fn output(self, input: StreamProcessorOutput) -> Self
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.
Sourcepub fn set_output(self, input: Option<StreamProcessorOutput>) -> Self
pub fn set_output(self, input: Option<StreamProcessorOutput>) -> Self
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.
Sourcepub fn get_output(&self) -> &Option<StreamProcessorOutput>
pub fn get_output(&self) -> &Option<StreamProcessorOutput>
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.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
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.
Sourcepub fn settings(self, input: StreamProcessorSettings) -> Self
pub fn settings(self, input: StreamProcessorSettings) -> Self
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.
Sourcepub fn set_settings(self, input: Option<StreamProcessorSettings>) -> Self
pub fn set_settings(self, input: Option<StreamProcessorSettings>) -> Self
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.
Sourcepub fn get_settings(&self) -> &Option<StreamProcessorSettings>
pub fn get_settings(&self) -> &Option<StreamProcessorSettings>
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.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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.
This field is required.Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
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.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
A set of tags (key-value pairs) that you want to attach to the stream processor.
A set of tags (key-value pairs) that you want to attach to the stream processor.
A set of tags (key-value pairs) that you want to attach to the stream processor.
Sourcepub fn notification_channel(
self,
input: StreamProcessorNotificationChannel,
) -> Self
pub fn notification_channel( self, input: StreamProcessorNotificationChannel, ) -> Self
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.
Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.
Sourcepub fn set_notification_channel(
self,
input: Option<StreamProcessorNotificationChannel>,
) -> Self
pub fn set_notification_channel( self, input: Option<StreamProcessorNotificationChannel>, ) -> Self
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.
Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.
Sourcepub fn get_notification_channel(
&self,
) -> &Option<StreamProcessorNotificationChannel>
pub fn get_notification_channel( &self, ) -> &Option<StreamProcessorNotificationChannel>
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.
Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
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.
Sourcepub fn regions_of_interest(self, input: RegionOfInterest) -> Self
pub fn regions_of_interest(self, input: RegionOfInterest) -> Self
Appends an item to regions_of_interest
.
To override the contents of this collection use set_regions_of_interest
.
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.
Sourcepub fn set_regions_of_interest(
self,
input: Option<Vec<RegionOfInterest>>,
) -> Self
pub fn set_regions_of_interest( self, input: Option<Vec<RegionOfInterest>>, ) -> Self
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.
Sourcepub fn get_regions_of_interest(&self) -> &Option<Vec<RegionOfInterest>>
pub fn get_regions_of_interest(&self) -> &Option<Vec<RegionOfInterest>>
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.
Sourcepub fn data_sharing_preference(
self,
input: StreamProcessorDataSharingPreference,
) -> Self
pub fn data_sharing_preference( self, input: StreamProcessorDataSharingPreference, ) -> Self
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.
Sourcepub fn set_data_sharing_preference(
self,
input: Option<StreamProcessorDataSharingPreference>,
) -> Self
pub fn set_data_sharing_preference( self, input: Option<StreamProcessorDataSharingPreference>, ) -> Self
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.
Sourcepub fn get_data_sharing_preference(
&self,
) -> &Option<StreamProcessorDataSharingPreference>
pub fn get_data_sharing_preference( &self, ) -> &Option<StreamProcessorDataSharingPreference>
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.
Sourcepub fn build(self) -> Result<CreateStreamProcessorInput, BuildError>
pub fn build(self) -> Result<CreateStreamProcessorInput, BuildError>
Consumes the builder and constructs a CreateStreamProcessorInput
.
Source§impl CreateStreamProcessorInputBuilder
impl CreateStreamProcessorInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateStreamProcessorOutput, SdkError<CreateStreamProcessorError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateStreamProcessorOutput, SdkError<CreateStreamProcessorError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateStreamProcessorInputBuilder
impl Clone for CreateStreamProcessorInputBuilder
Source§fn clone(&self) -> CreateStreamProcessorInputBuilder
fn clone(&self) -> CreateStreamProcessorInputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for CreateStreamProcessorInputBuilder
impl Default for CreateStreamProcessorInputBuilder
Source§fn default() -> CreateStreamProcessorInputBuilder
fn default() -> CreateStreamProcessorInputBuilder
Source§impl PartialEq for CreateStreamProcessorInputBuilder
impl PartialEq for CreateStreamProcessorInputBuilder
Source§fn eq(&self, other: &CreateStreamProcessorInputBuilder) -> bool
fn eq(&self, other: &CreateStreamProcessorInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateStreamProcessorInputBuilder
Auto Trait Implementations§
impl Freeze for CreateStreamProcessorInputBuilder
impl RefUnwindSafe for CreateStreamProcessorInputBuilder
impl Send for CreateStreamProcessorInputBuilder
impl Sync for CreateStreamProcessorInputBuilder
impl Unpin for CreateStreamProcessorInputBuilder
impl UnwindSafe for CreateStreamProcessorInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);