Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPrefetchSchedules

Lists the prefetch schedules for a playback configuration.

Request Syntax


POST /prefetchSchedule/PlaybackConfigurationName HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "ScheduleType": "string",
   "StreamId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

PlaybackConfigurationName

Retrieves the prefetch schedule(s) for a specific playback configuration.

Required: Yes

Request Body

The request accepts the following data in JSON format.

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Required: No

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.

Type: String

Valid Values: SINGLE | RECURRING | ALL

Required: No

StreamId

An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Arn": "string",
         "Consumption": { 
            "AvailMatchingCriteria": [ 
               { 
                  "DynamicVariable": "string",
                  "Operator": "string"
               }
            ],
            "EndTime": number,
            "StartTime": number
         },
         "Name": "string",
         "PlaybackConfigurationName": "string",
         "RecurringPrefetchConfiguration": { 
            "EndTime": number,
            "RecurringConsumption": { 
               "AvailMatchingCriteria": [ 
                  { 
                     "DynamicVariable": "string",
                     "Operator": "string"
                  }
               ],
               "RetrievedAdExpirationSeconds": number
            },
            "RecurringRetrieval": { 
               "DelayAfterAvailEndSeconds": number,
               "DynamicVariables": { 
                  "string" : "string" 
               },
               "TrafficShapingRetrievalWindow": { 
                  "RetrievalWindowDurationSeconds": number
               },
               "TrafficShapingType": "string"
            },
            "StartTime": number
         },
         "Retrieval": { 
            "DynamicVariables": { 
               "string" : "string" 
            },
            "EndTime": number,
            "StartTime": number,
            "TrafficShapingRetrievalWindow": { 
               "RetrievalWindowDurationSeconds": number
            },
            "TrafficShapingType": "string"
         },
         "ScheduleType": "string",
         "StreamId": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Items

Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.

Type: Array of PrefetchSchedule objects

NextToken

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.