| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisVideoArchivedMedia.ListFragments
Description
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-ErrorTypeHTTP header – contains a more specific error type in addition to what the HTTP status code provides.x-amz-RequestIdHTTP 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.
This operation returns paginated results.
Synopsis
- data ListFragments = ListFragments' {}
- newListFragments :: ListFragments
- listFragments_fragmentSelector :: Lens' ListFragments (Maybe FragmentSelector)
- listFragments_streamARN :: Lens' ListFragments (Maybe Text)
- listFragments_nextToken :: Lens' ListFragments (Maybe Text)
- listFragments_streamName :: Lens' ListFragments (Maybe Text)
- listFragments_maxResults :: Lens' ListFragments (Maybe Natural)
- data ListFragmentsResponse = ListFragmentsResponse' {}
- newListFragmentsResponse :: Int -> ListFragmentsResponse
- listFragmentsResponse_nextToken :: Lens' ListFragmentsResponse (Maybe Text)
- listFragmentsResponse_fragments :: Lens' ListFragmentsResponse (Maybe [Fragment])
- listFragmentsResponse_httpStatus :: Lens' ListFragmentsResponse Int
Creating a Request
data ListFragments Source #
See: newListFragments smart constructor.
Constructors
| ListFragments' | |
Fields
| |
Instances
newListFragments :: ListFragments Source #
Create a value of ListFragments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fragmentSelector:ListFragments', listFragments_fragmentSelector - Describes the timestamp range and timestamp origin for the range of
fragments to return.
$sel:streamARN:ListFragments', listFragments_streamARN - The Amazon Resource Name (ARN) of the stream from which to retrieve a
fragment list. Specify either this parameter or the StreamName
parameter.
$sel:nextToken:ListFragments', listFragments_nextToken - A token to specify where to start paginating. This is the
ListFragmentsOutput$NextToken from a previously truncated response.
$sel:streamName:ListFragments', listFragments_streamName - The name of the stream from which to retrieve a fragment list. Specify
either this parameter or the StreamARN parameter.
$sel:maxResults:ListFragments', listFragments_maxResults - 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.
Request Lenses
listFragments_fragmentSelector :: Lens' ListFragments (Maybe FragmentSelector) Source #
Describes the timestamp range and timestamp origin for the range of fragments to return.
listFragments_streamARN :: Lens' ListFragments (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stream from which to retrieve a
fragment list. Specify either this parameter or the StreamName
parameter.
listFragments_nextToken :: Lens' ListFragments (Maybe Text) Source #
A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.
listFragments_streamName :: Lens' ListFragments (Maybe Text) Source #
The name of the stream from which to retrieve a fragment list. Specify
either this parameter or the StreamARN parameter.
listFragments_maxResults :: Lens' ListFragments (Maybe Natural) Source #
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.
Destructuring the Response
data ListFragmentsResponse Source #
See: newListFragmentsResponse smart constructor.
Constructors
| ListFragmentsResponse' | |
Fields
| |
Instances
newListFragmentsResponse Source #
Create a value of ListFragmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListFragments', listFragmentsResponse_nextToken - If the returned list is truncated, the operation returns this token to
use to retrieve the next page of results. This value is null when
there are no more results to return.
$sel:fragments:ListFragmentsResponse', listFragmentsResponse_fragments - A list of archived Fragment objects from the stream that meet the
selector criteria. Results are in no specific order, even across pages.
$sel:httpStatus:ListFragmentsResponse', listFragmentsResponse_httpStatus - The response's http status code.
Response Lenses
listFragmentsResponse_nextToken :: Lens' ListFragmentsResponse (Maybe Text) Source #
If the returned list is truncated, the operation returns this token to
use to retrieve the next page of results. This value is null when
there are no more results to return.
listFragmentsResponse_fragments :: Lens' ListFragmentsResponse (Maybe [Fragment]) Source #
A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no specific order, even across pages.
listFragmentsResponse_httpStatus :: Lens' ListFragmentsResponse Int Source #
The response's http status code.