/******************************************************************************* * 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.Redshift; using Amazon.Redshift.Model; namespace Amazon.PowerShell.Cmdlets.RS { /// /// Returns one or more snapshot objects, which contain metadata about your cluster snapshots. /// By default, this operation returns information about all snapshots of all clusters /// that are owned by your Amazon Web Services account. No information is returned for /// snapshots owned by inactive Amazon Web Services accounts. /// /// /// /// If you specify both tag keys and tag values in the same request, Amazon Redshift returns /// all snapshots that match any combination of the specified keys and values. For example, /// if you have owner and environment for tag keys, and admin /// and test for tag values, all snapshots that have any combination of those /// values are returned. Only snapshots that you own are returned in the response; shared /// snapshots are not returned with the tag key and tag value request parameters. /// /// If both tag keys and values are omitted from the request, snapshots are returned regardless /// of whether they have tag keys or values associated with them. ///

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Get", "RSClusterSnapshot")] [OutputType("Amazon.Redshift.Model.Snapshot")] [AWSCmdlet("Calls the Amazon Redshift DescribeClusterSnapshots API operation.", Operation = new[] {"DescribeClusterSnapshots"}, SelectReturnType = typeof(Amazon.Redshift.Model.DescribeClusterSnapshotsResponse), LegacyAlias="Get-RSClusterSnapshots")] [AWSCmdletOutput("Amazon.Redshift.Model.Snapshot or Amazon.Redshift.Model.DescribeClusterSnapshotsResponse", "This cmdlet returns a collection of Amazon.Redshift.Model.Snapshot objects.", "The service call response (type Amazon.Redshift.Model.DescribeClusterSnapshotsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetRSClusterSnapshotCmdlet : AmazonRedshiftClientCmdlet, IExecutor { #region Parameter ClusterExist /// /// /// A value that indicates whether to return snapshots only for an existing cluster. You /// can perform table-level restore only by using a snapshot of an existing cluster, that /// is, a cluster that has not been deleted. Values for this parameter work as follows: /// /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ClusterExists")] public System.Boolean? ClusterExist { get; set; } #endregion #region Parameter ClusterIdentifier /// /// /// The identifier of the cluster which generated the requested snapshots. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String ClusterIdentifier { get; set; } #endregion #region Parameter UtcEndTime /// /// /// A time value that requests only snapshots created at or before the specified time. /// The time value is specified in ISO 8601 format. For more information about ISO 8601, /// go to the ISO8601 Wikipedia page.Example: 2012-07-16T18:00:00Z /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? UtcEndTime { get; set; } #endregion #region Parameter OwnerAccount /// /// /// The Amazon Web Services account used to create or copy the snapshot. Use this field /// to filter the results to snapshots owned by a particular account. To describe snapshots /// you own, either specify your Amazon Web Services account, or do not specify the parameter. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OwnerAccount { get; set; } #endregion #region Parameter SnapshotArn /// /// /// The Amazon Resource Name (ARN) of the snapshot associated with the message to describe /// cluster snapshots. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SnapshotArn { get; set; } #endregion #region Parameter SnapshotIdentifier /// /// /// The snapshot identifier of the snapshot about which to return information. /// /// [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] public System.String SnapshotIdentifier { get; set; } #endregion #region Parameter SnapshotType /// /// /// The type of snapshots for which you are requesting information. By default, snapshots /// of all types are returned.Valid Values: automated | manual /// /// [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] public System.String SnapshotType { get; set; } #endregion #region Parameter SortingEntity /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SortingEntities")] public Amazon.Redshift.Model.SnapshotSortingEntity[] SortingEntity { get; set; } #endregion #region Parameter UtcStartTime /// /// /// A value that requests only snapshots created at or after the specified time. The time /// value is specified in ISO 8601 format. For more information about ISO 8601, go to /// the ISO8601 Wikipedia page.Example: 2012-07-16T18:00:00Z /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? UtcStartTime { get; set; } #endregion #region Parameter TagKey /// /// /// A tag key or keys for which you want to return all matching cluster snapshots that /// are associated with the specified key or keys. For example, suppose that you have /// snapshots that are tagged with keys called owner and environment. /// If you specify both of these tag keys in the request, Amazon Redshift returns a response /// with the snapshots that have either or both of these tag keys associated with them. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagKeys")] public System.String[] TagKey { get; set; } #endregion #region Parameter TagValue /// /// /// A tag value or values for which you want to return all matching cluster snapshots /// that are associated with the specified tag value or values. For example, suppose that /// you have snapshots that are tagged with values called admin and test. /// If you specify both of these tag values in the request, Amazon Redshift returns a /// response with the snapshots that have either or both of these tag values associated /// with them. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagValues")] public System.String[] TagValue { get; set; } #endregion #region Parameter EndTime /// /// /// This property is deprecated. Setting this property results in non-UTC DateTimes not /// being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc /// results in both EndTime and EndTimeUtc being assigned, the latest assignment to either /// one of the two property is reflected in the value of both. EndTime is provided for /// backwards compatibility only and assigning a non-Utc DateTime to it results in the /// wrong timestamp being passed to the service.A time value that requests only snapshots created at or before the specified time. /// The time value is specified in ISO 8601 format. For more information about ISO 8601, /// go to the ISO8601 Wikipedia page.Example: 2012-07-16T18:00:00Z /// /// This parameter is deprecated. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcEndTime instead.")] public System.DateTime? EndTime { get; set; } #endregion #region Parameter Marker /// /// /// An optional parameter that specifies the starting point to return a set of response /// records. When the results of a DescribeClusterSnapshots request exceed the /// value specified in MaxRecords, Amazon Web Services returns a value in /// the Marker field of the response. You can retrieve the next set of response /// records by providing the returned marker value in the Marker parameter /// and retrying the request. /// /// ///
Note: This parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String Marker { get; set; } #endregion #region Parameter MaxRecord /// /// /// The maximum number of response records to return in each call. If the number of remaining /// response records exceeds the specified MaxRecords value, a value is returned /// in a marker field of the response. You can retrieve the next set of records /// by retrying the command with the returned marker value. Default: 100Constraints: minimum 20, maximum 100. /// /// ///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. ///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. ///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. ///
/// If a value for this parameter is not specified the cmdlet will use a default value of '100'. ///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxItems","MaxRecords")] public int? MaxRecord { get; set; } #endregion #region Parameter StartTime /// /// /// This property is deprecated. Setting this property results in non-UTC DateTimes not /// being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or /// StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest /// assignment to either one of the two property is reflected in the value of both. StartTime /// is provided for backwards compatibility only and assigning a non-Utc DateTime to it /// results in the wrong timestamp being passed to the service.A value that requests only snapshots created at or after the specified time. The time /// value is specified in ISO 8601 format. For more information about ISO 8601, go to /// the ISO8601 Wikipedia page.Example: 2012-07-16T18:00:00Z /// /// This parameter is deprecated. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcStartTime instead.")] public System.DateTime? StartTime { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Snapshots'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Redshift.Model.DescribeClusterSnapshotsResponse). /// Specifying the name of a property of type Amazon.Redshift.Model.DescribeClusterSnapshotsResponse 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; } = "Snapshots"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ClusterIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter NoAutoIteration /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { 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.ClusterIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClusterExist = this.ClusterExist; context.ClusterIdentifier = this.ClusterIdentifier; context.UtcEndTime = this.UtcEndTime; context.Marker = this.Marker; context.MaxRecord = this.MaxRecord; #if MODULAR if (!ParameterWasBound(nameof(this.MaxRecord))) { WriteVerbose("MaxRecord parameter unset, using default value of '100'"); context.MaxRecord = 100; } #endif #if !MODULAR if (ParameterWasBound(nameof(this.MaxRecord)) && this.MaxRecord.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxRecord parameter to limit the total number of items returned by the cmdlet." + " This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" + " retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing MaxRecord" + " to the service to specify how many items should be returned by each service call."); } #endif context.OwnerAccount = this.OwnerAccount; context.SnapshotArn = this.SnapshotArn; context.SnapshotIdentifier = this.SnapshotIdentifier; context.SnapshotType = this.SnapshotType; if (this.SortingEntity != null) { context.SortingEntity = new List(this.SortingEntity); } context.UtcStartTime = this.UtcStartTime; if (this.TagKey != null) { context.TagKey = new List(this.TagKey); } if (this.TagValue != null) { context.TagValue = new List(this.TagValue); } #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute context.EndTime = this.EndTime; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute context.StartTime = this.StartTime; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members #if MODULAR public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // create request and set iteration invariants var request = new Amazon.Redshift.Model.DescribeClusterSnapshotsRequest(); if (cmdletContext.ClusterExist != null) { request.ClusterExists = cmdletContext.ClusterExist.Value; } if (cmdletContext.ClusterIdentifier != null) { request.ClusterIdentifier = cmdletContext.ClusterIdentifier; } if (cmdletContext.UtcEndTime != null) { request.EndTimeUtc = cmdletContext.UtcEndTime.Value; } if (cmdletContext.MaxRecord != null) { request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxRecord.Value); } if (cmdletContext.OwnerAccount != null) { request.OwnerAccount = cmdletContext.OwnerAccount; } if (cmdletContext.SnapshotArn != null) { request.SnapshotArn = cmdletContext.SnapshotArn; } if (cmdletContext.SnapshotIdentifier != null) { request.SnapshotIdentifier = cmdletContext.SnapshotIdentifier; } if (cmdletContext.SnapshotType != null) { request.SnapshotType = cmdletContext.SnapshotType; } if (cmdletContext.SortingEntity != null) { request.SortingEntities = cmdletContext.SortingEntity; } if (cmdletContext.UtcStartTime != null) { request.StartTimeUtc = cmdletContext.UtcStartTime.Value; } if (cmdletContext.TagKey != null) { request.TagKeys = cmdletContext.TagKey; } if (cmdletContext.TagValue != null) { request.TagValues = cmdletContext.TagValue; } #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (cmdletContext.EndTime != null) { if (cmdletContext.UtcEndTime != null) { throw new System.ArgumentException("Parameters EndTime and UtcEndTime are mutually exclusive.", nameof(this.EndTime)); } request.EndTime = cmdletContext.EndTime.Value; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (cmdletContext.StartTime != null) { if (cmdletContext.UtcStartTime != null) { throw new System.ArgumentException("Parameters StartTime and UtcStartTime are mutually exclusive.", nameof(this.StartTime)); } request.StartTime = cmdletContext.StartTime.Value; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // Initialize loop variant and commence piping var _nextToken = cmdletContext.Marker; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.Marker; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #else public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; // create request and set iteration invariants var request = new Amazon.Redshift.Model.DescribeClusterSnapshotsRequest(); if (cmdletContext.ClusterExist != null) { request.ClusterExists = cmdletContext.ClusterExist.Value; } if (cmdletContext.ClusterIdentifier != null) { request.ClusterIdentifier = cmdletContext.ClusterIdentifier; } if (cmdletContext.UtcEndTime != null) { request.EndTimeUtc = cmdletContext.UtcEndTime.Value; } if (cmdletContext.OwnerAccount != null) { request.OwnerAccount = cmdletContext.OwnerAccount; } if (cmdletContext.SnapshotArn != null) { request.SnapshotArn = cmdletContext.SnapshotArn; } if (cmdletContext.SnapshotIdentifier != null) { request.SnapshotIdentifier = cmdletContext.SnapshotIdentifier; } if (cmdletContext.SnapshotType != null) { request.SnapshotType = cmdletContext.SnapshotType; } if (cmdletContext.SortingEntity != null) { request.SortingEntities = cmdletContext.SortingEntity; } if (cmdletContext.UtcStartTime != null) { request.StartTimeUtc = cmdletContext.UtcStartTime.Value; } if (cmdletContext.TagKey != null) { request.TagKeys = cmdletContext.TagKey; } if (cmdletContext.TagValue != null) { request.TagValues = cmdletContext.TagValue; } #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (cmdletContext.EndTime != null) { if (cmdletContext.UtcEndTime != null) { throw new System.ArgumentException("Parameters EndTime and UtcEndTime are mutually exclusive.", nameof(this.EndTime)); } request.EndTime = cmdletContext.EndTime.Value; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (cmdletContext.StartTime != null) { if (cmdletContext.UtcStartTime != null) { throw new System.ArgumentException("Parameters StartTime and UtcStartTime are mutually exclusive.", nameof(this.StartTime)); } request.StartTime = cmdletContext.StartTime.Value; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // Initialize loop variants and commence piping System.String _nextToken = null; int? _emitLimit = null; int _retrievedSoFar = 0; if (AutoIterationHelpers.HasValue(cmdletContext.Marker)) { _nextToken = cmdletContext.Marker; } if (cmdletContext.MaxRecord.HasValue) { // The service has a maximum page size of 100. If the user has // asked for more items than page max, and there is no page size // configured, we rely on the service ignoring the set maximum // and giving us 100 items back. If a page size is set, that will // be used to configure the pagination. // We'll make further calls to satisfy the user's request. _emitLimit = cmdletContext.MaxRecord; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; if (_emitLimit.HasValue) { int correctPageSize = Math.Min(100, _emitLimit.Value); request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToInt32(correctPageSize); } else if (!ParameterWasBound(nameof(this.MaxRecord))) { request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToInt32(100); } CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; int _receivedThisCall = response.Snapshots.Count; _nextToken = response.Marker; _retrievedSoFar += _receivedThisCall; if (_emitLimit.HasValue) { _emitLimit -= _receivedThisCall; } } catch (Exception e) { if (_retrievedSoFar == 0 || !_emitLimit.HasValue) { output = new CmdletOutput { ErrorResponse = e }; } else { break; } } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.Redshift.Model.DescribeClusterSnapshotsResponse CallAWSServiceOperation(IAmazonRedshift client, Amazon.Redshift.Model.DescribeClusterSnapshotsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Redshift", "DescribeClusterSnapshots"); try { #if DESKTOP return client.DescribeClusterSnapshots(request); #elif CORECLR return client.DescribeClusterSnapshotsAsync(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.Boolean? ClusterExist { get; set; } public System.String ClusterIdentifier { get; set; } public System.DateTime? UtcEndTime { get; set; } public System.String Marker { get; set; } public int? MaxRecord { get; set; } public System.String OwnerAccount { get; set; } public System.String SnapshotArn { get; set; } public System.String SnapshotIdentifier { get; set; } public System.String SnapshotType { get; set; } public List SortingEntity { get; set; } public System.DateTime? UtcStartTime { get; set; } public List TagKey { get; set; } public List TagValue { get; set; } [System.ObsoleteAttribute] public System.DateTime? EndTime { get; set; } [System.ObsoleteAttribute] public System.DateTime? StartTime { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Snapshots; } } }