Liking cljdoc? Tell your friends :D

cljs-aws.dynamodb


batch-get-itemcljs

(batch-get-item params__1284__auto__)

Parameters :request-items†, :return-consumed-capacity

Returns :consumed-capacity, :responses, :unprocessed-keys

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#batchGetItem-property

required

__Parameters__
`:request-items`†, `:return-consumed-capacity`

__Returns__
`:consumed-capacity`, `:responses`, `:unprocessed-keys`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#batchGetItem-property

† _required_
sourceraw docstring

batch-write-itemcljs

(batch-write-item params__1284__auto__)

Parameters :request-items†, :return-consumed-capacity, :return-item-collection-metrics

Returns :consumed-capacity, :item-collection-metrics, :unprocessed-items

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#batchWriteItem-property

required

__Parameters__
`:request-items`†, `:return-consumed-capacity`, `:return-item-collection-metrics`

__Returns__
`:consumed-capacity`, `:item-collection-metrics`, `:unprocessed-items`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#batchWriteItem-property

† _required_
sourceraw docstring

create-backupcljs

(create-backup params__1284__auto__)

Parameters :backup-name†, :table-name

Returns :backup-details

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createBackup-property

required

__Parameters__
`:backup-name`†, `:table-name`†

__Returns__
`:backup-details`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createBackup-property

† _required_
sourceraw docstring

create-global-tablecljs

(create-global-table params__1284__auto__)

Parameters :global-table-name†, :replication-group

Returns :global-table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createGlobalTable-property

required

__Parameters__
`:global-table-name`†, `:replication-group`†

__Returns__
`:global-table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createGlobalTable-property

† _required_
sourceraw docstring

create-tablecljs

(create-table params__1284__auto__)

Parameters :attribute-definitions†, :global-secondary-indexes, :key-schema†, :local-secondary-indexes, :provisioned-throughput†, :sse-specification, :stream-specification, :table-name

Returns :table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createTable-property

required

__Parameters__
`:attribute-definitions`†, `:global-secondary-indexes`, `:key-schema`†, `:local-secondary-indexes`, `:provisioned-throughput`†, `:sse-specification`, `:stream-specification`, `:table-name`†

__Returns__
`:table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createTable-property

† _required_
sourceraw docstring

delete-backupcljs

(delete-backup params__1284__auto__)

Parameters :backup-arn

Returns :backup-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteBackup-property

required

__Parameters__
`:backup-arn`†

__Returns__
`:backup-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteBackup-property

† _required_
sourceraw docstring

delete-itemcljs

(delete-item params__1284__auto__)

Parameters :condition-expression, :conditional-operator, :expected, :expression-attribute-names, :expression-attribute-values, :key†, :return-consumed-capacity, :return-item-collection-metrics, :return-values, :table-name

Returns :attributes, :consumed-capacity, :item-collection-metrics

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteItem-property

required

__Parameters__
`:condition-expression`, `:conditional-operator`, `:expected`, `:expression-attribute-names`, `:expression-attribute-values`, `:key`†, `:return-consumed-capacity`, `:return-item-collection-metrics`, `:return-values`, `:table-name`†

__Returns__
`:attributes`, `:consumed-capacity`, `:item-collection-metrics`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteItem-property

† _required_
sourceraw docstring

delete-tablecljs

(delete-table params__1284__auto__)

Parameters :table-name

Returns :table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteTable-property

required

__Parameters__
`:table-name`†

__Returns__
`:table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteTable-property

† _required_
sourceraw docstring

describe-backupcljs

(describe-backup params__1284__auto__)

Parameters :backup-arn

Returns :backup-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeBackup-property

required

__Parameters__
`:backup-arn`†

__Returns__
`:backup-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeBackup-property

† _required_
sourceraw docstring

describe-continuous-backupscljs

(describe-continuous-backups params__1284__auto__)

Parameters :table-name

Returns :continuous-backups-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeContinuousBackups-property

required

__Parameters__
`:table-name`†

__Returns__
`:continuous-backups-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeContinuousBackups-property

