Struct ListDatasetEntriesFluentBuilder 

pub struct ListDatasetEntriesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListDatasetEntries.

This operation applies only to Amazon Rekognition Custom Labels.

Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file.

JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training.

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

Implementations

impl ListDatasetEntriesFluentBuilder

pub fn as_input(&self) -> &ListDatasetEntriesInputBuilder

Access the ListDatasetEntries as a reference.

pub async fn send( self, ) -> Result<ListDatasetEntriesOutput, SdkError<ListDatasetEntriesError, 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.

pub fn customize( self, ) -> CustomizableOperation<ListDatasetEntriesOutput, ListDatasetEntriesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListDatasetEntriesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

pub fn dataset_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the dataset that you want to use.

pub fn set_dataset_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the dataset that you want to use.

pub fn get_dataset_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the dataset that you want to use.

pub fn contains_labels(self, input: impl Into<String>) -> Self

Appends an item to ContainsLabels.

To override the contents of this collection use set_contains_labels.

Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

pub fn set_contains_labels(self, input: Option<Vec<String>>) -> Self

Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

pub fn get_contains_labels(&self) -> &Option<Vec<String>>

Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

pub fn labeled(self, input: bool) -> Self

Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.

pub fn set_labeled(self, input: Option<bool>) -> Self

Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.

pub fn get_labeled(&self) -> &Option<bool>

Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.

pub fn source_ref_contains(self, input: impl Into<String>) -> Self

If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.

pub fn set_source_ref_contains(self, input: Option<String>) -> Self

If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.

pub fn get_source_ref_contains(&self) -> &Option<String>

If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.

pub fn has_errors(self, input: bool) -> Self

Specifies an error filter for the response. Specify True to only include entries that have errors.

pub fn set_has_errors(self, input: Option<bool>) -> Self

Specifies an error filter for the response. Specify True to only include entries that have errors.

pub fn get_has_errors(&self) -> &Option<bool>

Specifies an error filter for the response. Specify True to only include entries that have errors.

pub fn next_token(self, input: impl Into<String>) -> Self

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

pub fn set_next_token(self, input: Option<String>) -> Self

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

pub fn get_next_token(&self) -> &Option<String>

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Trait Implementations

impl Clone for ListDatasetEntriesFluentBuilder

fn clone(&self) -> ListDatasetEntriesFluentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListDatasetEntriesFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.