/******************************************************************************* * 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.Glacier; using Amazon.Glacier.Model; namespace Amazon.PowerShell.Cmdlets.GLC { /// /// This operation returns information about a vault, including the vault's Amazon Resource /// Name (ARN), the date the vault was created, the number of archives it contains, and /// the total size of all the archives in the vault. The number of archives and their /// total size are as of the last inventory generation. This means that if you add or /// remove an archive from a vault, and then immediately use Describe Vault, the change /// in contents will not be immediately reflected. If you want to retrieve the latest /// inventory of the vault, use InitiateJob. Amazon S3 Glacier generates vault /// inventories approximately daily. For more information, see Downloading /// a Vault Inventory in Amazon S3 Glacier. /// /// /// /// An AWS account has full permission to perform all operations (actions). However, AWS /// Identity and Access Management (IAM) users don't have any permissions by default. /// You must grant them explicit permission to perform specific actions. For more information, /// see Access /// Control Using AWS Identity and Access Management (IAM). /// /// For conceptual information and underlying REST API, see Retrieving /// Vault Metadata in Amazon S3 Glacier and Describe /// Vault in the Amazon Glacier Developer Guide. /// /// [Cmdlet("Get", "GLCVault")] [OutputType("Amazon.Glacier.Model.DescribeVaultResponse")] [AWSCmdlet("Calls the Amazon Glacier DescribeVault API operation.", Operation = new[] {"DescribeVault"}, SelectReturnType = typeof(Amazon.Glacier.Model.DescribeVaultResponse))] [AWSCmdletOutput("Amazon.Glacier.Model.DescribeVaultResponse", "This cmdlet returns an Amazon.Glacier.Model.DescribeVaultResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetGLCVaultCmdlet : AmazonGlacierClientCmdlet, IExecutor { #region Parameter AccountId /// /// /// The AccountId value is the AWS account ID of the account that owns the /// vault. You can either specify an AWS account ID or optionally a single '-' /// (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with /// the credentials used to sign the request. If you use an account ID, do not include /// any hyphens ('-') in the ID. /// /// If a value for this parameter is not specified the cmdlet will use a default value of '-'. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AccountId { get; set; } #endregion #region Parameter VaultName /// /// /// The name of the vault. /// /// #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 VaultName { 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.Glacier.Model.DescribeVaultResponse). /// Specifying the name of a property of type Amazon.Glacier.Model.DescribeVaultResponse 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 VaultName parameter. /// The -PassThru parameter is deprecated, use -Select '^VaultName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^VaultName' 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.VaultName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AccountId = this.AccountId; if (!ParameterWasBound(nameof(this.AccountId))) { WriteVerbose("AccountId parameter unset, using default value of '-'"); context.AccountId = "-"; } #if MODULAR if (this.AccountId == null && ParameterWasBound(nameof(this.AccountId))) { WriteWarning("You are passing $null as a value for parameter AccountId 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.VaultName = this.VaultName; #if MODULAR if (this.VaultName == null && ParameterWasBound(nameof(this.VaultName))) { WriteWarning("You are passing $null as a value for parameter VaultName 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.Glacier.Model.DescribeVaultRequest(); if (cmdletContext.AccountId != null) { request.AccountId = cmdletContext.AccountId; } if (cmdletContext.VaultName != null) { request.VaultName = cmdletContext.VaultName; } 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.Glacier.Model.DescribeVaultResponse CallAWSServiceOperation(IAmazonGlacier client, Amazon.Glacier.Model.DescribeVaultRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Glacier", "DescribeVault"); try { #if DESKTOP return client.DescribeVault(request); #elif CORECLR return client.DescribeVaultAsync(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.String AccountId { get; set; } public System.String VaultName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }