pub struct CreateProjectVersionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateProjectVersion
.
Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion
is an Amazon Resource Name (ARN) for the project version.
The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions
. Training completed successfully if the value of the Status
field is TRAINING_COMPLETED
. Once training has successfully completed, call DescribeProjectVersions
to get the training results and evaluate the model.
This operation requires permissions to perform the rekognition:CreateProjectVersion
action.
The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature:
You can train a model in a project that doesn't have associated datasets by specifying manifest files in the TrainingData
and TestingData
fields.
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.
Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.
Implementations§
Source§impl CreateProjectVersionFluentBuilder
impl CreateProjectVersionFluentBuilder
Sourcepub fn as_input(&self) -> &CreateProjectVersionInputBuilder
pub fn as_input(&self) -> &CreateProjectVersionInputBuilder
Access the CreateProjectVersion as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateProjectVersionOutput, SdkError<CreateProjectVersionError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateProjectVersionOutput, SdkError<CreateProjectVersionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateProjectVersionOutput, CreateProjectVersionError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateProjectVersionOutput, CreateProjectVersionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn project_arn(self, input: impl Into<String>) -> Self
pub fn project_arn(self, input: impl Into<String>) -> Self
The ARN of the Amazon Rekognition project that will manage the project version you want to train.
Sourcepub fn set_project_arn(self, input: Option<String>) -> Self
pub fn set_project_arn(self, input: Option<String>) -> Self
The ARN of the Amazon Rekognition project that will manage the project version you want to train.
Sourcepub fn get_project_arn(&self) -> &Option<String>
pub fn get_project_arn(&self) -> &Option<String>
The ARN of the Amazon Rekognition project that will manage the project version you want to train.
Sourcepub fn version_name(self, input: impl Into<String>) -> Self
pub fn version_name(self, input: impl Into<String>) -> Self
A name for the version of the project version. This value must be unique.
Sourcepub fn set_version_name(self, input: Option<String>) -> Self
pub fn set_version_name(self, input: Option<String>) -> Self
A name for the version of the project version. This value must be unique.
Sourcepub fn get_version_name(&self) -> &Option<String>
pub fn get_version_name(&self) -> &Option<String>
A name for the version of the project version. This value must be unique.
Sourcepub fn output_config(self, input: OutputConfig) -> Self
pub fn output_config(self, input: OutputConfig) -> Self
The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject
permission on the bucket.
Sourcepub fn set_output_config(self, input: Option<OutputConfig>) -> Self
pub fn set_output_config(self, input: Option<OutputConfig>) -> Self
The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject
permission on the bucket.
Sourcepub fn get_output_config(&self) -> &Option<OutputConfig>
pub fn get_output_config(&self) -> &Option<OutputConfig>
The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject
permission on the bucket.
Sourcepub fn training_data(self, input: TrainingData) -> Self
pub fn training_data(self, input: TrainingData) -> Self
Specifies an external manifest that the services uses to train the project version. If you specify TrainingData
you must also specify TestingData
. The project must not have any associated datasets.
Sourcepub fn set_training_data(self, input: Option<TrainingData>) -> Self
pub fn set_training_data(self, input: Option<TrainingData>) -> Self
Specifies an external manifest that the services uses to train the project version. If you specify TrainingData
you must also specify TestingData
. The project must not have any associated datasets.
Sourcepub fn get_training_data(&self) -> &Option<TrainingData>
pub fn get_training_data(&self) -> &Option<TrainingData>
Specifies an external manifest that the services uses to train the project version. If you specify TrainingData
you must also specify TestingData
. The project must not have any associated datasets.
Sourcepub fn testing_data(self, input: TestingData) -> Self
pub fn testing_data(self, input: TestingData) -> Self
Specifies an external manifest that the service uses to test the project version. If you specify TestingData
you must also specify TrainingData
. The project must not have any associated datasets.
Sourcepub fn set_testing_data(self, input: Option<TestingData>) -> Self
pub fn set_testing_data(self, input: Option<TestingData>) -> Self
Specifies an external manifest that the service uses to test the project version. If you specify TestingData
you must also specify TrainingData
. The project must not have any associated datasets.
Sourcepub fn get_testing_data(&self) -> &Option<TestingData>
pub fn get_testing_data(&self) -> &Option<TestingData>
Specifies an external manifest that the service uses to test the project version. If you specify TestingData
you must also specify TrainingData
. The project must not have any associated datasets.
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 project version.
A set of tags (key-value pairs) that you want to attach to the project version.
A set of tags (key-value pairs) that you want to attach to the project version.
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). 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 training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig
).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
-
kms:CreateGrant
-
kms:DescribeKey
-
kms:GenerateDataKey
-
kms:Decrypt
If you don't specify a value for KmsKeyId
, images copied into the service are encrypted using a key that AWS owns and manages.
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). 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 training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig
).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
-
kms:CreateGrant
-
kms:DescribeKey
-
kms:GenerateDataKey
-
kms:Decrypt
If you don't specify a value for KmsKeyId
, images copied into the service are encrypted using a key that AWS owns and manages.
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). 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 training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig
).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
-
kms:CreateGrant
-
kms:DescribeKey
-
kms:GenerateDataKey
-
kms:Decrypt
If you don't specify a value for KmsKeyId
, images copied into the service are encrypted using a key that AWS owns and manages.
Sourcepub fn version_description(self, input: impl Into<String>) -> Self
pub fn version_description(self, input: impl Into<String>) -> Self
A description applied to the project version being created.
Sourcepub fn set_version_description(self, input: Option<String>) -> Self
pub fn set_version_description(self, input: Option<String>) -> Self
A description applied to the project version being created.
Sourcepub fn get_version_description(&self) -> &Option<String>
pub fn get_version_description(&self) -> &Option<String>
A description applied to the project version being created.
Sourcepub fn feature_config(self, input: CustomizationFeatureConfig) -> Self
pub fn feature_config(self, input: CustomizationFeatureConfig) -> Self
Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.
Sourcepub fn set_feature_config(
self,
input: Option<CustomizationFeatureConfig>,
) -> Self
pub fn set_feature_config( self, input: Option<CustomizationFeatureConfig>, ) -> Self
Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.
Sourcepub fn get_feature_config(&self) -> &Option<CustomizationFeatureConfig>
pub fn get_feature_config(&self) -> &Option<CustomizationFeatureConfig>
Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.
Trait Implementations§
Source§impl Clone for CreateProjectVersionFluentBuilder
impl Clone for CreateProjectVersionFluentBuilder
Source§fn clone(&self) -> CreateProjectVersionFluentBuilder
fn clone(&self) -> CreateProjectVersionFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateProjectVersionFluentBuilder
impl !RefUnwindSafe for CreateProjectVersionFluentBuilder
impl Send for CreateProjectVersionFluentBuilder
impl Sync for CreateProjectVersionFluentBuilder
impl Unpin for CreateProjectVersionFluentBuilder
impl !UnwindSafe for CreateProjectVersionFluentBuilder
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);