AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . mediatailor ]
Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide .
See also: AWS API Documentation
create-prefetch-schedule
--consumption <value>
--name <value>
--playback-configuration-name <value>
--retrieval <value>
[--stream-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--consumption
(structure)
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window . Prefetch schedules automatically expire no earlier than seven days after the end time.
AvailMatchingCriteria -> (list)
If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as
scte.event_id
, set the avail matching criteria.(structure)
MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
As an example, let's say that you set
DynamicVariable
toscte.event_id
andOperator
toEQUALS
, and your playback configuration has an ADS URL ofhttps://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]
. And the prefetch request to the ADS contains these valueshttps://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30
. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id ofmy-awesome-event
, since it must match the event id that MediaTailor uses to query the ADS.You can specify up to five
AvailMatchingCriteria
. If you specify multipleAvailMatchingCriteria
, MediaTailor combines them to match using a logicalAND
. You can model logicalOR
combinations by creating multiple prefetch schedules.DynamicVariable -> (string)
The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide .
You can include up to 100 dynamic variables.
Operator -> (string)
For theDynamicVariable
specified inAvailMatchingCriteria
, the Operator that is used for the comparison.EndTime -> (timestamp)
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can callDeletePrefetchSchedule
.StartTime -> (timestamp)
The time when prefetched ads are considered for use in an ad break. If you don't specifyStartTime
, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
Shorthand Syntax:
AvailMatchingCriteria=[{DynamicVariable=string,Operator=string},{DynamicVariable=string,Operator=string}],EndTime=timestamp,StartTime=timestamp
JSON Syntax:
{
"AvailMatchingCriteria": [
{
"DynamicVariable": "string",
"Operator": "EQUALS"
}
...
],
"EndTime": timestamp,
"StartTime": timestamp
}
--name
(string)
The name to assign to the schedule request.
--playback-configuration-name
(string)
The name to assign to the playback configuration.
--retrieval
(structure)
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
DynamicVariables -> (map)
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariables
for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.key -> (string)
value -> (string)
EndTime -> (timestamp)
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.StartTime -> (timestamp)
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
Shorthand Syntax:
DynamicVariables={KeyName1=string,KeyName2=string},EndTime=timestamp,StartTime=timestamp
JSON Syntax:
{
"DynamicVariables": {"string": "string"
...},
"EndTime": timestamp,
"StartTime": timestamp
}
--stream-id
(string)
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. IfStreamId
is specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId
. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId
.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Arn -> (string)
The ARN to assign to the prefetch schedule.
Consumption -> (structure)
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window . Prefetch schedules automatically expire no earlier than seven days after the end time.
AvailMatchingCriteria -> (list)
If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as
scte.event_id
, set the avail matching criteria.(structure)
MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
As an example, let's say that you set
DynamicVariable
toscte.event_id
andOperator
toEQUALS
, and your playback configuration has an ADS URL ofhttps://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]
. And the prefetch request to the ADS contains these valueshttps://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30
. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id ofmy-awesome-event
, since it must match the event id that MediaTailor uses to query the ADS.You can specify up to five
AvailMatchingCriteria
. If you specify multipleAvailMatchingCriteria
, MediaTailor combines them to match using a logicalAND
. You can model logicalOR
combinations by creating multiple prefetch schedules.DynamicVariable -> (string)
The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide .
You can include up to 100 dynamic variables.
Operator -> (string)
For theDynamicVariable
specified inAvailMatchingCriteria
, the Operator that is used for the comparison.EndTime -> (timestamp)
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can callDeletePrefetchSchedule
.StartTime -> (timestamp)
The time when prefetched ads are considered for use in an ad break. If you don't specifyStartTime
, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
Name -> (string)
The name to assign to the prefetch schedule.
PlaybackConfigurationName -> (string)
The name to assign to the playback configuration.
Retrieval -> (structure)
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
DynamicVariables -> (map)
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariables
for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.key -> (string)
value -> (string)
EndTime -> (timestamp)
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.StartTime -> (timestamp)
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
StreamId -> (string)
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. IfStreamId
is specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId
. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId
.