/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.KinesisVideoMedia; using Amazon.KinesisVideoMedia.Model; namespace Amazon.PowerShell.Cmdlets.KVM { /// /// Use this API to retrieve media content from a Kinesis video stream. In the request, /// you identify the stream name or stream Amazon Resource Name (ARN), and the starting /// chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment /// number. /// /// /// You must first call the GetDataEndpoint API to get an endpoint. Then /// send the GetMedia requests to this endpoint using the --endpoint-url /// parameter. /// /// When you put media data (fragments) on a stream, Kinesis Video Streams stores each /// incoming fragment and related metadata in what is called a "chunk." For more information, /// see PutMedia. /// The GetMedia API returns a stream of these chunks starting from the chunk /// that you specify in the request. /// /// The following limits apply when using the GetMedia API: /// /// If an error is thrown after invoking a Kinesis Video Streams media API, in addition /// to the HTTP status code and the response body, it includes the following pieces of /// information: /// /// Both the HTTP status code and the ErrorType header can be utilized to make programmatic /// decisions about whether errors are retry-able and under what conditions, as well as /// provide information on what actions the client programmer might need to take in order /// to successfully try again. /// /// For more information, see the Errors section at the bottom of this topic, as /// well as Common /// Errors. /// /// [Cmdlet("Get", "KVMMedia")] [OutputType("Amazon.KinesisVideoMedia.Model.GetMediaResponse")] [AWSCmdlet("Calls the Amazon Kinesis Video Streams Media GetMedia API operation.", Operation = new[] {"GetMedia"}, SelectReturnType = typeof(Amazon.KinesisVideoMedia.Model.GetMediaResponse))] [AWSCmdletOutput("Amazon.KinesisVideoMedia.Model.GetMediaResponse", "This cmdlet returns an Amazon.KinesisVideoMedia.Model.GetMediaResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetKVMMediaCmdlet : AmazonKinesisVideoMediaClientCmdlet, IExecutor { #region Parameter StartSelector /// /// /// Identifies the starting chunk to get from the specified stream. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public Amazon.KinesisVideoMedia.Model.StartSelector StartSelector { get; set; } #endregion #region Parameter StreamARN /// /// /// The ARN of the stream from where you want to get the media content. If you don't specify /// the streamARN, you must specify the streamName. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StreamARN { get; set; } #endregion #region Parameter StreamName /// /// /// The Kinesis video stream name from where you want to get the media content. If you /// don't specify the streamName, you must specify the streamARN. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StreamName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideoMedia.Model.GetMediaResponse). /// Specifying the name of a property of type Amazon.KinesisVideoMedia.Model.GetMediaResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the StartSelector parameter. /// The -PassThru parameter is deprecated, use -Select '^StartSelector' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StartSelector' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.StartSelector; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.StartSelector = this.StartSelector; #if MODULAR if (this.StartSelector == null && ParameterWasBound(nameof(this.StartSelector))) { WriteWarning("You are passing $null as a value for parameter StartSelector which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.StreamARN = this.StreamARN; context.StreamName = this.StreamName; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.KinesisVideoMedia.Model.GetMediaRequest(); if (cmdletContext.StartSelector != null) { request.StartSelector = cmdletContext.StartSelector; } if (cmdletContext.StreamARN != null) { request.StreamARN = cmdletContext.StreamARN; } if (cmdletContext.StreamName != null) { request.StreamName = cmdletContext.StreamName; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.KinesisVideoMedia.Model.GetMediaResponse CallAWSServiceOperation(IAmazonKinesisVideoMedia client, Amazon.KinesisVideoMedia.Model.GetMediaRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kinesis Video Streams Media", "GetMedia"); try { #if DESKTOP return client.GetMedia(request); #elif CORECLR return client.GetMediaAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public Amazon.KinesisVideoMedia.Model.StartSelector StartSelector { get; set; } public System.String StreamARN { get; set; } public System.String StreamName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }