listPrefetchSchedules method
Lists the prefetch schedules for a playback configuration.
Parameter playbackConfigurationName :
Retrieves the prefetch schedule(s) for a specific playback configuration.
Parameter maxResults :
The maximum number of prefetch schedules that you want MediaTailor to
return in response to the current request. If there are more than
MaxResults prefetch schedules, use the value of
NextToken in the response to get the next page of results.
The default value is 100. MediaTailor uses DynamoDB-based pagination,
which means that a response might contain fewer than
MaxResults items, including 0 items, even when more results
are available. To retrieve all results, you must continue making requests
using the NextToken value from each response until the
response no longer includes a NextToken value.
Parameter nextToken :
Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
For the first ListPrefetchSchedules request, omit this value.
For subsequent requests, get the value of NextToken from the
previous response and specify that value for NextToken in the
request. Continue making requests until the response no longer includes a
NextToken value, which indicates that all results have been
retrieved.
Parameter scheduleType :
The type of prefetch schedules that you want to list. SINGLE
indicates that you want to list the configured single prefetch schedules.
RECURRING indicates that you want to list the configured
recurring prefetch schedules. ALL indicates that you want to
list all configured prefetch schedules.
Parameter streamId :
An optional filtering parameter whereby MediaTailor filters the prefetch
schedules to include only specific streams.
Implementation
Future<ListPrefetchSchedulesResponse> listPrefetchSchedules({
required String playbackConfigurationName,
int? maxResults,
String? nextToken,
ListPrefetchScheduleType? scheduleType,
String? streamId,
}) async {
_s.validateNumRange(
'maxResults',
maxResults,
1,
100,
);
final $payload = <String, dynamic>{
if (maxResults != null) 'MaxResults': maxResults,
if (nextToken != null) 'NextToken': nextToken,
if (scheduleType != null) 'ScheduleType': scheduleType.value,
if (streamId != null) 'StreamId': streamId,
};
final response = await _protocol.send(
payload: $payload,
method: 'POST',
requestUri:
'/prefetchSchedule/${Uri.encodeComponent(playbackConfigurationName)}',
exceptionFnMap: _exceptionFns,
);
return ListPrefetchSchedulesResponse.fromJson(response);
}