Serialized Form (AWS Java SDK for Redshift Data API 1.12.1 API)

Package com.amazonaws.services.redshiftdataapi.model
- Class com.amazonaws.services.redshiftdataapi.model.ActiveStatementsExceededException extends AWSRedshiftDataAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.redshiftdataapi.model.AWSRedshiftDataAPIException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.redshiftdataapi.model.CancelStatementRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.
- Class com.amazonaws.services.redshiftdataapi.model.CancelStatementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
Boolean status
```
      A value that indicates whether the cancel statement succeeded (true).
- Class com.amazonaws.services.redshiftdataapi.model.ColumnMetadata extends Object implements Serializable
  - Serialized Fields
    - columnDefault
```
String columnDefault
```
      The default value of the column.
    - isCaseSensitive
```
Boolean isCaseSensitive
```
      A value that indicates whether the column is case-sensitive.
    - isCurrency
```
Boolean isCurrency
```
      A value that indicates whether the column contains currency values.
    - isSigned
```
Boolean isSigned
```
      A value that indicates whether an integer column is signed.
    - label
```
String label
```
      The label for the column.
    - length
```
Integer length
```
      The length of the column.
    - name
```
String name
```
      The name of the column.
    - nullable
```
Integer nullable
```
      A value that indicates whether the column is nullable.
    - precision
```
Integer precision
```
      The precision value of a decimal number column.
    - scale
```
Integer scale
```
      The scale value of a decimal number column.
    - schemaName
```
String schemaName
```
      The name of the schema that contains the table that includes the column.
    - tableName
```
String tableName
```
      The name of the table that includes the column.
    - typeName
```
String typeName
```
      The database-specific data type of the column.
- Class com.amazonaws.services.redshiftdataapi.model.DescribeStatementRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.
- Class com.amazonaws.services.redshiftdataapi.model.DescribeStatementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clusterIdentifier
```
String clusterIdentifier
```
      The cluster identifier.
    - createdAt
```
Date createdAt
```
      The date and time (UTC) when the SQL statement was submitted to run.
    - database
```
String database
```
      The name of the database.
    - dbUser
```
String dbUser
```
      The database user name.
    - duration
```
Long duration
```
      The amount of time in nanoseconds that the statement ran.
    - error
```
String error
```
      The error message from the cluster if the SQL statement encountered an error while running.
    - hasResultSet
```
Boolean hasResultSet
```
      A value that indicates whether the statement has a result set. The result set can be empty.
    - id
```
String id
```
      The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
    - queryString
```
String queryString
```
      The SQL statement text.
    - redshiftPid
```
Long redshiftPid
```
      The process identifier from Amazon Redshift.
    - redshiftQueryId
```
Long 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.
    - resultRows
```
Long 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.
    - resultSize
```
Long resultSize
```
      The size in bytes of the returned results.
    - secretArn
```
String secretArn
```
      The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
    - status
```
String 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.
    - updatedAt
```
Date 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.
- Class com.amazonaws.services.redshiftdataapi.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterIdentifier
```
String clusterIdentifier
```
      The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
    - connectedDatabase
```
String connectedDatabase
```
      A database name. The connected database is specified when you connect with your authentication credentials.
    - database
```
String database
```
      The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
    - dbUser
```
String dbUser
```
      The database user name. This parameter is required when authenticating using temporary credentials.
    - maxResults
```
Integer maxResults
```
      The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
    - nextToken
```
String 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.
    - schema
```
String schema
```
      The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
    - secretArn
```
String secretArn
```
      The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
    - table
```
String table
```
      The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned
- Class com.amazonaws.services.redshiftdataapi.model.DescribeTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - columnList
```
List<E> columnList
```
      A list of columns in the table.
    - nextToken
```
String 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.
    - tableName
```
String tableName
```
      The table name.
- Class com.amazonaws.services.redshiftdataapi.model.ExecuteStatementException extends AWSRedshiftDataAPIException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - statementId
```
String statementId
```
      Statement identifier of the exception.
- Class com.amazonaws.services.redshiftdataapi.model.ExecuteStatementRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterIdentifier
```
String clusterIdentifier
```
      The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
    - database
```
String database
```
      The name of the database. This parameter is required when authenticating using temporary credentials.
    - dbUser
```
String dbUser
```
      The database user name. This parameter is required when authenticating using temporary credentials.
    - secretArn
```
String secretArn
```
      The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
    - sql
```
String sql
```
      The SQL statement text to run.
    - statementName
```
String statementName
```
      The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
    - withEvent
```
Boolean withEvent
```
      A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
- Class com.amazonaws.services.redshiftdataapi.model.ExecuteStatementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clusterIdentifier
```
String clusterIdentifier
```
      The cluster identifier.
    - createdAt
```
Date createdAt
```
      The date and time (UTC) the statement was created.
    - database
```
String database
```
      The name of the database.
    - dbUser
```
String dbUser
```
      The database user name.
    - id
```
String id
```
      The identifier of the statement to be run. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
    - secretArn
```
String secretArn
```
      The name or ARN of the secret that enables access to the database.
- Class com.amazonaws.services.redshiftdataapi.model.Field extends Object implements Serializable
  - Serialized Fields
    - blobValue
```
ByteBuffer blobValue
```
      A value of the BLOB data type.
    - booleanValue
```
Boolean booleanValue
```
      A value of the Boolean data type.
    - doubleValue
```
Double doubleValue
```
      A value of the double data type.
    - isNull
```
Boolean isNull
```
      A value that indicates whether the data is NULL.
    - longValue
```
Long longValue
```
      A value of the long data type.
    - stringValue
```
String stringValue
```
      A value of the string data type.
- Class com.amazonaws.services.redshiftdataapi.model.GetStatementResultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.
    - nextToken
```
String 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.
- Class com.amazonaws.services.redshiftdataapi.model.GetStatementResultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - columnMetadata
```
List<E> columnMetadata
```
      The properties (metadata) of a column.
    - nextToken
```
String 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.
    - records
```
List<E> records
```
      The results of the SQL statement.
    - totalNumRows
```
Long totalNumRows
```
      The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.
- Class com.amazonaws.services.redshiftdataapi.model.InternalServerException extends AWSRedshiftDataAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.redshiftdataapi.model.ListDatabasesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterIdentifier
```
String clusterIdentifier
```
      The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
    - database
```
String database
```
      The name of the database. This parameter is required when authenticating using temporary credentials.
    - dbUser
```
String dbUser
```
      The database user name. This parameter is required when authenticating using temporary credentials.
    - maxResults
```
Integer maxResults
```
      The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
    - nextToken
```
String 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.
    - secretArn
```
String secretArn
```
      The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
- Class com.amazonaws.services.redshiftdataapi.model.ListDatabasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - databases
```
List<E> databases
```
      The names of databases.
    - nextToken
```
String 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.
- Class com.amazonaws.services.redshiftdataapi.model.ListSchemasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterIdentifier
```
String clusterIdentifier
```
      The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
    - connectedDatabase
```
String connectedDatabase
```
      A database name. The connected database is specified when you connect with your authentication credentials.
    - database
```
String database
```
      The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
    - dbUser
```
String dbUser
```
      The database user name. This parameter is required when authenticating using temporary credentials.
    - maxResults
```
Integer maxResults
```
      The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.
    - nextToken
```
String 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.
    - schemaPattern
```
String schemaPattern
```
      A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.
    - secretArn
```
String secretArn
```
      The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
- Class com.amazonaws.services.redshiftdataapi.model.ListSchemasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String 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.
    - schemas
```
List<E> schemas
```
      The schemas that match the request pattern.
- Class com.amazonaws.services.redshiftdataapi.model.ListStatementsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      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.
    - nextToken
```
String 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.
    - roleLevel
```
Boolean 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.
    - statementName
```
String statementName
```
      The name of the SQL statement specified as input to 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.
    - status
