Struct aws_sdk_kinesisvideoarchivedmedia::client::fluent_builders::ListFragments

pub struct ListFragments { /* private fields */ }

Fluent builder constructing a request to ListFragments.

Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second.

You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url parameter.

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

• x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

• x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

Implementations

impl ListFragments

pub async fn send(
    self
) -> Result<ListFragmentsOutput, SdkError<ListFragmentsError>>

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 stream_name(self, input: impl Into<String>) -> Self

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

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

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

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

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

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

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

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

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

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

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

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

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

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

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

pub fn fragment_selector(self, input: FragmentSelector) -> Self

Describes the timestamp range and timestamp origin for the range of fragments to return.

pub fn set_fragment_selector(self, input: Option<FragmentSelector>) -> Self

Describes the timestamp range and timestamp origin for the range of fragments to return.

Trait Implementations

impl Clone for ListFragments

fn clone(&self) -> ListFragments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListFragments

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

Formats the value using the given formatter.