libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaTailor.ListPrefetchSchedules

Description

Creates a new prefetch schedule.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPrefetchSchedules Source #

See: newListPrefetchSchedules smart constructor.

Constructors

ListPrefetchSchedules' 

Fields

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

    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.

  • streamId :: Maybe Text

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

  • playbackConfigurationName :: Text

    The name of the playback configuration.

Instances

Instances details
Eq ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Read ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Show ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Generic ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Associated Types

type Rep ListPrefetchSchedules :: Type -> Type #

NFData ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Methods

rnf :: ListPrefetchSchedules -> () #

Hashable ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

ToJSON ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

AWSPager ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

AWSRequest ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Associated Types

type AWSResponse ListPrefetchSchedules #

ToHeaders ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

ToPath ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

ToQuery ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

type Rep ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

type Rep ListPrefetchSchedules = D1 ('MetaData "ListPrefetchSchedules" "Amazonka.MediaTailor.ListPrefetchSchedules" "libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor" 'False) (C1 ('MetaCons "ListPrefetchSchedules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "playbackConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListPrefetchSchedules Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

newListPrefetchSchedules Source #

Create a value of ListPrefetchSchedules with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListPrefetchSchedules', listPrefetchSchedules_nextToken - (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.

$sel:maxResults:ListPrefetchSchedules', listPrefetchSchedules_maxResults - 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.

$sel:streamId:ListPrefetchSchedules', listPrefetchSchedules_streamId - An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

$sel:playbackConfigurationName:ListPrefetchSchedules', listPrefetchSchedules_playbackConfigurationName - The name of the playback configuration.

Request Lenses

listPrefetchSchedules_nextToken :: Lens' ListPrefetchSchedules (Maybe Text) Source #

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

listPrefetchSchedules_maxResults :: Lens' ListPrefetchSchedules (Maybe Natural) Source #

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.

listPrefetchSchedules_streamId :: Lens' ListPrefetchSchedules (Maybe Text) Source #

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

Destructuring the Response

data ListPrefetchSchedulesResponse Source #

See: newListPrefetchSchedulesResponse smart constructor.

Constructors

ListPrefetchSchedulesResponse' 

Fields

  • items :: Maybe [PrefetchSchedule]

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

  • nextToken :: Maybe Text

    The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListPrefetchSchedulesResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Read ListPrefetchSchedulesResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Show ListPrefetchSchedulesResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Generic ListPrefetchSchedulesResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

Associated Types

type Rep ListPrefetchSchedulesResponse :: Type -> Type #

NFData ListPrefetchSchedulesResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

type Rep ListPrefetchSchedulesResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.ListPrefetchSchedules

type Rep ListPrefetchSchedulesResponse = D1 ('MetaData "ListPrefetchSchedulesResponse" "Amazonka.MediaTailor.ListPrefetchSchedules" "libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor" 'False) (C1 ('MetaCons "ListPrefetchSchedulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PrefetchSchedule])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPrefetchSchedulesResponse Source #

Create a value of ListPrefetchSchedulesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:items:ListPrefetchSchedulesResponse', listPrefetchSchedulesResponse_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.

$sel:nextToken:ListPrefetchSchedules', listPrefetchSchedulesResponse_nextToken - The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.

$sel:httpStatus:ListPrefetchSchedulesResponse', listPrefetchSchedulesResponse_httpStatus - The response's http status code.

Response Lenses

listPrefetchSchedulesResponse_items :: Lens' ListPrefetchSchedulesResponse (Maybe [PrefetchSchedule]) Source #

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

listPrefetchSchedulesResponse_nextToken :: Lens' ListPrefetchSchedulesResponse (Maybe Text) Source #

The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.