5.0.0 • Published 7 years ago

@datafire/amazonaws_dynamodb v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_dynamodb

Client library for Amazon DynamoDB

Installation and Usage

npm install --save @datafire/amazonaws_dynamodb
let amazonaws_dynamodb = require('@datafire/amazonaws_dynamodb').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_dynamodb.BatchGetItem({
  "RequestItems": []
}).then(data => {
  console.log(data);
});

Description

Amazon DynamoDB Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling. With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics. DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.

Actions

BatchGetItem

amazonaws_dynamodb.BatchGetItem({
  "RequestItems": []
}, context)

Input

Output

BatchWriteItem

amazonaws_dynamodb.BatchWriteItem({
  "RequestItems": []
}, context)

Input

Output

CreateBackup

amazonaws_dynamodb.CreateBackup({
  "TableName": "",
  "BackupName": ""
}, context)

Input

Output

CreateGlobalTable

amazonaws_dynamodb.CreateGlobalTable({
  "GlobalTableName": "",
  "ReplicationGroup": []
}, context)

Input

Output

CreateTable

amazonaws_dynamodb.CreateTable({
  "AttributeDefinitions": [],
  "TableName": "",
  "KeySchema": [],
  "ProvisionedThroughput": {
    "ReadCapacityUnits": 0,
    "WriteCapacityUnits": 0
  }
}, context)

Input

Output

DeleteBackup

amazonaws_dynamodb.DeleteBackup({
  "BackupArn": ""
}, context)

Input

Output

DeleteItem

amazonaws_dynamodb.DeleteItem({
  "TableName": "",
  "Key": []
}, context)

Input

Output

DeleteTable

amazonaws_dynamodb.DeleteTable({
  "TableName": ""
}, context)

Input

Output

DescribeBackup

amazonaws_dynamodb.DescribeBackup({
  "BackupArn": ""
}, context)

Input

Output

DescribeContinuousBackups

amazonaws_dynamodb.DescribeContinuousBackups({
  "TableName": ""
}, context)

Input

Output

DescribeGlobalTable

amazonaws_dynamodb.DescribeGlobalTable({
  "GlobalTableName": ""
}, context)

Input

  • input object

Output

DescribeLimits

amazonaws_dynamodb.DescribeLimits({}, context)

Input

  • input object

Output

DescribeTable

amazonaws_dynamodb.DescribeTable({
  "TableName": ""
}, context)

Input

Output

DescribeTimeToLive

amazonaws_dynamodb.DescribeTimeToLive({
  "TableName": ""
}, context)

Input

Output

GetItem

amazonaws_dynamodb.GetItem({
  "TableName": "",
  "Key": []
}, context)

Input

Output

ListBackups

amazonaws_dynamodb.ListBackups({}, context)

Input

Output

ListGlobalTables

amazonaws_dynamodb.ListGlobalTables({}, context)

Input

Output

ListTables

amazonaws_dynamodb.ListTables({}, context)

Input

Output

ListTagsOfResource

amazonaws_dynamodb.ListTagsOfResource({
  "ResourceArn": ""
}, context)

Input

Output

PutItem

amazonaws_dynamodb.PutItem({
  "TableName": "",
  "Item": []
}, context)

Input

Output

Query

amazonaws_dynamodb.Query({
  "TableName": ""
}, context)

Input

Output

RestoreTableFromBackup

amazonaws_dynamodb.RestoreTableFromBackup({
  "TargetTableName": "",
  "BackupArn": ""
}, context)

Input

Output

Scan

amazonaws_dynamodb.Scan({
  "TableName": ""
}, context)

Input

Output

TagResource

amazonaws_dynamodb.TagResource({
  "ResourceArn": "",
  "Tags": []
}, context)

Input

Output

Output schema unknown

UntagResource

amazonaws_dynamodb.UntagResource({
  "ResourceArn": "",
  "TagKeys": []
}, context)

Input

Output

Output schema unknown

UpdateGlobalTable

amazonaws_dynamodb.UpdateGlobalTable({
  "GlobalTableName": "",
  "ReplicaUpdates": []
}, context)

Input

Output

UpdateItem

amazonaws_dynamodb.UpdateItem({
  "TableName": "",
  "Key": []
}, context)

Input

Output

UpdateTable

amazonaws_dynamodb.UpdateTable({
  "TableName": ""
}, context)

Input

Output

UpdateTimeToLive

amazonaws_dynamodb.UpdateTimeToLive({
  "TableName": "",
  "TimeToLiveSpecification": {
    "Enabled": true,
    "AttributeName": ""
  }
}, context)

Input

Output

