github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/mediapackage-vod/2018-11-07/docs-2.json (about) 1 { 2 "version" : "2.0", 3 "service" : "AWS Elemental MediaPackage VOD", 4 "operations" : { 5 "ConfigureLogs" : "Changes the packaging group's properities to configure log subscription", 6 "CreateAsset" : "Creates a new MediaPackage VOD Asset resource.", 7 "CreatePackagingConfiguration" : "Creates a new MediaPackage VOD PackagingConfiguration resource.", 8 "CreatePackagingGroup" : "Creates a new MediaPackage VOD PackagingGroup resource.", 9 "DeleteAsset" : "Deletes an existing MediaPackage VOD Asset resource.", 10 "DeletePackagingConfiguration" : "Deletes a MediaPackage VOD PackagingConfiguration resource.", 11 "DeletePackagingGroup" : "Deletes a MediaPackage VOD PackagingGroup resource.", 12 "DescribeAsset" : "Returns a description of a MediaPackage VOD Asset resource.", 13 "DescribePackagingConfiguration" : "Returns a description of a MediaPackage VOD PackagingConfiguration resource.", 14 "DescribePackagingGroup" : "Returns a description of a MediaPackage VOD PackagingGroup resource.", 15 "ListAssets" : "Returns a collection of MediaPackage VOD Asset resources.", 16 "ListPackagingConfigurations" : "Returns a collection of MediaPackage VOD PackagingConfiguration resources.", 17 "ListPackagingGroups" : "Returns a collection of MediaPackage VOD PackagingGroup resources.", 18 "ListTagsForResource" : "Returns a list of the tags assigned to the specified resource.", 19 "TagResource" : "Adds tags to the specified resource. You can specify one or more tags to add.", 20 "UntagResource" : "Removes tags from the specified resource. You can specify one or more tags to remove.", 21 "UpdatePackagingGroup" : "Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes." 22 }, 23 "shapes" : { 24 "AdMarkers" : { 25 "base" : null, 26 "refs" : { 27 "HlsManifest$AdMarkers" : "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n" 28 } 29 }, 30 "Asset" : { 31 "base" : "A MediaPackage VOD Asset resource.", 32 "refs" : { } 33 }, 34 "AssetCreateParameters" : { 35 "base" : "Parameters used to create a MediaPackage VOD Asset.", 36 "refs" : { } 37 }, 38 "AssetList" : { 39 "base" : "A collection of MediaPackage VOD Asset resources.", 40 "refs" : { } 41 }, 42 "AssetShallow" : { 43 "base" : "A MediaPackage VOD Asset resource.", 44 "refs" : { 45 "__listOfAssetShallow$member" : null 46 } 47 }, 48 "Authorization" : { 49 "base" : "CDN Authorization credentials", 50 "refs" : { 51 "PackagingGroup$Authorization" : null, 52 "PackagingGroupCreateParameters$Authorization" : null, 53 "PackagingGroupUpdateParameters$Authorization" : null 54 } 55 }, 56 "CmafEncryption" : { 57 "base" : "A CMAF encryption configuration.", 58 "refs" : { 59 "CmafPackage$Encryption" : null 60 } 61 }, 62 "CmafPackage" : { 63 "base" : "A CMAF packaging configuration.", 64 "refs" : { 65 "PackagingConfiguration$CmafPackage" : null, 66 "PackagingConfigurationCreateParameters$CmafPackage" : null 67 } 68 }, 69 "ConfigureLogsParameters" : { 70 "base" : "The configuration parameters for egress access logging.", 71 "refs" : { } 72 }, 73 "DashEncryption" : { 74 "base" : "A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.", 75 "refs" : { 76 "DashPackage$Encryption" : null 77 } 78 }, 79 "DashManifest" : { 80 "base" : "A DASH manifest configuration.", 81 "refs" : { 82 "__listOfDashManifest$member" : null 83 } 84 }, 85 "DashPackage" : { 86 "base" : "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.", 87 "refs" : { 88 "PackagingConfiguration$DashPackage" : null, 89 "PackagingConfigurationCreateParameters$DashPackage" : null 90 } 91 }, 92 "EgressAccessLogs" : { 93 "base" : "Configure egress access logging.", 94 "refs" : { 95 "ConfigureLogsParameters$EgressAccessLogs" : null, 96 "PackagingGroup$EgressAccessLogs" : null, 97 "PackagingGroupCreateParameters$EgressAccessLogs" : null 98 } 99 }, 100 "EgressEndpoint" : { 101 "base" : "The endpoint URL used to access an Asset using one PackagingConfiguration.", 102 "refs" : { 103 "__listOfEgressEndpoint$member" : null 104 } 105 }, 106 "EncryptionMethod" : { 107 "base" : null, 108 "refs" : { 109 "HlsEncryption$EncryptionMethod" : "The encryption method to use." 110 } 111 }, 112 "HlsEncryption" : { 113 "base" : "An HTTP Live Streaming (HLS) encryption configuration.", 114 "refs" : { 115 "HlsPackage$Encryption" : null 116 } 117 }, 118 "HlsManifest" : { 119 "base" : "An HTTP Live Streaming (HLS) manifest configuration.", 120 "refs" : { 121 "__listOfHlsManifest$member" : null 122 } 123 }, 124 "HlsPackage" : { 125 "base" : "An HTTP Live Streaming (HLS) packaging configuration.", 126 "refs" : { 127 "PackagingConfiguration$HlsPackage" : null, 128 "PackagingConfigurationCreateParameters$HlsPackage" : null 129 } 130 }, 131 "ManifestLayout" : { 132 "base" : null, 133 "refs" : { 134 "DashManifest$ManifestLayout" : "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level." 135 } 136 }, 137 "MssEncryption" : { 138 "base" : "A Microsoft Smooth Streaming (MSS) encryption configuration.", 139 "refs" : { 140 "MssPackage$Encryption" : null 141 } 142 }, 143 "MssManifest" : { 144 "base" : "A Microsoft Smooth Streaming (MSS) manifest configuration.", 145 "refs" : { 146 "__listOfMssManifest$member" : null 147 } 148 }, 149 "MssPackage" : { 150 "base" : "A Microsoft Smooth Streaming (MSS) PackagingConfiguration.", 151 "refs" : { 152 "PackagingConfiguration$MssPackage" : null, 153 "PackagingConfigurationCreateParameters$MssPackage" : null 154 } 155 }, 156 "PackagingConfiguration" : { 157 "base" : "A MediaPackage VOD PackagingConfiguration resource.", 158 "refs" : { 159 "__listOfPackagingConfiguration$member" : null 160 } 161 }, 162 "PackagingConfigurationCreateParameters" : { 163 "base" : "Parameters used to create a new MediaPackage VOD PackagingConfiguration resource.", 164 "refs" : { } 165 }, 166 "PackagingConfigurationList" : { 167 "base" : "A collection of MediaPackage VOD PackagingConfiguration resources.", 168 "refs" : { } 169 }, 170 "PackagingGroup" : { 171 "base" : "A MediaPackage VOD PackagingGroup resource.", 172 "refs" : { 173 "__listOfPackagingGroup$member" : null 174 } 175 }, 176 "PackagingGroupCreateParameters" : { 177 "base" : "Parameters used to create a new MediaPackage VOD PackagingGroup resource.", 178 "refs" : { } 179 }, 180 "PackagingGroupList" : { 181 "base" : "A collection of MediaPackage VOD PackagingGroup resources.", 182 "refs" : { } 183 }, 184 "PackagingGroupUpdateParameters" : { 185 "base" : "Parameters used to update a MediaPackage packaging group.", 186 "refs" : { } 187 }, 188 "Profile" : { 189 "base" : null, 190 "refs" : { 191 "DashManifest$Profile" : "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled." 192 } 193 }, 194 "SegmentTemplateFormat" : { 195 "base" : null, 196 "refs" : { 197 "DashPackage$SegmentTemplateFormat" : "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs." 198 } 199 }, 200 "SpekeKeyProvider" : { 201 "base" : "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.", 202 "refs" : { 203 "CmafEncryption$SpekeKeyProvider" : null, 204 "DashEncryption$SpekeKeyProvider" : null, 205 "HlsEncryption$SpekeKeyProvider" : null, 206 "MssEncryption$SpekeKeyProvider" : null 207 } 208 }, 209 "StreamOrder" : { 210 "base" : null, 211 "refs" : { 212 "StreamSelection$StreamOrder" : "A directive that determines the order of streams in the output." 213 } 214 }, 215 "StreamSelection" : { 216 "base" : "A StreamSelection configuration.", 217 "refs" : { 218 "DashManifest$StreamSelection" : null, 219 "HlsManifest$StreamSelection" : null, 220 "MssManifest$StreamSelection" : null 221 } 222 }, 223 "Tags" : { 224 "base" : "A collection of tags associated with a resource", 225 "refs" : { 226 "Asset$Tags" : null, 227 "AssetCreateParameters$Tags" : null, 228 "AssetShallow$Tags" : null, 229 "PackagingConfiguration$Tags" : null, 230 "PackagingConfigurationCreateParameters$Tags" : null, 231 "PackagingGroup$Tags" : null, 232 "PackagingGroupCreateParameters$Tags" : null 233 } 234 }, 235 "TagsModel" : { 236 "base" : null, 237 "refs" : { } 238 }, 239 "__PeriodTriggersElement" : { 240 "base" : null, 241 "refs" : { 242 "__listOf__PeriodTriggersElement$member" : null 243 } 244 }, 245 "__boolean" : { 246 "base" : null, 247 "refs" : { 248 "CmafPackage$IncludeEncoderConfigurationInSegments" : "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.\n", 249 "DashPackage$IncludeEncoderConfigurationInSegments" : "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.\n", 250 "HlsManifest$IncludeIframeOnlyStream" : "When enabled, an I-Frame only stream will be included in the output.", 251 "HlsManifest$RepeatExtXKey" : "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", 252 "HlsPackage$UseAudioRenditionGroup" : "When enabled, audio streams will be placed in rendition groups in the output." 253 } 254 }, 255 "__integer" : { 256 "base" : null, 257 "refs" : { 258 "CmafPackage$SegmentDurationSeconds" : "Duration (in seconds) of each fragment. Actual fragments will be\nrounded to the nearest multiple of the source fragment duration.\n", 259 "DashManifest$MinBufferTimeSeconds" : "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", 260 "DashPackage$SegmentDurationSeconds" : "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.\n", 261 "HlsManifest$ProgramDateTimeIntervalSeconds" : "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.\n", 262 "HlsPackage$SegmentDurationSeconds" : "Duration (in seconds) of each fragment. Actual fragments will be\nrounded to the nearest multiple of the source fragment duration.\n", 263 "MssPackage$SegmentDurationSeconds" : "The duration (in seconds) of each segment.", 264 "StreamSelection$MaxVideoBitsPerSecond" : "The maximum video bitrate (bps) to include in output.", 265 "StreamSelection$MinVideoBitsPerSecond" : "The minimum video bitrate (bps) to include in output." 266 } 267 }, 268 "__listOfAssetShallow" : { 269 "base" : null, 270 "refs" : { 271 "AssetList$Assets" : "A list of MediaPackage VOD Asset resources." 272 } 273 }, 274 "__listOfDashManifest" : { 275 "base" : null, 276 "refs" : { 277 "DashPackage$DashManifests" : "A list of DASH manifest configurations." 278 } 279 }, 280 "__listOfEgressEndpoint" : { 281 "base" : null, 282 "refs" : { 283 "Asset$EgressEndpoints" : "The list of egress endpoints available for the Asset." 284 } 285 }, 286 "__listOfHlsManifest" : { 287 "base" : null, 288 "refs" : { 289 "CmafPackage$HlsManifests" : "A list of HLS manifest configurations.", 290 "HlsPackage$HlsManifests" : "A list of HLS manifest configurations." 291 } 292 }, 293 "__listOfMssManifest" : { 294 "base" : null, 295 "refs" : { 296 "MssPackage$MssManifests" : "A list of MSS manifest configurations." 297 } 298 }, 299 "__listOfPackagingConfiguration" : { 300 "base" : null, 301 "refs" : { 302 "PackagingConfigurationList$PackagingConfigurations" : "A list of MediaPackage VOD PackagingConfiguration resources." 303 } 304 }, 305 "__listOfPackagingGroup" : { 306 "base" : null, 307 "refs" : { 308 "PackagingGroupList$PackagingGroups" : "A list of MediaPackage VOD PackagingGroup resources." 309 } 310 }, 311 "__listOf__PeriodTriggersElement" : { 312 "base" : null, 313 "refs" : { 314 "DashPackage$PeriodTriggers" : "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)\nMedia Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not\nbe partitioned into more than one period. If the list contains \"ADS\", new periods will be created where\nthe Asset contains SCTE-35 ad markers.\n" 315 } 316 }, 317 "__listOf__string" : { 318 "base" : null, 319 "refs" : { 320 "SpekeKeyProvider$SystemIds" : "The system IDs to include in key requests." 321 } 322 }, 323 "__mapOf__string" : { 324 "base" : null, 325 "refs" : { 326 "TagsModel$Tags" : "A collection of tags associated with a resource" 327 } 328 }, 329 "__string" : { 330 "base" : null, 331 "refs" : { 332 "Asset$Arn" : "The ARN of the Asset.", 333 "Asset$CreatedAt" : "The time the Asset was initially submitted for Ingest.", 334 "Asset$Id" : "The unique identifier for the Asset.", 335 "Asset$PackagingGroupId" : "The ID of the PackagingGroup for the Asset.", 336 "Asset$ResourceId" : "The resource ID to include in SPEKE key requests.", 337 "Asset$SourceArn" : "ARN of the source object in S3.", 338 "Asset$SourceRoleArn" : "The IAM role_arn used to access the source S3 bucket.", 339 "AssetCreateParameters$Id" : "The unique identifier for the Asset.", 340 "AssetCreateParameters$PackagingGroupId" : "The ID of the PackagingGroup for the Asset.", 341 "AssetCreateParameters$ResourceId" : "The resource ID to include in SPEKE key requests.", 342 "AssetCreateParameters$SourceArn" : "ARN of the source object in S3.", 343 "AssetCreateParameters$SourceRoleArn" : "The IAM role ARN used to access the source S3 bucket.", 344 "AssetList$NextToken" : "A token that can be used to resume pagination from the end of the collection.", 345 "AssetShallow$Arn" : "The ARN of the Asset.", 346 "AssetShallow$CreatedAt" : "The time the Asset was initially submitted for Ingest.", 347 "AssetShallow$Id" : "The unique identifier for the Asset.", 348 "AssetShallow$PackagingGroupId" : "The ID of the PackagingGroup for the Asset.", 349 "AssetShallow$ResourceId" : "The resource ID to include in SPEKE key requests.", 350 "AssetShallow$SourceArn" : "ARN of the source object in S3.", 351 "AssetShallow$SourceRoleArn" : "The IAM role ARN used to access the source S3 bucket.", 352 "Authorization$CdnIdentifierSecret" : "The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.", 353 "Authorization$SecretsRoleArn" : "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.", 354 "CmafEncryption$ConstantInitializationVector" : "An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).", 355 "DashManifest$ManifestName" : "An optional string to include in the name of the manifest.", 356 "EgressAccessLogs$LogGroupName" : "Customize the log group name.", 357 "EgressEndpoint$PackagingConfigurationId" : "The ID of the PackagingConfiguration being applied to the Asset.", 358 "EgressEndpoint$Status" : "The current processing status of the asset used for the packaging configuration. The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. Status information won't be available for most assets ingested before 2021-09-30.", 359 "EgressEndpoint$Url" : "The URL of the parent manifest for the repackaged Asset.", 360 "HlsEncryption$ConstantInitializationVector" : "A constant initialization vector for encryption (optional).\nWhen not specified the initialization vector will be periodically rotated.\n", 361 "HlsManifest$ManifestName" : "An optional string to include in the name of the manifest.", 362 "MssManifest$ManifestName" : "An optional string to include in the name of the manifest.", 363 "PackagingConfiguration$Arn" : "The ARN of the PackagingConfiguration.", 364 "PackagingConfiguration$Id" : "The ID of the PackagingConfiguration.", 365 "PackagingConfiguration$PackagingGroupId" : "The ID of a PackagingGroup.", 366 "PackagingConfigurationCreateParameters$Id" : "The ID of the PackagingConfiguration.", 367 "PackagingConfigurationCreateParameters$PackagingGroupId" : "The ID of a PackagingGroup.", 368 "PackagingConfigurationList$NextToken" : "A token that can be used to resume pagination from the end of the collection.", 369 "PackagingGroup$Arn" : "The ARN of the PackagingGroup.", 370 "PackagingGroup$DomainName" : "The fully qualified domain name for Assets in the PackagingGroup.", 371 "PackagingGroup$Id" : "The ID of the PackagingGroup.", 372 "PackagingGroupCreateParameters$Id" : "The ID of the PackagingGroup.", 373 "PackagingGroupList$NextToken" : "A token that can be used to resume pagination from the end of the collection.", 374 "SpekeKeyProvider$RoleArn" : "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental\nMediaPackage will assume when accessing the key provider service.\n", 375 "SpekeKeyProvider$Url" : "The URL of the external key provider service.", 376 "Tags$member" : null, 377 "__listOf__string$member" : null, 378 "__mapOf__string$member" : null 379 } 380 } 381 } 382 }