lib/aws-sdk-mediapackagevod/client.rb in aws-sdk-mediapackagevod-1.10.0 vs lib/aws-sdk-mediapackagevod/client.rb in aws-sdk-mediapackagevod-1.11.0

- old
+ new

@@ -30,15 +30,15 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:mediapackagevod) module Aws::MediaPackageVod # An API client for MediaPackageVod. To construct a client, you need to configure a `:region` and `:credentials`. # - # client = Aws::MediaPackageVod::Client.new( - # region: region_name, - # credentials: credentials, - # # ... - # ) + # client = Aws::MediaPackageVod::Client.new( + # region: region_name, + # credentials: credentials, + # # ... + # ) # # For details on configuring region and credentials see # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. @@ -227,20 +227,24 @@ # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: - # * `legacy` - The pre-existing retry behavior. This is default value if - # no retry mode is provided. - # * `standard` - A standardized set of retry rules across the AWS SDKs. - # This includes support for retry quotas, which limit the number of - # unsuccessful retries a client can make. - # * `adaptive` - An experimental retry mode that includes all the - # functionality of `standard` mode along with automatic client side - # throttling. This is a provisional mode that may change behavior - # in the future. # + # * `legacy` - The pre-existing retry behavior. This is default value if + # no retry mode is provided. + # + # * `standard` - A standardized set of retry rules across the AWS SDKs. + # This includes support for retry quotas, which limit the number of + # unsuccessful retries a client can make. + # + # * `adaptive` - An experimental retry mode that includes all the + # functionality of `standard` mode along with automatic client side + # throttling. This is a provisional mode that may change behavior + # in the future. + # + # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :stub_responses (false) @@ -263,12 +267,11 @@ # seconds to wait when opening a HTTP session before raising a # `Timeout::Error`. # # @option options [Integer] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can - # safely be set - # per-request on the session yielded by {#session_for}. + # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idle before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. @@ -276,11 +279,11 @@ # @option options [Float] :http_continue_timeout (1) The number of # seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has # "Expect" header set to "100-continue". Defaults to `nil` which # disables this behaviour. This value can safely be set per - # request on the session yielded by {#session_for}. + # request on the session. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, @@ -315,29 +318,36 @@ # # @option params [required, String] :source_arn # # @option params [required, String] :source_role_arn # + # @option params [Hash<String,String>] :tags + # A collection of tags associated with a resource + # # @return [Types::CreateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateAssetResponse#arn #arn} => String # * {Types::CreateAssetResponse#created_at #created_at} => String # * {Types::CreateAssetResponse#egress_endpoints #egress_endpoints} => Array&lt;Types::EgressEndpoint&gt; # * {Types::CreateAssetResponse#id #id} => String # * {Types::CreateAssetResponse#packaging_group_id #packaging_group_id} => String # * {Types::CreateAssetResponse#resource_id #resource_id} => String # * {Types::CreateAssetResponse#source_arn #source_arn} => String # * {Types::CreateAssetResponse#source_role_arn #source_role_arn} => String + # * {Types::CreateAssetResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.create_asset({ # id: "__string", # required # packaging_group_id: "__string", # required # resource_id: "__string", # source_arn: "__string", # required # source_role_arn: "__string", # required + # tags: { + # "__string" => "__string", + # }, # }) # # @example Response structure # # resp.arn #=> String @@ -348,10 +358,12 @@ # resp.id #=> String # resp.packaging_group_id #=> String # resp.resource_id #=> String # resp.source_arn #=> String # resp.source_role_arn #=> String + # resp.tags #=> Hash + # resp.tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/CreateAsset AWS API Documentation # # @overload create_asset(params = {}) # @param [Hash] params ({}) @@ -376,19 +388,23 @@ # @option params [Types::MssPackage] :mss_package # A Microsoft Smooth Streaming (MSS) PackagingConfiguration. # # @option params [required, String] :packaging_group_id # + # @option params [Hash<String,String>] :tags + # A collection of tags associated with a resource + # # @return [Types::CreatePackagingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreatePackagingConfigurationResponse#arn #arn} => String # * {Types::CreatePackagingConfigurationResponse#cmaf_package #cmaf_package} => Types::CmafPackage # * {Types::CreatePackagingConfigurationResponse#dash_package #dash_package} => Types::DashPackage # * {Types::CreatePackagingConfigurationResponse#hls_package #hls_package} => Types::HlsPackage # * {Types::CreatePackagingConfigurationResponse#id #id} => String # * {Types::CreatePackagingConfigurationResponse#mss_package #mss_package} => Types::MssPackage # * {Types::CreatePackagingConfigurationResponse#packaging_group_id #packaging_group_id} => String + # * {Types::CreatePackagingConfigurationResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.create_packaging_configuration({ # cmaf_package: { @@ -487,10 +503,13 @@ # }, # ], # segment_duration_seconds: 1, # }, # packaging_group_id: "__string", # required + # tags: { + # "__string" => "__string", + # }, # }) # # @example Response structure # # resp.arn #=> String @@ -551,10 +570,12 @@ # resp.mss_package.mss_manifests[0].stream_selection.max_video_bits_per_second #=> Integer # resp.mss_package.mss_manifests[0].stream_selection.min_video_bits_per_second #=> Integer # resp.mss_package.mss_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING" # resp.mss_package.segment_duration_seconds #=> Integer # resp.packaging_group_id #=> String + # resp.tags #=> Hash + # resp.tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/CreatePackagingConfiguration AWS API Documentation # # @overload create_packaging_configuration(params = {}) # @param [Hash] params ({}) @@ -565,27 +586,36 @@ # Creates a new MediaPackage VOD PackagingGroup resource. # # @option params [required, String] :id # + # @option params [Hash<String,String>] :tags + # A collection of tags associated with a resource + # # @return [Types::CreatePackagingGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreatePackagingGroupResponse#arn #arn} => String # * {Types::CreatePackagingGroupResponse#domain_name #domain_name} => String # * {Types::CreatePackagingGroupResponse#id #id} => String + # * {Types::CreatePackagingGroupResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.create_packaging_group({ # id: "__string", # required + # tags: { + # "__string" => "__string", + # }, # }) # # @example Response structure # # resp.arn #=> String # resp.domain_name #=> String # resp.id #=> String + # resp.tags #=> Hash + # resp.tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/CreatePackagingGroup AWS API Documentation # # @overload create_packaging_group(params = {}) # @param [Hash] params ({}) @@ -669,10 +699,11 @@ # * {Types::DescribeAssetResponse#id #id} => String # * {Types::DescribeAssetResponse#packaging_group_id #packaging_group_id} => String # * {Types::DescribeAssetResponse#resource_id #resource_id} => String # * {Types::DescribeAssetResponse#source_arn #source_arn} => String # * {Types::DescribeAssetResponse#source_role_arn #source_role_arn} => String + # * {Types::DescribeAssetResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.describe_asset({ # id: "__string", # required @@ -688,10 +719,12 @@ # resp.id #=> String # resp.packaging_group_id #=> String # resp.resource_id #=> String # resp.source_arn #=> String # resp.source_role_arn #=> String + # resp.tags #=> Hash + # resp.tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/DescribeAsset AWS API Documentation # # @overload describe_asset(params = {}) # @param [Hash] params ({}) @@ -712,10 +745,11 @@ # * {Types::DescribePackagingConfigurationResponse#dash_package #dash_package} => Types::DashPackage # * {Types::DescribePackagingConfigurationResponse#hls_package #hls_package} => Types::HlsPackage # * {Types::DescribePackagingConfigurationResponse#id #id} => String # * {Types::DescribePackagingConfigurationResponse#mss_package #mss_package} => Types::MssPackage # * {Types::DescribePackagingConfigurationResponse#packaging_group_id #packaging_group_id} => String + # * {Types::DescribePackagingConfigurationResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.describe_packaging_configuration({ # id: "__string", # required @@ -781,10 +815,12 @@ # resp.mss_package.mss_manifests[0].stream_selection.max_video_bits_per_second #=> Integer # resp.mss_package.mss_manifests[0].stream_selection.min_video_bits_per_second #=> Integer # resp.mss_package.mss_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING" # resp.mss_package.segment_duration_seconds #=> Integer # resp.packaging_group_id #=> String + # resp.tags #=> Hash + # resp.tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/DescribePackagingConfiguration AWS API Documentation # # @overload describe_packaging_configuration(params = {}) # @param [Hash] params ({}) @@ -800,10 +836,11 @@ # @return [Types::DescribePackagingGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribePackagingGroupResponse#arn #arn} => String # * {Types::DescribePackagingGroupResponse#domain_name #domain_name} => String # * {Types::DescribePackagingGroupResponse#id #id} => String + # * {Types::DescribePackagingGroupResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.describe_packaging_group({ # id: "__string", # required @@ -812,10 +849,12 @@ # @example Response structure # # resp.arn #=> String # resp.domain_name #=> String # resp.id #=> String + # resp.tags #=> Hash + # resp.tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/DescribePackagingGroup AWS API Documentation # # @overload describe_packaging_group(params = {}) # @param [Hash] params ({}) @@ -835,10 +874,12 @@ # @return [Types::ListAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListAssetsResponse#assets #assets} => Array&lt;Types::AssetShallow&gt; # * {Types::ListAssetsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_assets({ # max_results: 1, # next_token: "__string", @@ -853,10 +894,12 @@ # resp.assets[0].id #=> String # resp.assets[0].packaging_group_id #=> String # resp.assets[0].resource_id #=> String # resp.assets[0].source_arn #=> String # resp.assets[0].source_role_arn #=> String + # resp.assets[0].tags #=> Hash + # resp.assets[0].tags["__string"] #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/ListAssets AWS API Documentation # # @overload list_assets(params = {}) @@ -878,10 +921,12 @@ # @return [Types::ListPackagingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPackagingConfigurationsResponse#next_token #next_token} => String # * {Types::ListPackagingConfigurationsResponse#packaging_configurations #packaging_configurations} => Array&lt;Types::PackagingConfiguration&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_packaging_configurations({ # max_results: 1, # next_token: "__string", @@ -950,10 +995,12 @@ # resp.packaging_configurations[0].mss_package.mss_manifests[0].stream_selection.max_video_bits_per_second #=> Integer # resp.packaging_configurations[0].mss_package.mss_manifests[0].stream_selection.min_video_bits_per_second #=> Integer # resp.packaging_configurations[0].mss_package.mss_manifests[0].stream_selection.stream_order #=> String, one of "ORIGINAL", "VIDEO_BITRATE_ASCENDING", "VIDEO_BITRATE_DESCENDING" # resp.packaging_configurations[0].mss_package.segment_duration_seconds #=> Integer # resp.packaging_configurations[0].packaging_group_id #=> String + # resp.packaging_configurations[0].tags #=> Hash + # resp.packaging_configurations[0].tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/ListPackagingConfigurations AWS API Documentation # # @overload list_packaging_configurations(params = {}) # @param [Hash] params ({}) @@ -971,10 +1018,12 @@ # @return [Types::ListPackagingGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPackagingGroupsResponse#next_token #next_token} => String # * {Types::ListPackagingGroupsResponse#packaging_groups #packaging_groups} => Array&lt;Types::PackagingGroup&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_packaging_groups({ # max_results: 1, # next_token: "__string", @@ -985,20 +1034,94 @@ # resp.next_token #=> String # resp.packaging_groups #=> Array # resp.packaging_groups[0].arn #=> String # resp.packaging_groups[0].domain_name #=> String # resp.packaging_groups[0].id #=> String + # resp.packaging_groups[0].tags #=> Hash + # resp.packaging_groups[0].tags["__string"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/ListPackagingGroups AWS API Documentation # # @overload list_packaging_groups(params = {}) # @param [Hash] params ({}) def list_packaging_groups(params = {}, options = {}) req = build_request(:list_packaging_groups, params) req.send_request(options) end + # @option params [required, String] :resource_arn + # + # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.list_tags_for_resource({ + # resource_arn: "__string", # required + # }) + # + # @example Response structure + # + # resp.tags #=> Hash + # resp.tags["__string"] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/ListTagsForResource AWS API Documentation + # + # @overload list_tags_for_resource(params = {}) + # @param [Hash] params ({}) + def list_tags_for_resource(params = {}, options = {}) + req = build_request(:list_tags_for_resource, params) + req.send_request(options) + end + + # @option params [required, String] :resource_arn + # + # @option params [required, Hash<String,String>] :tags + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.tag_resource({ + # resource_arn: "__string", # required + # tags: { # required + # "__string" => "__string", + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/TagResource AWS API Documentation + # + # @overload tag_resource(params = {}) + # @param [Hash] params ({}) + def tag_resource(params = {}, options = {}) + req = build_request(:tag_resource, params) + req.send_request(options) + end + + # @option params [required, String] :resource_arn + # + # @option params [required, Array<String>] :tag_keys + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.untag_resource({ + # resource_arn: "__string", # required + # tag_keys: ["__string"], # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/mediapackage-vod-2018-11-07/UntagResource AWS API Documentation + # + # @overload untag_resource(params = {}) + # @param [Hash] params ({}) + def untag_resource(params = {}, options = {}) + req = build_request(:untag_resource, params) + req.send_request(options) + end + # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) @@ -1008,10 +1131,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-mediapackagevod' - context[:gem_version] = '1.10.0' + context[:gem_version] = '1.11.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated