Client library for Redshift Data API Service
npm install --save @datafire/amazonaws_redshift_data
let amazonaws_redshift_data = require('@datafire/amazonaws_redshift_data').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
.then(data => {
console.log(data);
});
You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run individual SQL statements, which are committed if the statement succeeds.
amazonaws_redshift_data.CancelStatement({
"Id": null
}, context)
- input
object
- Id required
- output CancelStatementResponse
amazonaws_redshift_data.DescribeStatement({
"Id": null
}, context)
- input
object
- Id required
- output DescribeStatementResponse
amazonaws_redshift_data.DescribeTable({
"ClusterIdentifier": null
}, context)
- input
object
- MaxResults
string
- NextToken
string
- ClusterIdentifier required
- Database
- DbUser
- MaxResults
- NextToken
- Schema
- SecretArn
- Table
- MaxResults
- output DescribeTableResponse
amazonaws_redshift_data.ExecuteStatement({
"ClusterIdentifier": null,
"Sql": null
}, context)
- input
object
- ClusterIdentifier required
- Database
- DbUser
- SecretArn
- Sql required
- StatementName
- WithEvent
- output ExecuteStatementOutput
amazonaws_redshift_data.GetStatementResult({
"Id": null
}, context)
- input
object
- NextToken
string
- Id required
- NextToken
- NextToken
- output GetStatementResultResponse
amazonaws_redshift_data.ListDatabases({
"ClusterIdentifier": null
}, context)
- input
object
- MaxResults
string
- NextToken
string
- ClusterIdentifier required
- Database
- DbUser
- MaxResults
- NextToken
- SecretArn
- MaxResults
- output ListDatabasesResponse
amazonaws_redshift_data.ListSchemas({
"ClusterIdentifier": null,
"Database": null
}, context)
- input
object
- MaxResults
string
- NextToken
string
- ClusterIdentifier required
- Database required
- DbUser
- MaxResults
- NextToken
- SchemaPattern
- SecretArn
- MaxResults
- output ListSchemasResponse
amazonaws_redshift_data.ListStatements({}, context)
- input
object
- MaxResults
string
- NextToken
string
- MaxResults
- NextToken
- StatementName
- Status
- MaxResults
- output ListStatementsResponse
amazonaws_redshift_data.ListTables({
"ClusterIdentifier": null,
"Database": null
}, context)
- input
object
- MaxResults
string
- NextToken
string
- ClusterIdentifier required
- Database required
- DbUser
- MaxResults
- NextToken
- SchemaPattern
- SecretArn
- TablePattern
- MaxResults
- output ListTablesResponse
- Blob
string
- Boolean
boolean
- BoxedBoolean
boolean
- BoxedDouble
number
- BoxedLong
integer
- CancelStatementRequest
object
- Id required
- CancelStatementResponse
object
- Status
- ColumnList
array
- items ColumnMetadata
- ColumnMetadata
object
: The properties (metadata) of a column.- columnDefault
- isCaseSensitive
- isCurrency
- isSigned
- label
- length
- name
- nullable
- precision
- scale
- schemaName
- tableName
- typeName
- ColumnMetadataList
array
- items ColumnMetadata
- DatabaseList
array
- items String
- DescribeStatementRequest
object
- Id required
- DescribeStatementResponse
object
- ClusterIdentifier
- CreatedAt
- Database
- DbUser
- Duration
- Error
- Id required
- QueryString
- RedshiftPid
- RedshiftQueryId
- ResultRows
- ResultSize
- SecretArn
- Status
- UpdatedAt
- DescribeTableRequest
object
- ClusterIdentifier required
- Database
- DbUser
- MaxResults
- NextToken
- Schema
- SecretArn
- Table
- DescribeTableResponse
object
- ColumnList
- items ColumnMetadata
- NextToken
- TableName
- ColumnList
- ExecuteStatementInput
object
- ClusterIdentifier required
- Database
- DbUser
- SecretArn
- Sql required
- StatementName
- WithEvent
- ExecuteStatementOutput
object
- ClusterIdentifier
- CreatedAt
- Database
- DbUser
- Id
- SecretArn
- Field
object
: A data value in a column.- blobValue
- booleanValue
- doubleValue
- isNull
- longValue
- stringValue
- FieldList
array
- items Field
- GetStatementResultRequest
object
- Id required
- NextToken
- GetStatementResultResponse
object
- ColumnMetadata
- items ColumnMetadata
- NextToken
- Records required
- items FieldList
- TotalNumRows
- ColumnMetadata
- Integer
integer
- ListDatabasesRequest
object
- ClusterIdentifier required
- Database
- DbUser
- MaxResults
- NextToken
- SecretArn
- ListDatabasesResponse
object
- Databases
- items String
- NextToken
- Databases
- ListSchemasRequest
object
- ClusterIdentifier required
- Database required
- DbUser
- MaxResults
- NextToken
- SchemaPattern
- SecretArn
- ListSchemasResponse
object
- NextToken
- Schemas
- items String
- ListStatementsLimit
integer
- ListStatementsRequest
object
- MaxResults
- NextToken
- StatementName
- Status
- ListStatementsResponse
object
- NextToken
- Statements required
- items StatementData
- ListTablesRequest
object
- ClusterIdentifier required
- Database required
- DbUser
- MaxResults
- NextToken
- SchemaPattern
- SecretArn
- TablePattern
- ListTablesResponse
object
- NextToken
- Tables
- items TableMember
- Location
string
- Long
integer
- PageSize
integer
- SchemaList
array
- items String
- SecretArn
string
- SqlRecords
array
- items FieldList
- StatementData
object
: The SQL statement to run.- CreatedAt
- Id required
- QueryString
- SecretArn
- StatementName
- Status
- UpdatedAt
- StatementList
array
- items StatementData
- StatementNameString
string
- StatementString
string
- StatusString
string
(values: ABORTED, ALL, FAILED, FINISHED, PICKED, STARTED, SUBMITTED)
- String
string
- TableList
array
- items TableMember
- TableMember
object
: The properties of a table.- name
- schema
- type
- Timestamp
string
- UUID
string
- bool
boolean