AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the DescribeStatement operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.RedshiftDataAPIService.Model.DescribeStatementResponse

Namespace: Amazon.RedshiftDataAPIService.Model
Assembly: AWSSDK.RedshiftDataAPIService.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeStatementResponse : AmazonWebServiceResponse

The DescribeStatementResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeStatementResponse()

Properties

NameTypeDescription
Public Property ClusterIdentifier System.String

Gets and sets the property ClusterIdentifier.

The cluster identifier.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt.

The date and time (UTC) when the SQL statement was submitted to run.

Public Property Database System.String

Gets and sets the property Database.

The name of the database.

Public Property DbUser System.String

Gets and sets the property DbUser.

The database user name.

Public Property Duration System.Int64

Gets and sets the property Duration.

The amount of time in nanoseconds that the statement ran.

Public Property Error System.String

Gets and sets the property Error.

The error message from the cluster if the SQL statement encountered an error while running.

Public Property HasResultSet System.Boolean

Gets and sets the property HasResultSet.

A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Id System.String

Gets and sets the property Id.

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

Public Property QueryParameters System.Collections.Generic.List<Amazon.RedshiftDataAPIService.Model.SqlParameter>

Gets and sets the property QueryParameters.

The parameters for the SQL statement.

Public Property QueryString System.String

Gets and sets the property QueryString.

The SQL statement text.

Public Property RedshiftPid System.Int64

Gets and sets the property RedshiftPid.

The process identifier from Amazon Redshift.

Public Property RedshiftQueryId System.Int64

Gets and sets the property RedshiftQueryId.

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResultFormat Amazon.RedshiftDataAPIService.ResultFormatString

Gets and sets the property ResultFormat.

The data format of the result of the SQL statement.

Public Property ResultRows System.Int64

Gets and sets the property ResultRows.

Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

Public Property ResultSize System.Int64

Gets and sets the property ResultSize.

The size in bytes of the returned results. A -1 indicates the value is null.

Public Property SecretArn System.String

Gets and sets the property SecretArn.

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

Public Property SessionId System.String

Gets and sets the property SessionId.

The session identifier of the query.

Public Property Status Amazon.RedshiftDataAPIService.StatusString

Gets and sets the property Status.

The status of the SQL statement being described. 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.

Public Property SubStatements System.Collections.Generic.List<Amazon.RedshiftDataAPIService.Model.SubStatementData>

Gets and sets the property SubStatements.

The SQL statements from a multiple statement run.

Public Property UpdatedAt System.DateTime

Gets and sets the property UpdatedAt.

The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

Public Property WorkgroupName System.String

Gets and sets the property WorkgroupName.

The serverless workgroup name or Amazon Resource Name (ARN).

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5