@pureskillgg/awsjs 1.8.0

DynamodbDocumentClient

lib/clients/dynamodb-document.doc.js

AWS DynamoDB document client.

new DynamodbDocumentClient(parameters: Object)

Parameters

parameters (Object)

Name	Description
parameters.tableName `string`	Table name.
parameters.hashKey `string`	Table hash key.
parameters.rangeKey `string?`	Table range key.
parameters.translateConfig `Object` (default `defaultTranslateConfig`)	Translate config.
parameters.createAwsDynamoDBDocumentClient `function` (default `DynamoDBDocumentClient.from`)	Factory to create a DynamoDBDocumentClient.
parameters.name `string` (default `dynamodb-document`)	Client name.
parameters.reqId `string` (default `<uuid>`)	Request id.
parameters.log `Object` (default `<logger>`)	Pino compatible logger.
parameters.AwsDynamoDBClient `Constructor` (default `DynamoDBClient`)	Constructor for a DynamoDBClient from the AWS SDK.
parameters.params `Object` (default `{}`)	Additional params to pass to the AwsDynamoDBClient constructor.

Properties

db (Object) : Raw DynamoDBClient.

tableName (Object) : Configured table name.

Instance Members

▸ get(key, params)

lib/clients/dynamodb-document.doc.js

Get an item from the DynamoDB table.

get(key: Object, params: Object): Promise<[Object, Object]>

Parameters

key (Object) Item hash and range key.

params

(Object
            = {})

Additional params to pass to the GetCommand.

Returns

Promise<[Object, Object]>: Tuple of the item and other response properties normalized to camel case.

Throws

DynamodbMissingKeyError: Thrown when the input is missing the hashKey or rangeKey.

▸ put(item, params)

lib/clients/dynamodb-document.doc.js

Put an item into the DynamoDB table.

put(item: Object, params: Object): Promise<Object>

Parameters

item (Object) Item to put.

params

(Object
            = {})

Additional params to pass to the PutCommand.

Returns

Promise<Object>: Response normalized to camel case.

Throws

DynamodbMissingKeyError: Thrown when the input is missing the hashKey or rangeKey.

▸ update(key, params)

lib/clients/dynamodb-document.doc.js

Update an item from the DynamoDB table.

update(key: Object, params: Object): Promise<Object>

Parameters

key (Object) Item hash and range key.

params

(Object
            = {})

Additional params to pass to the UpdateCommand.

Returns

Promise<Object>: Response normalized to camel case.

Throws

DynamodbMissingKeyError: Thrown when the input is missing the hashKey or rangeKey.

▸ delete(key, params)

lib/clients/dynamodb-document.doc.js

Delete an item from the DynamoDB table.

delete(key: Object, params: Object): Promise<Object>

Parameters

key (Object) Item hash and range key.

params

(Object
            = {})

Additional params to pass to the DeleteCommand.

Returns

Promise<Object>: Response normalized to camel case.

Throws

DynamodbMissingKeyError: Thrown when the input is missing the hashKey or rangeKey.

▸ query(params)

lib/clients/dynamodb-document.doc.js

Query the DynamoDB table.

query(params: Object): Promise<[Array<Object>, Object]>

Parameters

params

(Object
            = {})

Additional params to pass to the QueryCommand.

Returns

Promise<[Array<Object>, Object]>: Tuple of the items and other response properties normalized to camel case.

▸ transactGet(transactItems, params)

lib/clients/dynamodb-document.doc.js

Get items from one or more DynamoDB tables using a transaction.

transactGet(transactItems: Array<Object>, params: Object): Promise<[Array<Object>, Array<Object>]>

Parameters

transactItems (Array<Object>) Array of TransactGetItem objects. The default tableName will be used for each object if not overridden.

params

(Object
            = {})

Additional params to pass to the TransactGetCommand.

Returns

Promise<[Array<Object>, Array<Object>]>: Tuple of the array of transaction-ordered items and array of transaction-ordered metrics normalized to camel case.

▸ transactWrite(transactItems, params)

lib/clients/dynamodb-document.doc.js

Write items to one or more DynamoDB tables using a transaction.

transactWrite(transactItems: Array<Object>, params: Object): Promise<[Array<Object>, Object]>

Parameters

transactItems (Array<Object>) Array of TransactWriteItem objects. The default tableName will be used for each object if not overridden.

params

(Object
            = {})

Additional params to pass to the TransactWriteCommand.

Returns