† _required_
sourceraw docstring

describe-endpointscljs

(describe-endpoints params__1284__auto__)
__Parameters__
(none)

__Returns__
`:endpoints`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeEndpoints-property
sourceraw docstring

describe-global-tablecljs

(describe-global-table params__1284__auto__)

Parameters :global-table-name

Returns :global-table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeGlobalTable-property

required

__Parameters__
`:global-table-name`†

__Returns__
`:global-table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeGlobalTable-property

† _required_
sourceraw docstring

describe-global-table-settingscljs

(describe-global-table-settings params__1284__auto__)

Parameters :global-table-name

Returns :global-table-name, :replica-settings

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeGlobalTableSettings-property

required

__Parameters__
`:global-table-name`†

__Returns__
`:global-table-name`, `:replica-settings`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeGlobalTableSettings-property

† _required_
sourceraw docstring

describe-limitscljs

(describe-limits params__1284__auto__)

Parameters (none)

Returns :account-max-read-capacity-units, :account-max-write-capacity-units, :table-max-read-capacity-units, :table-max-write-capacity-units

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeLimits-property

__Parameters__
(none)

__Returns__
`:account-max-read-capacity-units`, `:account-max-write-capacity-units`, `:table-max-read-capacity-units`, `:table-max-write-capacity-units`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeLimits-property
sourceraw docstring

describe-tablecljs

(describe-table params__1284__auto__)
__Parameters__
`:table-name`†

__Returns__
`:table`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeTable-property

† _required_
sourceraw docstring

describe-time-to-livecljs

(describe-time-to-live params__1284__auto__)

Parameters :table-name

Returns :time-to-live-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeTimeToLive-property

required

__Parameters__
`:table-name`†

__Returns__
`:time-to-live-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#describeTimeToLive-property

† _required_
sourceraw docstring

get-itemcljs

(get-item params__1284__auto__)

Parameters :attributes-to-get, :consistent-read, :expression-attribute-names, :key†, :projection-expression, :return-consumed-capacity, :table-name

Returns :consumed-capacity, :item

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#getItem-property

required

__Parameters__
`:attributes-to-get`, `:consistent-read`, `:expression-attribute-names`, `:key`†, `:projection-expression`, `:return-consumed-capacity`, `:table-name`†

__Returns__
`:consumed-capacity`, `:item`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#getItem-property

† _required_
sourceraw docstring

list-backupscljs

(list-backups params__1284__auto__)

Parameters :backup-type, :exclusive-start-backup-arn, :limit, :table-name, :time-range-lower-bound, :time-range-upper-bound

Returns :backup-summaries, :last-evaluated-backup-arn

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listBackups-property

__Parameters__
`:backup-type`, `:exclusive-start-backup-arn`, `:limit`, `:table-name`, `:time-range-lower-bound`, `:time-range-upper-bound`

__Returns__
`:backup-summaries`, `:last-evaluated-backup-arn`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listBackups-property
sourceraw docstring

list-global-tablescljs

(list-global-tables params__1284__auto__)

Parameters :exclusive-start-global-table-name, :limit, :region-name

Returns :global-tables, :last-evaluated-global-table-name

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listGlobalTables-property

__Parameters__
`:exclusive-start-global-table-name`, `:limit`, `:region-name`

__Returns__
`:global-tables`, `:last-evaluated-global-table-name`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listGlobalTables-property
sourceraw docstring

list-tablescljs

(list-tables params__1284__auto__)

Parameters :exclusive-start-table-name, :limit

Returns :last-evaluated-table-name, :table-names

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listTables-property

__Parameters__
`:exclusive-start-table-name`, `:limit`

__Returns__
`:last-evaluated-table-name`, `:table-names`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listTables-property
sourceraw docstring

