/*******************************************************************************
* 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.RDS;
using Amazon.RDS.Model;
namespace Amazon.PowerShell.Cmdlets.RDS
{
///
/// Returns information about a snapshot or cluster export to Amazon S3. This API operation
/// supports pagination.
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", "RDSExportTask")]
[OutputType("Amazon.RDS.Model.ExportTask")]
[AWSCmdlet("Calls the Amazon Relational Database Service DescribeExportTasks API operation.", Operation = new[] {"DescribeExportTasks"}, SelectReturnType = typeof(Amazon.RDS.Model.DescribeExportTasksResponse))]
[AWSCmdletOutput("Amazon.RDS.Model.ExportTask or Amazon.RDS.Model.DescribeExportTasksResponse",
"This cmdlet returns a collection of Amazon.RDS.Model.ExportTask objects.",
"The service call response (type Amazon.RDS.Model.DescribeExportTasksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetRDSExportTaskCmdlet : AmazonRDSClientCmdlet, IExecutor
{
#region Parameter ExportTaskIdentifier
///
///
/// The identifier of the snapshot or cluster export task to be described.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String ExportTaskIdentifier { get; set; }
#endregion
#region Parameter Filter
///
///
/// Filters specify one or more snapshot or cluster exports to describe. The filters are
/// specified as name-value pairs that define what to include in the output. Filter names
/// and values are case-sensitive.Supported filters include the following:export-task-identifier
- An identifier for the snapshot or cluster export
/// task.s3-bucket
- The Amazon S3 bucket the data is exported to.source-arn
- The Amazon Resource Name (ARN) of the snapshot or cluster
/// exported to Amazon S3.status
- The status of the export task. Must be lowercase. Valid statuses
/// are the following:canceled
canceling
complete
failed
in_progress
starting
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public Amazon.RDS.Model.Filter[] Filter { get; set; }
#endregion
#region Parameter SourceArn
///
///
/// The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceArn { get; set; }
#endregion
#region Parameter SourceType
///
///
/// The type of source for the export.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.RDS.ExportSourceType")]
public Amazon.RDS.ExportSourceType SourceType { get; set; }
#endregion
#region Parameter Marker
///
///
/// An optional pagination token provided by a previous DescribeExportTasks
/// request. If you specify this parameter, the response includes only records beyond
/// the marker, up to the value specified by the MaxRecords
parameter.
///
///
///
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 records to include in the response. If more records exist than
/// the specified value, a pagination token called a marker is included in the response.
/// You can use the marker in a later DescribeExportTasks
request to retrieve
/// the remaining results.Default: 100Constraints: Minimum 20, maximum 100.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxRecords")]
public System.Int32? MaxRecord { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'ExportTasks'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.DescribeExportTasksResponse).
/// Specifying the name of a property of type Amazon.RDS.Model.DescribeExportTasksResponse 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; } = "ExportTasks";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ExportTaskIdentifier parameter.
/// The -PassThru parameter is deprecated, use -Select '^ExportTaskIdentifier' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ExportTaskIdentifier' 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.ExportTaskIdentifier;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ExportTaskIdentifier = this.ExportTaskIdentifier;
if (this.Filter != null)
{
context.Filter = new List(this.Filter);
}
context.Marker = this.Marker;
context.MaxRecord = this.MaxRecord;
context.SourceArn = this.SourceArn;
context.SourceType = this.SourceType;
// 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;
#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.RDS.Model.DescribeExportTasksRequest();
if (cmdletContext.ExportTaskIdentifier != null)
{
request.ExportTaskIdentifier = cmdletContext.ExportTaskIdentifier;
}
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.MaxRecord != null)
{
request.MaxRecords = cmdletContext.MaxRecord.Value;
}
if (cmdletContext.SourceArn != null)
{
request.SourceArn = cmdletContext.SourceArn;
}
if (cmdletContext.SourceType != null)
{
request.SourceType = cmdletContext.SourceType;
}
// 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;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.RDS.Model.DescribeExportTasksResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.DescribeExportTasksRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "DescribeExportTasks");
try
{
#if DESKTOP
return client.DescribeExportTasks(request);
#elif CORECLR
return client.DescribeExportTasksAsync(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 ExportTaskIdentifier { get; set; }
public List Filter { get; set; }
public System.String Marker { get; set; }
public System.Int32? MaxRecord { get; set; }
public System.String SourceArn { get; set; }
public Amazon.RDS.ExportSourceType SourceType { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ExportTasks;
}
}
}