```
String 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.
- Class com.amazonaws.services.redshiftdataapi.model.ListStatementsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String 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.
    - statements
```
List<E> statements
```
      The SQL statements.
- Class com.amazonaws.services.redshiftdataapi.model.ListTablesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterIdentifier
```
String clusterIdentifier
```
      The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
    - connectedDatabase
```
String connectedDatabase
```
      A database name. The connected database is specified when you connect with your authentication credentials.
    - database
```
String database
```
      The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
    - dbUser
```
String dbUser
```
      The database user name. This parameter is required when authenticating using temporary credentials.
    - maxResults
```
Integer maxResults
```
      The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
    - nextToken
```
String 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.
    - schemaPattern
```
String schemaPattern
```
      A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
    - secretArn
```
String secretArn
```
      The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
    - tablePattern
```
String tablePattern
```
      A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
- Class com.amazonaws.services.redshiftdataapi.model.ListTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String 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.
    - tables
```
List<E> tables
```
      The tables that match the request pattern.
- Class com.amazonaws.services.redshiftdataapi.model.ResourceNotFoundException extends AWSRedshiftDataAPIException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      Resource identifier associated with the exception.
- Class com.amazonaws.services.redshiftdataapi.model.StatementData extends Object implements Serializable
  - Serialized Fields
    - createdAt
```
Date createdAt
```
      The date and time (UTC) the statement was created.
    - id
```
String id
```
      The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
    - queryString
```
String queryString
```
      The SQL statement.
    - secretArn
```
String secretArn
```
      The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
    - statementName
```
String statementName
```
      The name of the SQL statement.
    - status
```
String status
```
      The status of the SQL statement. An example is the that the SQL statement finished.
    - updatedAt
```
Date updatedAt
```
      The date and time (UTC) that the statement metadata was last updated.
- Class com.amazonaws.services.redshiftdataapi.model.TableMember extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the table.
    - schema
```
String schema
```
      The schema containing the table.
    - type
```
String type
```
      The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.
- Class com.amazonaws.services.redshiftdataapi.model.ValidationException extends AWSRedshiftDataAPIException implements Serializable
  
  serialVersionUID:
  
  1L

Serialized Form

Package com.amazonaws.services.redshiftdataapi.model

Class com.amazonaws.services.redshiftdataapi.model.ActiveStatementsExceededException extends AWSRedshiftDataAPIException implements Serializable

Class com.amazonaws.services.redshiftdataapi.model.AWSRedshiftDataAPIException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.redshiftdataapi.model.CancelStatementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

Class com.amazonaws.services.redshiftdataapi.model.CancelStatementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

status

Class com.amazonaws.services.redshiftdataapi.model.ColumnMetadata extends Object implements Serializable

Serialized Fields

columnDefault

isCaseSensitive

isCurrency

isSigned

label

length

name

nullable

precision

scale

schemaName

tableName

typeName

Class com.amazonaws.services.redshiftdataapi.model.DescribeStatementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

Class com.amazonaws.services.redshiftdataapi.model.DescribeStatementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

clusterIdentifier

createdAt

database

dbUser

duration

error

hasResultSet

id

queryString

redshiftPid

redshiftQueryId

resultRows

resultSize

secretArn

status

updatedAt

Class com.amazonaws.services.redshiftdataapi.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

connectedDatabase

database

dbUser

maxResults

nextToken

schema

secretArn

table

Class com.amazonaws.services.redshiftdataapi.model.DescribeTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

columnList

nextToken

tableName

Class com.amazonaws.services.redshiftdataapi.model.ExecuteStatementException extends AWSRedshiftDataAPIException implements Serializable

Serialized Fields

statementId

Class com.amazonaws.services.redshiftdataapi.model.ExecuteStatementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

database

dbUser

secretArn

sql

statementName

withEvent

Class com.amazonaws.services.redshiftdataapi.model.ExecuteStatementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

clusterIdentifier

createdAt

database

dbUser