Mediapackage
This page documents function available when using the Mediapackage module, created with @service Mediapackage.
Index
Main.Mediapackage.configure_logsMain.Mediapackage.create_channelMain.Mediapackage.create_harvest_jobMain.Mediapackage.create_origin_endpointMain.Mediapackage.delete_channelMain.Mediapackage.delete_origin_endpointMain.Mediapackage.describe_channelMain.Mediapackage.describe_harvest_jobMain.Mediapackage.describe_origin_endpointMain.Mediapackage.list_channelsMain.Mediapackage.list_harvest_jobsMain.Mediapackage.list_origin_endpointsMain.Mediapackage.list_tags_for_resourceMain.Mediapackage.rotate_channel_credentialsMain.Mediapackage.rotate_ingest_endpoint_credentialsMain.Mediapackage.tag_resourceMain.Mediapackage.untag_resourceMain.Mediapackage.update_channelMain.Mediapackage.update_origin_endpoint
Documentation
Main.Mediapackage.configure_logs — Method
configure_logs(id)
configure_logs(id, params::Dict{String,<:Any})Changes the Channel's properities to configure log subscription
Arguments
id: The ID of the channel to log subscription.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"egressAccessLogs":"ingressAccessLogs":
Main.Mediapackage.create_channel — Method
create_channel(id)
create_channel(id, params::Dict{String,<:Any})Creates a new Channel.
Arguments
id: The ID of the Channel. The ID must be unique within the region and it
cannot be changed after a Channel is created.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": A short text description of the Channel."tags":
Main.Mediapackage.create_harvest_job — Method
create_harvest_job(end_time, id, origin_endpoint_id, s3_destination, start_time)
create_harvest_job(end_time, id, origin_endpoint_id, s3_destination, start_time, params::Dict{String,<:Any})Creates a new HarvestJob record.
Arguments
end_time: The end of the time-window which will be harvestedid: The ID of the HarvestJob. The ID must be unique within the region
and it cannot be changed after the HarvestJob is submitted
origin_endpoint_id: The ID of the OriginEndpoint that the HarvestJob will harvest from.
This cannot be changed after the HarvestJob is submitted.
s3_destination:start_time: The start of the time-window which will be harvested
Main.Mediapackage.create_origin_endpoint — Method
create_origin_endpoint(channel_id, id)
create_origin_endpoint(channel_id, id, params::Dict{String,<:Any})Creates a new OriginEndpoint record.
Arguments
channel_id: The ID of the Channel that the OriginEndpoint will be associated with.
This cannot be changed after the OriginEndpoint is created.
id: The ID of the OriginEndpoint. The ID must be unique within the region
and it cannot be changed after the OriginEndpoint is created.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"authorization":"cmafPackage":"dashPackage":"description": A short text description of the OriginEndpoint."hlsPackage":"manifestName": A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index")."mssPackage":"origination": Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
"startoverWindowSeconds": Maximum duration (seconds) of content to retain for startover playback.
If not specified, startover playback will be disabled for the OriginEndpoint.
"tags":"timeDelaySeconds": Amount of delay (seconds) to enforce on the playback of live content.
If not specified, there will be no time delay in effect for the OriginEndpoint.
"whitelist": A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
Main.Mediapackage.delete_channel — Method
delete_channel(id)
delete_channel(id, params::Dict{String,<:Any})Deletes an existing Channel.
Arguments
id: The ID of the Channel to delete.
Main.Mediapackage.delete_origin_endpoint — Method
delete_origin_endpoint(id)
delete_origin_endpoint(id, params::Dict{String,<:Any})Deletes an existing OriginEndpoint.
Arguments
id: The ID of the OriginEndpoint to delete.
Main.Mediapackage.describe_channel — Method
describe_channel(id)
describe_channel(id, params::Dict{String,<:Any})Gets details about a Channel.
Arguments
id: The ID of a Channel.
Main.Mediapackage.describe_harvest_job — Method
describe_harvest_job(id)
describe_harvest_job(id, params::Dict{String,<:Any})Gets details about an existing HarvestJob.
Arguments
id: The ID of the HarvestJob.
Main.Mediapackage.describe_origin_endpoint — Method
describe_origin_endpoint(id)
describe_origin_endpoint(id, params::Dict{String,<:Any})Gets details about an existing OriginEndpoint.
Arguments
id: The ID of the OriginEndpoint.
Main.Mediapackage.list_channels — Method
list_channels()
list_channels(params::Dict{String,<:Any})Returns a collection of Channels.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": Upper bound on number of records to return."nextToken": A token used to resume pagination from the end of a previous request.
Main.Mediapackage.list_harvest_jobs — Method
list_harvest_jobs()
list_harvest_jobs(params::Dict{String,<:Any})Returns a collection of HarvestJob records.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"includeChannelId": When specified, the request will return only HarvestJobs associated with the given Channel ID."includeStatus": When specified, the request will return only HarvestJobs in the given status."maxResults": The upper bound on the number of records to return."nextToken": A token used to resume pagination from the end of a previous request.
Main.Mediapackage.list_origin_endpoints — Method
list_origin_endpoints()
list_origin_endpoints(params::Dict{String,<:Any})Returns a collection of OriginEndpoint records.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"channelId": When specified, the request will return only OriginEndpoints associated with the given Channel ID."maxResults": The upper bound on the number of records to return."nextToken": A token used to resume pagination from the end of a previous request.
Main.Mediapackage.list_tags_for_resource — Method
list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})Arguments
resource-arn:
Main.Mediapackage.rotate_channel_credentials — Method
rotate_channel_credentials(id)
rotate_channel_credentials(id, params::Dict{String,<:Any})Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
Arguments
id: The ID of the channel to update.
Main.Mediapackage.rotate_ingest_endpoint_credentials — Method
rotate_ingest_endpoint_credentials(id, ingest_endpoint_id)
rotate_ingest_endpoint_credentials(id, ingest_endpoint_id, params::Dict{String,<:Any})Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
Arguments
id: The ID of the channel the IngestEndpoint is on.ingest_endpoint_id: The id of the IngestEndpoint whose credentials should be rotated
Main.Mediapackage.tag_resource — Method
tag_resource(resource-arn, tags)
tag_resource(resource-arn, tags, params::Dict{String,<:Any})Arguments
resource-arn:tags:
Main.Mediapackage.untag_resource — Method
untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})Arguments
resource-arn:tag_keys: The key(s) of tag to be deleted
Main.Mediapackage.update_channel — Method
update_channel(id)
update_channel(id, params::Dict{String,<:Any})Updates an existing Channel.
Arguments
id: The ID of the Channel to update.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": A short text description of the Channel.
Main.Mediapackage.update_origin_endpoint — Method
update_origin_endpoint(id)
update_origin_endpoint(id, params::Dict{String,<:Any})Updates an existing OriginEndpoint.
Arguments
id: The ID of the OriginEndpoint to update.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"authorization":"cmafPackage":"dashPackage":"description": A short text description of the OriginEndpoint."hlsPackage":"manifestName": A short string that will be appended to the end of the Endpoint URL."mssPackage":"origination": Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
"startoverWindowSeconds": Maximum duration (in seconds) of content to retain for startover playback.
If not specified, startover playback will be disabled for the OriginEndpoint.
"timeDelaySeconds": Amount of delay (in seconds) to enforce on the playback of live content.
If not specified, there will be no time delay in effect for the OriginEndpoint.
"whitelist": A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.