Class: Aws::MediaTailor::Types::ListChannelsRequest

Inherits:

Struct

Object
Struct
Aws::MediaTailor::Types::ListChannelsRequest

show all

Defined in:: gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#max_results ⇒ Integer
The maximum number of channels that you want MediaTailor to return in response to the current request.
#next_token ⇒ String
Pagination token returned by the list request when results exceed the maximum allowed.

Instance Attribute Details

#max_results ⇒ `Integer`

The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, 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.

Returns:

(Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2711

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

#next_token ⇒ `String`

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 ListChannels 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.