Struct aws_sdk_kinesisvideoarchivedmedia::operation::list_fragments::builders::ListFragmentsFluentBuilder
source · pub struct ListFragmentsFluentBuilder { /* private fields */ }
Expand description
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 Amazon Web Services, 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§
source§impl ListFragmentsFluentBuilder
impl ListFragmentsFluentBuilder
sourcepub fn as_input(&self) -> &ListFragmentsInputBuilder
pub fn as_input(&self) -> &ListFragmentsInputBuilder
Access the ListFragments as a reference.
sourcepub async fn send(
self
) -> Result<ListFragmentsOutput, SdkError<ListFragmentsError, HttpResponse>>
pub async fn send( self ) -> Result<ListFragmentsOutput, SdkError<ListFragmentsError, 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<ListFragmentsOutput, ListFragmentsError, Self>
pub fn customize( self ) -> CustomizableOperation<ListFragmentsOutput, ListFragmentsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListFragmentsPaginator
pub fn into_paginator(self) -> ListFragmentsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_stream_name(&self) -> &Option<String>
pub fn get_stream_name(&self) -> &Option<String>
The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN
parameter.
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName
parameter.
sourcepub fn max_results(self, input: i64) -> Self
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.
sourcepub fn set_max_results(self, input: Option<i64>) -> Self
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.
sourcepub fn get_max_results(&self) -> &Option<i64>
pub fn get_max_results(&self) -> &Option<i64>
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.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken
from a previously truncated response.
sourcepub fn fragment_selector(self, input: FragmentSelector) -> Self
pub fn fragment_selector(self, input: FragmentSelector) -> Self
Describes the timestamp range and timestamp origin for the range of fragments to return.
sourcepub fn set_fragment_selector(self, input: Option<FragmentSelector>) -> Self
pub fn set_fragment_selector(self, input: Option<FragmentSelector>) -> Self
Describes the timestamp range and timestamp origin for the range of fragments to return.
sourcepub fn get_fragment_selector(&self) -> &Option<FragmentSelector>
pub fn get_fragment_selector(&self) -> &Option<FragmentSelector>
Describes the timestamp range and timestamp origin for the range of fragments to return.
Trait Implementations§
source§impl Clone for ListFragmentsFluentBuilder
impl Clone for ListFragmentsFluentBuilder
source§fn clone(&self) -> ListFragmentsFluentBuilder
fn clone(&self) -> ListFragmentsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more