Promise<[Array<Object>, Object]>: Tuple of the array of transaction-ordered metrics and other response properties normalized to camel case.

DynamodbMissingKeyError

lib/clients/dynamodb-document.doc.js

AWS DynamoDB missing key error.

new DynamodbMissingKeyError(keyType: string, keyName: string)

Extends Error

Parameters

keyType (string) The type of key that is missing: hashKey or rangeKey.

keyName (string) The corresponding key name for this table.

Properties

keyType (string) : The type of key that is missing: hashKey or rangeKey.

keyName (string) : The corresponding key name for this table.

EventbridgeClient

lib/clients/eventbridge.doc.js

AWS EventBridge client.

new EventbridgeClient(parameters: Object)

Parameters

parameters (Object)

Name	Description
parameters.eventBusName `string`	Event bus name.
parameters.name `string` (default `eventbridge`)	Client name.
parameters.reqId `string` (default `<uuid>`)	Request id.
parameters.log `Object` (default `<logger>`)	Pino compatible logger.
parameters.AwsEventBridgeClient `Constructor` (default `EventBridgeClient`)	Constructor for an EventBridgeClient from the AWS SDK.
parameters.params `Object` (default `{}`)	Additional params to pass to the AwsEventBridgeClient constructor.

Instance Members

▸ putEvents(events, params)

lib/clients/eventbridge.doc.js

Send events to the EventBridge Event Bus.

putEvents(events: Array<Object>, params: Object): Promise<Object>

Parameters

events

(Array<Object>
            = [])

Event entries to send (with EventBusName omitted).

params

(Object
            = [])

Additional params to pass to the PutEventsCommand.

Returns

Promise<Object>: Response normalized to camel case.

Throws

EventbridgeFailedEntriesError: Thrown when the response contains failed entries.

EventbridgeFailedEntriesError

lib/clients/eventbridge.doc.js

AWS EventBridge failed entries error.

new EventbridgeFailedEntriesError(res: PutEventsCommandOutput)

Extends Error

Parameters

res (PutEventsCommandOutput)

Properties

failedEntryCount (number) : Number of failed entries.

data (Array<Object>) : Event entries response normalized to camel case.

PutEventsCommandOutput

lib/clients/eventbridge.doc.js

PutEventsCommandOutput

LambdaClient

lib/clients/lambda.doc.js

AWS Lambda client.

new LambdaClient(parameters: Object)

Parameters

parameters (Object)

Name	Description
parameters.functionName `string`	Lambda function name.
parameters.name `string` (default `lambda`)	Client name.
parameters.reqId `string` (default `<uuid>`)	Request id.
parameters.log `Object` (default `<logger>`)	Pino compatible logger.
parameters.AwsLambdaClient `Constructor` (default `LambdaClient`)	Constructor for a LambdaClient from the AWS SDK.
parameters.params `Object` (default `{}`)	Additional params to pass to the AwsLambdaClient constructor.

Instance Members

▸ invokeJson(payload, params)

lib/clients/lambda.doc.js

Invoke the Lambda function with a JSON payload.

invokeJson(payload: Object, params: Object): Promise<Object>

Parameters

payload (Object) JSON serializable request payload.

params

(Object
            = {})

Additional params to pass to the InvokeCommand.

Returns

Promise<Object>: Lambda function response payload parsed as JSON.

Throws

LambdaFunctionError: Thrown when the response contains a FunctionError.
LambdaStatusCodeError: Thrown when the response StatusCode is not 2xx.

LambdaFunctionError

lib/clients/lambda.doc.js

AWS Lambda function error.

new LambdaFunctionError(res: InvokeCommandOutput)

Extends Error

Parameters

res (InvokeCommandOutput)

Properties

data (Object) : Lambda function response payload parsed as JSON.

LambdaStatusCodeError

lib/clients/lambda.doc.js

AWS Lambda status code error.

new LambdaStatusCodeError(res: InvokeCommandOutput)

Extends Error

Parameters

res (InvokeCommandOutput)

Properties

statusCode (number) : Status code from invoking the Lambda function.

InvokeCommandOutput

lib/clients/lambda.doc.js

InvokeCommandOutput

S3Client

lib/clients/s3.doc.js

AWS S3 client.

new S3Client(parameters: Object)

Parameters

parameters (Object)

