@datafire/amazonaws_athena v5.0.0

@datafire/amazonaws_athena

Client library for Amazon Athena

Installation and Usage

npm install --save @datafire/amazonaws_athena

let amazonaws_athena = require('@datafire/amazonaws_athena').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_athena.BatchGetNamedQuery({
  "NamedQueryIds": []
}).then(data => {
  console.log(data);
});

Description

Actions

BatchGetNamedQuery

amazonaws_athena.BatchGetNamedQuery({
  "NamedQueryIds": []
}, context)

Input

• input object
  • NamedQueryIds required NamedQueryIdList

Output

• output BatchGetNamedQueryOutput

BatchGetQueryExecution

amazonaws_athena.BatchGetQueryExecution({
  "QueryExecutionIds": []
}, context)

Input

• input object
  • QueryExecutionIds required QueryExecutionIdList

Output

• output BatchGetQueryExecutionOutput

CreateNamedQuery

amazonaws_athena.CreateNamedQuery({
  "Name": "",
  "Database": "",
  "QueryString": ""
}, context)

Input

• input object
  • ClientRequestToken IdempotencyToken
  • Database required DatabaseString
  • Description DescriptionString
  • Name required NameString
  • QueryString required QueryString

Output

• output CreateNamedQueryOutput

DeleteNamedQuery

amazonaws_athena.DeleteNamedQuery({
  "NamedQueryId": ""
}, context)

Input

• input object
  • NamedQueryId required NamedQueryId

Output

• output DeleteNamedQueryOutput

GetNamedQuery

amazonaws_athena.GetNamedQuery({
  "NamedQueryId": ""
}, context)

Input

• input object
  • NamedQueryId required NamedQueryId

Output

• output GetNamedQueryOutput

GetQueryExecution

amazonaws_athena.GetQueryExecution({
  "QueryExecutionId": ""
}, context)

Input

• input object
  • QueryExecutionId required QueryExecutionId

Output

• output GetQueryExecutionOutput

GetQueryResults

