@datafire/amazonaws_redshift_data v5.0.0

@datafire/amazonaws_redshift_data

Client library for Redshift Data API Service

Installation and Usage

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);
});

Description

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.

Actions

CancelStatement

amazonaws_redshift_data.CancelStatement({
  "Id": null
}, context)

Input

• input object
  • Id required

Output

• output CancelStatementResponse

DescribeStatement

amazonaws_redshift_data.DescribeStatement({
  "Id": null
}, context)

Input

• input object
  • Id required

Output

• output DescribeStatementResponse

DescribeTable

amazonaws_redshift_data.DescribeTable({
  "ClusterIdentifier": null
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • ClusterIdentifier required
  • Database
  • DbUser
  • MaxResults
  • NextToken
  • Schema
  • SecretArn
  • Table

Output

• output DescribeTableResponse

ExecuteStatement

amazonaws_redshift_data.ExecuteStatement({
  "ClusterIdentifier": null,
  "Sql": null
}, context)

Input

• input object
  • ClusterIdentifier required
  • Database
  • DbUser
  • SecretArn
  • Sql required
  • StatementName
  • WithEvent

Output

• output ExecuteStatementOutput

GetStatementResult

amazonaws_redshift_data.GetStatementResult({
  "Id": null
}, context)

Input

• input object
  • NextToken string
  • Id required
  • NextToken

Output

• output GetStatementResultResponse

ListDatabases

amazonaws_redshift_data.ListDatabases({
  "ClusterIdentifier": null
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • ClusterIdentifier required
  • Database
  • DbUser
  • MaxResults
  • NextToken
  • SecretArn

Output

• output ListDatabasesResponse

ListSchemas

amazonaws_redshift_data.ListSchemas({
  "ClusterIdentifier": null,
  "Database": null
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • ClusterIdentifier required
  • Database required
  • DbUser
  • MaxResults
  • NextToken
  • SchemaPattern
  • SecretArn

Output

• output ListSchemasResponse

ListStatements

amazonaws_redshift_data.ListStatements({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults
  • NextToken
  • StatementName
  • Status

Output

• output ListStatementsResponse

ListTables

amazonaws_redshift_data.ListTables({
  "ClusterIdentifier": null,
  "Database": null
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • ClusterIdentifier required
  • Database required
  • DbUser
  • MaxResults
  • NextToken
  • SchemaPattern
  • SecretArn
  • TablePattern

Output

• output ListTablesResponse

Definitions

Blob

• Blob string

Boolean

• Boolean boolean

BoxedBoolean

• BoxedBoolean boolean

BoxedDouble

• BoxedDouble number

BoxedLong

• BoxedLong integer

CancelStatementRequest

• CancelStatementRequest object
  • Id required

CancelStatementResponse

• CancelStatementResponse object
  • Status

ColumnList

• ColumnList array
  • items ColumnMetadata

ColumnMetadata

• ColumnMetadata object: The properties (metadata) of a column.
  • columnDefault
  • isCaseSensitive
  • isCurrency
  • isSigned
  • label
  • length
  • name
  • nullable
  • precision
  • scale
  • schemaName
  • tableName
  • typeName

ColumnMetadataList

• ColumnMetadataList array
  • items ColumnMetadata

DatabaseList

• DatabaseList array
  • items String

DescribeStatementRequest

• DescribeStatementRequest object
  • Id required

DescribeStatementResponse

• DescribeStatementResponse object
  • ClusterIdentifier
  • CreatedAt
  • Database
  • DbUser
  • Duration
  • Error
  • Id required
  • QueryString
  • RedshiftPid
  • RedshiftQueryId
  • ResultRows
  • ResultSize
  • SecretArn
  • Status
  • UpdatedAt

DescribeTableRequest

• DescribeTableRequest object
  • ClusterIdentifier required
  • Database
  • DbUser
  • MaxResults
  • NextToken
  • Schema
  • SecretArn
  • Table

DescribeTableResponse

• DescribeTableResponse object
  • ColumnList
    • items ColumnMetadata
  • NextToken
  • TableName

ExecuteStatementException

ExecuteStatementInput

• ExecuteStatementInput object
  • ClusterIdentifier required
  • Database
  • DbUser
  • SecretArn
  • Sql required
  • StatementName
  • WithEvent

ExecuteStatementOutput

• ExecuteStatementOutput object
  • ClusterIdentifier
  • CreatedAt
  • Database
  • DbUser
  • Id
  • SecretArn

Field

• Field object: A data value in a column.
  • blobValue
  • booleanValue
  • doubleValue
  • isNull
  • longValue
  • stringValue

FieldList

• FieldList array
  • items Field

GetStatementResultRequest

• GetStatementResultRequest object
  • Id required
  • NextToken

GetStatementResultResponse

• GetStatementResultResponse object
  • ColumnMetadata
    • items ColumnMetadata
  • NextToken
  • Records required
    • items FieldList
  • TotalNumRows

Integer

• Integer integer

InternalServerException

ListDatabasesRequest

• ListDatabasesRequest object
  • ClusterIdentifier required
  • Database
  • DbUser
  • MaxResults
  • NextToken
  • SecretArn

ListDatabasesResponse

• ListDatabasesResponse object
  • Databases
    • items String
  • NextToken

ListSchemasRequest

• ListSchemasRequest object
  • ClusterIdentifier required
  • Database required
  • DbUser
  • MaxResults
  • NextToken
  • SchemaPattern
  • SecretArn

ListSchemasResponse

• ListSchemasResponse object
  • NextToken
  • Schemas
    • items String

ListStatementsLimit

• ListStatementsLimit integer

ListStatementsRequest

• ListStatementsRequest object
  • MaxResults
  • NextToken
  • StatementName
  • Status

ListStatementsResponse

• ListStatementsResponse object
  • NextToken
  • Statements required
    • items StatementData

ListTablesRequest

• ListTablesRequest object
  • ClusterIdentifier required
  • Database required
  • DbUser
  • MaxResults
  • NextToken
  • SchemaPattern
  • SecretArn
  • TablePattern

ListTablesResponse

• ListTablesResponse object
  • NextToken
  • Tables
    • items TableMember

Location

• Location string

Long

• Long integer

PageSize

• PageSize integer

ResourceNotFoundException

SchemaList

• SchemaList array
  • items String

SecretArn

• SecretArn string

SqlRecords

• SqlRecords array
  • items FieldList

StatementData

• StatementData object: The SQL statement to run.
  • CreatedAt
  • Id required
  • QueryString
  • SecretArn
  • StatementName
  • Status
  • UpdatedAt

StatementList

• StatementList array
  • items StatementData

StatementNameString

• StatementNameString string

StatementString

• StatementString string

StatusString

• StatusString string (values: ABORTED, ALL, FAILED, FINISHED, PICKED, STARTED, SUBMITTED)

String

• String string

TableList

• TableList array
  • items TableMember

TableMember

• TableMember object: The properties of a table.
  • name
  • schema
  • type

Timestamp

• Timestamp string

UUID

• UUID string

ValidationException

bool

• bool boolean