Class: Aws::MediaTailor::Types::ListPrefetchSchedulesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb

Overview

Note:

When making an API call, you may pass ListPrefetchSchedulesRequest data as a hash:

{
  max_results: 1,
  next_token: "__string",
  playback_configuration_name: "__string", # required
  stream_id: "__string",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If the playback configuration has more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

Returns:

  • (Integer)


2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2512

class ListPrefetchSchedulesRequest < Struct.new(
  :max_results,
  :next_token,
  :playback_configuration_name,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.

For the first ListPrefetchSchedulesRequest request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2512

class ListPrefetchSchedulesRequest < Struct.new(
  :max_results,
  :next_token,
  :playback_configuration_name,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#playback_configuration_nameString

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2512

class ListPrefetchSchedulesRequest < Struct.new(
  :max_results,
  :next_token,
  :playback_configuration_name,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_idString

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

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2512

class ListPrefetchSchedulesRequest < Struct.new(
  :max_results,
  :next_token,
  :playback_configuration_name,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end