amazonaws_athena.GetQueryResults({
  "QueryExecutionId": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxQueryResults
  • NextToken Token
  • QueryExecutionId required QueryExecutionId

Output

• output GetQueryResultsOutput

ListNamedQueries

amazonaws_athena.ListNamedQueries({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxNamedQueriesCount
  • NextToken Token

Output

• output ListNamedQueriesOutput

ListQueryExecutions

amazonaws_athena.ListQueryExecutions({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxQueryExecutionsCount
  • NextToken Token

Output

• output ListQueryExecutionsOutput

StartQueryExecution

amazonaws_athena.StartQueryExecution({
  "QueryString": "",
  "ResultConfiguration": {
    "OutputLocation": ""
  }
}, context)

Input

• input object
  • ClientRequestToken IdempotencyToken
  • QueryExecutionContext QueryExecutionContext
  • QueryString required QueryString
  • ResultConfiguration required ResultConfiguration

Output

• output StartQueryExecutionOutput

StopQueryExecution

amazonaws_athena.StopQueryExecution({
  "QueryExecutionId": ""
}, context)

Input

• input object
  • QueryExecutionId required QueryExecutionId

Output

• output StopQueryExecutionOutput

Definitions

BatchGetNamedQueryInput

• BatchGetNamedQueryInput object
  • NamedQueryIds required NamedQueryIdList

BatchGetNamedQueryOutput

• BatchGetNamedQueryOutput object
  • NamedQueries NamedQueryList
  • UnprocessedNamedQueryIds UnprocessedNamedQueryIdList

BatchGetQueryExecutionInput

• BatchGetQueryExecutionInput object
  • QueryExecutionIds required QueryExecutionIdList

BatchGetQueryExecutionOutput

• BatchGetQueryExecutionOutput object
  • QueryExecutions QueryExecutionList
  • UnprocessedQueryExecutionIds UnprocessedQueryExecutionIdList

Boolean

• Boolean boolean

ColumnInfo

• ColumnInfo object: Information about the columns in a query execution result.
  • CaseSensitive Boolean
  • CatalogName String
  • Label String
  • Name required String
  • Nullable ColumnNullable
  • Precision Integer
  • Scale Integer
  • SchemaName String
  • TableName String
  • Type required String

ColumnInfoList

• ColumnInfoList array
  • items ColumnInfo

ColumnNullable

• ColumnNullable string (values: NOT_NULL, NULLABLE, UNKNOWN)

CreateNamedQueryInput

• CreateNamedQueryInput object
  • ClientRequestToken IdempotencyToken
  • Database required DatabaseString
  • Description DescriptionString
  • Name required NameString
  • QueryString required QueryString

CreateNamedQueryOutput

• CreateNamedQueryOutput object
  • NamedQueryId NamedQueryId

DatabaseString

• DatabaseString string

Date

• Date string

Datum

• Datum object: A piece of data (a field in the table).
  • VarCharValue datumString

DeleteNamedQueryInput

• DeleteNamedQueryInput object
  • NamedQueryId required NamedQueryId

DeleteNamedQueryOutput

• DeleteNamedQueryOutput object

DescriptionString

• DescriptionString string

EncryptionConfiguration

• EncryptionConfiguration object: If query results are encrypted in Amazon S3, indicates the Amazon S3 encryption option used.
  • EncryptionOption required EncryptionOption
  • KmsKey String

EncryptionOption

• EncryptionOption string (values: SSE_S3, SSE_KMS, CSE_KMS)

ErrorCode

• ErrorCode string

ErrorMessage

• ErrorMessage string

GetNamedQueryInput

• GetNamedQueryInput object
  • NamedQueryId required NamedQueryId

GetNamedQueryOutput

• GetNamedQueryOutput object
  • NamedQuery NamedQuery

GetQueryExecutionInput

• GetQueryExecutionInput object
  • QueryExecutionId required QueryExecutionId

GetQueryExecutionOutput

• GetQueryExecutionOutput object
  • QueryExecution QueryExecution

GetQueryResultsInput

• GetQueryResultsInput object
  • MaxResults MaxQueryResults
  • NextToken Token
  • QueryExecutionId required QueryExecutionId

GetQueryResultsOutput

• GetQueryResultsOutput object
  • NextToken Token
  • ResultSet ResultSet

IdempotencyToken

• IdempotencyToken string

Integer

• Integer integer

InternalServerException

• InternalServerException object: Indicates a platform issue, which may be due to a transient condition or outage.
  • Message ErrorMessage

InvalidRequestException

• InvalidRequestException object: Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
  • AthenaErrorCode ErrorCode
  • Message ErrorMessage

ListNamedQueriesInput

• ListNamedQueriesInput object
  • MaxResults MaxNamedQueriesCount
  • NextToken Token

ListNamedQueriesOutput

• ListNamedQueriesOutput object
  • NamedQueryIds NamedQueryIdList
  • NextToken Token

ListQueryExecutionsInput

• ListQueryExecutionsInput object
  • MaxResults MaxQueryExecutionsCount
  • NextToken Token

ListQueryExecutionsOutput

• ListQueryExecutionsOutput object
  • NextToken Token
  • QueryExecutionIds QueryExecutionIdList

Long

• Long integer

MaxNamedQueriesCount

• MaxNamedQueriesCount integer

MaxQueryExecutionsCount

• MaxQueryExecutionsCount integer

MaxQueryResults

• MaxQueryResults integer

NameString

• NameString string

NamedQuery

• NamedQuery object: A query, where QueryString is the SQL query statements that comprise the query.
  • Database required DatabaseString
  • Description DescriptionString
  • Name required NameString
  • NamedQueryId NamedQueryId
  • QueryString required QueryString

NamedQueryId

• NamedQueryId string

NamedQueryIdList

• NamedQueryIdList array
  • items NamedQueryId

NamedQueryList

• NamedQueryList array
  • items NamedQuery

QueryExecution

• QueryExecution object: Information about a single instance of a query execution.
  • Query QueryString
  • QueryExecutionContext QueryExecutionContext
  • QueryExecutionId QueryExecutionId
  • ResultConfiguration ResultConfiguration
  • Statistics QueryExecutionStatistics
  • Status QueryExecutionStatus

QueryExecutionContext

• QueryExecutionContext object: The database in which the query execution occurs.
  • Database DatabaseString

QueryExecutionId

• QueryExecutionId string

QueryExecutionIdList

• QueryExecutionIdList array
  • items QueryExecutionId

QueryExecutionList

• QueryExecutionList array
  • items QueryExecution

QueryExecutionState

• QueryExecutionState string (values: QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELLED)

QueryExecutionStatistics

• QueryExecutionStatistics object: The amount of data scanned during the query execution and the amount of time that it took to execute.
  • DataScannedInBytes Long
  • EngineExecutionTimeInMillis Long

QueryExecutionStatus

• QueryExecutionStatus object: The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
  • CompletionDateTime Date
  • State QueryExecutionState
  • StateChangeReason String
  • SubmissionDateTime Date

QueryString

• QueryString string

ResultConfiguration

• ResultConfiguration object: The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.
  • EncryptionConfiguration EncryptionConfiguration
  • OutputLocation required String

ResultSet

• ResultSet object: The metadata and rows that comprise a query result set. The metadata describes the column structure and data types.
  • ResultSetMetadata ResultSetMetadata
  • Rows RowList

ResultSetMetadata

• ResultSetMetadata object: The metadata that describes the column structure and data types of a table of query results.
  • ColumnInfo ColumnInfoList

Row

• Row object: The rows that comprise a query result table.
  • Data datumList

RowList

• RowList array
  • items Row

StartQueryExecutionInput

• StartQueryExecutionInput object
  • ClientRequestToken IdempotencyToken
  • QueryExecutionContext QueryExecutionContext
  • QueryString required QueryString
  • ResultConfiguration required ResultConfiguration

StartQueryExecutionOutput

• StartQueryExecutionOutput object
  • QueryExecutionId QueryExecutionId

StopQueryExecutionInput

• StopQueryExecutionInput object
  • QueryExecutionId required QueryExecutionId

StopQueryExecutionOutput

• StopQueryExecutionOutput object

String

• String string

ThrottleReason

• ThrottleReason string (values: CONCURRENT_QUERY_LIMIT_EXCEEDED)

Token

• Token string

TooManyRequestsException

• TooManyRequestsException object: Indicates that the request was throttled.
  • Message ErrorMessage
  • Reason ThrottleReason

UnprocessedNamedQueryId

• UnprocessedNamedQueryId object: Information about a named query ID that could not be processed.
  • ErrorCode ErrorCode
  • ErrorMessage ErrorMessage
  • NamedQueryId NamedQueryId

UnprocessedNamedQueryIdList

• UnprocessedNamedQueryIdList array
  • items UnprocessedNamedQueryId

UnprocessedQueryExecutionId

• UnprocessedQueryExecutionId object: Describes a query execution that failed to process.
  • ErrorCode ErrorCode
  • ErrorMessage ErrorMessage
  • QueryExecutionId QueryExecutionId

UnprocessedQueryExecutionIdList

• UnprocessedQueryExecutionIdList array
  • items UnprocessedQueryExecutionId

datumList

• datumList array
  • items Datum

datumString

• datumString string