1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Access configuration parameters.
type AccessConfiguration struct {
// The type of authentication used to access content from
// HttpConfiguration::BaseUrl on your source location. S3_SIGV4 - AWS Signature
// Version 4 authentication for Amazon S3 hosted virtual-style access. If your
// source location base URL is an Amazon S3 bucket, MediaTailor can use AWS
// Signature Version 4 (SigV4) authentication to access the bucket where your
// source content is stored. Your MediaTailor source location baseURL must follow
// the S3 virtual hosted-style request URL format. For example,
// https://bucket-name.s3.Region.amazonaws.com/key-name. Before you can use
// S3_SIGV4 , you must meet these requirements: • You must allow MediaTailor to
// access your S3 bucket by granting mediatailor.amazonaws.com principal access in
// IAM. For information about configuring access in IAM, see Access management in
// the IAM User Guide. • The mediatailor.amazonaws.com service principal must have
// permissions to read all top level manifests referenced by the VodSource
// packaging configurations. • The caller of the API must have s3:GetObject IAM
// permissions to read all top level manifests referenced by your MediaTailor
// VodSource packaging configurations. AUTODETECT_SIGV4 - AWS Signature Version 4
// authentication for a set of supported services: MediaPackage Version 2 and
// Amazon S3 hosted virtual-style access. If your source location base URL is a
// MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS
// Signature Version 4 (SigV4) authentication to access the resource where your
// source content is stored. Before you can use AUTODETECT_SIGV4 with a
// MediaPackage Version 2 endpoint, you must meet these requirements: • You must
// grant MediaTailor access to your MediaPackage endpoint by granting
// mediatailor.amazonaws.com principal access in an Origin Access policy on the
// endpoint. • Your MediaTailor source location base URL must be a MediaPackage V2
// endpoint. • The caller of the API must have mediapackagev2:GetObject IAM
// permissions to read all top level manifests referenced by the MediaTailor source
// packaging configurations. Before you can use AUTODETECT_SIGV4 with an Amazon S3
// bucket, you must meet these requirements: • You must grant MediaTailor access to
// your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM.
// For more information about configuring access in IAM, see Access management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html)
// in the IAM User Guide.. • The mediatailor.amazonaws.com service principal must
// have permissions to read all top-level manifests referenced by the VodSource
// packaging configurations. • The caller of the API must have s3:GetObject IAM
// permissions to read all top level manifests referenced by your MediaTailor
// VodSource packaging configurations.
AccessType AccessType
// AWS Secrets Manager access token configuration parameters.
SecretsManagerAccessTokenConfiguration *SecretsManagerAccessTokenConfiguration
noSmithyDocumentSerde
}
// Ad break configuration parameters.
type AdBreak struct {
// Defines a list of key/value pairs that MediaTailor generates within the
// EXT-X-ASSET tag for SCTE35_ENHANCED output.
AdBreakMetadata []KeyValuePair
// The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT , TIME_SIGNAL .
MessageType MessageType
// How long (in milliseconds) after the beginning of the program that an ad
// starts. This value must fall within 100ms of a segment boundary, otherwise the
// ad break will be skipped.
OffsetMillis int64
// Ad break slate configuration.
Slate *SlateSource
// This defines the SCTE-35 splice_insert() message inserted around the ad. For
// information about using splice_insert() , see the SCTE-35 specficiaiton, section
// 9.7.3.1.
SpliceInsertMessage *SpliceInsertMessage
// Defines the SCTE-35 time_signal message inserted around the ad. Programs on a
// channel's schedule can be configured with one or more ad breaks. You can attach
// a splice_insert SCTE-35 message to the ad break. This message provides basic
// metadata about the ad break. See section 9.7.4 of the 2022 SCTE-35 specification
// for more information.
TimeSignalMessage *TimeSignalMessage
noSmithyDocumentSerde
}
// A location at which a zero-duration ad marker was detected in a VOD source
// manifest.
type AdBreakOpportunity struct {
// The offset in milliseconds from the start of the VOD source at which an ad
// marker was detected.
//
// This member is required.
OffsetMillis int64
noSmithyDocumentSerde
}
// For HLS, when set to true , MediaTailor passes through EXT-X-CUE-IN ,
// EXT-X-CUE-OUT , and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin
// manifest to the MediaTailor personalized manifest. No logic is applied to these
// ad markers. For example, if EXT-X-CUE-OUT has a value of 60 , but no ads are
// filled for that ad break, MediaTailor will not set the value to 0 .
type AdMarkerPassthrough struct {
// Enables ad marker passthrough for your configuration.
Enabled bool
noSmithyDocumentSerde
}
// Alert configuration parameters.
type Alert struct {
// The code for the alert. For example, NOT_PROCESSED .
//
// This member is required.
AlertCode *string
// If an alert is generated for a resource, an explanation of the reason for the
// alert.
//
// This member is required.
AlertMessage *string
// The timestamp when the alert was last modified.
//
// This member is required.
LastModifiedTime *time.Time
// The Amazon Resource Names (ARNs) related to this alert.
//
// This member is required.
RelatedResourceArns []string
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
ResourceArn *string
// The category that MediaTailor assigns to the alert.
Category AlertCategory
noSmithyDocumentSerde
}
// 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 to scte.event_id and Operator to EQUALS , and your
// playback configuration has an ADS URL of
// https://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 values
// https://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 of my-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 multiple AvailMatchingCriteria ,
// MediaTailor combines them to match using a logical AND . You can model logical
// OR combinations by creating multiple prefetch schedules.
type AvailMatchingCriteria struct {
// 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 (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html)
// in the MediaTailor User Guide. You can include up to 100 dynamic variables.
//
// This member is required.
DynamicVariable *string
// For the DynamicVariable specified in AvailMatchingCriteria , the Operator that
// is used for the comparison.
//
// This member is required.
Operator Operator
noSmithyDocumentSerde
}
// The configuration for avail suppression, also known as ad suppression. For more
// information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html)
// .
type AvailSuppression struct {
// Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE
// will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be
// used to invoke partial ad break fills when a session starts mid-break.
FillPolicy FillPolicy
// Sets the ad suppression mode. By default, ad suppression is off and all ad
// breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE , ad
// suppression is active and MediaTailor won't fill ad breaks on or behind the ad
// suppression Value time in the manifest lookback window. When Mode is set to
// AFTER_LIVE_EDGE , ad suppression is active and MediaTailor won't fill ad breaks
// that are within the live edge plus the avail suppression value.
Mode Mode
// A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or
// behind this time in the manifest lookback window. If Value is set to 00:00:00,
// it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or
// behind the live edge. If you set a Value time, MediaTailor won't fill any ad
// breaks on or behind this time in the manifest lookback window. For example, if
// you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45
// minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes
// behind the live edge.
Value *string
noSmithyDocumentSerde
}
// The configuration for bumpers. Bumpers are short audio or video clips that play
// at the start or before the end of an ad break. To learn more about bumpers, see
// Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) .
type Bumper struct {
// The URL for the end bumper asset.
EndUrl *string
// The URL for the start bumper asset.
StartUrl *string
noSmithyDocumentSerde
}
// The configuration for using a content delivery network (CDN), like Amazon
// CloudFront, for content and ad segment management.
type CdnConfiguration struct {
// A non-default content delivery network (CDN) to serve ad segments. By default,
// AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as
// its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN
// for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's
// name in this AdSegmentUrlPrefix . When AWS Elemental MediaTailor serves a
// manifest, it reports your CDN as the source for ad segments.
AdSegmentUrlPrefix *string
// A content delivery network (CDN) to cache content segments, so that content
// requests don’t always have to go to the origin server. First, create a rule in
// your CDN for the content segment origin server. Then specify the rule's name in
// this ContentSegmentUrlPrefix . When AWS Elemental MediaTailor serves a manifest,
// it reports your CDN as the source for content segments.
ContentSegmentUrlPrefix *string
noSmithyDocumentSerde
}
// The configuration parameters for a channel. For information about MediaTailor
// channels, see Working with channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html)
// in the MediaTailor User Guide.
type Channel struct {
// The ARN of the channel.
//
// This member is required.
Arn *string
// The name of the channel.
//
// This member is required.
ChannelName *string
// Returns the state whether the channel is running or not.
//
// This member is required.
ChannelState *string
// The log configuration.
//
// This member is required.
LogConfiguration *LogConfigurationForChannel
// The channel's output properties.
//
// This member is required.
Outputs []ResponseOutputItem
// The type of playback mode for this channel. LINEAR - Programs play back-to-back
// only once. LOOP - Programs play back-to-back in an endless loop. When the last
// program in the schedule plays, playback loops back to the first program in the
// schedule.
//
// This member is required.
PlaybackMode *string
// The tier for this channel. STANDARD tier channels can contain live programs.
//
// This member is required.
Tier *string
// The timestamp of when the channel was created.
CreationTime *time.Time
// The slate used to fill gaps between programs in the schedule. You must
// configure filler slate if your channel uses the LINEAR PlaybackMode .
// MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode
// .
FillerSlate *SlateSource
// The timestamp of when the channel was last modified.
LastModifiedTime *time.Time
// The tags to assign to the channel. Tags are key-value pairs that you can
// associate with Amazon resources to help with organization, access control, and
// cost tracking. For more information, see Tagging AWS Elemental MediaTailor
// Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) .
Tags map[string]string
noSmithyDocumentSerde
}
// Clip range configuration for the VOD source associated with the program.
type ClipRange struct {
// The end offset of the clip range, in milliseconds, starting from the beginning
// of the VOD source associated with the program.
//
// This member is required.
EndOffsetMillis *int64
noSmithyDocumentSerde
}
// The configuration for DASH content.
type DashConfiguration struct {
// The URL generated by MediaTailor to initiate a playback session. The session
// uses server-side reporting. This setting is ignored in PUT operations.
ManifestEndpointPrefix *string
// The setting that controls whether MediaTailor includes the Location tag in DASH
// manifests. MediaTailor populates the Location tag with the URL for manifest
// update requests, to be used by players that don't support sticky redirects.
// Disable this if you have CDN routing rules set up for accessing MediaTailor
// manifests, and you are either using client-side reporting or your players
// support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT . The
// EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
MpdLocation *string
// The setting that controls whether MediaTailor handles manifests from the origin
// server as multi-period manifests or single-period manifests. If your origin
// server produces single-period manifests, set this to SINGLE_PERIOD . The default
// setting is MULTI_PERIOD . For multi-period manifests, omit this setting or set
// it to MULTI_PERIOD .
OriginManifestType OriginManifestType
noSmithyDocumentSerde
}
// The configuration for DASH PUT operations.
type DashConfigurationForPut struct {
// The setting that controls whether MediaTailor includes the Location tag in DASH
// manifests. MediaTailor populates the Location tag with the URL for manifest
// update requests, to be used by players that don't support sticky redirects.
// Disable this if you have CDN routing rules set up for accessing MediaTailor
// manifests, and you are either using client-side reporting or your players
// support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT . The
// EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
MpdLocation *string
// The setting that controls whether MediaTailor handles manifests from the origin
// server as multi-period manifests or single-period manifests. If your origin
// server produces single-period manifests, set this to SINGLE_PERIOD . The default
// setting is MULTI_PERIOD . For multi-period manifests, omit this setting or set
// it to MULTI_PERIOD .
OriginManifestType OriginManifestType
noSmithyDocumentSerde
}
// Dash manifest configuration parameters.
type DashPlaylistSettings struct {
// The total duration (in seconds) of each manifest. Minimum value: 30 seconds.
// Maximum value: 3600 seconds.
ManifestWindowSeconds *int32
// Minimum amount of content (measured in seconds) that a player must keep
// available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinBufferTimeSeconds *int32
// Minimum amount of time (in seconds) that the player should wait before
// requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60
// seconds.
MinUpdatePeriodSeconds *int32
// Amount of time (in seconds) that the player should be from the live point at
// the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds *int32
noSmithyDocumentSerde
}
// The optional configuration for a server that serves segments. Use this if you
// want the segment delivery server to be different from the source location
// server. For example, you can configure your source location server to be an
// origination server, such as MediaPackage, and the segment delivery server to be
// a content delivery network (CDN), such as CloudFront. If you don't specify a
// segment delivery server, then the source location server is used.
type DefaultSegmentDeliveryConfiguration struct {
// The hostname of the server that will be used to serve segments. This string
// must include the protocol, such as https://.
BaseUrl *string
noSmithyDocumentSerde
}
// The configuration for HLS content.
type HlsConfiguration struct {
// The URL that is used to initiate a playback session for devices that support
// Apple HLS. The session uses server-side reporting.
ManifestEndpointPrefix *string
noSmithyDocumentSerde
}
// HLS playlist configuration parameters.
type HlsPlaylistSettings struct {
// Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to
// use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use
// EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
AdMarkupType []AdMarkupType
// The total duration (in seconds) of each manifest. Minimum value: 30 seconds.
// Maximum value: 3600 seconds.
ManifestWindowSeconds *int32
noSmithyDocumentSerde
}
// The HTTP configuration for the source location.
type HttpConfiguration struct {
// The base URL for the source location host server. This string must include the
// protocol, such as https://.
//
// This member is required.
BaseUrl *string
noSmithyDocumentSerde
}
// The HTTP package configuration properties for the requested VOD source.
type HttpPackageConfiguration struct {
// The relative path to the URL for this VOD source. This is combined with
// SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
//
// This member is required.
Path *string
// The name of the source group. This has to match one of the
// Channel::Outputs::SourceGroup .
//
// This member is required.
SourceGroup *string
// The streaming protocol for this package configuration. Supported values are HLS
// and DASH .
//
// This member is required.
Type Type
noSmithyDocumentSerde
}
// For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor
// generates these pairs within the EXT-X-ASSET tag.
type KeyValuePair struct {
// For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its
// associated value, and generates the key/value pair within the EXT-X-ASSET tag.
// If you specify a key, you must also specify a corresponding value.
//
// This member is required.
Key *string
// For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and
// its associated key, and generates the key/value pair within the EXT-X-ASSET tag.
// If you specify a value, you must also specify a corresponding key.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// The configuration for pre-roll ad insertion.
type LivePreRollConfiguration struct {
// The URL for the ad decision server (ADS) for pre-roll ads. This includes the
// specification of static parameters and placeholders for dynamic parameters. AWS
// Elemental MediaTailor substitutes player-specific and session-specific
// parameters as needed when calling the ADS. Alternately, for testing, you can
// provide a static VAST URL. The maximum length is 25,000 characters.
AdDecisionServerUrl *string
// The maximum allowed duration for the pre-roll ad avail. AWS Elemental
// MediaTailor won't play pre-roll ads to exceed this duration, regardless of the
// total duration of ads that the ADS returns.
MaxDurationSeconds *int32
noSmithyDocumentSerde
}
// Live source configuration parameters.
type LiveSource struct {
// The ARN for the live source.
//
// This member is required.
Arn *string
// The HTTP package configurations for the live source.
//
// This member is required.
HttpPackageConfigurations []HttpPackageConfiguration
// The name that's used to refer to a live source.
//
// This member is required.
LiveSourceName *string
// The name of the source location.
//
// This member is required.
SourceLocationName *string
// The timestamp that indicates when the live source was created.
CreationTime *time.Time
// The timestamp that indicates when the live source was last modified.
LastModifiedTime *time.Time
// The tags assigned to the live source. Tags are key-value pairs that you can
// associate with Amazon resources to help with organization, access control, and
// cost tracking. For more information, see Tagging AWS Elemental MediaTailor
// Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) .
Tags map[string]string
noSmithyDocumentSerde
}
// Returns Amazon CloudWatch log settings for a playback configuration.
type LogConfiguration struct {
// The percentage of session logs that MediaTailor sends to your Cloudwatch Logs
// account. For example, if your playback configuration has 1000 sessions and
// percentEnabled is set to 60 , MediaTailor sends logs for 600 of the sessions to
// CloudWatch Logs. MediaTailor decides at random which of the playback
// configuration sessions to send logs for. If you want to view logs for a specific
// session, you can use the debug log mode (https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html)
// . Valid values: 0 - 100
//
// This member is required.
PercentEnabled int32
noSmithyDocumentSerde
}
// The log configuration for the channel.
type LogConfigurationForChannel struct {
// The log types.
LogTypes []LogType
noSmithyDocumentSerde
}
// The configuration for manifest processing rules. Manifest processing rules
// enable customization of the personalized manifests created by MediaTailor.
type ManifestProcessingRules struct {
// For HLS, when set to true , MediaTailor passes through EXT-X-CUE-IN ,
// EXT-X-CUE-OUT , and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin
// manifest to the MediaTailor personalized manifest. No logic is applied to these
// ad markers. For example, if EXT-X-CUE-OUT has a value of 60 , but no ads are
// filled for that ad break, MediaTailor will not set the value to 0 .
AdMarkerPassthrough *AdMarkerPassthrough
noSmithyDocumentSerde
}
// A playback configuration. For information about MediaTailor configurations, see
// Working with configurations in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html)
// .
type PlaybackConfiguration struct {
// The URL for the ad decision server (ADS). This includes the specification of
// static parameters and placeholders for dynamic parameters. AWS Elemental
// MediaTailor substitutes player-specific and session-specific parameters as
// needed when calling the ADS. Alternately, for testing you can provide a static
// VAST URL. The maximum length is 25,000 characters.
AdDecisionServerUrl *string
// The configuration for avail suppression, also known as ad suppression. For more
// information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html)
// .
AvailSuppression *AvailSuppression
// The configuration for bumpers. Bumpers are short audio or video clips that play
// at the start or before the end of an ad break. To learn more about bumpers, see
// Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) .
Bumper *Bumper
// The configuration for using a content delivery network (CDN), like Amazon
// CloudFront, for content and ad segment management.
CdnConfiguration *CdnConfiguration
// The player parameters and aliases used as dynamic variables during session
// initialization. For more information, see Domain Variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html)
// .
ConfigurationAliases map[string]map[string]string
// The configuration for a DASH source.
DashConfiguration *DashConfiguration
// The configuration for HLS content.
HlsConfiguration *HlsConfiguration
// The configuration for pre-roll ad insertion.
LivePreRollConfiguration *LivePreRollConfiguration
// The Amazon CloudWatch log settings for a playback configuration.
LogConfiguration *LogConfiguration
// The configuration for manifest processing rules. Manifest processing rules
// enable customization of the personalized manifests created by MediaTailor.
ManifestProcessingRules *ManifestProcessingRules
// The identifier for the playback configuration.
Name *string
// Defines the maximum duration of underfilled ad time (in seconds) allowed in an
// ad break. If the duration of underfilled ad time exceeds the personalization
// threshold, then the personalization of the ad break is abandoned and the
// underlying content is shown. This feature applies to ad replacement in live and
// VOD streams, rather than ad insertion, because it relies on an underlying
// content stream. For more information about ad break behavior, including ad
// replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html)
// .
PersonalizationThresholdSeconds *int32
// The Amazon Resource Name (ARN) for the playback configuration.
PlaybackConfigurationArn *string
// The URL that the player accesses to get a manifest from AWS Elemental
// MediaTailor.
PlaybackEndpointPrefix *string
// The URL that the player uses to initialize a session that uses client-side
// reporting.
SessionInitializationEndpointPrefix *string
// The URL for a video asset to transcode and use to fill in time that's not used
// by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media
// content. Configuring the slate is optional for non-VPAID playback
// configurations. For VPAID, the slate is required because MediaTailor provides it
// in the slots designated for dynamic ad content. The slate must be a high-quality
// asset that contains both audio and video.
SlateAdUrl *string
// The tags to assign to the playback configuration. Tags are key-value pairs that
// you can associate with Amazon resources to help with organization, access
// control, and cost tracking. For more information, see Tagging AWS Elemental
// MediaTailor Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html)
// .
Tags map[string]string
// The name that is used to associate this playback configuration with a custom
// transcode profile. This overrides the dynamic transcoding defaults of
// MediaTailor. Use this only if you have already set up custom profiles with the
// help of AWS Support.
TranscodeProfileName *string
// The URL prefix for the parent manifest for the stream, minus the asset ID. The
// maximum length is 512 characters.
VideoContentSourceUrl *string
noSmithyDocumentSerde
}
// A complex type that contains settings that determine how and when that
// MediaTailor places prefetched ads into upcoming ad breaks.
type PrefetchConsumption struct {
// 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 call DeletePrefetchSchedule .
//
// This member is required.
EndTime *time.Time
// 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.
AvailMatchingCriteria []AvailMatchingCriteria
// The time when prefetched ads are considered for use in an ad break. If you
// don't specify StartTime , the prefetched ads are available after MediaTailor
// retrives them from the ad decision server.
StartTime *time.Time
noSmithyDocumentSerde
}
// A complex type that contains settings governing when MediaTailor prefetches
// ads, and which dynamic variables that MediaTailor includes in the request to the
// ad decision server.
type PrefetchRetrieval struct {
// The time when prefetch retrieval ends for the ad break. Prefetching will be
// attempted for manifest requests that occur at or before this time.
//
// This member is required.
EndTime *time.Time
// The dynamic variables to use for substitution during prefetch requests to the
// ad decision server (ADS). You initially configure dynamic variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html)
// 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.
DynamicVariables map[string]string
// 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.
StartTime *time.Time
noSmithyDocumentSerde
}
// 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 (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html)
// in the MediaTailor User Guide.
type PrefetchSchedule struct {
// The Amazon Resource Name (ARN) of the prefetch schedule.
//
// This member is required.
Arn *string
// Consumption settings determine how, and when, MediaTailor places the prefetched
// ads into ad breaks. Ad consumption occurs within a span of time that you define,
// called a consumption window. You can designate which ad breaks that MediaTailor
// fills with prefetch ads by setting avail matching criteria.
//
// This member is required.
Consumption *PrefetchConsumption
// The name of the prefetch schedule. The name must be unique among all prefetch
// schedules that are associated with the specified playback configuration.
//
// This member is required.
Name *string
// The name of the playback configuration to create the prefetch schedule for.
//
// This member is required.
PlaybackConfigurationName *string
// A complex type that contains settings for prefetch retrieval from the ad
// decision server (ADS).
//
// This member is required.
Retrieval *PrefetchRetrieval
// An optional stream identifier that you can specify in order to prefetch for
// multiple streams that use the same playback configuration.
StreamId *string
noSmithyDocumentSerde
}
// The output configuration for this channel.
type RequestOutputItem struct {
// The name of the manifest for the channel. The name appears in the PlaybackUrl .
//
// This member is required.
ManifestName *string
// A string used to match which HttpPackageConfiguration is used for each VodSource
// .
//
// This member is required.
SourceGroup *string
// DASH manifest configuration parameters.
DashPlaylistSettings *DashPlaylistSettings
// HLS playlist configuration parameters.
HlsPlaylistSettings *HlsPlaylistSettings
noSmithyDocumentSerde
}
// The output item response.
type ResponseOutputItem struct {
// The name of the manifest for the channel that will appear in the channel
// output's playback URL.
//
// This member is required.
ManifestName *string
// The URL used for playback by content players.
//
// This member is required.
PlaybackUrl *string
// A string used to associate a package configuration source group with a channel
// output.
//
// This member is required.
SourceGroup *string
// DASH manifest configuration settings.
DashPlaylistSettings *DashPlaylistSettings
// HLS manifest configuration settings.
HlsPlaylistSettings *HlsPlaylistSettings
noSmithyDocumentSerde
}
// The schedule's ad break properties.
type ScheduleAdBreak struct {
// The approximate duration of the ad break, in seconds.
ApproximateDurationSeconds *int64
// The approximate time that the ad will start playing.
ApproximateStartTime *time.Time
// The name of the source location containing the VOD source used for the ad break.
SourceLocationName *string
// The name of the VOD source used for the ad break.
VodSourceName *string
noSmithyDocumentSerde
}
// Schedule configuration parameters. A channel must be stopped before changes can
// be made to the schedule.
type ScheduleConfiguration struct {
// Program transition configurations.
//
// This member is required.
Transition *Transition
// Program clip range configuration.
ClipRange *ClipRange
noSmithyDocumentSerde
}
// The properties for a schedule.
type ScheduleEntry struct {
// The ARN of the program.
//
// This member is required.
Arn *string
// The name of the channel that uses this schedule.
//
// This member is required.
ChannelName *string
// The name of the program.
//
// This member is required.
ProgramName *string
// The name of the source location.
//
// This member is required.
SourceLocationName *string
// The approximate duration of this program, in seconds.
ApproximateDurationSeconds *int64
// The approximate time that the program will start playing.
ApproximateStartTime *time.Time
// The name of the live source used for the program.
LiveSourceName *string
// The schedule's ad break properties.
ScheduleAdBreaks []ScheduleAdBreak
// The type of schedule entry.
ScheduleEntryType ScheduleEntryType
// The name of the VOD source.
VodSourceName *string
noSmithyDocumentSerde
}
// AWS Secrets Manager access token configuration parameters. For information
// about Secrets Manager access token authentication, see Working with AWS Secrets
// Manager access token authentication (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html)
// .
type SecretsManagerAccessTokenConfiguration struct {
// The name of the HTTP header used to supply the access token in requests to the
// source location.
HeaderName *string
// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains
// the access token.
SecretArn *string
// The AWS Secrets Manager SecretString (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html)
// key associated with the access token. MediaTailor uses the key to look up
// SecretString key and value pair containing the access token.
SecretStringKey *string
noSmithyDocumentSerde
}
// The segmentation_descriptor message can contain advanced metadata fields, like
// content identifiers, to convey a wide range of information about the ad break.
// MediaTailor writes the ad metadata in the egress manifest as part of the
// EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data. segmentation_descriptor
// messages must be sent with the time_signal message type. See the
// segmentation_descriptor() table of the 2022 SCTE-35 specification for more
// information.
type SegmentationDescriptor struct {
// The segment number to assign to the segmentation_descriptor.segment_num
// message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values
// must be between 0 and 256, inclusive. The default value is 0.
SegmentNum *int32
// The Event Identifier to assign to the
// segmentation_descriptor.segmentation_event_id message, as defined in section
// 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationEventId *int32
// The Type Identifier to assign to the
// segmentation_descriptor.segmentation_type_id message, as defined in section
// 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
// inclusive. The default value is 48.
SegmentationTypeId *int32
// The Upid to assign to the segmentation_descriptor.segmentation_upid message, as
// defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be
// a hexadecimal string containing only the characters 0 though 9 and A through F.
// The default value is "" (an empty string).
SegmentationUpid *string
// The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type
// message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification.
// Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpidType *int32
// The number of segments expected, which is assigned to the
// segmentation_descriptor.segments_expectedS message, as defined in section
// 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256,
// inclusive. The default value is 0.
SegmentsExpected *int32
// The sub-segment number to assign to the segmentation_descriptor.sub_segment_num
// message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification.
// Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentNum *int32
// The number of sub-segments expected, which is assigned to the
// segmentation_descriptor.sub_segments_expected message, as defined in section
// 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
// inclusive. The default value is null.
SubSegmentsExpected *int32
noSmithyDocumentSerde
}
// The segment delivery configuration settings.
type SegmentDeliveryConfiguration struct {
// The base URL of the host or path of the segment delivery server that you're
// using to serve segments. This is typically a content delivery network (CDN). The
// URL can be absolute or relative. To use an absolute URL include the protocol,
// such as https://example.com/some/path . To use a relative URL specify the
// relative path, such as /some/path* .
BaseUrl *string
// A unique identifier used to distinguish between multiple segment delivery
// configurations in a source location.
Name *string
noSmithyDocumentSerde
}
// Slate VOD source configuration.
type SlateSource struct {
// The name of the source location where the slate VOD source is stored.
SourceLocationName *string
// The slate VOD source name. The VOD source must already exist in a source
// location before it can be used for slate.
VodSourceName *string
noSmithyDocumentSerde
}
// A source location is a container for sources. For more information about source
// locations, see Working with source locations (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html)
// in the MediaTailor User Guide.
type SourceLocation struct {
// The ARN of the SourceLocation.
//
// This member is required.
Arn *string
// The HTTP configuration for the source location.
//
// This member is required.
HttpConfiguration *HttpConfiguration
// The name of the source location.
//
// This member is required.
SourceLocationName *string
// The access configuration for the source location.
AccessConfiguration *AccessConfiguration
// The timestamp that indicates when the source location was created.
CreationTime *time.Time
// The default segment delivery configuration.
DefaultSegmentDeliveryConfiguration *DefaultSegmentDeliveryConfiguration
// The timestamp that indicates when the source location was last modified.
LastModifiedTime *time.Time
// The segment delivery configurations for the source location.
SegmentDeliveryConfigurations []SegmentDeliveryConfiguration
// The tags assigned to the source location. Tags are key-value pairs that you can
// associate with Amazon resources to help with organization, access control, and
// cost tracking. For more information, see Tagging AWS Elemental MediaTailor
// Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) .
Tags map[string]string
noSmithyDocumentSerde
}
// Splice insert message configuration.
type SpliceInsertMessage struct {
// This is written to splice_insert.avail_num , as defined in section 9.7.3.1 of
// the SCTE-35 specification. The default value is 0 . Values must be between 0
// and 256 , inclusive.
AvailNum *int32
// This is written to splice_insert.avails_expected , as defined in section 9.7.3.1
// of the SCTE-35 specification. The default value is 0 . Values must be between 0
// and 256 , inclusive.
AvailsExpected *int32
// This is written to splice_insert.splice_event_id , as defined in section 9.7.3.1
// of the SCTE-35 specification. The default value is 1 .
SpliceEventId *int32
// This is written to splice_insert.unique_program_id , as defined in section
// 9.7.3.1 of the SCTE-35 specification. The default value is 0 . Values must be
// between 0 and 256 , inclusive.
UniqueProgramId *int32
noSmithyDocumentSerde
}
// The configuration for time-shifted viewing.
type TimeShiftConfiguration struct {
// The maximum time delay for time-shifted viewing. The minimum allowed maximum
// time delay is 0 seconds, and the maximum allowed maximum time delay is 21600
// seconds (6 hours).
//
// This member is required.
MaxTimeDelaySeconds *int32
noSmithyDocumentSerde
}
// The SCTE-35 time_signal message can be sent with one or more
// segmentation_descriptor messages. A time_signal message can be sent only if a
// single segmentation_descriptor message is sent. The time_signal message
// contains only the splice_time field which is constructed using a given
// presentation timestamp. When sending a time_signal message, the
// splice_command_type field in the splice_info_section message is set to 6
// (0x06). See the time_signal() table of the 2022 SCTE-35 specification for more
// information.
type TimeSignalMessage struct {
// The configurations for the SCTE-35 segmentation_descriptor message(s) sent with
// the time_signal message.
SegmentationDescriptors []SegmentationDescriptor
noSmithyDocumentSerde
}
// Program transition configuration.
type Transition struct {
// The position where this program will be inserted relative to the
// RelativePosition .
//
// This member is required.
RelativePosition RelativePosition
// Defines when the program plays in the schedule. You can set the value to
// ABSOLUTE or RELATIVE . ABSOLUTE - The program plays at a specific wall clock
// time. This setting can only be used for channels using the LINEAR PlaybackMode .
// Note the following considerations when using ABSOLUTE transitions: If the
// preceding program in the schedule has a duration that extends past the wall
// clock time, MediaTailor truncates the preceding program on a common segment
// boundary. If there are gaps in playback, MediaTailor plays the FillerSlate you
// configured for your linear channel. RELATIVE - The program is inserted into the
// schedule either before or after a program that you specify via RelativePosition .
//
// This member is required.
Type *string
// The duration of the live program in seconds.
DurationMillis *int64
// The name of the program that this program will be inserted next to, as defined
// by RelativePosition .
RelativeProgram *string
// The date and time that the program is scheduled to start, in epoch milliseconds.
ScheduledStartTimeMillis *int64
noSmithyDocumentSerde
}
// Schedule configuration parameters.
type UpdateProgramScheduleConfiguration struct {
// Program clip range configuration.
ClipRange *ClipRange
// Program transition configuration.
Transition *UpdateProgramTransition
noSmithyDocumentSerde
}
// Program transition configuration.
type UpdateProgramTransition struct {
// The duration of the live program in seconds.
DurationMillis *int64
// The date and time that the program is scheduled to start, in epoch milliseconds.
ScheduledStartTimeMillis *int64
noSmithyDocumentSerde
}
// VOD source configuration parameters.
type VodSource struct {
// The ARN for the VOD source.
//
// This member is required.
Arn *string
// The HTTP package configurations for the VOD source.
//
// This member is required.
HttpPackageConfigurations []HttpPackageConfiguration
// The name of the source location that the VOD source is associated with.
//
// This member is required.
SourceLocationName *string
// The name of the VOD source.
//
// This member is required.
VodSourceName *string
// The timestamp that indicates when the VOD source was created.
CreationTime *time.Time
// The timestamp that indicates when the VOD source was last modified.
LastModifiedTime *time.Time
// The tags assigned to the VOD source. Tags are key-value pairs that you can
// associate with Amazon resources to help with organization, access control, and
// cost tracking. For more information, see Tagging AWS Elemental MediaTailor
// Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) .
Tags map[string]string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|