Definitions

AttributeAction

  • AttributeAction string (values: ADD, PUT, DELETE)

AttributeDefinition

AttributeDefinitions

AttributeMap

AttributeName

  • AttributeName string

AttributeNameList

AttributeUpdates

AttributeValue

AttributeValueList

AttributeValueUpdate

  • AttributeValueUpdate object: For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each. You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes. Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

Backfilling

  • Backfilling boolean

BackupArn

  • BackupArn string

BackupCreationDateTime

  • BackupCreationDateTime string

BackupDescription

BackupDetails

BackupInUseException

  • BackupInUseException object: There is another ongoing conflicting backup control plane operation on the table. The backups is either being created, deleted or restored to a table.

BackupName

  • BackupName string

BackupNotFoundException

  • BackupNotFoundException object: Backup not found for the given BackupARN.

BackupSizeBytes

  • BackupSizeBytes integer

BackupStatus

  • BackupStatus string (values: CREATING, DELETED, AVAILABLE)

BackupSummaries

BackupSummary

BackupsInputLimit

  • BackupsInputLimit integer

BatchGetItemInput

BatchGetItemOutput

BatchGetRequestMap

BatchGetResponseMap

BatchWriteItemInput

BatchWriteItemOutput

BatchWriteItemRequestMap

BinaryAttributeValue

  • BinaryAttributeValue string

BinarySetAttributeValue

BooleanAttributeValue

  • BooleanAttributeValue boolean

BooleanObject

  • BooleanObject boolean

Capacity

  • Capacity object: Represents the amount of provisioned throughput capacity consumed on a table or an index.

ComparisonOperator

  • ComparisonOperator string (values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH)

Condition

  • Condition object: Represents the selection criteria for a Query or Scan operation: For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions, only the following comparison operators are supported: EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN Condition is also used in a QueryFilter, which evaluates the query results and returns only the desired values. For a Scan operation, Condition is used in a ScanFilter, which evaluates the scan results and returns only the desired values.

ConditionExpression

  • ConditionExpression string

ConditionalCheckFailedException

  • ConditionalCheckFailedException object: A condition specified in the operation could not be evaluated.

ConditionalOperator

  • ConditionalOperator string (values: AND, OR)

ConsistentRead

  • ConsistentRead boolean

ConsumedCapacity

  • ConsumedCapacity object: The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

ConsumedCapacityMultiple

ConsumedCapacityUnits

  • ConsumedCapacityUnits number

ContinuousBackupsDescription

  • ContinuousBackupsDescription object: Represents the backup and restore settings on the table when the backup was created.

ContinuousBackupsStatus

  • ContinuousBackupsStatus string (values: ENABLED, DISABLED)

ContinuousBackupsUnavailableException

  • ContinuousBackupsUnavailableException object: Backups have not yet been enabled for this table.

CreateBackupInput

CreateBackupOutput

CreateGlobalSecondaryIndexAction

  • CreateGlobalSecondaryIndexAction object: Represents a new global secondary index to be added to an existing table.

CreateGlobalTableInput

  • CreateGlobalTableInput object

CreateGlobalTableOutput

CreateReplicaAction

  • CreateReplicaAction object: Represents a replica to be added.

CreateTableInput

CreateTableOutput

  • CreateTableOutput object: Represents the output of a CreateTable operation.

Date

  • Date string

DeleteBackupInput

  • DeleteBackupInput object

DeleteBackupOutput

DeleteGlobalSecondaryIndexAction

  • DeleteGlobalSecondaryIndexAction object: Represents a global secondary index to be deleted from an existing table.

DeleteItemInput

DeleteItemOutput

DeleteReplicaAction

  • DeleteReplicaAction object: Represents a replica to be removed.

DeleteRequest

  • DeleteRequest object: Represents a request to perform a DeleteItem operation on an item.
    • Key required Key

DeleteTableInput

  • DeleteTableInput object: Represents the input of a DeleteTable operation.

DeleteTableOutput

  • DeleteTableOutput object: Represents the output of a DeleteTable operation.

DescribeBackupInput

  • DescribeBackupInput object

DescribeBackupOutput

DescribeContinuousBackupsInput

  • DescribeContinuousBackupsInput object

DescribeContinuousBackupsOutput

DescribeGlobalTableInput

  • DescribeGlobalTableInput object

DescribeGlobalTableOutput

DescribeLimitsInput

  • DescribeLimitsInput object: Represents the input of a DescribeLimits operation. Has no content.

DescribeLimitsOutput

DescribeTableInput

  • DescribeTableInput object: Represents the input of a DescribeTable operation.

