dynamodb
DynamoDB client.
Usageimport { createClient } from "https://denopkg.com/chiefbiiko/dynamodb/mod.ts" ;
const dyno = createClient ( ) ;
const result = await dyno. listTables ( ) ; The client config can be omitted entirely when calling createClient
. If that is the case the config will be derived from the environment and filesystem, in that order, using get-aws-config
.
Prefer using temporary credentials and a session token.
API Contents
Basics
Factory
Ops
Basics
export interface Doc {
[ key: string ] : any ;
}
export interface DynamoDBClient {
describeEndpoints : ( options? : Doc ) => Promise < Doc > ;
describeLimits : ( options? : Doc ) => Promise < Doc > ;
listTables : ( options? : Doc ) => Promise < Doc > ;
scan : (
params: Doc ,
options? : Doc
) => Promise < Doc | AsyncIterableIterator < Doc >> ;
query : (
params: Doc ,
options? : Doc
) => Promise < Doc | AsyncIterableIterator < Doc >> ;
[ key: string ] : ( params: Doc , options? : Doc ) => Promise < Doc > ;
}
export interface Credentials {
accessKeyId: string ;
secretAccessKey: string ;
sessionToken? : string ;
}
export interface ClientConfig {
credentials? : Credentials | ( ( ) => Credentials | Promise < Credentials > ) ;
region? : string ;
profile? : string ;
canonicalUri? : string ;
port? : number ;
}
export interface OpOptions {
wrapNumbers? : boolean ,
convertEmptyValues? : boolean ,
translateJSON? : boolean ,
iteratePages? : boolean
} Factory createClientcreateClient(conf: ClientConfig): DynamoDBClient
Creates a DynamoDB client.
OpsThe client supports all DynamoDB operations. Check the linked aws docs for info about parameters of a specific operation.
BatchGetItembatchGetItem(params: Doc, options?: OpOptions): Promise<Doc>
aws BatchGetItem docs
BatchWriteItembatchWriteItem(params: Doc, options?: OpOptions): Promise<Doc>
aws BatchWriteItem docs
CreateBackupcreateBackup(params: Doc, options?: OpOptions): Promise<Doc>
aws CreateBackup docs
CreateGlobalTablecreateGlobalTable(params: Doc, options?: OpOptions): Promise<Doc>
aws CreateGlobalTable docs
CreateTablecreateTable(params: Doc, options?: OpOptions): Promise<Doc>
aws CreateTable docs
DeleteBackupdeleteBackup(params: Doc, options?: OpOptions): Promise<Doc>
aws DeleteBackup docs
DeleteItemdeleteItem(params: Doc, options?: OpOptions): Promise<Doc>
aws DeleteItem docs
DeleteTabledeleteTable(params: Doc, options?: OpOptions): Promise<Doc>
aws DeleteTable docs
DescribeBackupdescribeBackup(params: Doc, options?: OpOptions): Promise<Doc>
aws DescribeBackup docs
DescribeContinuousBackupsdescribeContinuousBackups(params: Doc, options?: OpOptions): Promise<Doc>
aws DescribeContinuousBackups docs
DescribeEndpointsdescribeEndpoints(options?: OpOptions): Promise<Doc>
aws DescribeEndpoints docs
DescribeGlobalTabledescribeGlobalTable(params: Doc, options?: OpOptions): Promise<Doc>
aws DescribeGlobalTable docs
DescribeGlobalTableSettingsdescribeGlobalTableSettings(params: Doc, options?: OpOptions): Promise<Doc>
aws DescribeGlobalTableSettings docs
DescribeLimitsdescribeLimits(options?: OpOptions): Promise<Doc>
aws DescribeLimits docs
DescribeTabledescribeTable(params: Doc, options?: OpOptions): Promise<Doc>
aws DescribeTable docs
DescribeTimeToLivedescribeTimeToLive(params: Doc, options?: OpOptions): Promise<Doc>
aws DescribeTimeToLive docs
GetItemgetItem(params: Doc, options?: OpOptions): Promise<Doc>
aws GetItem docs
ListBackupslistBackups(params: Doc, options?: OpOptions): Promise<Doc>
aws ListBackups docs
ListGlobalTableslistGlobalTables(params: Doc, options?: OpOptions): Promise<Doc>
aws ListGlobalTables docs
ListTableslistTables(options?: OpOptions): Promise<Doc>
aws ListTables docs
aws ListTagsOfResource docs
PutItemputItem(params: Doc, options?: OpOptions): Promise<Doc>
aws PutItem docs
Queryquery(params: Doc, options?: OpOptions): Promise<Doc | AsyncIterableIterator<Doc>>
aws Query docs
RestoreTableFromBackuprestoreTableFromBackup(params: Doc, options?: OpOptions): Promise<Doc>
aws RestoreTableFromBackup docs
RestoreTableToPointInTimerestoreTableToPointInTime(params: Doc, options?: OpOptions): Promise<Doc>
aws RestoreTableToPointInTime docs
Scanscan(params: Doc, options?: OpOptions): Promise<Doc | AsyncIterableIterator<Doc>>
aws Scan docs
TagResourcetagResource(params: Doc, options?: OpOptions): Promise<Doc>
aws TagResource docs
TransactGetItemstransactGetItems(params: Doc, options?: OpOptions): Promise<Doc>
aws TransactGetItems docs
TransactWriteItemstransactWriteItems(params: Doc, options?: OpOptions): Promise<Doc>
aws TransactWriteItems docs
UntagResourceuntagResource(params: Doc, options?: OpOptions): Promise<Doc>
aws UntagResource docs
UpdateContinuousBackupsupdateContinuousBackups(params: Doc, options?: OpOptions): Promise<Doc>
aws UpdateContinuousBackups docs
UpdateGlobalTableupdateGlobalTable(params: Doc, options?: OpOptions): Promise<Doc>
aws UpdateGlobalTable docs
UpdateGlobalTableSettingsupdateGlobalTableSettings(params: Doc, options?: OpOptions): Promise<Doc>
aws UpdateGlobalTableSettings docs
UpdateItemupdateItem(params: Doc, options?: OpOptions): Promise<Doc>
aws UpdateItem docs
UpdateTableupdateTable(params: Doc, options?: OpOptions): Promise<Doc>
aws UpdateTable docs
UpdateTimeToLiveupdateTimeToLive(params: Doc, options?: OpOptions): Promise<Doc>
aws UpdateTimeToLive docs
FYIDon't want to do all development against the real AWS cloud?
LicenseMIT