Class: Aws::MediaPackageV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MediaPackageV2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb
Overview
An API client for MediaPackageV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MediaPackageV2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Create a channel to start receiving content streams.
-
#create_channel_group(params = {}) ⇒ Types::CreateChannelGroupResponse
Create a channel group to group your channels and origin endpoints.
-
#create_origin_endpoint(params = {}) ⇒ Types::CreateOriginEndpointResponse
The endpoint is attached to a channel, and represents the output of the live content.
-
#delete_channel(params = {}) ⇒ Struct
Delete a channel to stop AWS Elemental MediaPackage from receiving further content.
-
#delete_channel_group(params = {}) ⇒ Struct
Delete a channel group.
-
#delete_channel_policy(params = {}) ⇒ Struct
Delete a channel policy.
-
#delete_origin_endpoint(params = {}) ⇒ Struct
Origin endpoints can serve content until they're deleted.
-
#delete_origin_endpoint_policy(params = {}) ⇒ Struct
Delete an origin endpoint policy.
-
#get_channel(params = {}) ⇒ Types::GetChannelResponse
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
-
#get_channel_group(params = {}) ⇒ Types::GetChannelGroupResponse
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
-
#get_channel_policy(params = {}) ⇒ Types::GetChannelPolicyResponse
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.
-
#get_origin_endpoint(params = {}) ⇒ Types::GetOriginEndpointResponse
Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
-
#get_origin_endpoint_policy(params = {}) ⇒ Types::GetOriginEndpointPolicyResponse
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
-
#list_channel_groups(params = {}) ⇒ Types::ListChannelGroupsResponse
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
-
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
-
#list_origin_endpoints(params = {}) ⇒ Types::ListOriginEndpointsResponse
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a resource.
-
#put_channel_policy(params = {}) ⇒ Struct
Attaches an IAM policy to the specified channel.
-
#put_origin_endpoint_policy(params = {}) ⇒ Struct
Attaches an IAM policy to the specified origin endpoint.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
-
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Update the specified channel.
-
#update_channel_group(params = {}) ⇒ Types::UpdateChannelGroupResponse
Update the specified channel group.
-
#update_origin_endpoint(params = {}) ⇒ Types::UpdateOriginEndpointResponse
Update the specified origin endpoint.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.
498 499 500 501 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 498 def create_channel(params = {}, = {}) req = build_request(:create_channel, params) req.send_request() end |
#create_channel_group(params = {}) ⇒ Types::CreateChannelGroupResponse
Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.
573 574 575 576 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 573 def create_channel_group(params = {}, = {}) req = build_request(:create_channel_group, params) req.send_request() end |
#create_origin_endpoint(params = {}) ⇒ Types::CreateOriginEndpointResponse
The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.
842 843 844 845 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 842 def create_origin_endpoint(params = {}, = {}) req = build_request(:create_origin_endpoint, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.
874 875 876 877 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 874 def delete_channel(params = {}, = {}) req = build_request(:delete_channel, params) req.send_request() end |
#delete_channel_group(params = {}) ⇒ Struct
Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.
901 902 903 904 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 901 def delete_channel_group(params = {}, = {}) req = build_request(:delete_channel_group, params) req.send_request() end |
#delete_channel_policy(params = {}) ⇒ Struct
Delete a channel policy.
931 932 933 934 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 931 def delete_channel_policy(params = {}, = {}) req = build_request(:delete_channel_policy, params) req.send_request() end |
#delete_origin_endpoint(params = {}) ⇒ Struct
Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.
969 970 971 972 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 969 def delete_origin_endpoint(params = {}, = {}) req = build_request(:delete_origin_endpoint, params) req.send_request() end |
#delete_origin_endpoint_policy(params = {}) ⇒ Struct
Delete an origin endpoint policy.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1005 def delete_origin_endpoint_policy(params = {}, = {}) req = build_request(:delete_origin_endpoint_policy, params) req.send_request() end |
#get_channel(params = {}) ⇒ Types::GetChannelResponse
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1062 def get_channel(params = {}, = {}) req = build_request(:get_channel, params) req.send_request() end |
#get_channel_group(params = {}) ⇒ Types::GetChannelGroupResponse
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1109 def get_channel_group(params = {}, = {}) req = build_request(:get_channel_group, params) req.send_request() end |
#get_channel_policy(params = {}) ⇒ Types::GetChannelPolicyResponse
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1151 def get_channel_policy(params = {}, = {}) req = build_request(:get_channel_policy, params) req.send_request() end |
#get_origin_endpoint(params = {}) ⇒ Types::GetOriginEndpointResponse
Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1278 def get_origin_endpoint(params = {}, = {}) req = build_request(:get_origin_endpoint, params) req.send_request() end |
#get_origin_endpoint_policy(params = {}) ⇒ Types::GetOriginEndpointPolicyResponse
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
1327 1328 1329 1330 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1327 def get_origin_endpoint_policy(params = {}, = {}) req = build_request(:get_origin_endpoint_policy, params) req.send_request() end |
#list_channel_groups(params = {}) ⇒ Types::ListChannelGroupsResponse
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1371 1372 1373 1374 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1371 def list_channel_groups(params = {}, = {}) req = build_request(:list_channel_groups, params) req.send_request() end |
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1422 1423 1424 1425 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1422 def list_channels(params = {}, = {}) req = build_request(:list_channels, params) req.send_request() end |
#list_origin_endpoints(params = {}) ⇒ Types::ListOriginEndpointsResponse
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1491 1492 1493 1494 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1491 def list_origin_endpoints(params = {}, = {}) req = build_request(:list_origin_endpoints, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a resource.
1520 1521 1522 1523 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1520 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_channel_policy(params = {}) ⇒ Struct
Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1557 def put_channel_policy(params = {}, = {}) req = build_request(:put_channel_policy, params) req.send_request() end |
#put_origin_endpoint_policy(params = {}) ⇒ Struct
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
1598 1599 1600 1601 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1598 def put_origin_endpoint_policy(params = {}, = {}) req = build_request(:put_origin_endpoint_policy, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
1637 1638 1639 1640 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1637 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
1663 1664 1665 1666 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1663 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.
Any edits you make that impact the video output may not be reflected for a few minutes.
1736 1737 1738 1739 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1736 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_channel_group(params = {}) ⇒ Types::UpdateChannelGroupResponse
Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.
Any edits you make that impact the video output may not be reflected for a few minutes.
1797 1798 1799 1800 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 1797 def update_channel_group(params = {}, = {}) req = build_request(:update_channel_group, params) req.send_request() end |
#update_origin_endpoint(params = {}) ⇒ Types::UpdateOriginEndpointResponse
Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.
Any edits you make that impact the video output may not be reflected for a few minutes.
2051 2052 2053 2054 |
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/client.rb', line 2051 def update_origin_endpoint(params = {}, = {}) req = build_request(:update_origin_endpoint, params) req.send_request() end |