guilopes04/aws-sdk-helper

AWS SDK Services Helper

Este pacote vai te ajudar a se conectar com os serviços da AWS de forma mais fácil e rápida, sem precisar se preocupar com documentação e quais os parâmetros necessários para funcionar.

Detalhes: esse projeto foi implementado utilizando typescript e versão v3 do SDK da AWS.

Serviços

DynamoDB

DynamoDB

Parameters: tableName: string, config?: DynamoDBClientConfig

getItem

Parameters: key: Record<string, any>

Return Type: Promise<GetCommandOutput>

getItemWithoutSK

Parameters: indexKeys: Record<string, any>, skName: string, indexName?: string

Return Type: Promise<GetCommandOutput>

putItem

Parameters: item: Record<string, any>

Return Type: Promise<PutCommandOutput>

query

Parameters: indexQueryParams: Record<string, any>, indexName?: string

Return Type: Promise<QueryCommandOutput>

updateItem

Parameters: key: Record<string, any>, item: Record<string, any>

Return Type: Promise<UpdateCommandOutput>

deleteItem

Parameters: key: Record<string, any>

Return Type: Promise<DeleteCommandOutput>

scan

Parameters: ``

Return Type: Promise<ScanCommandOutput>

---

Lambda

Lambda

Parameters: lambdaFunctionName: string, config?: LambdaClientConfig

invoke

Parameters: { payload, invocationType }: LambdaInvokeInputType

Return Type: Promise<InvokeCommandOutput>

---

SNS

SNS

Parameters: topicArn?: string, config?: SNSClientConfig

publish

Parameters: message: string

Return Type: Promise<PublishCommandOutput>

publishBatch

Parameters: messages: PublishBatchRequestEntry[]

Return Type: Promise<PublishCommandOutput>

sendSMS

Parameters: phoneNumber: string, message: string

Return Type: Promise<PublishCommandOutput>

publishCommand

Parameters: command: PublishCommandInput

Return Type: Promise<PublishCommandOutput>

---

SQS

SQS

Parameters: queueUrl: string, config?: SQSClientConfig

sendMessage

Parameters: messageBody: string

Return Type: Promise<SendMessageCommandOutput>

sendMessageBatch

Parameters: messages: Record<string, any>[]

Return Type: Promise<SendMessageCommandOutput>

receiveMessages

Parameters: maxNumberOfMessages: number = 1

Return Type: Promise<ReceiveMessageCommandOutput>

deleteMessage

Parameters: receiptHandle: string

Return Type: Promise<DeleteMessageCommandOutput>

---