list-tags-of-resourcecljs

(list-tags-of-resource params__1284__auto__)

Parameters :next-token, :resource-arn

Returns :next-token, :tags

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listTagsOfResource-property

required

__Parameters__
`:next-token`, `:resource-arn`†

__Returns__
`:next-token`, `:tags`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#listTagsOfResource-property

† _required_
sourceraw docstring

put-itemcljs

(put-item params__1284__auto__)

Parameters :condition-expression, :conditional-operator, :expected, :expression-attribute-names, :expression-attribute-values, :item†, :return-consumed-capacity, :return-item-collection-metrics, :return-values, :table-name

Returns :attributes, :consumed-capacity, :item-collection-metrics

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#putItem-property

required

__Parameters__
`:condition-expression`, `:conditional-operator`, `:expected`, `:expression-attribute-names`, `:expression-attribute-values`, `:item`†, `:return-consumed-capacity`, `:return-item-collection-metrics`, `:return-values`, `:table-name`†

__Returns__
`:attributes`, `:consumed-capacity`, `:item-collection-metrics`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#putItem-property

† _required_
sourceraw docstring

querycljs

(query params__1284__auto__)

Parameters :attributes-to-get, :conditional-operator, :consistent-read, :exclusive-start-key, :expression-attribute-names, :expression-attribute-values, :filter-expression, :index-name, :key-condition-expression, :key-conditions, :limit, :projection-expression, :query-filter, :return-consumed-capacity, :scan-index-forward, :select, :table-name

Returns :consumed-capacity, :count, :items, :last-evaluated-key, :scanned-count

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#query-property

required

__Parameters__
`:attributes-to-get`, `:conditional-operator`, `:consistent-read`, `:exclusive-start-key`, `:expression-attribute-names`, `:expression-attribute-values`, `:filter-expression`, `:index-name`, `:key-condition-expression`, `:key-conditions`, `:limit`, `:projection-expression`, `:query-filter`, `:return-consumed-capacity`, `:scan-index-forward`, `:select`, `:table-name`†

__Returns__
`:consumed-capacity`, `:count`, `:items`, `:last-evaluated-key`, `:scanned-count`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#query-property

† _required_
sourceraw docstring

restore-table-from-backupcljs

(restore-table-from-backup params__1284__auto__)

Parameters :backup-arn†, :target-table-name

Returns :table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#restoreTableFromBackup-property

required

__Parameters__
`:backup-arn`†, `:target-table-name`†

__Returns__
`:table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#restoreTableFromBackup-property

† _required_
sourceraw docstring

restore-table-to-point-in-timecljs

(restore-table-to-point-in-time params__1284__auto__)

Parameters :restore-date-time, :source-table-name†, :target-table-name†, :use-latest-restorable-time

Returns :table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#restoreTableToPointInTime-property

required

__Parameters__
`:restore-date-time`, `:source-table-name`†, `:target-table-name`†, `:use-latest-restorable-time`

__Returns__
`:table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#restoreTableToPointInTime-property

† _required_
sourceraw docstring

scancljs

(scan params__1284__auto__)

Parameters :attributes-to-get, :conditional-operator, :consistent-read, :exclusive-start-key, :expression-attribute-names, :expression-attribute-values, :filter-expression, :index-name, :limit, :projection-expression, :return-consumed-capacity, :scan-filter, :segment, :select, :table-name†, :total-segments

Returns :consumed-capacity, :count, :items, :last-evaluated-key, :scanned-count

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#scan-property

required

__Parameters__
`:attributes-to-get`, `:conditional-operator`, `:consistent-read`, `:exclusive-start-key`, `:expression-attribute-names`, `:expression-attribute-values`, `:filter-expression`, `:index-name`, `:limit`, `:projection-expression`, `:return-consumed-capacity`, `:scan-filter`, `:segment`, `:select`, `:table-name`†, `:total-segments`