DescribeTableOutput

  • DescribeTableOutput object: Represents the output of a DescribeTable operation.

DescribeTimeToLiveInput

  • DescribeTimeToLiveInput object

DescribeTimeToLiveOutput

ErrorMessage

  • ErrorMessage string

ExpectedAttributeMap

ExpectedAttributeValue

  • ExpectedAttributeValue object: Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways: Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false. Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

ExpressionAttributeNameMap

ExpressionAttributeNameVariable

  • ExpressionAttributeNameVariable string

ExpressionAttributeValueMap

ExpressionAttributeValueVariable

  • ExpressionAttributeValueVariable string

FilterConditionMap

GetItemInput

GetItemOutput

GlobalSecondaryIndex

GlobalSecondaryIndexDescription

GlobalSecondaryIndexDescriptionList

GlobalSecondaryIndexInfo

GlobalSecondaryIndexList

GlobalSecondaryIndexUpdate

GlobalSecondaryIndexUpdateList

GlobalSecondaryIndexes

GlobalTable

  • GlobalTable object: Represents the properties of a global table.

GlobalTableAlreadyExistsException

  • GlobalTableAlreadyExistsException object: The specified global table already exists.

GlobalTableArnString

  • GlobalTableArnString string

GlobalTableDescription

GlobalTableList

GlobalTableNotFoundException

  • GlobalTableNotFoundException object: The specified global table does not exist.

GlobalTableStatus

  • GlobalTableStatus string (values: CREATING, ACTIVE, DELETING, UPDATING)

IndexName

  • IndexName string

IndexStatus

  • IndexStatus string (values: CREATING, UPDATING, DELETING, ACTIVE)

Integer

  • Integer integer

InternalServerError

  • InternalServerError object: An error occurred on the server side.

ItemCollectionKeyAttributeMap

ItemCollectionMetrics

  • ItemCollectionMetrics object: Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

ItemCollectionMetricsMultiple

ItemCollectionMetricsPerTable

ItemCollectionSizeEstimateBound

  • ItemCollectionSizeEstimateBound number

ItemCollectionSizeEstimateRange

ItemCollectionSizeLimitExceededException

  • ItemCollectionSizeLimitExceededException object: An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

ItemCount

  • ItemCount integer

ItemList

Key

KeyConditions

KeyExpression

  • KeyExpression string

KeyList

  • KeyList array

KeySchema

KeySchemaAttributeName

  • KeySchemaAttributeName string

KeySchemaElement

  • KeySchemaElement object: Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key. A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

KeyType

  • KeyType string (values: HASH, RANGE)

KeysAndAttributes

  • KeysAndAttributes object: Represents a set of primary keys and, for each key, the attributes to retrieve from the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

LimitExceededException

  • LimitExceededException object: Up to 50 CreateBackup operations are allowed per second, per account. There is no limit to the number of daily on-demand backups that can be taken. Up to 10 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, and RestoreTableFromBackup. For tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously. The total limit of tables in the ACTIVE state is 250. For tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously. The total limit of tables in the ACTIVE state is 250.

ListAttributeValue

ListBackupsInput

ListBackupsOutput

ListGlobalTablesInput

ListGlobalTablesOutput

ListTablesInput

ListTablesInputLimit

  • ListTablesInputLimit integer

ListTablesOutput

  • ListTablesOutput object: Represents the output of a ListTables operation.

ListTagsOfResourceInput

ListTagsOfResourceOutput

LocalSecondaryIndex

  • LocalSecondaryIndex object: Represents the properties of a local secondary index.

LocalSecondaryIndexDescription

LocalSecondaryIndexDescriptionList

LocalSecondaryIndexInfo

  • LocalSecondaryIndexInfo object: Represents the properties of a local secondary index for the table when the backup was created.

LocalSecondaryIndexList

LocalSecondaryIndexes

Long

  • Long integer

MapAttributeValue

NextTokenString

  • NextTokenString string

NonKeyAttributeName

  • NonKeyAttributeName string

NonKeyAttributeNameList

NullAttributeValue

  • NullAttributeValue boolean

NumberAttributeValue

  • NumberAttributeValue string

NumberSetAttributeValue

PositiveIntegerObject

  • PositiveIntegerObject integer

PositiveLongObject

  • PositiveLongObject integer

Projection

  • Projection object: Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

ProjectionExpression

  • ProjectionExpression string

ProjectionType

  • ProjectionType string (values: ALL, KEYS_ONLY, INCLUDE)

ProvisionedThroughput

  • ProvisionedThroughput object: Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

ProvisionedThroughputDescription

  • ProvisionedThroughputDescription object: Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