Name	Description
parameters.bucket `string`	Bucket name.
parameters.name `string` (default `s3`)	Client name.
parameters.reqId `string` (default `<uuid>`)	Request id.
parameters.log `Object` (default `<logger>`)	Pino compatible logger.
parameters.AwsS3Client `Constructor` (default `S3Client`)	Constructor for an S3Client from the AWS SDK.
parameters.params `Object` (default `{}`)	Additional params to pass to the AwsS3Client constructor.

Instance Members

▸ putObjectJson(key, body, params)

lib/clients/s3.doc.js

Put a JSON serializable object to the S3 bucket. If a gzip Content-Encoding is set, automatically compress.

putObjectJson(key: string, body: Object, params: Object): Promise<Object>

Parameters

key (string) S3 object key.

body (Object) JSON serializable S3 object body.

params

(Object
            = {})

Additional params to pass to the PutObjectCommand.

Returns

Promise<Object>: Response normalized to camel case.

▸ getObjectJson(key, params)

lib/clients/s3.doc.js

Get a JSON serializable object from the S3 bucket. If a gzip Content-Encoding is set, automatically decompress.

getObjectJson(key: string, params: Object): Promise<Object>

Parameters

key (string) S3 object key.

params

(Object
            = {})

Additional params to pass to the GetObjectCommand.

Returns

Promise<Object>: Response normalized to camel case.

SchedulerClient

lib/clients/scheduler.doc.js

AWS SchedulerClient client.

new SchedulerClient(parameters: Object)

Parameters

parameters (Object)

Name	Description
parameters.groupName `string` (default `default`)	Schedule group name.
parameters.name `string` (default `scheduler`)	Client name.
parameters.reqId `string` (default `<uuid>`)	Request id.
parameters.log `Object` (default `<logger>`)	Pino compatible logger.
parameters.AwsSdkSchedulerClient `Constructor` (default `SchedulerClient`)	Constructor for a SchedulerClient from the AWS SDK.
parameters.params `Object` (default `{}`)	Additional params to pass to the AwsSdkSchedulerClient constructor.

Instance Members

▸ getSchedule(name?, params)

lib/clients/scheduler.doc.js

Get a schedule.

getSchedule(name: Array<Object>?, params: Object): Promise<Object>

Parameters

name (Array<Object>?) Name of the schedule to get.

params

(Object
            = [])

Additional params to pass to the GetScheduleCommand.

Returns

Promise<Object>: Response normalized to camel case.

▸ createSchedule(name?, params)

lib/clients/scheduler.doc.js

Create a schedule.

createSchedule(name: Array<Object>?, params: Object): Promise<Object>

Parameters

name (Array<Object>?) Name of the schedule to create.

params

(Object
            = [])

Additional params to pass to the CreateScheduleCommand.

Returns

Promise<Object>: Response normalized to camel case.

▸ deleteSchedule(name?, params)

lib/clients/scheduler.doc.js

Delete a schedule.

deleteSchedule(name: Array<Object>?, params: Object): Promise<Object>

Parameters

name (Array<Object>?) Name of the schedule to delete.

params

(Object
            = [])

Additional params to pass to the DeleteScheduleCommand.

Returns

Promise<Object>: Response normalized to camel case.

▸ deleteSchedule(name?, params)

lib/clients/scheduler.doc.js

Update a schedule. AWS uses a replace all attributes strategy when updating schedules. AWS schedules

deleteSchedule(name: Array<Object>?, params: Object): Promise<Object>

Parameters

name (Array<Object>?) Name of the schedule to update.

params

(Object
            = [])

Additional params to pass to the UpdateScheduleCommand.

Returns

Promise<Object>: Response normalized to camel case.

SqsClient

lib/clients/sqs.doc.js

AWS SQS client.

new SqsClient(parameters: Object)

Parameters

parameters (Object)

Name	Description
parameters.queueUrl `string`	Queue URL.
parameters.name `string` (default `sqs`)	Client name.
parameters.reqId `string` (default `<uuid>`)	Request id.
parameters.log `Object` (default `<logger>`)	Pino compatible logger.
parameters.AwsSQSClient `Constructor` (default `SQSClient`)	Constructor for an SQSClient from the AWS SDK.
parameters.params `Object` (default `{}`)	Additional params to pass to the AwsSQSClient constructor.

Instance Members

▸ sendMessageJson(message, params)

lib/clients/sqs.doc.js

Send a JSON serializable message to the SQS queue.

sendMessageJson(message: Object, params: Object): Promise<Object>

Parameters

message (Object) JSON serializable SQS message body.

params

(Object
            = {})

Additional params to pass to the SendMessageCommand.

Returns

Promise<Object>: Response normalized to camel case.