/*******************************************************************************
* 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.RedshiftDataAPIService;
using Amazon.RedshiftDataAPIService.Model;
namespace Amazon.PowerShell.Cmdlets.RSD
{
///
/// List of SQL statements. By default, only finished statements are shown. A token is
/// returned to page through the statement list.
///
///
///
/// For more information about the Amazon Redshift Data API and CLI usage examples, see
/// Using the
/// Amazon Redshift Data API in the Amazon Redshift Management Guide.
///
///
[Cmdlet("Get", "RSDStatementList")]
[OutputType("Amazon.RedshiftDataAPIService.Model.StatementData")]
[AWSCmdlet("Calls the Redshift Data API Service ListStatements API operation.", Operation = new[] {"ListStatements"}, SelectReturnType = typeof(Amazon.RedshiftDataAPIService.Model.ListStatementsResponse))]
[AWSCmdletOutput("Amazon.RedshiftDataAPIService.Model.StatementData or Amazon.RedshiftDataAPIService.Model.ListStatementsResponse",
"This cmdlet returns a collection of Amazon.RedshiftDataAPIService.Model.StatementData objects.",
"The service call response (type Amazon.RedshiftDataAPIService.Model.ListStatementsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetRSDStatementListCmdlet : AmazonRedshiftDataAPIServiceClientCmdlet, IExecutor
{
#region Parameter RoleLevel
///
///
/// A value that filters which statements to return in the response. If true, all statements
/// run by the caller's IAM role are returned. If false, only statements run by the caller's
/// IAM role in the current IAM session are returned. The default is true.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? RoleLevel { get; set; }
#endregion
#region Parameter StatementName
///
///
/// The name of the SQL statement specified as input to BatchExecuteStatement
/// or ExecuteStatement
to identify the query. You can list multiple statements
/// by providing a prefix that matches the beginning of the statement name. For example,
/// to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value
/// of myStatement
. Data API does a case-sensitive match of SQL statement
/// names to the prefix value you provide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String StatementName { get; set; }
#endregion
#region Parameter Status
///
///
/// The status of the SQL statement to list. Status values are defined as follows: - ABORTED - The query run was stopped by the user.
- ALL - A status value that includes all query statuses. This value can be used to filter
/// results.
- FAILED - The query run failed.
- FINISHED - The query has finished running.
- PICKED - The query has been chosen to be run.
- STARTED - The query run has started.
- SUBMITTED - The query was submitted, but not yet processed.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.RedshiftDataAPIService.StatusString")]
public Amazon.RedshiftDataAPIService.StatusString Status { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of SQL statements to return in the response. If more SQL statements
/// exist than fit in one response, then NextToken
is returned to page through
/// the results.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// A value that indicates the starting point for the next set of response records in
/// a subsequent request. If a value is returned in a response, you can retrieve the next
/// set of records by providing this returned NextToken value in the next NextToken parameter
/// and retrying the command. If the NextToken field is empty, all response records have
/// been retrieved for the request.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Statements'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RedshiftDataAPIService.Model.ListStatementsResponse).
/// Specifying the name of a property of type Amazon.RedshiftDataAPIService.Model.ListStatementsResponse 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; } = "Statements";
#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);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.RoleLevel = this.RoleLevel;
context.StatementName = this.StatementName;
context.Status = this.Status;
// 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.RedshiftDataAPIService.Model.ListStatementsRequest();
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
if (cmdletContext.RoleLevel != null)
{
request.RoleLevel = cmdletContext.RoleLevel.Value;
}
if (cmdletContext.StatementName != null)
{
request.StatementName = cmdletContext.StatementName;
}
if (cmdletContext.Status != null)
{
request.Status = cmdletContext.Status;
}
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.RedshiftDataAPIService.Model.ListStatementsResponse CallAWSServiceOperation(IAmazonRedshiftDataAPIService client, Amazon.RedshiftDataAPIService.Model.ListStatementsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Redshift Data API Service", "ListStatements");
try
{
#if DESKTOP
return client.ListStatements(request);
#elif CORECLR
return client.ListStatementsAsync(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? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Boolean? RoleLevel { get; set; }
public System.String StatementName { get; set; }
public Amazon.RedshiftDataAPIService.StatusString Status { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Statements;
}
}
}