ProvisionedThroughputExceededException

  • ProvisionedThroughputExceededException object: Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

PutItemInput

PutItemInputAttributeMap

PutItemOutput

PutRequest

  • PutRequest object: Represents a request to perform a PutItem operation on an item.

QueryInput

QueryOutput

RegionName

  • RegionName string

Replica

  • Replica object: Represents the properties of a replica.

ReplicaAlreadyExistsException

  • ReplicaAlreadyExistsException object: The specified replica is already part of the global table.

ReplicaDescription

  • ReplicaDescription object: Contains the details of the replica.

ReplicaDescriptionList

ReplicaList

ReplicaNotFoundException

  • ReplicaNotFoundException object: The specified replica is no longer part of the global table.

ReplicaUpdate

  • ReplicaUpdate object: Represents one of the following: A new replica to be added to an existing global table. New parameters for an existing replica. An existing replica to be removed from an existing global table.

ReplicaUpdateList

ResourceArnString

  • ResourceArnString string

ResourceInUseException

  • ResourceInUseException object: The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

ResourceNotFoundException

  • ResourceNotFoundException object: The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

RestoreDateTime

  • RestoreDateTime string

RestoreInProgress

  • RestoreInProgress boolean

RestoreSummary

RestoreTableFromBackupInput

  • RestoreTableFromBackupInput object

RestoreTableFromBackupOutput

ReturnConsumedCapacity

  • ReturnConsumedCapacity string (values: INDEXES, TOTAL, NONE): Determines the level of detail about provisioned throughput consumption that is returned in the response: INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed. Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s). TOTAL - The response includes only the aggregate ConsumedCapacity for the operation. NONE - No ConsumedCapacity details are included in the response.

ReturnItemCollectionMetrics

  • ReturnItemCollectionMetrics string (values: SIZE, NONE)

ReturnValue

  • ReturnValue string (values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW)

SSEDescription

  • SSEDescription object: The description of the server-side encryption status on the specified table.

SSEEnabled

  • SSEEnabled boolean

SSESpecification

  • SSESpecification object: Represents the settings used to enable server-side encryption.

SSEStatus

  • SSEStatus string (values: ENABLING, ENABLED, DISABLING, DISABLED)

ScalarAttributeType

  • ScalarAttributeType string (values: S, N, B)

ScanInput

ScanOutput

ScanSegment

  • ScanSegment integer

ScanTotalSegments

  • ScanTotalSegments integer

SecondaryIndexesCapacityMap

Select

  • Select string (values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT)

SourceTableDetails

SourceTableFeatureDetails

StreamArn

  • StreamArn string

StreamEnabled

  • StreamEnabled boolean

StreamSpecification

  • StreamSpecification object: Represents the DynamoDB Streams configuration for a table in DynamoDB.

StreamViewType

  • StreamViewType string (values: NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES, KEYS_ONLY)

String

  • String string

StringAttributeValue

  • StringAttributeValue string

StringSetAttributeValue

TableAlreadyExistsException

  • TableAlreadyExistsException object: A table with the name already exists.

TableArn

  • TableArn string

TableCreationDateTime

  • TableCreationDateTime string

TableDescription

TableId

  • TableId string

TableInUseException

  • TableInUseException object: A table by that name is either being created or deleted.

TableName

  • TableName string

TableNameList

TableNotFoundException

  • TableNotFoundException object: A table with the name TableName does not currently exist within the subscriber's account.

TableStatus

  • TableStatus string (values: CREATING, UPDATING, DELETING, ACTIVE)

Tag

  • Tag object: Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

TagKeyList

TagKeyString

  • TagKeyString string

TagList

  • TagList array

TagResourceInput

TagValueString

  • TagValueString string

TimeRangeLowerBound

  • TimeRangeLowerBound string

TimeRangeUpperBound

  • TimeRangeUpperBound string

TimeToLiveAttributeName

  • TimeToLiveAttributeName string

TimeToLiveDescription

TimeToLiveEnabled

  • TimeToLiveEnabled boolean

TimeToLiveSpecification

TimeToLiveStatus

  • TimeToLiveStatus string (values: ENABLING, DISABLING, ENABLED, DISABLED)

UntagResourceInput

UpdateExpression

  • UpdateExpression string

UpdateGlobalSecondaryIndexAction

  • UpdateGlobalSecondaryIndexAction object: Represents the new provisioned throughput settings to be applied to a global secondary index.

UpdateGlobalTableInput

UpdateGlobalTableOutput

UpdateItemInput

datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

7 years ago

4.0.0

8 years ago

3.0.4

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago