Network.AWS.KinesisVideoArchivedMedia.ListFragments

Returns a list of Fragment objects from the specified stream and start location within the archived data.

Creating a Request

listFragments

Arguments

:: Text

lfStreamName

-> ListFragments

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 in max-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

See: listFragments smart constructor.

Instances

Eq ListFragments

Methods

(==) :: ListFragments -> ListFragments -> Bool

(/=) :: ListFragments -> ListFragments -> Bool

Data ListFragments

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFragments -> c ListFragments

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFragments

toConstr :: ListFragments -> Constr

dataTypeOf :: ListFragments -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListFragments)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFragments)

gmapT :: (forall b. Data b => b -> b) -> ListFragments -> ListFragments

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFragments -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFragments -> r

gmapQ :: (forall d. Data d => d -> u) -> ListFragments -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFragments -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFragments -> m ListFragments

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFragments -> m ListFragments

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFragments -> m ListFragments

Read ListFragments

Methods

readsPrec :: Int -> ReadS ListFragments

readList :: ReadS [ListFragments]

readPrec :: ReadPrec ListFragments

readListPrec :: ReadPrec [ListFragments]

Show ListFragments

Methods

showsPrec :: Int -> ListFragments -> ShowS

show :: ListFragments -> String

showList :: [ListFragments] -> ShowS

Generic ListFragments

Associated Types

type Rep ListFragments :: * -> *

Methods

from :: ListFragments -> Rep ListFragments x

to :: Rep ListFragments x -> ListFragments

Hashable ListFragments

Methods

hashWithSalt :: Int -> ListFragments -> Int

hash :: ListFragments -> Int

ToJSON ListFragments

Methods

toJSON :: ListFragments -> Value

toEncoding :: ListFragments -> Encoding

toJSONList :: [ListFragments] -> Value

toEncodingList :: [ListFragments] -> Encoding

NFData ListFragments

Methods

rnf :: ListFragments -> ()

AWSRequest ListFragments

Associated Types

type Rs ListFragments :: *

Methods

request :: ListFragments -> Request ListFragments

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListFragments -> ClientResponse -> m (Response ListFragments)

ToHeaders ListFragments

Methods

toHeaders :: ListFragments -> [Header]

ToPath ListFragments

Methods

toPath :: ListFragments -> ByteString

ToQuery ListFragments

Methods

toQuery :: ListFragments -> QueryString

type Rep ListFragments

type Rep ListFragments = D1 * (MetaData "ListFragments" "Network.AWS.KinesisVideoArchivedMedia.ListFragments" "amazonka-kinesis-video-archived-media-1.6.0-BK4sg7YWMNVCwg3NegaW0Y" False) (C1 * (MetaCons "ListFragments'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lfFragmentSelector") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe FragmentSelector))) (S1 * (MetaSel (Just Symbol "_lfNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lfMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_lfStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs ListFragments

type Rs ListFragments = ListFragmentsResponse

Request Lenses

lfFragmentSelector :: Lens' ListFragments (Maybe FragmentSelector)

Describes the time stamp range and time stamp origin for the range of fragments to return.

lfNextToken :: Lens' ListFragments (Maybe Text)

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

lfMaxResults :: Lens' ListFragments (Maybe Natural)

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

The name of the stream from which to retrieve a fragment list.

Destructuring the Response

listFragmentsResponse

Arguments

:: Int

lfrsResponseStatus

-> ListFragmentsResponse

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 is null 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

See: listFragmentsResponse smart constructor.

Instances

Eq ListFragmentsResponse

Methods

(==) :: ListFragmentsResponse -> ListFragmentsResponse -> Bool

(/=) :: ListFragmentsResponse -> ListFragmentsResponse -> Bool

Data ListFragmentsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFragmentsResponse -> c ListFragmentsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFragmentsResponse

toConstr :: ListFragmentsResponse -> Constr

dataTypeOf :: ListFragmentsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListFragmentsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFragmentsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListFragmentsResponse -> ListFragmentsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFragmentsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFragmentsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListFragmentsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFragmentsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFragmentsResponse -> m ListFragmentsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFragmentsResponse -> m ListFragmentsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFragmentsResponse -> m ListFragmentsResponse

Read ListFragmentsResponse

Methods

readsPrec :: Int -> ReadS ListFragmentsResponse

readList :: ReadS [ListFragmentsResponse]

readPrec :: ReadPrec ListFragmentsResponse

readListPrec :: ReadPrec [ListFragmentsResponse]

Show ListFragmentsResponse

Methods

showsPrec :: Int -> ListFragmentsResponse -> ShowS

show :: ListFragmentsResponse -> String

showList :: [ListFragmentsResponse] -> ShowS

Generic ListFragmentsResponse

Associated Types

type Rep ListFragmentsResponse :: * -> *

Methods

from :: ListFragmentsResponse -> Rep ListFragmentsResponse x

to :: Rep ListFragmentsResponse x -> ListFragmentsResponse

NFData ListFragmentsResponse

Methods

rnf :: ListFragmentsResponse -> ()

type Rep ListFragmentsResponse

type Rep ListFragmentsResponse = D1 * (MetaData "ListFragmentsResponse" "Network.AWS.KinesisVideoArchivedMedia.ListFragments" "amazonka-kinesis-video-archived-media-1.6.0-BK4sg7YWMNVCwg3NegaW0Y" False) (C1 * (MetaCons "ListFragmentsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lfrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lfrsFragments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Fragment]))) (S1 * (MetaSel (Just Symbol "_lfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lfrsNextToken :: Lens' ListFragmentsResponse (Maybe Text)

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]

A list of fragment numbers that correspond to the time stamp range provided.

lfrsResponseStatus :: Lens' ListFragmentsResponse Int

• - | The response status code.