321 lines
16 KiB
JSON
321 lines
16 KiB
JSON
{
|
||
"metadata" : {
|
||
"apiVersion" : "2018-04-23",
|
||
"endpointPrefix" : "api.mediatailor",
|
||
"signingName" : "mediatailor",
|
||
"serviceFullName" : "AWS MediaTailor",
|
||
"serviceId" : "MediaTailor",
|
||
"protocol" : "rest-json",
|
||
"jsonVersion" : "1.1",
|
||
"uid" : "mediatailor-2018-04-23",
|
||
"signatureVersion" : "v4",
|
||
"serviceAbbreviation": "MediaTailor"
|
||
},
|
||
"operations" : {
|
||
"DeletePlaybackConfiguration" : {
|
||
"name" : "DeletePlaybackConfiguration",
|
||
"http" : {
|
||
"method" : "DELETE",
|
||
"requestUri" : "/playbackConfiguration/{Name}",
|
||
"responseCode" : 204
|
||
},
|
||
"input" : {
|
||
"shape" : "DeletePlaybackConfigurationRequest"
|
||
},
|
||
"output" : {
|
||
"shape" : "DeletePlaybackConfigurationResponse"
|
||
},
|
||
"errors" : [ ],
|
||
"documentation" : "<p>Deletes the configuration for the specified name. </p>"
|
||
},
|
||
"GetPlaybackConfiguration" : {
|
||
"name" : "GetPlaybackConfiguration",
|
||
"http" : {
|
||
"method" : "GET",
|
||
"requestUri" : "/playbackConfiguration/{Name}",
|
||
"responseCode" : 200
|
||
},
|
||
"input" : {
|
||
"shape" : "GetPlaybackConfigurationRequest"
|
||
},
|
||
"output" : {
|
||
"shape" : "GetPlaybackConfigurationResponse"
|
||
},
|
||
"errors" : [ ],
|
||
"documentation" : "<p>Returns the configuration for the specified name. </p>"
|
||
},
|
||
"ListPlaybackConfigurations" : {
|
||
"name" : "ListPlaybackConfigurations",
|
||
"http" : {
|
||
"method" : "GET",
|
||
"requestUri" : "/playbackConfigurations",
|
||
"responseCode" : 200
|
||
},
|
||
"input" : {
|
||
"shape" : "ListPlaybackConfigurationsRequest"
|
||
},
|
||
"output" : {
|
||
"shape" : "ListPlaybackConfigurationsResponse"
|
||
},
|
||
"errors" : [ ],
|
||
"documentation" : "<p>Returns a list of the configurations defined in AWS Elemental MediaTailor. You can specify a max number of configurations to return at a time. The default max is 50. Results are returned in pagefuls. If AWS Elemental MediaTailor has more configurations than the specified max, it provides parameters in the response that you can use to retrieve the next pageful. </p>"
|
||
},
|
||
"PutPlaybackConfiguration" : {
|
||
"name" : "PutPlaybackConfiguration",
|
||
"http" : {
|
||
"method" : "PUT",
|
||
"requestUri" : "/playbackConfiguration",
|
||
"responseCode" : 200
|
||
},
|
||
"input" : {
|
||
"shape" : "PutPlaybackConfigurationRequest"
|
||
},
|
||
"output" : {
|
||
"shape" : "PutPlaybackConfigurationResponse"
|
||
},
|
||
"errors" : [ ],
|
||
"documentation" : "<p>Adds a new configuration to AWS Elemental MediaTailor.</p>"
|
||
}
|
||
},
|
||
"shapes" : {
|
||
"CdnConfiguration" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"AdSegmentUrlPrefix" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>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 following 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.</p>"
|
||
},
|
||
"ContentSegmentUrlPrefix" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>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.</p>"
|
||
}
|
||
},
|
||
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
|
||
},
|
||
"HlsConfiguration": {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"ManifestEndpointPrefix" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.</p>"
|
||
}
|
||
},
|
||
"documentation" : "<p>The configuration for HLS content. </p>"
|
||
},
|
||
"DeletePlaybackConfigurationRequest" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"Name" : {
|
||
"shape" : "__string",
|
||
"location" : "uri",
|
||
"locationName" : "Name",
|
||
"documentation" : "<p>The identifier for the configuration.</p>"
|
||
}
|
||
},
|
||
"required" : [ "Name" ]
|
||
},
|
||
"DeletePlaybackConfigurationResponse" : {
|
||
"type" : "structure",
|
||
"members" : { }
|
||
},
|
||
"Empty" : {
|
||
"type" : "structure",
|
||
"members" : { }
|
||
},
|
||
"GetPlaybackConfigurationRequest" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"Name" : {
|
||
"shape" : "__string",
|
||
"location" : "uri",
|
||
"locationName" : "Name",
|
||
"documentation" : "<p>The identifier for the configuration.</p>"
|
||
}
|
||
},
|
||
"required" : [ "Name" ]
|
||
},
|
||
"GetPlaybackConfigurationResponse" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"AdDecisionServerUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>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 25000 characters.</p>"
|
||
},
|
||
"CdnConfiguration" : {
|
||
"shape" : "CdnConfiguration",
|
||
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
|
||
},
|
||
"HlsConfiguration" : {
|
||
"shape" : "HlsConfiguration",
|
||
"documentation" : "<p>The configuration for HLS content. </p>"
|
||
},
|
||
"Name" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The identifier for the configuration.</p>"
|
||
},
|
||
"PlaybackEndpointPrefix" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. </p>"
|
||
},
|
||
"SessionInitializationEndpointPrefix" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL that the player uses to initialize a session that uses client-side reporting. </p>"
|
||
},
|
||
"SlateAdUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>URL for a high-quality 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 configurations. For VPAID, the slate is required because AWS Elemental 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. </p>"
|
||
},
|
||
"VideoContentSourceUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
|
||
}
|
||
}
|
||
},
|
||
"PlaybackConfiguration" : {
|
||
"type" : "structure",
|
||
"documentation": "<p>The AWSMediaTailor configuration.</p>",
|
||
"members" : {
|
||
"AdDecisionServerUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>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 25000 characters.</p>"
|
||
},
|
||
"CdnConfiguration" : {
|
||
"shape" : "CdnConfiguration",
|
||
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
|
||
},
|
||
"Name" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The identifier for the configuration.</p>"
|
||
},
|
||
"SlateAdUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>URL for a high-quality 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 configurations. For VPAID, the slate is required because AWS Elemental 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. </p>"
|
||
},
|
||
"VideoContentSourceUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListPlaybackConfigurationsRequest" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"MaxResults" : {
|
||
"shape" : "__integerMin1Max100",
|
||
"location" : "querystring",
|
||
"locationName" : "MaxResults",
|
||
"documentation" : "<p>Maximum number of records to return. </p>"
|
||
},
|
||
"NextToken" : {
|
||
"shape" : "__string",
|
||
"location" : "querystring",
|
||
"locationName" : "NextToken",
|
||
"documentation" : "<p>Pagination token returned by the GET list request when results overrun the meximum allowed. Use the token to fetch the next page of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListPlaybackConfigurationsResponse" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"Items" : {
|
||
"shape" : "__listOfPlaybackConfigurations",
|
||
"documentation" : "<p>Array of playback configurations. This may be all of the available configurations or a subset, depending on the settings you provide and on the total number of configurations stored. </p>"
|
||
},
|
||
"NextToken" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>Pagination token returned by the GET list request when results overrun the meximum allowed. Use the token to fetch the next page of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"PutPlaybackConfigurationRequest" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"AdDecisionServerUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>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 25000 characters.</p>"
|
||
},
|
||
"CdnConfiguration" : {
|
||
"shape" : "CdnConfiguration",
|
||
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
|
||
},
|
||
"Name" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The identifier for the configuration.</p>"
|
||
},
|
||
"SlateAdUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL for a high-quality 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 configurations. For VPAID, the slate is required because AWS Elemental MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>"
|
||
},
|
||
"VideoContentSourceUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
|
||
}
|
||
}
|
||
},
|
||
"PutPlaybackConfigurationResponse" : {
|
||
"type" : "structure",
|
||
"members" : {
|
||
"AdDecisionServerUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>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 25000 characters.</p>"
|
||
},
|
||
"CdnConfiguration" : {
|
||
"shape" : "CdnConfiguration",
|
||
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
|
||
},
|
||
"HlsConfiguration" : {
|
||
"shape" : "HlsConfiguration",
|
||
"documentation" : "<p>The configuration for HLS content. </p>"
|
||
},
|
||
"Name" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The identifier for the configuration.</p>"
|
||
},
|
||
"PlaybackEndpointPrefix" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. </p>"
|
||
},
|
||
"SessionInitializationEndpointPrefix" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL that the player uses to initialize a session that uses client-side reporting. </p>"
|
||
},
|
||
"SlateAdUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>URL for a high-quality 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 configurations. For VPAID, the slate is required because AWS Elemental 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. </p>"
|
||
},
|
||
"VideoContentSourceUrl" : {
|
||
"shape" : "__string",
|
||
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
|
||
}
|
||
}
|
||
},
|
||
"__boolean" : {
|
||
"type" : "boolean"
|
||
},
|
||
"__double" : {
|
||
"type" : "double"
|
||
},
|
||
"__integer" : {
|
||
"type" : "integer"
|
||
},
|
||
"__listOfPlaybackConfigurations" : {
|
||
"type" : "list",
|
||
"member": {
|
||
"shape" : "PlaybackConfiguration"
|
||
}
|
||
},
|
||
"__long" : {
|
||
"type" : "long"
|
||
},
|
||
"__string" : {
|
||
"type" : "string"
|
||
},
|
||
"__integerMin1Max100" : {
|
||
"type": "integer",
|
||
"min": 1,
|
||
"max": 100
|
||
}
|
||
},
|
||
"documentation" : "<p>Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.<p>Through the SDK, you manage AWS Elemental MediaTailor configurations the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>"
|
||
}
|