/******************************************************************************* * 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.EBS; using Amazon.EBS.Model; namespace Amazon.PowerShell.Cmdlets.EBS { /// /// Returns the data in a block in an Amazon Elastic Block Store snapshot. /// /// /// You should always retry requests that receive server (5xx) error responses, /// and ThrottlingException and RequestThrottledException client /// error responses. For more information see Error /// retries in the Amazon Elastic Compute Cloud User Guide. /// /// [Cmdlet("Get", "EBSSnapshotBlock")] [OutputType("Amazon.EBS.Model.GetSnapshotBlockResponse")] [AWSCmdlet("Calls the Amazon EBS GetSnapshotBlock API operation.", Operation = new[] {"GetSnapshotBlock"}, SelectReturnType = typeof(Amazon.EBS.Model.GetSnapshotBlockResponse))] [AWSCmdletOutput("Amazon.EBS.Model.GetSnapshotBlockResponse", "This cmdlet returns an Amazon.EBS.Model.GetSnapshotBlockResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEBSSnapshotBlockCmdlet : AmazonEBSClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter BlockIndex /// /// /// The block index of the block in which to read the data. A block index is a logical /// index in units of 512 KiB blocks. To identify the block index, divide /// the logical offset of the data in the logical volume by the block size (logical offset /// of data/524288). The logical offset of the data must be 512 /// KiB aligned. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.Int32? BlockIndex { get; set; } #endregion #region Parameter BlockToken /// /// /// The block token of the block from which to get data. You can obtain the BlockToken /// by running the ListChangedBlocks or ListSnapshotBlocks operations. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String BlockToken { get; set; } #endregion #region Parameter SnapshotId /// /// /// The ID of the snapshot containing the block from which to get data.If the specified snapshot is encrypted, you must have permission to use the KMS key /// that was used to encrypt the snapshot. For more information, see /// Using encryption in the Amazon Elastic Compute Cloud User Guide. /// /// #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.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String SnapshotId { 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.EBS.Model.GetSnapshotBlockResponse). /// Specifying the name of a property of type Amazon.EBS.Model.GetSnapshotBlockResponse 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 SnapshotId parameter. /// The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SnapshotId' 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.SnapshotId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.BlockIndex = this.BlockIndex; #if MODULAR if (this.BlockIndex == null && ParameterWasBound(nameof(this.BlockIndex))) { WriteWarning("You are passing $null as a value for parameter BlockIndex 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.BlockToken = this.BlockToken; #if MODULAR if (this.BlockToken == null && ParameterWasBound(nameof(this.BlockToken))) { WriteWarning("You are passing $null as a value for parameter BlockToken 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.SnapshotId = this.SnapshotId; #if MODULAR if (this.SnapshotId == null && ParameterWasBound(nameof(this.SnapshotId))) { WriteWarning("You are passing $null as a value for parameter SnapshotId 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 // 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.EBS.Model.GetSnapshotBlockRequest(); if (cmdletContext.BlockIndex != null) { request.BlockIndex = cmdletContext.BlockIndex.Value; } if (cmdletContext.BlockToken != null) { request.BlockToken = cmdletContext.BlockToken; } if (cmdletContext.SnapshotId != null) { request.SnapshotId = cmdletContext.SnapshotId; } 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.EBS.Model.GetSnapshotBlockResponse CallAWSServiceOperation(IAmazonEBS client, Amazon.EBS.Model.GetSnapshotBlockRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EBS", "GetSnapshotBlock"); try { #if DESKTOP return client.GetSnapshotBlock(request); #elif CORECLR return client.GetSnapshotBlockAsync(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 System.Int32? BlockIndex { get; set; } public System.String BlockToken { get; set; } public System.String SnapshotId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }