Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Returns a list of Fragment
objects from the specified stream and start location within the archived data.
Synopsis
- listFragments :: Text -> ListFragments
- data ListFragments
- lfFragmentSelector :: Lens' ListFragments (Maybe FragmentSelector)
- lfNextToken :: Lens' ListFragments (Maybe Text)
- lfMaxResults :: Lens' ListFragments (Maybe Natural)
- lfStreamName :: Lens' ListFragments Text
- listFragmentsResponse :: Int -> ListFragmentsResponse
- data ListFragmentsResponse
- lfrsNextToken :: Lens' ListFragmentsResponse (Maybe Text)
- lfrsFragments :: Lens' ListFragmentsResponse [Fragment]
- lfrsResponseStatus :: Lens' ListFragmentsResponse Int
Creating a Request
Creates a value of ListFragments
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lfFragmentSelector
- Describes the time stamp range and time stamp origin for the range of fragments to return.lfNextToken
- A token to specify where to start paginating. This is the 'ListFragmentsOutput$NextToken' from a previously truncated response.lfMaxResults
- The total number of fragments to return. If the total number of fragments available is more than the value specified inmax-results
, then a 'ListFragmentsOutput$NextToken' is provided in the output that you can use to resume pagination.lfStreamName
- The name of the stream from which to retrieve a fragment list.
data ListFragments Source #
See: listFragments
smart constructor.
Instances
Request Lenses
lfFragmentSelector :: Lens' ListFragments (Maybe FragmentSelector) Source #
Describes the time stamp range and time stamp origin for the range of fragments to return.
lfNextToken :: Lens' ListFragments (Maybe Text) Source #
A token to specify where to start paginating. This is the 'ListFragmentsOutput$NextToken' from a previously truncated response.
lfMaxResults :: 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.
lfStreamName :: Lens' ListFragments Text Source #
The name of the stream from which to retrieve a fragment list.
Destructuring the Response
listFragmentsResponse Source #
Creates a value of ListFragmentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lfrsNextToken
- If the returned list is truncated, the operation returns this token to use to retrieve the next page of results. This value isnull
when there are no more results to return.lfrsFragments
- A list of fragment numbers that correspond to the time stamp range provided.lfrsResponseStatus
- -- | The response status code.
data ListFragmentsResponse Source #
See: listFragmentsResponse
smart constructor.
Instances
Response Lenses
lfrsNextToken :: 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.
lfrsFragments :: Lens' ListFragmentsResponse [Fragment] Source #
A list of fragment numbers that correspond to the time stamp range provided.
lfrsResponseStatus :: Lens' ListFragmentsResponse Int Source #
- - | The response status code.