__Returns__
`:consumed-capacity`, `:count`, `:items`, `:last-evaluated-key`, `:scanned-count`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#scan-property

† _required_
sourceraw docstring

tag-resourcecljs

(tag-resource params__1284__auto__)

Parameters :resource-arn†, :tags

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#tagResource-property

required

__Parameters__
`:resource-arn`†, `:tags`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#tagResource-property

† _required_
sourceraw docstring

untag-resourcecljs

(untag-resource params__1284__auto__)

Parameters :resource-arn†, :tag-keys

Returns (none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#untagResource-property

required

__Parameters__
`:resource-arn`†, `:tag-keys`†

__Returns__
(none)

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#untagResource-property

† _required_
sourceraw docstring

update-continuous-backupscljs

(update-continuous-backups params__1284__auto__)

Parameters :point-in-time-recovery-specification†, :table-name

Returns :continuous-backups-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateContinuousBackups-property

required

__Parameters__
`:point-in-time-recovery-specification`†, `:table-name`†

__Returns__
`:continuous-backups-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateContinuousBackups-property

† _required_
sourceraw docstring

update-global-tablecljs

(update-global-table params__1284__auto__)

Parameters :global-table-name†, :replica-updates

Returns :global-table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateGlobalTable-property

required

__Parameters__
`:global-table-name`†, `:replica-updates`†

__Returns__
`:global-table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateGlobalTable-property

† _required_
sourceraw docstring

update-global-table-settingscljs

(update-global-table-settings params__1284__auto__)

Parameters :global-table-global-secondary-index-settings-update, :global-table-name†, :global-table-provisioned-write-capacity-auto-scaling-settings-update, :global-table-provisioned-write-capacity-units, :replica-settings-update

Returns :global-table-name, :replica-settings

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateGlobalTableSettings-property

required

__Parameters__
`:global-table-global-secondary-index-settings-update`, `:global-table-name`†, `:global-table-provisioned-write-capacity-auto-scaling-settings-update`, `:global-table-provisioned-write-capacity-units`, `:replica-settings-update`

__Returns__
`:global-table-name`, `:replica-settings`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateGlobalTableSettings-property

† _required_
sourceraw docstring

update-itemcljs

(update-item params__1284__auto__)

Parameters :attribute-updates, :condition-expression, :conditional-operator, :expected, :expression-attribute-names, :expression-attribute-values, :key†, :return-consumed-capacity, :return-item-collection-metrics, :return-values, :table-name†, :update-expression

Returns :attributes, :consumed-capacity, :item-collection-metrics

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateItem-property

required

__Parameters__
`:attribute-updates`, `:condition-expression`, `:conditional-operator`, `:expected`, `:expression-attribute-names`, `:expression-attribute-values`, `:key`†, `:return-consumed-capacity`, `:return-item-collection-metrics`, `:return-values`, `:table-name`†, `:update-expression`

__Returns__
`:attributes`, `:consumed-capacity`, `:item-collection-metrics`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateItem-property

† _required_
sourceraw docstring

update-tablecljs

(update-table params__1284__auto__)

Parameters :attribute-definitions, :global-secondary-index-updates, :provisioned-throughput, :sse-specification, :stream-specification, :table-name

Returns :table-description

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateTable-property

required

__Parameters__
`:attribute-definitions`, `:global-secondary-index-updates`, `:provisioned-throughput`, `:sse-specification`, `:stream-specification`, `:table-name`†

__Returns__
`:table-description`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateTable-property

† _required_
sourceraw docstring

update-time-to-livecljs

(update-time-to-live params__1284__auto__)

Parameters :table-name†, :time-to-live-specification

Returns :time-to-live-specification

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateTimeToLive-property

required

__Parameters__
`:table-name`†, `:time-to-live-specification`†

__Returns__
`:time-to-live-specification`

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#updateTimeToLive-property

† _required_
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close