luciano/kinesis-consumer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Bump github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue

Browse source 
Bumps [github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue](https://github.com/aws/aws-sdk-go-v2) from 1.13.14 to 1.13.19.
- [Release notes](https://github.com/aws/aws-sdk-go-v2/releases)
- [Commits](https://github.com/aws/aws-sdk-go-v2/compare/service/mq/v1.13.14...credentials/v1.13.19)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
This commit is contained in:
dependabot[bot] 2024-05-28 08:08:34 +00:00 committed by GitHub
parent 02c0ada62c
commit 41539557e7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
61 changed files with 3028 additions and 1585 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
go.mod
View file

@ -9,8 +9,8 @@ require (
github.com/aws/aws-sdk-go-v2 v1.27.0
github.com/aws/aws-sdk-go-v2/config v1.27.16
github.com/aws/aws-sdk-go-v2/credentials v1.17.16
github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.14
github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.0
github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.19
github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.5
github.com/aws/aws-sdk-go-v2/service/kinesis v1.27.8
github.com/awslabs/kinesis-aggregation/go/v2 v2.0.0-20230808105340-e631fe742486
github.com/go-sql-driver/mysql v1.8.1

8
go.sum
View file

@ -21,8 +21,8 @@ github.com/aws/aws-sdk-go-v2/config v1.27.16 h1:knpCuH7laFVGYTNd99Ns5t+8PuRjDn4H
github.com/aws/aws-sdk-go-v2/config v1.27.16/go.mod h1:vutqgRhDUktwSge3hrC3nkuirzkJ4E/mLj5GvI0BQas=
github.com/aws/aws-sdk-go-v2/credentials v1.17.16 h1:7d2QxY83uYl0l58ceyiSpxg9bSbStqBC6BeEeHEchwo=
github.com/aws/aws-sdk-go-v2/credentials v1.17.16/go.mod h1:Ae6li/6Yc6eMzysRL2BXlPYvnrLLBg3D11/AmOjw50k=
github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.14 h1:MqN3V/VApAVAheStH43Dl3BWuGE712Cp5s97WmCMbYQ=
github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.14/go.mod h1:WwwihVdoE2S7TTziJGvgWaHI8HlOt1DwO6DM338pkzo=
github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.19 h1:Y9GflNZ9Ty+qjyY7Oral0gcaeI5NiPNHX23vXCiXfe8=
github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.19/go.mod h1:RACJwWn6am6SvBqlCM9/DKHaR+79Q6/yMx3QCjuq8nw=
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.3 h1:dQLK4TjtnlRGb0czOht2CevZ5l6RSyRWAnKeGd7VAFE=
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.3/go.mod h1:TL79f2P6+8Q7dTsILpiVST+AL9lkF6PPGI167Ny0Cjw=
github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.7 h1:lf/8VTF2cM+N4SLzaYJERKEWAXq8MOMpZfU6wEPWsPk=
@ -31,8 +31,8 @@ github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.7 h1:4OYVp0705xu8yjdyoWi
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.7/go.mod h1:vd7ESTEvI76T2Na050gODNmNU7+OyKrIKroYTu4ABiI=
github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0 h1:hT8rVHwugYE2lEfdFE0QWVo81lF7jMrYJVDWI+f+VxU=
github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0/go.mod h1:8tu/lYfQfFe6IGnaOdrpVgEL2IrrDOf6/m9RQum4NkY=
github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.0 h1:tGV+9T7NwSJNky5tGLh6/i7CoIkd9fPiGWDn9u4PWgI=
github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.0/go.mod h1:lVLqEtX+ezgtfalyJs7Peb0uv9dEpAQP5yuq2O26R44=
github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.5 h1:HLbOhDOP/191cJLS829oCL8sn9tXF6qhAjh1emp8TEE=
github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.5/go.mod h1:uNhUf9Z3MT6Ex+u0ADa8r3MKK5zjuActEfXQPo4YqEI=
github.com/aws/aws-sdk-go-v2/service/dynamodbstreams v1.20.8 h1:PapW7iWHqua6Gk+qRjgXpM3fNqUxY3N+1WURHPcmKhc=
github.com/aws/aws-sdk-go-v2/service/dynamodbstreams v1.20.8/go.mod h1:IL6qnQxrc/qIjwzeg7USP3P7ySEehOPpXJslRbXNYJ4=
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.11.2 h1:Ji0DY1xUsUr3I8cHps0G+XM3WWU16lP6yG8qu1GAZAs=

20
vendor/github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue/CHANGELOG.md generated vendored
View file

@ -1,3 +1,23 @@
# v1.13.19 (2024-05-24)
* **Dependency Update**: Updated to the latest SDK module versions
# v1.13.18 (2024-05-23)
* **Dependency Update**: Updated to the latest SDK module versions
# v1.13.17 (2024-05-16)
* **Dependency Update**: Updated to the latest SDK module versions
# v1.13.16 (2024-05-15)
* **Dependency Update**: Updated to the latest SDK module versions
# v1.13.15 (2024-05-08)
* **Dependency Update**: Updated to the latest SDK module versions
# v1.13.14 (2024-05-02)
* **Dependency Update**: Updated to the latest SDK module versions

2
vendor/github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue/go_module_metadata.go generated vendored
View file

@ -3,4 +3,4 @@
package attributevalue
// goModuleVersion is the tagged release for this module
const goModuleVersion = "1.13.14"
const goModuleVersion = "1.13.19"

20
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/CHANGELOG.md generated vendored
View file

@ -1,3 +1,23 @@
# v1.32.5 (2024-05-24)
* **Documentation**: Documentation only updates for DynamoDB.
# v1.32.4 (2024-05-23)
* No change notes available for this release.
# v1.32.3 (2024-05-16)
* **Dependency Update**: Updated to the latest SDK module versions
# v1.32.2 (2024-05-15)
* **Dependency Update**: Updated to the latest SDK module versions
# v1.32.1 (2024-05-08)
* **Bug Fix**: GoDoc improvement
# v1.32.0 (2024-05-02)
* **Feature**: This release adds support to specify an optional, maximum OnDemandThroughput for DynamoDB tables and global secondary indexes in the CreateTable or UpdateTable APIs. You can also override the OnDemandThroughput settings by calling the ImportTable, RestoreFromPointInTime, or RestoreFromBackup APIs.

25
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_BatchExecuteStatement.go generated vendored
View file

@ -14,12 +14,16 @@ import (
// This operation allows you to perform batch reads or writes on data stored in
// DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must
// specify an equality condition on all key attributes. This enforces that each
// SELECT statement in a batch returns at most a single item. The entire batch must
// consist of either read statements or write statements, you cannot mix both in
// one batch. A HTTP 200 response does not mean that all statements in the
// SELECT statement in a batch returns at most a single item.
//
// The entire batch must consist of either read statements or write statements,
// you cannot mix both in one batch.
//
// A HTTP 200 response does not mean that all statements in the
// BatchExecuteStatement succeeded. Error details for individual statements can be
// found under the Error (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error)
// field of the BatchStatementResponse for each statement.
// found under the [Error]field of the BatchStatementResponse for each statement.
//
// [Error]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error
func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error) {
if params == nil {
params = &BatchExecuteStatementInput{}
@ -44,13 +48,18 @@ type BatchExecuteStatementInput struct {
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity

172
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_BatchGetItem.go generated vendored
View file

@ -13,43 +13,57 @@ import (
)
// The BatchGetItem operation returns the attributes of one or more items from one
// or more tables. You identify requested items by primary key. A single operation
// can retrieve up to 16 MB of data, which can contain as many as 100 items.
// BatchGetItem returns a partial result if the response size limit is exceeded,
// the table's provisioned throughput is exceeded, more than 1MB per partition is
// requested, or an internal processing failure occurs. If a partial result is
// returned, the operation returns a value for UnprocessedKeys . You can use this
// value to retry the operation starting with the next item to get. If you request
// more than 100 items, BatchGetItem returns a ValidationException with the
// message "Too many items requested for the BatchGetItem call." For example, if
// you ask to retrieve 100 items, but each individual item is 300 KB in size, the
// system returns 52 items (so as not to exceed the 16 MB limit). It also returns
// an appropriate UnprocessedKeys value so you can get the next page of results.
// If desired, your application can include its own logic to assemble the pages of
// results into one dataset. If none of the items can be processed due to
// insufficient provisioned throughput on all of the tables in the request, then
// BatchGetItem returns a ProvisionedThroughputExceededException . If at least one
// of the items is successfully processed, then BatchGetItem completes
// successfully, while returning the keys of the unread items in UnprocessedKeys .
// or more tables. You identify requested items by primary key.
//
// A single operation can retrieve up to 16 MB of data, which can contain as many
// as 100 items. BatchGetItem returns a partial result if the response size limit
// is exceeded, the table's provisioned throughput is exceeded, more than 1MB per
// partition is requested, or an internal processing failure occurs. If a partial
// result is returned, the operation returns a value for UnprocessedKeys . You can
// use this value to retry the operation starting with the next item to get.
//
// If you request more than 100 items, BatchGetItem returns a ValidationException
// with the message "Too many items requested for the BatchGetItem call."
//
// For example, if you ask to retrieve 100 items, but each individual item is 300
// KB in size, the system returns 52 items (so as not to exceed the 16 MB limit).
// It also returns an appropriate UnprocessedKeys value so you can get the next
// page of results. If desired, your application can include its own logic to
// assemble the pages of results into one dataset.
//
// If none of the items can be processed due to insufficient provisioned
// throughput on all of the tables in the request, then BatchGetItem returns a
// ProvisionedThroughputExceededException . If at least one of the items is
// successfully processed, then BatchGetItem completes successfully, while
// returning the keys of the unread items in UnprocessedKeys .
//
// If DynamoDB returns any unprocessed items, you should retry the batch operation
// on those items. However, we strongly recommend that you use an exponential
// backoff algorithm. If you retry the batch operation immediately, the underlying
// read or write requests can still fail due to throttling on the individual
// tables. If you delay the batch operation using exponential backoff, the
// individual requests in the batch are much more likely to succeed. For more
// information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations)
// in the Amazon DynamoDB Developer Guide. By default, BatchGetItem performs
// eventually consistent reads on every table in the request. If you want strongly
// consistent reads instead, you can set ConsistentRead to true for any or all
// tables. In order to minimize response latency, BatchGetItem may retrieve items
// in parallel. When designing your application, keep in mind that DynamoDB does
// not return items in any particular order. To help parse the response by item,
// include the primary key values for the items in your request in the
// ProjectionExpression parameter. If a requested item does not exist, it is not
// returned in the result. Requests for nonexistent items consume the minimum read
// capacity units according to the type of read. For more information, see Working
// with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations)
// in the Amazon DynamoDB Developer Guide.
// individual requests in the batch are much more likely to succeed.
//
// For more information, see [Batch Operations and Error Handling] in the Amazon DynamoDB Developer Guide.
//
// By default, BatchGetItem performs eventually consistent reads on every table in
// the request. If you want strongly consistent reads instead, you can set
// ConsistentRead to true for any or all tables.
//
// In order to minimize response latency, BatchGetItem may retrieve items in
// parallel.
//
// When designing your application, keep in mind that DynamoDB does not return
// items in any particular order. To help parse the response by item, include the
// primary key values for the items in your request in the ProjectionExpression
// parameter.
//
// If a requested item does not exist, it is not returned in the result. Requests
// for nonexistent items consume the minimum read capacity units according to the
// type of read. For more information, see [Working with Tables]in the Amazon DynamoDB Developer Guide.
//
// [Batch Operations and Error Handling]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations
// [Working with Tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations
func (c *Client) BatchGetItem(ctx context.Context, params *BatchGetItemInput, optFns ...func(*Options)) (*BatchGetItemOutput, error) {
if params == nil {
params = &BatchGetItemInput{}
@ -70,59 +84,87 @@ type BatchGetItemInput struct {
// A map of one or more table names or table ARNs and, for each table, a map that
// describes one or more items to retrieve from that table. Each table name or ARN
// can be used only once per BatchGetItem request. Each element in the map of
// items to retrieve consists of the following:
// can be used only once per BatchGetItem request.
//
// Each element in the map of items to retrieve consists of the following:
//
// - ConsistentRead - If true , a strongly consistent read is used; if false (the
// default), an eventually consistent read is used.
//
// - ExpressionAttributeNames - One or more substitution tokens for attribute
// names in the ProjectionExpression parameter. The following are some use cases
// for using ExpressionAttributeNames :
//
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
//
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
//
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression. Use the # character in an expression to
// dereference an attribute name. For example, consider the following attribute
// name:
// - Percentile The name of this attribute conflicts with a reserved word, so it
// cannot be used directly in an expression. (For the complete list of reserved
// words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
// the following for ExpressionAttributeNames :
// - {"#P":"Percentile"} You could then use this substitution in an expression,
// as in this example:
// - #P = :val Tokens that begin with the : character are expression attribute
// values, which are placeholders for the actual value at runtime. For more
// information about expression attribute names, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// misinterpreted in an expression.
//
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
//
// - Percentile
//
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see [Reserved Words]in
// the Amazon DynamoDB Developer Guide). To work around this, you could specify the
// following for ExpressionAttributeNames :
//
// - {"#P":"Percentile"}
//
// You could then use this substitution in an expression, as in this example:
//
// - #P = :val
//
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime.
//
// For more information about expression attribute names, see [Accessing Item Attributes]in the Amazon
// DynamoDB Developer Guide.
//
// - Keys - An array of primary key attribute values that define specific items
// in 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 value. For a composite key, you must provide both the partition key value
// and the sort key value.
//
// - ProjectionExpression - A string that identifies one or more attributes to
// retrieve from the table. These attributes can include scalars, sets, or elements
// of a JSON document. The attributes in the expression must be separated by
// commas. If no attribute names are specified, then all attributes are returned.
// If any of the requested attributes are not found, they do not appear in the
// result. For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// commas.
//
// If no attribute names are specified, then all attributes are returned. If any
// of the requested attributes are not found, they do not appear in the result.
//
// For more information, see [Accessing Item Attributes]in the Amazon DynamoDB Developer Guide.
//
// - AttributesToGet - This is a legacy parameter. Use ProjectionExpression
// instead. For more information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
// in the Amazon DynamoDB Developer Guide.
// instead. For more information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Accessing Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
// [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html
//
// This member is required.
RequestItems map[string]types.KeysAndAttributes
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
@ -132,9 +174,12 @@ type BatchGetItemInput struct {
// Represents the output of a BatchGetItem operation.
type BatchGetItemOutput struct {
// The read capacity units consumed by the entire BatchGetItem operation. Each
// element consists of:
// The read capacity units consumed by the entire BatchGetItem operation.
//
// Each element consists of:
//
// - TableName - The table that consumed the provisioned throughput.
//
// - CapacityUnits - The total number of capacity units consumed.
ConsumedCapacity []types.ConsumedCapacity
@ -146,16 +191,21 @@ type BatchGetItemOutput struct {
// A map of tables and their respective keys that were not processed with the
// current response. The UnprocessedKeys value is in the same form as RequestItems
// , so the value can be provided directly to a subsequent BatchGetItem operation.
// For more information, see RequestItems in the Request Parameters section. Each
// element consists of:
// For more information, see RequestItems in the Request Parameters section.
//
// Each element consists of:
//
// - Keys - An array of primary key attribute values that define specific items
// in the table.
//
// - ProjectionExpression - One or more attributes to be retrieved from the table
// or index. By default, all attributes are returned. If a requested attribute is
// not found, it does not appear in the result.
//
// - ConsistentRead - The consistency of a read operation. If set to true , then
// a strongly consistent read is used; otherwise, an eventually consistent read is
// used.
//
// If there are no unprocessed keys remaining, the response contains an empty
// UnprocessedKeys map.
UnprocessedKeys map[string]types.KeysAndAttributes

160
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_BatchWriteItem.go generated vendored
View file

@ -17,57 +17,82 @@ import (
// the network, consisting of up to 25 item put or delete operations. While
// individual items can be up to 400 KB once stored, it's important to note that an
// item's representation might be greater than 400KB while being sent in DynamoDB's
// JSON format for the API call. For more details on this distinction, see Naming
// Rules and Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html)
// . BatchWriteItem cannot update items. If you perform a BatchWriteItem operation
// JSON format for the API call. For more details on this distinction, see [Naming Rules and Data Types].
//
// BatchWriteItem cannot update items. If you perform a BatchWriteItem operation
// on an existing item, that item's values will be overwritten by the operation and
// it will appear like it was updated. To update items, we recommend you use the
// UpdateItem action. The individual PutItem and DeleteItem operations specified
// in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any
// requested operations fail because the table's provisioned throughput is exceeded
// or an internal processing failure occurs, the failed operations are returned in
// the UnprocessedItems response parameter. You can investigate and optionally
// resend the requests. Typically, you would call BatchWriteItem in a loop. Each
// UpdateItem action.
//
// The individual PutItem and DeleteItem operations specified in BatchWriteItem
// are atomic; however BatchWriteItem as a whole is not. If any requested
// operations fail because the table's provisioned throughput is exceeded or an
// internal processing failure occurs, the failed operations are returned in the
// UnprocessedItems response parameter. You can investigate and optionally resend
// the requests. Typically, you would call BatchWriteItem in a loop. Each
// iteration would check for unprocessed items and submit a new BatchWriteItem
// request with those unprocessed items until all items have been processed. If
// none of the items can be processed due to insufficient provisioned throughput on
// all of the tables in the request, then BatchWriteItem returns a
// ProvisionedThroughputExceededException . If DynamoDB returns any unprocessed
// items, you should retry the batch operation on those items. However, we strongly
// recommend that you use an exponential backoff algorithm. If you retry the batch
// operation immediately, the underlying read or write requests can still fail due
// to throttling on the individual tables. If you delay the batch operation using
// exponential backoff, the individual requests in the batch are much more likely
// to succeed. For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations)
// in the Amazon DynamoDB Developer Guide. With BatchWriteItem , you can
// efficiently write or delete large amounts of data, such as from Amazon EMR, or
// copy data from another database into DynamoDB. In order to improve performance
// with these large-scale operations, BatchWriteItem does not behave in the same
// way as individual PutItem and DeleteItem calls would. For example, you cannot
// specify conditions on individual put and delete requests, and BatchWriteItem
// does not return deleted items in the response. If you use a programming language
// that supports concurrency, you can use threads to write items in parallel. Your
// application must include the necessary logic to manage the threads. With
// languages that don't support threading, you must update or delete the specified
// items one at a time. In both situations, BatchWriteItem performs the specified
// put and delete operations in parallel, giving you the power of the thread pool
// approach without having to introduce complexity into your application. Parallel
// processing reduces latency, but each specified put and delete request consumes
// the same number of write capacity units whether it is processed in parallel or
// not. Delete operations on nonexistent items consume one write capacity unit. If
// one or more of the following is true, DynamoDB rejects the entire batch write
// operation:
// request with those unprocessed items until all items have been processed.
//
// If none of the items can be processed due to insufficient provisioned
// throughput on all of the tables in the request, then BatchWriteItem returns a
// ProvisionedThroughputExceededException .
//
// If DynamoDB returns any unprocessed items, you should retry the batch operation
// on those items. However, we strongly recommend that you use an exponential
// backoff algorithm. If you retry the batch operation immediately, the underlying
// read or write requests can still fail due to throttling on the individual
// tables. If you delay the batch operation using exponential backoff, the
// individual requests in the batch are much more likely to succeed.
//
// For more information, see [Batch Operations and Error Handling] in the Amazon DynamoDB Developer Guide.
//
// With BatchWriteItem , you can efficiently write or delete large amounts of data,
// such as from Amazon EMR, or copy data from another database into DynamoDB. In
// order to improve performance with these large-scale operations, BatchWriteItem
// does not behave in the same way as individual PutItem and DeleteItem calls
// would. For example, you cannot specify conditions on individual put and delete
// requests, and BatchWriteItem does not return deleted items in the response.
//
// If you use a programming language that supports concurrency, you can use
// threads to write items in parallel. Your application must include the necessary
// logic to manage the threads. With languages that don't support threading, you
// must update or delete the specified items one at a time. In both situations,
// BatchWriteItem performs the specified put and delete operations in parallel,
// giving you the power of the thread pool approach without having to introduce
// complexity into your application.
//
// Parallel processing reduces latency, but each specified put and delete request
// consumes the same number of write capacity units whether it is processed in
// parallel or not. Delete operations on nonexistent items consume one write
// capacity unit.
//
// If one or more of the following is true, DynamoDB rejects the entire batch
// write operation:
//
// - One or more tables specified in the BatchWriteItem request does not exist.
//
// - Primary key attributes specified on an item in the request do not match
// those in the corresponding table's primary key schema.
//
// - You try to perform multiple operations on the same item in the same
// BatchWriteItem request. For example, you cannot put and delete the same item
// in the same BatchWriteItem request.
//
// - Your request contains at least two items with identical hash and range keys
// (which essentially is two put operations).
//
// - There are more than 25 requests in the batch.
//
// - Any individual item in a batch exceeds 400 KB.
//
// - The total request size exceeds 16 MB.
//
// - Any individual items with keys exceeding the key length limits. For a
// partition key, the limit is 2048 bytes and for a sort key, the limit is 1024
// bytes.
//
// [Batch Operations and Error Handling]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations
// [Naming Rules and Data Types]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html
func (c *Client) BatchWriteItem(ctx context.Context, params *BatchWriteItemInput, optFns ...func(*Options)) (*BatchWriteItemOutput, error) {
if params == nil {
params = &BatchWriteItemInput{}
@ -89,36 +114,47 @@ type BatchWriteItemInput struct {
// A map of one or more table names or table ARNs and, for each table, a list of
// operations to be performed ( DeleteRequest or PutRequest ). Each element in the
// map consists of the following:
//
// - DeleteRequest - Perform a DeleteItem operation on the specified item. The
// item to be deleted is identified by a Key subelement:
//
// - Key - A map of primary key attribute values that uniquely identify the item.
// Each entry in this map consists of an attribute name and an attribute value. For
// each primary key, you must provide all of the key attributes. For example, with
// a simple primary key, you only need to provide a value for the partition key.
// For a composite primary key, you must provide values for both the partition key
// and the sort key.
//
// - PutRequest - Perform a PutItem operation on the specified item. The item to
// be put is identified by an Item subelement:
//
// - Item - A map of attributes and their values. Each entry in this map consists
// of an attribute name and an attribute value. Attribute values must not be null;
// string and binary type attributes must have lengths greater than zero; and set
// type attributes must not be empty. Requests that contain empty values are
// rejected with a ValidationException exception. If you specify any attributes
// that are part of an index key, then the data types for those attributes must
// match those of the schema in the table's attribute definition.
// rejected with a ValidationException exception.
//
// If you specify any attributes that are part of an index key, then the data
// types for those attributes must match those of the schema in the table's
// attribute definition.
//
// This member is required.
RequestItems map[string][]types.WriteRequest
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
@ -134,46 +170,62 @@ type BatchWriteItemInput struct {
// Represents the output of a BatchWriteItem operation.
type BatchWriteItemOutput struct {
// The capacity units consumed by the entire BatchWriteItem operation. Each
// element consists of:
// The capacity units consumed by the entire BatchWriteItem operation.
//
// Each element consists of:
//
// - TableName - The table that consumed the provisioned throughput.
//
// - CapacityUnits - The total number of capacity units consumed.
ConsumedCapacity []types.ConsumedCapacity
// A list of tables that were processed by BatchWriteItem and, for each table,
// information about any item collections that were affected by individual
// DeleteItem or PutItem operations. Each entry consists of the following
// subelements:
// DeleteItem or PutItem operations.
//
// Each entry consists of the following subelements:
//
// - ItemCollectionKey - The partition key value of the item collection. This is
// the same as the partition key value of the item.
//
// - SizeEstimateRangeGB - An estimate of item collection size, expressed in GB.
// This is a two-element array containing a lower bound and an upper bound for the
// estimate. The estimate includes the size of all the items in the table, plus the
// size of all attributes projected into all of the local secondary indexes on the
// table. Use this estimate to measure whether a local secondary index is
// approaching its size limit. The estimate is subject to change over time;
// therefore, do not rely on the precision or accuracy of the estimate.
// approaching its size limit.
//
// The estimate is subject to change over time; therefore, do not rely on the
// precision or accuracy of the estimate.
ItemCollectionMetrics map[string][]types.ItemCollectionMetrics
// A map of tables and requests against those tables that were not processed. The
// UnprocessedItems value is in the same form as RequestItems , so you can provide
// this value directly to a subsequent BatchWriteItem operation. For more
// information, see RequestItems in the Request Parameters section. Each
// UnprocessedItems entry consists of a table name or table ARN and, for that
// information, see RequestItems in the Request Parameters section.
//
// Each UnprocessedItems entry consists of a table name or table ARN and, for that
// table, a list of operations to perform ( DeleteRequest or PutRequest ).
//
// - DeleteRequest - Perform a DeleteItem operation on the specified item. The
// item to be deleted is identified by a Key subelement:
//
// - Key - A map of primary key attribute values that uniquely identify the item.
// Each entry in this map consists of an attribute name and an attribute value.
//
// - PutRequest - Perform a PutItem operation on the specified item. The item to
// be put is identified by an Item subelement:
//
// - Item - A map of attributes and their values. Each entry in this map consists
// of an attribute name and an attribute value. Attribute values must not be null;
// string and binary type attributes must have lengths greater than zero; and set
// type attributes must not be empty. Requests that contain empty values will be
// rejected with a ValidationException exception. If you specify any attributes
// that are part of an index key, then the data types for those attributes must
// match those of the schema in the table's attribute definition.
// rejected with a ValidationException exception.
//
// If you specify any attributes that are part of an index key, then the data
// types for those attributes must match those of the schema in the table's
// attribute definition.
//
// If there are no unprocessed items remaining, the response contains an empty
// UnprocessedItems map.
UnprocessedItems map[string][]types.WriteRequest

40
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_CreateBackup.go generated vendored
View file

@ -12,23 +12,35 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a backup for an existing table. Each time you create an on-demand
// backup, the entire table data is backed up. There is no limit to the number of
// on-demand backups that can be taken. When you create an on-demand backup, a time
// marker of the request is cataloged, and the backup is created asynchronously, by
// applying all changes until the time of the request to the last full table
// snapshot. Backup requests are processed instantaneously and become available for
// restore within minutes. You can call CreateBackup at a maximum rate of 50 times
// per second. All backups in DynamoDB work without consuming any provisioned
// throughput on the table. If you submit a backup request on 2018-12-14 at
// 14:25:00, the backup is guaranteed to contain all data committed to the table up
// to 14:24:00, and data committed after 14:26:00 will not be. The backup might
// contain data modifications made between 14:24:00 and 14:26:00. On-demand backup
// does not support causal consistency. Along with data, the following are also
// included on the backups:
// Creates a backup for an existing table.
//
// Each time you create an on-demand backup, the entire table data is backed up.
// There is no limit to the number of on-demand backups that can be taken.
//
// When you create an on-demand backup, a time marker of the request is cataloged,
// and the backup is created asynchronously, by applying all changes until the time
// of the request to the last full table snapshot. Backup requests are processed
// instantaneously and become available for restore within minutes.
//
// You can call CreateBackup at a maximum rate of 50 times per second.
//
// All backups in DynamoDB work without consuming any provisioned throughput on
// the table.
//
// If you submit a backup request on 2018-12-14 at 14:25:00, the backup is
// guaranteed to contain all data committed to the table up to 14:24:00, and data
// committed after 14:26:00 will not be. The backup might contain data
// modifications made between 14:24:00 and 14:26:00. On-demand backup does not
// support causal consistency.
//
// Along with data, the following are also included on the backups:
//
// - Global secondary indexes (GSIs)
//
// - Local secondary indexes (LSIs)
//
// - Streams
//
// - Provisioned read and write capacity
func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, optFns ...func(*Options)) (*CreateBackupOutput, error) {
if params == nil {

39
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_CreateGlobalTable.go generated vendored
View file

@ -14,41 +14,54 @@ import (
// Creates a global table from an existing table. A global table creates a
// replication relationship between two or more DynamoDB tables with the same table
// name in the provided Regions. This operation only applies to Version 2017.11.29
// (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html)
// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// when creating new global tables, as it provides greater flexibility, higher
// name in the provided Regions.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version), as it provides greater flexibility, higher
// efficiency and consumes less write capacity than 2017.11.29 (Legacy). To
// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html)
// . To update existing global tables from version 2017.11.29 (Legacy) to version
// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html)
// . If you want to add a new replica table to a global table, each of the
// following conditions must be true:
// determine which version you are using, see [Determining the version]. To update existing global tables
// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables].
//
// If you want to add a new replica table to a global table, each of the following
// conditions must be true:
//
// - The table must have the same primary key as all of the other replicas.
//
// - The table must have the same name as all of the other replicas.
//
// - The table must have DynamoDB Streams enabled, with the stream containing
// both the new and the old images of the item.
//
// - None of the replica tables in the global table can contain any data.
//
// If global secondary indexes are specified, then the following conditions must
// also be met:
//
// - The global secondary indexes must have the same name.
//
// - The global secondary indexes must have the same hash key and sort key (if
// present).
//
// If local secondary indexes are specified, then the following conditions must
// also be met:
//
// - The local secondary indexes must have the same name.
//
// - The local secondary indexes must have the same hash key and sort key (if
// present).
//
// Write capacity settings should be set consistently across your replica tables
// and secondary indexes. DynamoDB strongly recommends enabling auto scaling to
// manage the write capacity settings for all of your global tables replicas and
// indexes. If you prefer to manage write capacity settings manually, you should
// provision equal replicated write capacity units to your replica tables. You
// should also provision equal replicated write capacity units to matching
// secondary indexes across your global table.
// indexes.
//
// If you prefer to manage write capacity settings manually, you should provision
// equal replicated write capacity units to your replica tables. You should also
// provision equal replicated write capacity units to matching secondary indexes
// across your global table.
//
// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html
// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html
func (c *Client) CreateGlobalTable(ctx context.Context, params *CreateGlobalTableInput, optFns ...func(*Options)) (*CreateGlobalTableOutput, error) {
if params == nil {
params = &CreateGlobalTableInput{}

135
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_CreateTable.go generated vendored
View file

@ -15,15 +15,19 @@ import (
// The CreateTable operation adds a new table to your account. In an Amazon Web
// Services account, table names must be unique within each Region. That is, you
// can have two tables with same name if you create the tables in different
// Regions. CreateTable is an asynchronous operation. Upon receiving a CreateTable
// request, DynamoDB immediately returns a response with a TableStatus of CREATING
// . After the table is created, DynamoDB sets the TableStatus to ACTIVE . You can
// perform read and write operations only on an ACTIVE table. You can optionally
// define secondary indexes on the new table, as part of the CreateTable
// operation. If you want to create multiple tables with secondary indexes on them,
// you must create the tables sequentially. Only one table with secondary indexes
// can be in the CREATING state at any given time. You can use the DescribeTable
// action to check the table status.
// Regions.
//
// CreateTable is an asynchronous operation. Upon receiving a CreateTable request,
// DynamoDB immediately returns a response with a TableStatus of CREATING . After
// the table is created, DynamoDB sets the TableStatus to ACTIVE . You can perform
// read and write operations only on an ACTIVE table.
//
// You can optionally define secondary indexes on the new table, as part of the
// CreateTable operation. If you want to create multiple tables with secondary
// indexes on them, you must create the tables sequentially. Only one table with
// secondary indexes can be in the CREATING state at any given time.
//
// You can use the DescribeTable action to check the table status.
func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) {
if params == nil {
params = &CreateTableInput{}
@ -49,25 +53,38 @@ type CreateTableInput struct {
// Specifies the attributes that make up the primary key for a table or an index.
// The attributes in KeySchema must also be defined in the AttributeDefinitions
// array. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html)
// in the Amazon DynamoDB Developer Guide. Each KeySchemaElement in the array is
// composed of:
// array. For more information, see [Data Model]in the Amazon DynamoDB Developer Guide.
//
// Each KeySchemaElement in the array is composed of:
//
// - AttributeName - The name of this key attribute.
//
// - KeyType - The role that the key attribute will assume:
//
// - HASH - partition key
//
// - RANGE - sort key
//
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from the DynamoDB usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
// values.
//
// The sort key of an item is also known as its range attribute. The term "range
// attribute" derives from the way DynamoDB stores items with the same partition
// key physically close together, in sorted order by the sort key value.
//
// For a simple primary key (partition key), you must provide exactly one element
// with a KeyType of HASH . For a composite primary key (partition key and sort
// key), you must provide exactly two elements, in this order: The first element
// must have a KeyType of HASH , and the second element must have a KeyType of
// RANGE . For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)
// in the Amazon DynamoDB Developer Guide.
// with a KeyType of HASH .
//
// For a composite primary key (partition key and sort key), you must provide
// exactly two elements, in this order: The first element must have a KeyType of
// HASH , and the second element must have a KeyType of RANGE .
//
// For more information, see [Working with Tables] in the Amazon DynamoDB Developer Guide.
//
// [Data Model]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html
// [Working with Tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key
//
// This member is required.
KeySchema []types.KeySchemaElement
@ -80,12 +97,15 @@ type CreateTableInput struct {
// Controls how you are charged for read and write throughput and how you manage
// capacity. This setting can be changed later.
//
// - PROVISIONED - We recommend using PROVISIONED for predictable workloads.
// PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)
// .
// PROVISIONED sets the billing mode to [Provisioned capacity mode].
//
// - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
// workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)
// .
// workloads. PAY_PER_REQUEST sets the billing mode to [On-demand capacity mode].
//
// [Provisioned capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html
// [On-demand capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html
BillingMode types.BillingMode
// Indicates whether deletion protection is to be enabled (true) or disabled
@ -94,23 +114,32 @@ type CreateTableInput struct {
// One or more global secondary indexes (the maximum is 20) to be created on the
// table. Each global secondary index in the array includes the following:
//
// - IndexName - The name of the global secondary index. Must be unique only for
// this table.
//
// - KeySchema - Specifies the key schema for the global secondary index.
//
// - Projection - Specifies attributes that are copied (projected) from the table
// into the index. These are in addition to the primary key attributes and index
// key attributes, which are automatically projected. Each attribute specification
// is composed of:
//
// - ProjectionType - One of the following:
//
// - KEYS_ONLY - Only the index and primary keys are projected into the index.
//
// - INCLUDE - Only the specified table attributes are projected into the index.
// The list of projected attributes is in NonKeyAttributes .
//
// - ALL - All of the table attributes are projected into the index.
//
// - NonKeyAttributes - A list of one or more non-key attribute names that are
// projected into the secondary index. The total count of attributes provided in
// NonKeyAttributes , summed across all of the secondary indexes, must not exceed
// 100. If you project the same attribute into two different indexes, this counts
// as two distinct attributes when determining the total.
//
// - ProvisionedThroughput - The provisioned throughput settings for the global
// secondary index, consisting of read and write capacity units.
GlobalSecondaryIndexes []types.GlobalSecondaryIndex
@ -118,21 +147,30 @@ type CreateTableInput struct {
// One or more local secondary indexes (the maximum is 5) to be created on the
// table. Each index is scoped to a given partition key value. There is a 10 GB
// size limit per partition key value; otherwise, the size of a local secondary
// index is unconstrained. Each local secondary index in the array includes the
// following:
// index is unconstrained.
//
// Each local secondary index in the array includes the following:
//
// - IndexName - The name of the local secondary index. Must be unique only for
// this table.
//
// - KeySchema - Specifies the key schema for the local secondary index. The key
// schema must begin with the same partition key as the table.
//
// - Projection - Specifies attributes that are copied (projected) from the table
// into the index. These are in addition to the primary key attributes and index
// key attributes, which are automatically projected. Each attribute specification
// is composed of:
//
// - ProjectionType - One of the following:
//
// - KEYS_ONLY - Only the index and primary keys are projected into the index.
//
// - INCLUDE - Only the specified table attributes are projected into the index.
// The list of projected attributes is in NonKeyAttributes .
//
// - ALL - All of the table attributes are projected into the index.
//
// - NonKeyAttributes - A list of one or more non-key attribute names that are
// projected into the secondary index. The total count of attributes provided in
// NonKeyAttributes , summed across all of the secondary indexes, must not exceed
@ -146,39 +184,52 @@ type CreateTableInput struct {
OnDemandThroughput *types.OnDemandThroughput
// Represents the provisioned throughput settings for a specified table or index.
// The settings can be modified using the UpdateTable operation. If you set
// BillingMode as PROVISIONED , you must specify this property. If you set
// BillingMode as PAY_PER_REQUEST , you cannot specify this property. For current
// minimum and maximum provisioned throughput values, see Service, Account, and
// Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
// The settings can be modified using the UpdateTable operation.
//
// If you set BillingMode as PROVISIONED , you must specify this property. If you
// set BillingMode as PAY_PER_REQUEST , you cannot specify this property.
//
// For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the
// Amazon DynamoDB Developer Guide.
//
// [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html
ProvisionedThroughput *types.ProvisionedThroughput
// An Amazon Web Services resource-based policy document in JSON format that will
// be attached to the table. When you attach a resource-based policy while creating
// a table, the policy application is strongly consistent. The maximum size
// supported for a resource-based policy document is 20 KB. DynamoDB counts
// whitespaces when calculating the size of a policy against this limit. For a full
// list of all considerations that apply for resource-based policies, see
// Resource-based policy considerations (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)
// .
// be attached to the table.
//
// When you attach a resource-based policy while creating a table, the policy
// application is strongly consistent.
//
// The maximum size supported for a resource-based policy document is 20 KB.
// DynamoDB counts whitespaces when calculating the size of a policy against this
// limit. For a full list of all considerations that apply for resource-based
// policies, see [Resource-based policy considerations].
//
// [Resource-based policy considerations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
ResourcePolicy *string
// Represents the settings used to enable server-side encryption.
SSESpecification *types.SSESpecification
// The settings for DynamoDB Streams on the table. These settings consist of:
//
// - StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true)
// or disabled (false).
//
// - StreamViewType - When an item in the table is modified, StreamViewType
// determines what information is written to the table's stream. Valid values for
// StreamViewType are:
//
// - KEYS_ONLY - Only the key attributes of the modified item are written to the
// stream.
//
// - NEW_IMAGE - The entire item, as it appears after it was modified, is written
// to the stream.
//
// - OLD_IMAGE - The entire item, as it appeared before it was modified, is
// written to the stream.
//
// - NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are
// written to the stream.
StreamSpecification *types.StreamSpecification
@ -187,9 +238,9 @@ type CreateTableInput struct {
// STANDARD_INFREQUENT_ACCESS .
TableClass types.TableClass
// A list of key-value pairs to label the table. For more information, see Tagging
// for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
// .
// A list of key-value pairs to label the table. For more information, see [Tagging for DynamoDB].
//
// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html
Tags []types.Tag
noSmithyDocumentSerde

5
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DeleteBackup.go generated vendored
View file

@ -12,8 +12,9 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Deletes an existing backup of a table. You can call DeleteBackup at a maximum
// rate of 10 times per second.
// Deletes an existing backup of a table.
//
// You can call DeleteBackup at a maximum rate of 10 times per second.
func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, optFns ...func(*Options)) (*DeleteBackupOutput, error) {
if params == nil {
params = &DeleteBackupInput{}

154
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DeleteItem.go generated vendored
View file

@ -14,13 +14,18 @@ import (
// Deletes a single item in a table by primary key. You can perform a conditional
// delete operation that deletes the item if it exists, or if it has an expected
// attribute value. In addition to deleting an item, you can also return the item's
// attribute values in the same operation, using the ReturnValues parameter.
// attribute value.
//
// In addition to deleting an item, you can also return the item's attribute
// values in the same operation, using the ReturnValues parameter.
//
// Unless you specify conditions, the DeleteItem is an idempotent operation;
// running it multiple times on the same item or attribute does not result in an
// error response. Conditional deletes are useful for deleting items only if
// specific conditions are met. If those conditions are met, DynamoDB performs the
// delete. Otherwise, the item is not deleted.
// error response.
//
// Conditional deletes are useful for deleting items only if specific conditions
// are met. If those conditions are met, DynamoDB performs the delete. Otherwise,
// the item is not deleted.
func (c *Client) DeleteItem(ctx context.Context, params *DeleteItemInput, optFns ...func(*Options)) (*DeleteItemOutput, error) {
if params == nil {
params = &DeleteItemInput{}
@ -40,10 +45,12 @@ func (c *Client) DeleteItem(ctx context.Context, params *DeleteItemInput, optFns
type DeleteItemInput struct {
// A map of attribute names to AttributeValue objects, representing the primary
// key of the item to delete. For the primary key, you must provide all of the key
// attributes. For example, with a simple primary key, you only need to provide a
// value for the partition key. For a composite primary key, you must provide
// values for both the partition key and the sort key.
// key of the item to delete.
//
// For the primary key, you must provide all of the key attributes. For example,
// with a simple primary key, you only need to provide a value for the partition
// key. For a composite primary key, you must provide values for both the partition
// key and the sort key.
//
// This member is required.
Key map[string]types.AttributeValue
@ -55,70 +62,111 @@ type DeleteItemInput struct {
TableName *string
// A condition that must be satisfied in order for a conditional DeleteItem to
// succeed. An expression can contain any of the following:
// succeed.
//
// An expression can contain any of the following:
//
// - Functions: attribute_exists | attribute_not_exists | attribute_type |
// contains | begins_with | size These function names are case-sensitive.
// contains | begins_with | size
//
// These function names are case-sensitive.
//
// - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
//
// - Logical operators: AND | OR | NOT
// For more information about condition expressions, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
//
// For more information about condition expressions, see [Condition Expressions] in the Amazon DynamoDB
// Developer Guide.
//
// [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ConditionExpression *string
// This is a legacy parameter. Use ConditionExpression instead. For more
// information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [ConditionalOperator]in the Amazon DynamoDB Developer Guide.
//
// [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html
ConditionalOperator types.ConditionalOperator
// This is a legacy parameter. Use ConditionExpression instead. For more
// information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [Expected]in the Amazon DynamoDB Developer Guide.
//
// [Expected]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html
Expected map[string]types.ExpectedAttributeValue
// One or more substitution tokens for attribute names in an expression. The
// following are some use cases for using ExpressionAttributeNames :
//
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
//
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
//
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression.
//
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
//
// - Percentile
//
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see
// Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
// the following for ExpressionAttributeNames :
// directly in an expression. (For the complete list of reserved words, see [Reserved Words]in the
// Amazon DynamoDB Developer Guide). To work around this, you could specify the
// following for ExpressionAttributeNames :
//
// - {"#P":"Percentile"}
//
// You could then use this substitution in an expression, as in this example:
//
// - #P = :val
//
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime. For more information on
// expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// are placeholders for the actual value at runtime.
//
// For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB
// Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression. Use the : (colon)
// character in an expression to dereference an attribute value. For example,
// suppose that you wanted to check whether the value of the ProductStatus
// attribute was one of the following: Available | Backordered | Discontinued You
// would first need to specify ExpressionAttributeValues as follows: {
// ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} } You could then use these values in an expression,
// such as this: ProductStatus IN (:avail, :back, :disc) For more information on
// expression attribute values, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
// One or more values that can be substituted in an expression.
//
// Use the : (colon) character in an expression to dereference an attribute value.
// For example, suppose that you wanted to check whether the value of the
// ProductStatus attribute was one of the following:
//
// Available | Backordered | Discontinued
//
// You would first need to specify ExpressionAttributeValues as follows:
//
// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} }
//
// You could then use these values in an expression, such as this:
//
// ProductStatus IN (:avail, :back, :disc)
//
// For more information on expression attribute values, see [Condition Expressions] in the Amazon
// DynamoDB Developer Guide.
//
// [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ExpressionAttributeValues map[string]types.AttributeValue
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
@ -130,20 +178,26 @@ type DeleteItemInput struct {
// Use ReturnValues if you want to get the item attributes as they appeared before
// they were deleted. For DeleteItem , the valid values are:
//
// - NONE - If ReturnValues is not specified, or if its value is NONE , then
// nothing is returned. (This setting is the default for ReturnValues .)
//
// - ALL_OLD - The content of the old item is returned.
//
// There is no additional cost associated with requesting a return value aside
// from the small network and processing overhead of receiving a larger response.
// No read capacity units are consumed. The ReturnValues parameter is used by
// several DynamoDB operations; however, DeleteItem does not recognize any values
// other than NONE or ALL_OLD .
// No read capacity units are consumed.
//
// The ReturnValues parameter is used by several DynamoDB operations; however,
// DeleteItem does not recognize any values other than NONE or ALL_OLD .
ReturnValues types.ReturnValue
// An optional parameter that returns the item attributes for a DeleteItem
// operation that failed a condition check. There is no additional cost associated
// with requesting a return value aside from the small network and processing
// overhead of receiving a larger response. No read capacity units are consumed.
// operation that failed a condition check.
//
// There is no additional cost associated with requesting a return value aside
// from the small network and processing overhead of receiving a larger response.
// No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
@ -161,24 +215,30 @@ type DeleteItemOutput struct {
// 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 ReturnConsumedCapacity parameter was specified. For more
// information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [Provisioned capacity mode]in the Amazon DynamoDB Developer Guide.
//
// [Provisioned capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html
ConsumedCapacity *types.ConsumedCapacity
// Information about item collections, if any, that were affected by the DeleteItem
// operation. ItemCollectionMetrics is only returned if the
// ReturnItemCollectionMetrics parameter was specified. If the table does not have
// any local secondary indexes, this information is not returned in the response.
//
// Each ItemCollectionMetrics element consists of:
//
// - ItemCollectionKey - The partition key value of the item collection. This is
// the same as the partition key value of the item itself.
//
// - SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
// This value is a two-element array containing a lower bound and an upper bound
// for the estimate. The estimate includes the size of all the items in the table,
// plus the size of all attributes projected into all of the local secondary
// indexes on that table. Use this estimate to measure whether a local secondary
// index is approaching its size limit. The estimate is subject to change over
// time; therefore, do not rely on the precision or accuracy of the estimate.
// index is approaching its size limit.
//
// The estimate is subject to change over time; therefore, do not rely on the
// precision or accuracy of the estimate.
ItemCollectionMetrics *types.ItemCollectionMetrics
// Metadata pertaining to the operation's result.

24
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DeleteResourcePolicy.go generated vendored
View file

@ -12,13 +12,17 @@ import (
)
// Deletes the resource-based policy attached to the resource, which can be a
// table or stream. DeleteResourcePolicy is an idempotent operation; running it
// multiple times on the same resource doesn't result in an error response, unless
// you specify an ExpectedRevisionId , which will then return a
// PolicyNotFoundException . To make sure that you don't inadvertently lock
// yourself out of your own resources, the root principal in your Amazon Web
// Services account can perform DeleteResourcePolicy requests, even if your
// resource-based policy explicitly denies the root principal's access.
// table or stream.
//
// DeleteResourcePolicy is an idempotent operation; running it multiple times on
// the same resource doesn't result in an error response, unless you specify an
// ExpectedRevisionId , which will then return a PolicyNotFoundException .
//
// To make sure that you don't inadvertently lock yourself out of your own
// resources, the root principal in your Amazon Web Services account can perform
// DeleteResourcePolicy requests, even if your resource-based policy explicitly
// denies the root principal's access.
//
// DeleteResourcePolicy is an asynchronous operation. If you issue a
// GetResourcePolicy request immediately after running the DeleteResourcePolicy
// request, DynamoDB might still return the deleted policy. This is because the
@ -62,8 +66,10 @@ type DeleteResourcePolicyInput struct {
type DeleteResourcePolicyOutput struct {
// A unique string that represents the revision ID of the policy. If you're
// comparing revision IDs, make sure to always use string comparison logic. This
// value will be empty if you make a request against a resource without a policy.
// comparing revision IDs, make sure to always use string comparison logic.
//
// This value will be empty if you make a request against a resource without a
// policy.
RevisionId *string
// Metadata pertaining to the operation's result.

25
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DeleteTable.go generated vendored
View file

@ -18,15 +18,22 @@ import (
// delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns
// a ResourceInUseException . If the specified table does not exist, DynamoDB
// returns a ResourceNotFoundException . If table is already in the DELETING
// state, no error is returned. This operation only applies to Version 2019.11.21
// (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// of global tables. DynamoDB might continue to accept data read and write
// operations, such as GetItem and PutItem , on a table in the DELETING state
// until the table deletion is complete. When you delete a table, any indexes on
// that table are also deleted. If you have DynamoDB Streams enabled on the table,
// then the corresponding stream on that table goes into the DISABLED state, and
// the stream is automatically deleted after 24 hours. Use the DescribeTable
// action to check the status of the table.
// state, no error is returned.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version).
//
// DynamoDB might continue to accept data read and write operations, such as
// GetItem and PutItem , on a table in the DELETING state until the table deletion
// is complete.
//
// When you delete a table, any indexes on that table are also deleted.
//
// If you have DynamoDB Streams enabled on the table, then the corresponding
// stream on that table goes into the DISABLED state, and the stream is
// automatically deleted after 24 hours.
//
// Use the DescribeTable action to check the status of the table.
func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optFns ...func(*Options)) (*DeleteTableOutput, error) {
if params == nil {
params = &DeleteTableInput{}

5
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeBackup.go generated vendored
View file

@ -12,8 +12,9 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Describes an existing backup of a table. You can call DescribeBackup at a
// maximum rate of 10 times per second.
// Describes an existing backup of a table.
//
// You can call DescribeBackup at a maximum rate of 10 times per second.
func (c *Client) DescribeBackup(ctx context.Context, params *DescribeBackupInput, optFns ...func(*Options)) (*DescribeBackupOutput, error) {
if params == nil {
params = &DescribeBackupInput{}

22
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeContinuousBackups.go generated vendored
View file

@ -15,12 +15,16 @@ import (
// Checks the status of continuous backups and point in time recovery on the
// specified table. Continuous backups are ENABLED on all tables at table
// creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will
// be set to ENABLED. After continuous backups and point in time recovery are
// enabled, you can restore to any point in time within EarliestRestorableDateTime
// and LatestRestorableDateTime . LatestRestorableDateTime is typically 5 minutes
// before the current time. You can restore your table to any point in time during
// the last 35 days. You can call DescribeContinuousBackups at a maximum rate of
// 10 times per second.
// be set to ENABLED.
//
// After continuous backups and point in time recovery are enabled, you can
// restore to any point in time within EarliestRestorableDateTime and
// LatestRestorableDateTime .
//
// LatestRestorableDateTime is typically 5 minutes before the current time. You
// can restore your table to any point in time during the last 35 days.
//
// You can call DescribeContinuousBackups at a maximum rate of 10 times per second.
func (c *Client) DescribeContinuousBackups(ctx context.Context, params *DescribeContinuousBackupsInput, optFns ...func(*Options)) (*DescribeContinuousBackupsOutput, error) {
if params == nil {
params = &DescribeContinuousBackupsInput{}
@ -39,8 +43,10 @@ func (c *Client) DescribeContinuousBackups(ctx context.Context, params *Describe
type DescribeContinuousBackupsInput struct {
// Name of the table for which the customer wants to check the continuous backups
// and point in time recovery settings. You can also provide the Amazon Resource
// Name (ARN) of the table in this parameter.
// and point in time recovery settings.
//
// You can also provide the Amazon Resource Name (ARN) of the table in this
// parameter.
//
// This member is required.
TableName *string

9
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeContributorInsights.go generated vendored
View file

@ -51,15 +51,20 @@ type DescribeContributorInsightsOutput struct {
// Current status of contributor insights.
ContributorInsightsStatus types.ContributorInsightsStatus
// Returns information about the last failure that was encountered. The most
// common exceptions for a FAILED status are:
// Returns information about the last failure that was encountered.
//
// The most common exceptions for a FAILED status are:
//
// - LimitExceededException - Per-account Amazon CloudWatch Contributor Insights
// rule limit reached. Please disable Contributor Insights for other tables/indexes
// OR disable Contributor Insights rules before retrying.
//
// - AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot
// be modified due to insufficient permissions.
//
// - AccessDeniedException - Failed to create service-linked role for
// Contributor Insights due to insufficient permissions.
//
// - InternalServerError - Failed to create Amazon CloudWatch Contributor
// Insights rules. Please retry request.
FailureException *types.FailureException

5
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeEndpoints.go generated vendored
View file

@ -12,8 +12,9 @@ import (
)
// Returns the regional endpoint information. For more information on policy
// permissions, please see Internetwork traffic privacy (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints)
// .
// permissions, please see [Internetwork traffic privacy].
//
// [Internetwork traffic privacy]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints
func (c *Client) DescribeEndpoints(ctx context.Context, params *DescribeEndpointsInput, optFns ...func(*Options)) (*DescribeEndpointsOutput, error) {
if params == nil {
params = &DescribeEndpointsInput{}

17
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeGlobalTable.go generated vendored
View file

@ -12,15 +12,16 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns information about the specified global table. This operation only
// applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html)
// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// when creating new global tables, as it provides greater flexibility, higher
// Returns information about the specified global table.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version), as it provides greater flexibility, higher
// efficiency and consumes less write capacity than 2017.11.29 (Legacy). To
// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html)
// . To update existing global tables from version 2017.11.29 (Legacy) to version
// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html)
// .
// determine which version you are using, see [Determining the version]. To update existing global tables
// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables].
//
// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html
// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html
func (c *Client) DescribeGlobalTable(ctx context.Context, params *DescribeGlobalTableInput, optFns ...func(*Options)) (*DescribeGlobalTableOutput, error) {
if params == nil {
params = &DescribeGlobalTableInput{}

17
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeGlobalTableSettings.go generated vendored
View file

@ -12,15 +12,16 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Describes Region-specific settings for a global table. This operation only
// applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html)
// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// when creating new global tables, as it provides greater flexibility, higher
// Describes Region-specific settings for a global table.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version), as it provides greater flexibility, higher
// efficiency and consumes less write capacity than 2017.11.29 (Legacy). To
// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html)
// . To update existing global tables from version 2017.11.29 (Legacy) to version
// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html)
// .
// determine which version you are using, see [Determining the version]. To update existing global tables
// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables].
//
// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html
// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html
func (c *Client) DescribeGlobalTableSettings(ctx context.Context, params *DescribeGlobalTableSettingsInput, optFns ...func(*Options)) (*DescribeGlobalTableSettingsOutput, error) {
if params == nil {
params = &DescribeGlobalTableSettingsInput{}

4
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeImport.go generated vendored
View file

@ -29,7 +29,7 @@ func (c *Client) DescribeImport(ctx context.Context, params *DescribeImportInput
type DescribeImportInput struct {
// The Amazon Resource Name (ARN) associated with the table you're importing to.
// The Amazon Resource Name (ARN) associated with the table you're importing to.
//
// This member is required.
ImportArn *string
@ -39,7 +39,7 @@ type DescribeImportInput struct {
type DescribeImportOutput struct {
// Represents the properties of the table created for the import, and parameters
// Represents the properties of the table created for the import, and parameters
// of the import. The import parameters include import status, how many items were
// processed, and how many errors were encountered.
//

60
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeLimits.go generated vendored
View file

@ -13,42 +13,64 @@ import (
// Returns the current provisioned-capacity quotas for your Amazon Web Services
// account in a Region, both for the Region as a whole and for any one DynamoDB
// table that you create there. When you establish an Amazon Web Services account,
// the account has initial quotas on the maximum read capacity units and write
// capacity units that you can provision across all of your DynamoDB tables in a
// given Region. Also, there are per-table quotas that apply when you create a
// table there. For more information, see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// page in the Amazon DynamoDB Developer Guide. Although you can increase these
// quotas by filing a case at Amazon Web Services Support Center (https://console.aws.amazon.com/support/home#/)
// , obtaining the increase is not instantaneous. The DescribeLimits action lets
// you write code to compare the capacity you are currently using to those quotas
// imposed by your account so that you have enough time to apply for an increase
// before you hit a quota. For example, you could use one of the Amazon Web
// Services SDKs to do the following:
// table that you create there.
//
// When you establish an Amazon Web Services account, the account has initial
// quotas on the maximum read capacity units and write capacity units that you can
// provision across all of your DynamoDB tables in a given Region. Also, there are
// per-table quotas that apply when you create a table there. For more information,
// see [Service, Account, and Table Quotas]page in the Amazon DynamoDB Developer Guide.
//
// Although you can increase these quotas by filing a case at [Amazon Web Services Support Center], obtaining the
// increase is not instantaneous. The DescribeLimits action lets you write code to
// compare the capacity you are currently using to those quotas imposed by your
// account so that you have enough time to apply for an increase before you hit a
// quota.
//
// For example, you could use one of the Amazon Web Services SDKs to do the
// following:
//
// - Call DescribeLimits for a particular Region to obtain your current account
// quotas on provisioned capacity there.
//
// - Create a variable to hold the aggregate read capacity units provisioned for
// all your tables in that Region, and one to hold the aggregate write capacity
// units. Zero them both.
//
// - Call ListTables to obtain a list of all your DynamoDB tables.
//
// - For each table name listed by ListTables , do the following:
//
// - Call DescribeTable with the table name.
//
// - Use the data returned by DescribeTable to add the read capacity units and
// write capacity units provisioned for the table itself to your variables.
//
// - If the table has one or more global secondary indexes (GSIs), loop over
// these GSIs and add their provisioned capacity values to your variables as well.
//
// - Report the account quotas for that Region returned by DescribeLimits , along
// with the total current provisioned capacity levels you have calculated.
//
// This will let you see whether you are getting close to your account-level
// quotas. The per-table quotas apply only when you are creating a new table. They
// quotas.
//
// The per-table quotas apply only when you are creating a new table. They
// restrict the sum of the provisioned capacity of the new table itself and all its
// global secondary indexes. For existing tables and their GSIs, DynamoDB doesn't
// let you increase provisioned capacity extremely rapidly, but the only quota that
// applies is that the aggregate provisioned capacity over all your tables and GSIs
// cannot exceed either of the per-account quotas. DescribeLimits should only be
// called periodically. You can expect throttling errors if you call it more than
// once in a minute. The DescribeLimits Request element has no content.
// global secondary indexes.
//
// For existing tables and their GSIs, DynamoDB doesn't let you increase
// provisioned capacity extremely rapidly, but the only quota that applies is that
// the aggregate provisioned capacity over all your tables and GSIs cannot exceed
// either of the per-account quotas.
//
// DescribeLimits should only be called periodically. You can expect throttling
// errors if you call it more than once in a minute.
//
// The DescribeLimits Request element has no content.
//
// [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html
// [Amazon Web Services Support Center]: https://console.aws.amazon.com/support/home#/
func (c *Client) DescribeLimits(ctx context.Context, params *DescribeLimitsInput, optFns ...func(*Options)) (*DescribeLimitsOutput, error) {
if params == nil {
params = &DescribeLimitsInput{}

43
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeTable.go generated vendored
View file

@ -18,13 +18,16 @@ import (
)
// Returns information about the table, including the current status of the table,
// when it was created, the primary key schema, and any indexes on the table. This
// operation only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// of global tables. If you issue a DescribeTable request immediately after a
// CreateTable request, DynamoDB might return a ResourceNotFoundException . This is
// because DescribeTable uses an eventually consistent query, and the metadata for
// your table might not be available at that moment. Wait for a few seconds, and
// then try the DescribeTable request again.
// when it was created, the primary key schema, and any indexes on the table.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version).
//
// If you issue a DescribeTable request immediately after a CreateTable request,
// DynamoDB might return a ResourceNotFoundException . This is because
// DescribeTable uses an eventually consistent query, and the metadata for your
// table might not be available at that moment. Wait for a few seconds, and then
// try the DescribeTable request again.
func (c *Client) DescribeTable(ctx context.Context, params *DescribeTableInput, optFns ...func(*Options)) (*DescribeTableOutput, error) {
if params == nil {
params = &DescribeTableInput{}
@ -234,12 +237,13 @@ type TableExistsWaiterOptions struct {
// Retryable is function that can be used to override the service defined
// waiter-behavior based on operation output, or returned error. This function is
// used by the waiter to decide if a state is retryable or a terminal state. By
// default service-modeled logic will populate this option. This option can thus be
// used to define a custom waiter state with fall-back to service-modeled waiter
// state mutators.The function returns an error in case of a failure state. In case
// of retry state, this function returns a bool value of true and nil error, while
// in case of success it returns a bool value of false and nil error.
// used by the waiter to decide if a state is retryable or a terminal state.
//
// By default service-modeled logic will populate this option. This option can
// thus be used to define a custom waiter state with fall-back to service-modeled
// waiter state mutators.The function returns an error in case of a failure state.
// In case of retry state, this function returns a bool value of true and nil
// error, while in case of success it returns a bool value of false and nil error.
Retryable func(context.Context, *DescribeTableInput, *DescribeTableOutput, error) (bool, error)
}
@ -412,12 +416,13 @@ type TableNotExistsWaiterOptions struct {
// Retryable is function that can be used to override the service defined
// waiter-behavior based on operation output, or returned error. This function is
// used by the waiter to decide if a state is retryable or a terminal state. By
// default service-modeled logic will populate this option. This option can thus be
// used to define a custom waiter state with fall-back to service-modeled waiter
// state mutators.The function returns an error in case of a failure state. In case
// of retry state, this function returns a bool value of true and nil error, while
// in case of success it returns a bool value of false and nil error.
// used by the waiter to decide if a state is retryable or a terminal state.
//
// By default service-modeled logic will populate this option. This option can
// thus be used to define a custom waiter state with fall-back to service-modeled
// waiter state mutators.The function returns an error in case of a failure state.
// In case of retry state, this function returns a bool value of true and nil
// error, while in case of success it returns a bool value of false and nil error.
Retryable func(context.Context, *DescribeTableInput, *DescribeTableOutput, error) (bool, error)
}

5
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go generated vendored
View file

@ -12,8 +12,9 @@ import (
)
// Describes auto scaling settings across replicas of the global table at once.
// This operation only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// of global tables.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version).
func (c *Client) DescribeTableReplicaAutoScaling(ctx context.Context, params *DescribeTableReplicaAutoScalingInput, optFns ...func(*Options)) (*DescribeTableReplicaAutoScalingOutput, error) {
if params == nil {
params = &DescribeTableReplicaAutoScalingInput{}

40
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ExecuteStatement.go generated vendored
View file

@ -12,12 +12,15 @@ import (
)
// This operation allows you to perform reads and singleton writes on data stored
// in DynamoDB, using PartiQL. For PartiQL reads ( SELECT statement), if the total
// number of processed items exceeds the maximum dataset size limit of 1 MB, the
// read stops and results are returned to the user as a LastEvaluatedKey value to
// continue the read in a subsequent operation. If the filter criteria in WHERE
// clause does not match any data, the read will return an empty result set. A
// single SELECT statement response can return up to the maximum number of items
// in DynamoDB, using PartiQL.
//
// For PartiQL reads ( SELECT statement), if the total number of processed items
// exceeds the maximum dataset size limit of 1 MB, the read stops and results are
// returned to the user as a LastEvaluatedKey value to continue the read in a
// subsequent operation. If the filter criteria in WHERE clause does not match any
// data, the read will return an empty result set.
//
// A single SELECT statement response can return up to the maximum number of items
// (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
// filtering to the results using WHERE clause). If LastEvaluatedKey is present in
// the response, you need to paginate the result set. If NextToken is present, you
@ -67,20 +70,27 @@ type ExecuteStatementInput struct {
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
// An optional parameter that returns the item attributes for an ExecuteStatement
// operation that failed a condition check. There is no additional cost associated
// with requesting a return value aside from the small network and processing
// overhead of receiving a larger response. No read capacity units are consumed.
// operation that failed a condition check.
//
// There is no additional cost associated with requesting a return value aside
// from the small network and processing overhead of receiving a larger response.
// No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
@ -91,8 +101,10 @@ type ExecuteStatementOutput struct {
// 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
// in the Amazon DynamoDB Developer Guide.
// request asked for it. For more information, see [Provisioned capacity mode]in the Amazon DynamoDB
// Developer Guide.
//
// [Provisioned capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html
ConsumedCapacity *types.ConsumedCapacity
// If a read operation was used, this property will contain the result of the read

22
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ExecuteTransaction.go generated vendored
View file

@ -12,12 +12,14 @@ import (
)
// This operation allows you to perform transactional reads or writes on data
// stored in DynamoDB, using PartiQL. The entire transaction must consist of either
// read statements or write statements, you cannot mix both in one transaction. The
// EXISTS function is an exception and can be used to check the condition of
// specific attributes of the item in a similar manner to ConditionCheck in the
// TransactWriteItems (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems)
// API.
// stored in DynamoDB, using PartiQL.
//
// The entire transaction must consist of either read statements or write
// statements, you cannot mix both in one transaction. The EXISTS function is an
// exception and can be used to check the condition of specific attributes of the
// item in a similar manner to ConditionCheck in the [TransactWriteItems] API.
//
// [TransactWriteItems]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems
func (c *Client) ExecuteTransaction(ctx context.Context, params *ExecuteTransactionInput, optFns ...func(*Options)) (*ExecuteTransactionOutput, error) {
if params == nil {
params = &ExecuteTransactionInput{}
@ -45,10 +47,10 @@ type ExecuteTransactionInput struct {
ClientRequestToken *string
// Determines the level of detail about either provisioned or on-demand throughput
// consumption that is returned in the response. For more information, see
// TransactGetItems (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html)
// and TransactWriteItems (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html)
// .
// consumption that is returned in the response. For more information, see [TransactGetItems]and [TransactWriteItems].
//
// [TransactWriteItems]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html
// [TransactGetItems]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html
ReturnConsumedCapacity types.ReturnConsumedCapacity
noSmithyDocumentSerde

23
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ExportTableToPointInTime.go generated vendored
View file

@ -44,12 +44,15 @@ type ExportTableToPointInTimeInput struct {
// Providing a ClientToken makes the call to ExportTableToPointInTimeInput
// idempotent, meaning that multiple identical calls have the same effect as one
// single call. A client token is valid for 8 hours after the first request that
// uses it is completed. After 8 hours, any request with the same client token is
// treated as a new request. Do not resubmit the same request with the same client
// token for more than 8 hours, or the result might not be idempotent. If you
// submit a request with the same client token but a change in other parameters
// within the 8-hour idempotency window, DynamoDB returns an
// single call.
//
// A client token is valid for 8 hours after the first request that uses it is
// completed. After 8 hours, any request with the same client token is treated as a
// new request. Do not resubmit the same request with the same client token for
// more than 8 hours, or the result might not be idempotent.
//
// If you submit a request with the same client token but a change in other
// parameters within the 8-hour idempotency window, DynamoDB returns an
// ImportConflictException .
ClientToken *string
@ -72,8 +75,10 @@ type ExportTableToPointInTimeInput struct {
IncrementalExportSpecification *types.IncrementalExportSpecification
// The ID of the Amazon Web Services account that owns the bucket the export will
// be stored in. S3BucketOwner is a required parameter when exporting to a S3
// bucket in another account.
// be stored in.
//
// S3BucketOwner is a required parameter when exporting to a S3 bucket in another
// account.
S3BucketOwner *string
// The Amazon S3 bucket prefix to use as the file name and path of the exported
@ -82,7 +87,9 @@ type ExportTableToPointInTimeInput struct {
// Type of encryption used on the bucket where export data will be stored. Valid
// values for S3SseAlgorithm are:
//
// - AES256 - server-side encryption with Amazon S3 managed keys
//
// - KMS - server-side encryption with KMS managed keys
S3SseAlgorithm types.S3SseAlgorithm

82
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_GetItem.go generated vendored
View file

@ -14,11 +14,12 @@ import (
// The GetItem operation returns a set of attributes for the item with the given
// primary key. If there is no matching item, GetItem does not return any data and
// there will be no Item element in the response. GetItem provides an eventually
// consistent read by default. If your application requires a strongly consistent
// read, set ConsistentRead to true . Although a strongly consistent read might
// take more time than an eventually consistent read, it always returns the last
// updated value.
// there will be no Item element in the response.
//
// GetItem provides an eventually consistent read by default. If your application
// requires a strongly consistent read, set ConsistentRead to true . Although a
// strongly consistent read might take more time than an eventually consistent
// read, it always returns the last updated value.
func (c *Client) GetItem(ctx context.Context, params *GetItemInput, optFns ...func(*Options)) (*GetItemOutput, error) {
if params == nil {
params = &GetItemInput{}
@ -38,10 +39,12 @@ func (c *Client) GetItem(ctx context.Context, params *GetItemInput, optFns ...fu
type GetItemInput struct {
// A map of attribute names to AttributeValue objects, representing the primary
// key of the item to retrieve. For the primary key, you must provide all of the
// attributes. For example, with a simple primary key, you only need to provide a
// value for the partition key. For a composite primary key, you must provide
// values for both the partition key and the sort key.
// key of the item to retrieve.
//
// For the primary key, you must provide all of the attributes. For example, with
// a simple primary key, you only need to provide a value for the partition key.
// For a composite primary key, you must provide values for both the partition key
// and the sort key.
//
// This member is required.
Key map[string]types.AttributeValue
@ -53,8 +56,9 @@ type GetItemInput struct {
TableName *string
// This is a legacy parameter. Use ProjectionExpression instead. For more
// information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide.
//
// [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html
AttributesToGet []string
// Determines the read consistency model: If set to true , then the operation uses
@ -64,46 +68,67 @@ type GetItemInput struct {
// One or more substitution tokens for attribute names in an expression. The
// following are some use cases for using ExpressionAttributeNames :
//
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
//
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
//
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression.
//
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
//
// - Percentile
//
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see
// Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
// the following for ExpressionAttributeNames :
// directly in an expression. (For the complete list of reserved words, see [Reserved Words]in the
// Amazon DynamoDB Developer Guide). To work around this, you could specify the
// following for ExpressionAttributeNames :
//
// - {"#P":"Percentile"}
//
// You could then use this substitution in an expression, as in this example:
//
// - #P = :val
//
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime. For more information on
// expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// are placeholders for the actual value at runtime.
//
// For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB
// Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ExpressionAttributeNames map[string]string
// A string that identifies one or more attributes to retrieve from the table.
// These attributes can include scalars, sets, or elements of a JSON document. The
// attributes in the expression must be separated by commas. If no attribute names
// are specified, then all attributes are returned. If any of the requested
// attributes are not found, they do not appear in the result. For more
// information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// attributes in the expression must be separated by commas.
//
// If no attribute names are specified, then all attributes are returned. If any
// of the requested attributes are not found, they do not appear in the result.
//
// For more information, see [Specifying Item Attributes] in the Amazon DynamoDB Developer Guide.
//
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ProjectionExpression *string
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
@ -117,8 +142,9 @@ type GetItemOutput struct {
// 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 ReturnConsumedCapacity parameter was specified. For more
// information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads)
// in the Amazon DynamoDB Developer Guide.
// information, see [Capacity unit consumption for read operations]in the Amazon DynamoDB Developer Guide.
//
// [Capacity unit consumption for read operations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption
ConsumedCapacity *types.ConsumedCapacity
// A map of attribute names to AttributeValue objects, as specified by

29
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_GetResourcePolicy.go generated vendored
View file

@ -12,28 +12,35 @@ import (
)
// Returns the resource-based policy document attached to the resource, which can
// be a table or stream, in JSON format. GetResourcePolicy follows an eventually
// consistent (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html)
// model. The following list describes the outcomes when you issue the
// GetResourcePolicy request immediately after issuing another request:
// be a table or stream, in JSON format.
//
// GetResourcePolicy follows an [eventually consistent] model. The following list describes the outcomes
// when you issue the GetResourcePolicy request immediately after issuing another
// request:
//
// - If you issue a GetResourcePolicy request immediately after a
// PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException .
//
// - If you issue a GetResourcePolicy request immediately after a
// DeleteResourcePolicy request, DynamoDB might return the policy that was
// present before the deletion request.
//
// - If you issue a GetResourcePolicy request immediately after a CreateTable
// request, which includes a resource-based policy, DynamoDB might return a
// ResourceNotFoundException or a PolicyNotFoundException .
//
// Because GetResourcePolicy uses an eventually consistent query, the metadata for
// your policy or table might not be available at that moment. Wait for a few
// seconds, and then retry the GetResourcePolicy request. After a GetResourcePolicy
// request returns a policy created using the PutResourcePolicy request, the
// policy will be applied in the authorization of requests to the resource. Because
// this process is eventually consistent, it will take some time to apply the
// policy to all requests to a resource. Policies that you attach while creating a
// table using the CreateTable request will always be applied to all requests for
// that table.
// seconds, and then retry the GetResourcePolicy request.
//
// After a GetResourcePolicy request returns a policy created using the
// PutResourcePolicy request, the policy will be applied in the authorization of
// requests to the resource. Because this process is eventually consistent, it will
// take some time to apply the policy to all requests to a resource. Policies that
// you attach while creating a table using the CreateTable request will always be
// applied to all requests for that table.
//
// [eventually consistent]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error) {
if params == nil {
params = &GetResourcePolicyInput{}

27
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ImportTable.go generated vendored
View file

@ -29,13 +29,13 @@ func (c *Client) ImportTable(ctx context.Context, params *ImportTableInput, optF
type ImportTableInput struct {
// The format of the source data. Valid values for ImportFormat are CSV ,
// The format of the source data. Valid values for ImportFormat are CSV ,
// DYNAMODB_JSON or ION .
//
// This member is required.
InputFormat types.InputFormat
// The S3 bucket that provides the source for the import.
// The S3 bucket that provides the source for the import.
//
// This member is required.
S3BucketSource *types.S3BucketSource
@ -46,19 +46,22 @@ type ImportTableInput struct {
TableCreationParameters *types.TableCreationParameters
// Providing a ClientToken makes the call to ImportTableInput idempotent, meaning
// that multiple identical calls have the same effect as one single call. A client
// token is valid for 8 hours after the first request that uses it is completed.
// After 8 hours, any request with the same client token is treated as a new
// request. Do not resubmit the same request with the same client token for more
// than 8 hours, or the result might not be idempotent. If you submit a request
// with the same client token but a change in other parameters within the 8-hour
// idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.
// that multiple identical calls have the same effect as one single call.
//
// A client token is valid for 8 hours after the first request that uses it is
// completed. After 8 hours, any request with the same client token is treated as a
// new request. Do not resubmit the same request with the same client token for
// more than 8 hours, or the result might not be idempotent.
//
// If you submit a request with the same client token but a change in other
// parameters within the 8-hour idempotency window, DynamoDB returns an
// IdempotentParameterMismatch exception.
ClientToken *string
// Type of compression to be used on the input coming from the imported table.
// Type of compression to be used on the input coming from the imported table.
InputCompressionType types.InputCompressionType
// Additional properties that specify how the input is formatted,
// Additional properties that specify how the input is formatted,
InputFormatOptions *types.InputFormatOptions
noSmithyDocumentSerde
@ -66,7 +69,7 @@ type ImportTableInput struct {
type ImportTableOutput struct {
// Represents the properties of the table created for the import, and parameters
// Represents the properties of the table created for the import, and parameters
// of the import. The import parameters include import status, how many items were
// processed, and how many errors were encountered.
//

40
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ListBackups.go generated vendored
View file

@ -17,12 +17,17 @@ import (
// and weren't made with Amazon Web Services Backup. To list these backups for a
// given table, specify TableName . ListBackups returns a paginated list of
// results with at most 1 MB worth of items in a page. You can also specify a
// maximum number of entries to be returned in a page. In the request, start time
// is inclusive, but end time is exclusive. Note that these boundaries are for the
// time at which the original backup was requested. You can call ListBackups a
// maximum of five times per second. If you want to retrieve the complete list of
// backups made with Amazon Web Services Backup, use the Amazon Web Services
// Backup list API. (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html)
// maximum number of entries to be returned in a page.
//
// In the request, start time is inclusive, but end time is exclusive. Note that
// these boundaries are for the time at which the original backup was requested.
//
// You can call ListBackups a maximum of five times per second.
//
// If you want to retrieve the complete list of backups made with Amazon Web
// Services Backup, use the [Amazon Web Services Backup list API.]
//
// [Amazon Web Services Backup list API.]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html
func (c *Client) ListBackups(ctx context.Context, params *ListBackupsInput, optFns ...func(*Options)) (*ListBackupsOutput, error) {
if params == nil {
params = &ListBackupsInput{}
@ -40,11 +45,15 @@ func (c *Client) ListBackups(ctx context.Context, params *ListBackupsInput, optF
type ListBackupsInput struct {
// The backups from the table specified by BackupType are listed. Where BackupType
// can be:
// The backups from the table specified by BackupType are listed.
//
// Where BackupType can be:
//
// - USER - On-demand backup created by you. (The default setting if no other
// backup types are specified.)
//
// - SYSTEM - On-demand backup automatically created by DynamoDB.
//
// - ALL - All types of on-demand backups (USER and SYSTEM).
BackupType types.BackupTypeFilter
@ -78,14 +87,17 @@ type ListBackupsOutput struct {
// List of BackupSummary objects.
BackupSummaries []types.BackupSummary
// The ARN of the backup last evaluated when the current page of results was
// The ARN of the backup last evaluated when the current page of results was
// returned, inclusive of the current page of results. This value may be specified
// as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch
// the next page of results. If LastEvaluatedBackupArn is empty, then the last
// page of results has been processed and there are no more results to be
// retrieved. If LastEvaluatedBackupArn is not empty, this may or may not indicate
// that there is more data to be returned. All results are guaranteed to have been
// returned if and only if no value for LastEvaluatedBackupArn is returned.
// the next page of results.
//
// If LastEvaluatedBackupArn is empty, then the last page of results has been
// processed and there are no more results to be retrieved.
//
// If LastEvaluatedBackupArn is not empty, this may or may not indicate that there
// is more data to be returned. All results are guaranteed to have been returned if
// and only if no value for LastEvaluatedBackupArn is returned.
LastEvaluatedBackupArn *string
// Metadata pertaining to the operation's result.

27
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ListGlobalTables.go generated vendored
View file

@ -12,15 +12,16 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all global tables that have a replica in the specified Region. This
// operation only applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html)
// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// when creating new global tables, as it provides greater flexibility, higher
// Lists all global tables that have a replica in the specified Region.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version), as it provides greater flexibility, higher
// efficiency and consumes less write capacity than 2017.11.29 (Legacy). To
// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html)
// . To update existing global tables from version 2017.11.29 (Legacy) to version
// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html)
// .
// determine which version you are using, see [Determining the version]. To update existing global tables
// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables].
//
// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html
// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html
func (c *Client) ListGlobalTables(ctx context.Context, params *ListGlobalTablesInput, optFns ...func(*Options)) (*ListGlobalTablesOutput, error) {
if params == nil {
params = &ListGlobalTablesInput{}
@ -42,10 +43,12 @@ type ListGlobalTablesInput struct {
ExclusiveStartGlobalTableName *string
// The maximum number of table names to return, if the parameter is not specified
// DynamoDB defaults to 100. If the number of global tables DynamoDB finds reaches
// this limit, it stops the operation and returns the table names collected up to
// that point, with a table name in the LastEvaluatedGlobalTableName to apply in a
// subsequent operation to the ExclusiveStartGlobalTableName parameter.
// DynamoDB defaults to 100.
//
// If the number of global tables DynamoDB finds reaches this limit, it stops the
// operation and returns the table names collected up to that point, with a table
// name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to
// the ExclusiveStartGlobalTableName parameter.
Limit *int32
// Lists the global tables in a specific Region.

12
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ListImports.go generated vendored
View file

@ -29,15 +29,15 @@ func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optF
type ListImportsInput struct {
// An optional string that, if supplied, must be copied from the output of a
// An optional string that, if supplied, must be copied from the output of a
// previous call to ListImports . When provided in this manner, the API fetches the
// next page of results.
NextToken *string
// The number of ImportSummary objects returned in a single page.
// The number of ImportSummary objects returned in a single page.
PageSize *int32
// The Amazon Resource Name (ARN) associated with the table that was imported to.
// The Amazon Resource Name (ARN) associated with the table that was imported to.
TableArn *string
noSmithyDocumentSerde
@ -45,10 +45,10 @@ type ListImportsInput struct {
type ListImportsOutput struct {
// A list of ImportSummary objects.
// A list of ImportSummary objects.
ImportSummaryList []types.ImportSummary
// If this value is returned, there are additional results to be displayed. To
// If this value is returned, there are additional results to be displayed. To
// retrieve them, call ListImports again, with NextToken set to this value.
NextToken *string
@ -149,7 +149,7 @@ var _ ListImportsAPIClient = (*Client)(nil)
// ListImportsPaginatorOptions is the paginator options for ListImports
type ListImportsPaginatorOptions struct {
// The number of ImportSummary objects returned in a single page.
// The number of ImportSummary objects returned in a single page.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token

16
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ListTables.go generated vendored
View file

@ -49,16 +49,18 @@ type ListTablesOutput struct {
// The name of the last table in the current page of results. Use this value as
// the ExclusiveStartTableName in a new request to obtain the next page of
// results, until all the table names are returned. If you do not receive a
// LastEvaluatedTableName value in the response, this means that there are no more
// table names to be retrieved.
// results, until all the table names are returned.
//
// If you do not receive a LastEvaluatedTableName value in the response, this
// means that there are no more table names to be retrieved.
LastEvaluatedTableName *string
// The names of the tables associated with the current account at the current
// endpoint. The maximum size of this array is 100. If LastEvaluatedTableName also
// appears in the output, you can use this value as the ExclusiveStartTableName
// parameter in a subsequent ListTables request and obtain the next page of
// results.
// endpoint. The maximum size of this array is 100.
//
// If LastEvaluatedTableName also appears in the output, you can use this value as
// the ExclusiveStartTableName parameter in a subsequent ListTables request and
// obtain the next page of results.
TableNames []string
// Metadata pertaining to the operation's result.

9
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_ListTagsOfResource.go generated vendored
View file

@ -13,9 +13,12 @@ import (
)
// List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource
// up to 10 times per second, per account. For an overview on tagging DynamoDB
// resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
// in the Amazon DynamoDB Developer Guide.
// up to 10 times per second, per account.
//
// For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the Amazon DynamoDB
// Developer Guide.
//
// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html
func (c *Client) ListTagsOfResource(ctx context.Context, params *ListTagsOfResourceInput, optFns ...func(*Options)) (*ListTagsOfResourceOutput, error) {
if params == nil {
params = &ListTagsOfResourceInput{}

198
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_PutItem.go generated vendored
View file

@ -18,18 +18,28 @@ import (
// conditional put operation (add a new item if one with the specified primary key
// doesn't exist), or replace an existing item if it has certain attribute values.
// You can return the item's attribute values in the same operation, using the
// ReturnValues parameter. When you add an item, the primary key attributes are the
// only required attributes. Empty String and Binary attribute values are allowed.
// Attribute values of type String and Binary must have a length greater than zero
// if the attribute is used as a key attribute for a table or index. Set type
// attributes cannot be empty. Invalid Requests with empty values will be rejected
// with a ValidationException exception. To prevent a new item from replacing an
// existing item, use a conditional expression that contains the
// attribute_not_exists function with the name of the attribute being used as the
// partition key for the table. Since every record must contain that attribute, the
// attribute_not_exists function will only succeed if no matching item exists. For
// more information about PutItem , see Working with Items (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html)
// in the Amazon DynamoDB Developer Guide.
// ReturnValues parameter.
//
// When you add an item, the primary key attributes are the only required
// attributes.
//
// Empty String and Binary attribute values are allowed. Attribute values of type
// String and Binary must have a length greater than zero if the attribute is used
// as a key attribute for a table or index. Set type attributes cannot be empty.
//
// Invalid Requests with empty values will be rejected with a ValidationException
// exception.
//
// To prevent a new item from replacing an existing item, use a conditional
// expression that contains the attribute_not_exists function with the name of the
// attribute being used as the partition key for the table. Since every record must
// contain that attribute, the attribute_not_exists function will only succeed if
// no matching item exists.
//
// For more information about PutItem , see [Working with Items] in the Amazon DynamoDB Developer
// Guide.
//
// [Working with Items]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html
func (c *Client) PutItem(ctx context.Context, params *PutItemInput, optFns ...func(*Options)) (*PutItemOutput, error) {
if params == nil {
params = &PutItemInput{}
@ -50,18 +60,27 @@ type PutItemInput struct {
// A map of attribute name/value pairs, one for each attribute. Only the primary
// key attributes are required; you can optionally provide other attribute
// name-value pairs for the item. You must provide all of the attributes for the
// primary key. For example, with a simple primary key, you only need to provide a
// value for the partition key. For a composite primary key, you must provide both
// values for both the partition key and the sort key. If you specify any
// attributes that are part of an index key, then the data types for those
// attributes must match those of the schema in the table's attribute definition.
// name-value pairs for the item.
//
// You must provide all of the attributes for the primary key. For example, with a
// simple primary key, you only need to provide a value for the partition key. For
// a composite primary key, you must provide both values for both the partition key
// and the sort key.
//
// If you specify any attributes that are part of an index key, then the data
// types for those attributes must match those of the schema in the table's
// attribute definition.
//
// Empty String and Binary attribute values are allowed. Attribute values of type
// String and Binary must have a length greater than zero if the attribute is used
// as a key attribute for a table or index. For more information about primary
// keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey)
// in the Amazon DynamoDB Developer Guide. Each element in the Item map is an
// AttributeValue object.
// as a key attribute for a table or index.
//
// For more information about primary keys, see [Primary Key] in the Amazon DynamoDB Developer
// Guide.
//
// Each element in the Item map is an AttributeValue object.
//
// [Primary Key]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey
//
// This member is required.
Item map[string]types.AttributeValue
@ -73,70 +92,111 @@ type PutItemInput struct {
TableName *string
// A condition that must be satisfied in order for a conditional PutItem operation
// to succeed. An expression can contain any of the following:
// to succeed.
//
// An expression can contain any of the following:
//
// - Functions: attribute_exists | attribute_not_exists | attribute_type |
// contains | begins_with | size These function names are case-sensitive.
// contains | begins_with | size
//
// These function names are case-sensitive.
//
// - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
//
// - Logical operators: AND | OR | NOT
// For more information on condition expressions, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
//
// For more information on condition expressions, see [Condition Expressions] in the Amazon DynamoDB
// Developer Guide.
//
// [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ConditionExpression *string
// This is a legacy parameter. Use ConditionExpression instead. For more
// information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [ConditionalOperator]in the Amazon DynamoDB Developer Guide.
//
// [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html
ConditionalOperator types.ConditionalOperator
// This is a legacy parameter. Use ConditionExpression instead. For more
// information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [Expected]in the Amazon DynamoDB Developer Guide.
//
// [Expected]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html
Expected map[string]types.ExpectedAttributeValue
// One or more substitution tokens for attribute names in an expression. The
// following are some use cases for using ExpressionAttributeNames :
//
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
//
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
//
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression.
//
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
//
// - Percentile
//
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see
// Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
// the following for ExpressionAttributeNames :
// directly in an expression. (For the complete list of reserved words, see [Reserved Words]in the
// Amazon DynamoDB Developer Guide). To work around this, you could specify the
// following for ExpressionAttributeNames :
//
// - {"#P":"Percentile"}
//
// You could then use this substitution in an expression, as in this example:
//
// - #P = :val
//
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime. For more information on
// expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// are placeholders for the actual value at runtime.
//
// For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB
// Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression. Use the : (colon)
// character in an expression to dereference an attribute value. For example,
// suppose that you wanted to check whether the value of the ProductStatus
// attribute was one of the following: Available | Backordered | Discontinued You
// would first need to specify ExpressionAttributeValues as follows: {
// ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} } You could then use these values in an expression,
// such as this: ProductStatus IN (:avail, :back, :disc) For more information on
// expression attribute values, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
// One or more values that can be substituted in an expression.
//
// Use the : (colon) character in an expression to dereference an attribute value.
// For example, suppose that you wanted to check whether the value of the
// ProductStatus attribute was one of the following:
//
// Available | Backordered | Discontinued
//
// You would first need to specify ExpressionAttributeValues as follows:
//
// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} }
//
// You could then use these values in an expression, such as this:
//
// ProductStatus IN (:avail, :back, :disc)
//
// For more information on expression attribute values, see [Condition Expressions] in the Amazon
// DynamoDB Developer Guide.
//
// [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ExpressionAttributeValues map[string]types.AttributeValue
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
@ -148,21 +208,29 @@ type PutItemInput struct {
// Use ReturnValues if you want to get the item attributes as they appeared before
// they were updated with the PutItem request. For PutItem , the valid values are:
//
// - NONE - If ReturnValues is not specified, or if its value is NONE , then
// nothing is returned. (This setting is the default for ReturnValues .)
//
// - ALL_OLD - If PutItem overwrote an attribute name-value pair, then the
// content of the old item is returned.
// The values returned are strongly consistent. There is no additional cost
// associated with requesting a return value aside from the small network and
// processing overhead of receiving a larger response. No read capacity units are
// consumed. The ReturnValues parameter is used by several DynamoDB operations;
// however, PutItem does not recognize any values other than NONE or ALL_OLD .
//
// The values returned are strongly consistent.
//
// There is no additional cost associated with requesting a return value aside
// from the small network and processing overhead of receiving a larger response.
// No read capacity units are consumed.
//
// The ReturnValues parameter is used by several DynamoDB operations; however,
// PutItem does not recognize any values other than NONE or ALL_OLD .
ReturnValues types.ReturnValue
// An optional parameter that returns the item attributes for a PutItem operation
// that failed a condition check. There is no additional cost associated with
// requesting a return value aside from the small network and processing overhead
// of receiving a larger response. No read capacity units are consumed.
// that failed a condition check.
//
// There is no additional cost associated with requesting a return value aside
// from the small network and processing overhead of receiving a larger response.
// No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
@ -180,24 +248,30 @@ type PutItemOutput struct {
// 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 ReturnConsumedCapacity parameter was specified. For more
// information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [Capacity unity consumption for write operations]in the Amazon DynamoDB Developer Guide.
//
// [Capacity unity consumption for write operations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption
ConsumedCapacity *types.ConsumedCapacity
// Information about item collections, if any, that were affected by the PutItem
// operation. ItemCollectionMetrics is only returned if the
// ReturnItemCollectionMetrics parameter was specified. If the table does not have
// any local secondary indexes, this information is not returned in the response.
//
// Each ItemCollectionMetrics element consists of:
//
// - ItemCollectionKey - The partition key value of the item collection. This is
// the same as the partition key value of the item itself.
//
// - SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
// This value is a two-element array containing a lower bound and an upper bound
// for the estimate. The estimate includes the size of all the items in the table,
// plus the size of all attributes projected into all of the local secondary
// indexes on that table. Use this estimate to measure whether a local secondary
// index is approaching its size limit. The estimate is subject to change over
// time; therefore, do not rely on the precision or accuracy of the estimate.
// index is approaching its size limit.
//
// The estimate is subject to change over time; therefore, do not rely on the
// precision or accuracy of the estimate.
ItemCollectionMetrics *types.ItemCollectionMetrics
// Metadata pertaining to the operation's result.

50
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_PutResourcePolicy.go generated vendored
View file

@ -13,17 +13,21 @@ import (
// Attaches a resource-based policy document to the resource, which can be a table
// or stream. When you attach a resource-based policy using this API, the policy
// application is eventually consistent (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html)
// . PutResourcePolicy is an idempotent operation; running it multiple times on
// the same resource using the same policy document will return the same revision
// ID. If you specify an ExpectedRevisionId that doesn't match the current
// policy's RevisionId , the PolicyNotFoundException will be returned.
// application is [eventually consistent].
//
// PutResourcePolicy is an idempotent operation; running it multiple times on the
// same resource using the same policy document will return the same revision ID.
// If you specify an ExpectedRevisionId that doesn't match the current policy's
// RevisionId , the PolicyNotFoundException will be returned.
//
// PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy
// request immediately after a PutResourcePolicy request, DynamoDB might return
// your previous policy, if there was one, or return the PolicyNotFoundException .
// This is because GetResourcePolicy uses an eventually consistent query, and the
// metadata for your policy or table might not be available at that moment. Wait
// for a few seconds, and then try the GetResourcePolicy request again.
//
// [eventually consistent]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) {
if params == nil {
params = &PutResourcePolicyInput{}
@ -42,27 +46,32 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic
type PutResourcePolicyInput struct {
// An Amazon Web Services resource-based policy document in JSON format.
//
// - The maximum size supported for a resource-based policy document is 20 KB.
// DynamoDB counts whitespaces when calculating the size of a policy against this
// limit.
//
// - Within a resource-based policy, if the action for a DynamoDB service-linked
// role (SLR) to replicate data for a global table is denied, adding or deleting a
// replica will fail with an error.
//
// For a full list of all considerations that apply while attaching a
// resource-based policy, see Resource-based policy considerations (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)
// .
// resource-based policy, see [Resource-based policy considerations].
//
// [Resource-based policy considerations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html
//
// This member is required.
Policy *string
// The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy
// will be attached. The resources you can specify include tables and streams. You
// can control index permissions using the base table's policy. To specify the same
// permission level for your table and its indexes, you can provide both the table
// and index Amazon Resource Name (ARN)s in the Resource field of a given Statement
// in your policy document. Alternatively, to specify different permissions for
// your table, indexes, or both, you can define multiple Statement fields in your
// policy document.
// will be attached. The resources you can specify include tables and streams.
//
// You can control index permissions using the base table's policy. To specify the
// same permission level for your table and its indexes, you can provide both the
// table and index Amazon Resource Name (ARN)s in the Resource field of a given
// Statement in your policy document. Alternatively, to specify different
// permissions for your table, indexes, or both, you can define multiple Statement
// fields in your policy document.
//
// This member is required.
ResourceArn *string
@ -73,11 +82,14 @@ type PutResourcePolicyInput struct {
// A string value that you can use to conditionally update your policy. You can
// provide the revision ID of your existing policy to make mutating requests
// against that policy. When you provide an expected revision ID, if the revision
// ID of the existing policy on the resource doesn't match or if there's no policy
// attached to the resource, your request will be rejected with a
// PolicyNotFoundException . To conditionally attach a policy when no policy exists
// for the resource, specify NO_POLICY for the revision ID.
// against that policy.
//
// When you provide an expected revision ID, if the revision ID of the existing
// policy on the resource doesn't match or if there's no policy attached to the
// resource, your request will be rejected with a PolicyNotFoundException .
//
// To conditionally attach a policy when no policy exists for the resource,
// specify NO_POLICY for the revision ID.
ExpectedRevisionId *string
noSmithyDocumentSerde

383
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_Query.go generated vendored
View file

@ -15,40 +15,53 @@ import (
// You must provide the name of the partition key attribute and a single value for
// that attribute. Query returns all items with that partition key value.
// Optionally, you can provide a sort key attribute and use a comparison operator
// to refine the search results. Use the KeyConditionExpression parameter to
// provide a specific value for the partition key. The Query operation will return
// all of the items from the table or index with that partition key value. You can
// optionally narrow the scope of the Query operation by specifying a sort key
// value and a comparison operator in KeyConditionExpression . To further refine
// the Query results, you can optionally provide a FilterExpression . A
// FilterExpression determines which items within the results should be returned to
// you. All of the other results are discarded. A Query operation always returns a
// result set. If no matching items are found, the result set will be empty.
// Queries that do not return results consume the minimum number of read capacity
// units for that type of read operation. DynamoDB calculates the number of read
// capacity units consumed based on item size, not on the amount of data that is
// returned to an application. The number of capacity units consumed will be the
// same whether you request all of the attributes (the default behavior) or just
// some of them (using a projection expression). The number will also be the same
// whether or not you use a FilterExpression . Query results are always sorted by
// the sort key value. If the data type of the sort key is Number, the results are
// returned in numeric order; otherwise, the results are returned in order of UTF-8
// bytes. By default, the sort order is ascending. To reverse the order, set the
// ScanIndexForward parameter to false. A single Query operation will read up to
// the maximum number of items set (if using the Limit parameter) or a maximum of
// 1 MB of data and then apply any filtering to the results using FilterExpression
// . If LastEvaluatedKey is present in the response, you will need to paginate the
// result set. For more information, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination)
// in the Amazon DynamoDB Developer Guide. FilterExpression is applied after a
// Query finishes, but before the results are returned. A FilterExpression cannot
// contain partition key or sort key attributes. You need to specify those
// attributes in the KeyConditionExpression . A Query operation can return an
// empty result set and a LastEvaluatedKey if all the items read for the page of
// results are filtered out. You can query a table, a local secondary index, or a
// global secondary index. For a query on a table or on a local secondary index,
// you can set the ConsistentRead parameter to true and obtain a strongly
// consistent result. Global secondary indexes support eventually consistent reads
// only, so do not specify ConsistentRead when querying a global secondary index.
// to refine the search results.
//
// Use the KeyConditionExpression parameter to provide a specific value for the
// partition key. The Query operation will return all of the items from the table
// or index with that partition key value. You can optionally narrow the scope of
// the Query operation by specifying a sort key value and a comparison operator in
// KeyConditionExpression . To further refine the Query results, you can
// optionally provide a FilterExpression . A FilterExpression determines which
// items within the results should be returned to you. All of the other results are
// discarded.
//
// A Query operation always returns a result set. If no matching items are found,
// the result set will be empty. Queries that do not return results consume the
// minimum number of read capacity units for that type of read operation.
//
// DynamoDB calculates the number of read capacity units consumed based on item
// size, not on the amount of data that is returned to an application. The number
// of capacity units consumed will be the same whether you request all of the
// attributes (the default behavior) or just some of them (using a projection
// expression). The number will also be the same whether or not you use a
// FilterExpression .
//
// Query results are always sorted by the sort key value. If the data type of the
// sort key is Number, the results are returned in numeric order; otherwise, the
// results are returned in order of UTF-8 bytes. By default, the sort order is
// ascending. To reverse the order, set the ScanIndexForward parameter to false.
//
// A single Query operation will read up to the maximum number of items set (if
// using the Limit parameter) or a maximum of 1 MB of data and then apply any
// filtering to the results using FilterExpression . If LastEvaluatedKey is
// present in the response, you will need to paginate the result set. For more
// information, see [Paginating the Results]in the Amazon DynamoDB Developer Guide.
//
// FilterExpression is applied after a Query finishes, but before the results are
// returned. A FilterExpression cannot contain partition key or sort key
// attributes. You need to specify those attributes in the KeyConditionExpression .
//
// A Query operation can return an empty result set and a LastEvaluatedKey if all
// the items read for the page of results are filtered out.
//
// You can query a table, a local secondary index, or a global secondary index.
// For a query on a table or on a local secondary index, you can set the
// ConsistentRead parameter to true and obtain a strongly consistent result.
// Global secondary indexes support eventually consistent reads only, so do not
// specify ConsistentRead when querying a global secondary index.
//
// [Paginating the Results]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination
func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error) {
if params == nil {
params = &QueryInput{}
@ -74,72 +87,106 @@ type QueryInput struct {
TableName *string
// This is a legacy parameter. Use ProjectionExpression instead. For more
// information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide.
//
// [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html
AttributesToGet []string
// This is a legacy parameter. Use FilterExpression instead. For more information,
// see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
// in the Amazon DynamoDB Developer Guide.
// see [ConditionalOperator]in the Amazon DynamoDB Developer Guide.
//
// [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html
ConditionalOperator types.ConditionalOperator
// Determines the read consistency model: If set to true , then the operation uses
// strongly consistent reads; otherwise, the operation uses eventually consistent
// reads. Strongly consistent reads are not supported on global secondary indexes.
// If you query a global secondary index with ConsistentRead set to true , you will
// reads.
//
// Strongly consistent reads are not supported on global secondary indexes. If you
// query a global secondary index with ConsistentRead set to true , you will
// receive a ValidationException .
ConsistentRead *bool
// The primary key of the first item that this operation will evaluate. Use the
// value that was returned for LastEvaluatedKey in the previous operation. The
// data type for ExclusiveStartKey must be String, Number, or Binary. No set data
// types are allowed.
// value that was returned for LastEvaluatedKey in the previous operation.
//
// The data type for ExclusiveStartKey must be String, Number, or Binary. No set
// data types are allowed.
ExclusiveStartKey map[string]types.AttributeValue
// One or more substitution tokens for attribute names in an expression. The
// following are some use cases for using ExpressionAttributeNames :
//
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
//
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
//
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression.
//
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
//
// - Percentile
//
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see
// Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
// the following for ExpressionAttributeNames :
// directly in an expression. (For the complete list of reserved words, see [Reserved Words]in the
// Amazon DynamoDB Developer Guide). To work around this, you could specify the
// following for ExpressionAttributeNames :
//
// - {"#P":"Percentile"}
//
// You could then use this substitution in an expression, as in this example:
//
// - #P = :val
//
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime. For more information on
// expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// are placeholders for the actual value at runtime.
//
// For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB
// Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression. Use the : (colon)
// character in an expression to dereference an attribute value. For example,
// suppose that you wanted to check whether the value of the ProductStatus
// attribute was one of the following: Available | Backordered | Discontinued You
// would first need to specify ExpressionAttributeValues as follows: {
// ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} } You could then use these values in an expression,
// such as this: ProductStatus IN (:avail, :back, :disc) For more information on
// expression attribute values, see Specifying Conditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
// One or more values that can be substituted in an expression.
//
// Use the : (colon) character in an expression to dereference an attribute value.
// For example, suppose that you wanted to check whether the value of the
// ProductStatus attribute was one of the following:
//
// Available | Backordered | Discontinued
//
// You would first need to specify ExpressionAttributeValues as follows:
//
// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} }
//
// You could then use these values in an expression, such as this:
//
// ProductStatus IN (:avail, :back, :disc)
//
// For more information on expression attribute values, see [Specifying Conditions] in the Amazon
// DynamoDB Developer Guide.
//
// [Specifying Conditions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ExpressionAttributeValues map[string]types.AttributeValue
// A string that contains conditions that DynamoDB applies after the Query
// operation, but before the data is returned to you. Items that do not satisfy the
// FilterExpression criteria are not returned. A FilterExpression does not allow
// key attributes. You cannot define a filter expression based on a partition key
// or a sort key. A FilterExpression is applied after the items have already been
// read; the process of filtering does not consume any additional read capacity
// units. For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html)
// in the Amazon DynamoDB Developer Guide.
// FilterExpression criteria are not returned.
//
// A FilterExpression does not allow key attributes. You cannot define a filter
// expression based on a partition key or a sort key.
//
// A FilterExpression is applied after the items have already been read; the
// process of filtering does not consume any additional read capacity units.
//
// For more information, see [Filter Expressions] in the Amazon DynamoDB Developer Guide.
//
// [Filter Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html
FilterExpression *string
// The name of an index to query. This index can be any local secondary index or
@ -148,16 +195,26 @@ type QueryInput struct {
IndexName *string
// The condition that specifies the key values for items to be retrieved by the
// Query action. The condition must perform an equality test on a single partition
// key value. The condition can optionally perform one of several comparison tests
// on a single sort key value. This allows Query to retrieve one item with a given
// Query action.
//
// The condition must perform an equality test on a single partition key value.
//
// The condition can optionally perform one of several comparison tests on a
// single sort key value. This allows Query to retrieve one item with a given
// partition key value and sort key value, or several items that have the same
// partition key value but different sort key values. The partition key equality
// test is required, and must be specified in the following format:
// partitionKeyName = :partitionkeyval If you also want to provide a condition for
// the sort key, it must be combined using AND with the condition for the sort
// key. Following is an example, using the = comparison operator for the sort key:
// partitionKeyName
// partition key value but different sort key values.
//
// The partition key equality test is required, and must be specified in the
// following format:
//
// partitionKeyName = :partitionkeyval
//
// If you also want to provide a condition for the sort key, it must be combined
// using AND with the condition for the sort key. Following is an example, using
// the = comparison operator for the sort key:
//
// partitionKeyName
//
// =
//
// :partitionkeyval
@ -167,45 +224,64 @@ type QueryInput struct {
// sortKeyName
//
// =
// :sortkeyval Valid comparisons for the sort key condition are as follows:
//
// :sortkeyval
//
// Valid comparisons for the sort key condition are as follows:
//
// - sortKeyName = :sortkeyval - true if the sort key value is equal to
// :sortkeyval .
//
// - sortKeyName < :sortkeyval - true if the sort key value is less than
// :sortkeyval .
//
// - sortKeyName <= :sortkeyval - true if the sort key value is less than or
// equal to :sortkeyval .
//
// - sortKeyName > :sortkeyval - true if the sort key value is greater than
// :sortkeyval .
//
// - sortKeyName >= :sortkeyval - true if the sort key value is greater than or
// equal to :sortkeyval .
//
// - sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key
// value is greater than or equal to :sortkeyval1 , and less than or equal to
// :sortkeyval2 .
//
// - begins_with ( sortKeyName , :sortkeyval ) - true if the sort key value
// begins with a particular operand. (You cannot use this function with a sort key
// that is of type Number.) Note that the function name begins_with is
// case-sensitive.
//
// Use the ExpressionAttributeValues parameter to replace tokens such as
// :partitionval and :sortval with actual values at runtime. You can optionally
// use the ExpressionAttributeNames parameter to replace the names of the
// partition key and sort key with placeholder tokens. This option might be
// necessary if an attribute name conflicts with a DynamoDB reserved word. For
// example, the following KeyConditionExpression parameter causes an error because
// Size is a reserved word:
// :partitionval and :sortval with actual values at runtime.
//
// You can optionally use the ExpressionAttributeNames parameter to replace the
// names of the partition key and sort key with placeholder tokens. This option
// might be necessary if an attribute name conflicts with a DynamoDB reserved word.
// For example, the following KeyConditionExpression parameter causes an error
// because Size is a reserved word:
//
// - Size = :myval
//
// To work around this, define a placeholder (such a #S ) to represent the
// attribute name Size. KeyConditionExpression then is as follows:
//
// - #S = :myval
// For a list of reserved words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide. For more information on
// ExpressionAttributeNames and ExpressionAttributeValues , see Using Placeholders
// for Attribute Names and Values (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html)
// in the Amazon DynamoDB Developer Guide.
//
// For a list of reserved words, see [Reserved Words] in the Amazon DynamoDB Developer Guide.
//
// For more information on ExpressionAttributeNames and ExpressionAttributeValues ,
// see [Using Placeholders for Attribute Names and Values]in the Amazon DynamoDB Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Using Placeholders for Attribute Names and Values]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html
KeyConditionExpression *string
// This is a legacy parameter. Use KeyConditionExpression instead. For more
// information, see KeyConditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [KeyConditions]in the Amazon DynamoDB Developer Guide.
//
// [KeyConditions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html
KeyConditions map[string]types.Condition
// The maximum number of items to evaluate (not necessarily the number of matching
@ -216,82 +292,104 @@ type QueryInput struct {
// dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the
// operation and returns the matching values up to the limit, and a key in
// LastEvaluatedKey to apply in a subsequent operation to continue the operation.
// For more information, see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
// in the Amazon DynamoDB Developer Guide.
// For more information, see [Query and Scan]in the Amazon DynamoDB Developer Guide.
//
// [Query and Scan]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html
Limit *int32
// A string that identifies one or more attributes to retrieve from the table.
// These attributes can include scalars, sets, or elements of a JSON document. The
// attributes in the expression must be separated by commas. If no attribute names
// are specified, then all attributes will be returned. If any of the requested
// attributes are not found, they will not appear in the result. For more
// information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// attributes in the expression must be separated by commas.
//
// If no attribute names are specified, then all attributes will be returned. If
// any of the requested attributes are not found, they will not appear in the
// result.
//
// For more information, see [Accessing Item Attributes] in the Amazon DynamoDB Developer Guide.
//
// [Accessing Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ProjectionExpression *string
// This is a legacy parameter. Use FilterExpression instead. For more information,
// see QueryFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html)
// in the Amazon DynamoDB Developer Guide.
// see [QueryFilter]in the Amazon DynamoDB Developer Guide.
//
// [QueryFilter]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html
QueryFilter map[string]types.Condition
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
// Specifies the order for index traversal: If true (default), the traversal is
// performed in ascending order; if false , the traversal is performed in
// descending order. Items with the same partition key value are stored in sorted
// order by sort key. If the sort key data type is Number, the results are stored
// in numeric order. For type String, the results are stored in order of UTF-8
// bytes. For type Binary, DynamoDB treats each byte of the binary data as
// unsigned. If ScanIndexForward is true , DynamoDB returns the results in the
// order in which they are stored (by sort key value). This is the default
// behavior. If ScanIndexForward is false , DynamoDB reads the results in reverse
// order by sort key value, and then returns the results to the client.
// descending order.
//
// Items with the same partition key value are stored in sorted order by sort key.
// If the sort key data type is Number, the results are stored in numeric order.
// For type String, the results are stored in order of UTF-8 bytes. For type
// Binary, DynamoDB treats each byte of the binary data as unsigned.
//
// If ScanIndexForward is true , DynamoDB returns the results in the order in which
// they are stored (by sort key value). This is the default behavior. If
// ScanIndexForward is false , DynamoDB reads the results in reverse order by sort
// key value, and then returns the results to the client.
ScanIndexForward *bool
// The attributes to be returned in the result. You can retrieve all item
// attributes, specific item attributes, the count of matching items, or in the
// case of an index, some or all of the attributes projected into the index.
//
// - ALL_ATTRIBUTES - Returns all of the item attributes from the specified table
// or index. If you query a local secondary index, then for each matching item in
// the index, DynamoDB fetches the entire item from the parent table. If the index
// is configured to project all item attributes, then all of the data can be
// obtained from the local secondary index, and no fetching is required.
//
// - ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves
// all attributes that have been projected into the index. If the index is
// configured to project all attributes, this return value is equivalent to
// specifying ALL_ATTRIBUTES .
//
// - COUNT - Returns the number of matching items, rather than the matching items
// themselves. Note that this uses the same quantity of read capacity units as
// getting the items, and is subject to the same item size calculations.
//
// - SPECIFIC_ATTRIBUTES - Returns only the attributes listed in
// ProjectionExpression . This return value is equivalent to specifying
// ProjectionExpression without specifying any value for Select . If you query or
// scan a local secondary index and request only attributes that are projected into
// that index, the operation will read only the index and not the table. If any of
// the requested attributes are not projected into the local secondary index,
// DynamoDB fetches each of these attributes from the parent table. This extra
// fetching incurs additional throughput cost and latency. If you query or scan a
// global secondary index, you can only request attributes that are projected into
// the index. Global secondary index queries cannot fetch attributes from the
// parent table.
// ProjectionExpression without specifying any value for Select .
//
// If you query or scan a local secondary index and request only attributes that
// are projected into that index, the operation will read only the index and not
// the table. If any of the requested attributes are not projected into the local
// secondary index, DynamoDB fetches each of these attributes from the parent
// table. This extra fetching incurs additional throughput cost and latency.
//
// If you query or scan a global secondary index, you can only request attributes
// that are projected into the index. Global secondary index queries cannot fetch
// attributes from the parent table.
//
// If neither Select nor ProjectionExpression are specified, DynamoDB defaults to
// ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
// accessing an index. You cannot use both Select and ProjectionExpression
// together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES
// . (This usage is equivalent to specifying ProjectionExpression without any
// value for Select .) If you use the ProjectionExpression parameter, then the
// value for Select can only be SPECIFIC_ATTRIBUTES . Any other value for Select
// will return an error.
// value for Select .)
//
// If you use the ProjectionExpression parameter, then the value for Select can
// only be SPECIFIC_ATTRIBUTES . Any other value for Select will return an error.
Select types.Select
noSmithyDocumentSerde
@ -303,15 +401,19 @@ type QueryOutput struct {
// The capacity units consumed by the Query 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 ReturnConsumedCapacity parameter was specified. For more information, see
// Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
// the ReturnConsumedCapacity parameter was specified. For more information, see [Capacity unit consumption for read operations]
// in the Amazon DynamoDB Developer Guide.
//
// [Capacity unit consumption for read operations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption
ConsumedCapacity *types.ConsumedCapacity
// The number of items in the response. If you used a QueryFilter in the request,
// then Count is the number of items returned after the filter was applied, and
// ScannedCount is the number of matching items before the filter was applied. If
// you did not use a filter in the request, then Count and ScannedCount are the
// The number of items in the response.
//
// If you used a QueryFilter in the request, then Count is the number of items
// returned after the filter was applied, and ScannedCount is the number of
// matching items before the filter was applied.
//
// If you did not use a filter in the request, then Count and ScannedCount are the
// same.
Count int32
@ -321,18 +423,24 @@ type QueryOutput struct {
// The primary key of the item where the operation stopped, inclusive of the
// previous result set. Use this value to start a new operation, excluding this
// value in the new request. If LastEvaluatedKey is empty, then the "last page" of
// results has been processed and there is no more data to be retrieved. If
// LastEvaluatedKey is not empty, it does not necessarily mean that there is more
// data in the result set. The only way to know when you have reached the end of
// the result set is when LastEvaluatedKey is empty.
// value in the new request.
//
// If LastEvaluatedKey is empty, then the "last page" of results has been
// processed and there is no more data to be retrieved.
//
// If LastEvaluatedKey is not empty, it does not necessarily mean that there is
// more data in the result set. The only way to know when you have reached the end
// of the result set is when LastEvaluatedKey is empty.
LastEvaluatedKey map[string]types.AttributeValue
// The number of items evaluated, before any QueryFilter is applied. A high
// ScannedCount value with few, or no, Count results indicates an inefficient Query
// operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count)
// in the Amazon DynamoDB Developer Guide. If you did not use a filter in the
// request, then ScannedCount is the same as Count .
// operation. For more information, see [Count and ScannedCount]in the Amazon DynamoDB Developer Guide.
//
// If you did not use a filter in the request, then ScannedCount is the same as
// Count .
//
// [Count and ScannedCount]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count
ScannedCount int32
// Metadata pertaining to the operation's result.
@ -489,8 +597,9 @@ type QueryPaginatorOptions struct {
// dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the
// operation and returns the matching values up to the limit, and a key in
// LastEvaluatedKey to apply in a subsequent operation to continue the operation.
// For more information, see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
// in the Amazon DynamoDB Developer Guide.
// For more information, see [Query and Scan]in the Amazon DynamoDB Developer Guide.
//
// [Query and Scan]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html
Limit int32
}

14
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_RestoreTableFromBackup.go generated vendored
View file

@ -13,14 +13,22 @@ import (
)
// Creates a new table from an existing backup. Any number of users can execute up
// to 50 concurrent restores (any type of restore) in a given account. You can call
// RestoreTableFromBackup at a maximum rate of 10 times per second. You must
// manually set up the following on the restored table:
// to 50 concurrent restores (any type of restore) in a given account.
//
// You can call RestoreTableFromBackup at a maximum rate of 10 times per second.
//
// You must manually set up the following on the restored table:
//
// - Auto scaling policies
//
// - IAM policies
//
// - Amazon CloudWatch metrics and alarms
//
// - Tags
//
// - Stream settings
//
// - Time to Live (TTL) settings
func (c *Client) RestoreTableFromBackup(ctx context.Context, params *RestoreTableFromBackupInput, optFns ...func(*Options)) (*RestoreTableFromBackupOutput, error) {
if params == nil {

29
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_RestoreTableToPointInTime.go generated vendored
View file

@ -17,23 +17,40 @@ import (
// EarliestRestorableDateTime and LatestRestorableDateTime . You can restore your
// table to any point in time during the last 35 days. Any number of users can
// execute up to 50 concurrent restores (any type of restore) in a given account.
// When you restore using point in time recovery, DynamoDB restores your table data
// to the state based on the selected date and time (day:hour:minute:second) to a
// new table. Along with data, the following are also included on the new restored
// table using point in time recovery:
//
// When you restore using point in time recovery, DynamoDB restores your table
// data to the state based on the selected date and time (day:hour:minute:second)
// to a new table.
//
// Along with data, the following are also included on the new restored table
// using point in time recovery:
//
// - Global secondary indexes (GSIs)
//
// - Local secondary indexes (LSIs)
//
// - Provisioned read and write capacity
// - Encryption settings All these settings come from the current settings of
// the source table at the time of restore.
//
// - Encryption settings
//
// All these settings come from the current settings of the source table at the
//
// time of restore.
//
// You must manually set up the following on the restored table:
//
// - Auto scaling policies
//
// - IAM policies
//
// - Amazon CloudWatch metrics and alarms
//
// - Tags
//
// - Stream settings
//
// - Time to Live (TTL) settings
//
// - Point in time recovery settings
func (c *Client) RestoreTableToPointInTime(ctx context.Context, params *RestoreTableToPointInTimeInput, optFns ...func(*Options)) (*RestoreTableToPointInTimeOutput, error) {
if params == nil {

329
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_Scan.go generated vendored
View file

@ -14,37 +14,48 @@ import (
// The Scan operation returns one or more items and item attributes by accessing
// every item in a table or a secondary index. To have DynamoDB return fewer items,
// you can provide a FilterExpression operation. If the total size of scanned
// items exceeds the maximum dataset size limit of 1 MB, the scan completes and
// results are returned to the user. The LastEvaluatedKey value is also returned
// and the requestor can use the LastEvaluatedKey to continue the scan in a
// subsequent operation. Each scan response also includes number of items that were
// scanned (ScannedCount) as part of the request. If using a FilterExpression , a
// scan result can result in no items meeting the criteria and the Count will
// result in zero. If you did not use a FilterExpression in the scan request, then
// Count is the same as ScannedCount . Count and ScannedCount only return the
// count of items specific to a single scan request and, unless the table is less
// than 1MB, do not represent the total number of items in the table. A single Scan
// operation first reads up to the maximum number of items set (if using the Limit
// parameter) or a maximum of 1 MB of data and then applies any filtering to the
// results if a FilterExpression is provided. If LastEvaluatedKey is present in
// the response, pagination is required to complete the full table scan. For more
// information, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination)
// in the Amazon DynamoDB Developer Guide. Scan operations proceed sequentially;
// however, for faster performance on a large table or secondary index,
// applications can request a parallel Scan operation by providing the Segment and
// TotalSegments parameters. For more information, see Parallel Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan)
// in the Amazon DynamoDB Developer Guide. By default, a Scan uses eventually
// consistent reads when accessing the items in a table. Therefore, the results
// from an eventually consistent Scan may not include the latest item changes at
// the time the scan iterates through each item in the table. If you require a
// strongly consistent read of each item as the scan iterates through the items in
// the table, you can set the ConsistentRead parameter to true. Strong consistency
// only relates to the consistency of the read at the item level. DynamoDB does not
// provide snapshot isolation for a scan operation when the ConsistentRead
// parameter is set to true. Thus, a DynamoDB scan operation does not guarantee
// that all reads in a scan see a consistent snapshot of the table when the scan
// operation was requested.
// you can provide a FilterExpression operation.
//
// If the total size of scanned items exceeds the maximum dataset size limit of 1
// MB, the scan completes and results are returned to the user. The
// LastEvaluatedKey value is also returned and the requestor can use the
// LastEvaluatedKey to continue the scan in a subsequent operation. Each scan
// response also includes number of items that were scanned (ScannedCount) as part
// of the request. If using a FilterExpression , a scan result can result in no
// items meeting the criteria and the Count will result in zero. If you did not
// use a FilterExpression in the scan request, then Count is the same as
// ScannedCount .
//
// Count and ScannedCount only return the count of items specific to a single scan
// request and, unless the table is less than 1MB, do not represent the total
// number of items in the table.
//
// A single Scan operation first reads up to the maximum number of items set (if
// using the Limit parameter) or a maximum of 1 MB of data and then applies any
// filtering to the results if a FilterExpression is provided. If LastEvaluatedKey
// is present in the response, pagination is required to complete the full table
// scan. For more information, see [Paginating the Results]in the Amazon DynamoDB Developer Guide.
//
// Scan operations proceed sequentially; however, for faster performance on a
// large table or secondary index, applications can request a parallel Scan
// operation by providing the Segment and TotalSegments parameters. For more
// information, see [Parallel Scan]in the Amazon DynamoDB Developer Guide.
//
// By default, a Scan uses eventually consistent reads when accessing the items in
// a table. Therefore, the results from an eventually consistent Scan may not
// include the latest item changes at the time the scan iterates through each item
// in the table. If you require a strongly consistent read of each item as the scan
// iterates through the items in the table, you can set the ConsistentRead
// parameter to true. Strong consistency only relates to the consistency of the
// read at the item level.
//
// DynamoDB does not provide snapshot isolation for a scan operation when the
// ConsistentRead parameter is set to true. Thus, a DynamoDB scan operation does
// not guarantee that all reads in a scan see a consistent snapshot of the table
// when the scan operation was requested.
//
// [Paginating the Results]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination
// [Parallel Scan]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan
func (c *Client) Scan(ctx context.Context, params *ScanInput, optFns ...func(*Options)) (*ScanOutput, error) {
if params == nil {
params = &ScanInput{}
@ -64,83 +75,123 @@ func (c *Client) Scan(ctx context.Context, params *ScanInput, optFns ...func(*Op
type ScanInput struct {
// The name of the table containing the requested items or if you provide IndexName
// , the name of the table to which that index belongs. You can also provide the
// Amazon Resource Name (ARN) of the table in this parameter.
// , the name of the table to which that index belongs.
//
// You can also provide the Amazon Resource Name (ARN) of the table in this
// parameter.
//
// This member is required.
TableName *string
// This is a legacy parameter. Use ProjectionExpression instead. For more
// information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide.
//
// [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html
AttributesToGet []string
// This is a legacy parameter. Use FilterExpression instead. For more information,
// see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
// in the Amazon DynamoDB Developer Guide.
// see [ConditionalOperator]in the Amazon DynamoDB Developer Guide.
//
// [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html
ConditionalOperator types.ConditionalOperator
// A Boolean value that determines the read consistency model during the scan:
//
// - If ConsistentRead is false , then the data returned from Scan might not
// contain the results from other recently completed write operations ( PutItem ,
// UpdateItem , or DeleteItem ).
//
// - If ConsistentRead is true , then all of the write operations that completed
// before the Scan began are guaranteed to be contained in the Scan response.
// The default setting for ConsistentRead is false . The ConsistentRead parameter
// is not supported on global secondary indexes. If you scan a global secondary
// index with ConsistentRead set to true, you will receive a ValidationException .
//
// The default setting for ConsistentRead is false .
//
// The ConsistentRead parameter is not supported on global secondary indexes. If
// you scan a global secondary index with ConsistentRead set to true, you will
// receive a ValidationException .
ConsistentRead *bool
// The primary key of the first item that this operation will evaluate. Use the
// value that was returned for LastEvaluatedKey in the previous operation. The
// data type for ExclusiveStartKey must be String, Number or Binary. No set data
// types are allowed. In a parallel scan, a Scan request that includes
// ExclusiveStartKey must specify the same segment whose previous Scan returned
// the corresponding value of LastEvaluatedKey .
// value that was returned for LastEvaluatedKey in the previous operation.
//
// The data type for ExclusiveStartKey must be String, Number or Binary. No set
// data types are allowed.
//
// In a parallel scan, a Scan request that includes ExclusiveStartKey must specify
// the same segment whose previous Scan returned the corresponding value of
// LastEvaluatedKey .
ExclusiveStartKey map[string]types.AttributeValue
// One or more substitution tokens for attribute names in an expression. The
// following are some use cases for using ExpressionAttributeNames :
//
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
//
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
//
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression.
//
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
//
// - Percentile
//
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see
// Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
// the following for ExpressionAttributeNames :
// directly in an expression. (For the complete list of reserved words, see [Reserved Words]in the
// Amazon DynamoDB Developer Guide). To work around this, you could specify the
// following for ExpressionAttributeNames :
//
// - {"#P":"Percentile"}
//
// You could then use this substitution in an expression, as in this example:
//
// - #P = :val
//
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime. For more information on
// expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// are placeholders for the actual value at runtime.
//
// For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB
// Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression. Use the : (colon)
// character in an expression to dereference an attribute value. For example,
// suppose that you wanted to check whether the value of the ProductStatus
// attribute was one of the following: Available | Backordered | Discontinued You
// would first need to specify ExpressionAttributeValues as follows: {
// ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} } You could then use these values in an expression,
// such as this: ProductStatus IN (:avail, :back, :disc) For more information on
// expression attribute values, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
// One or more values that can be substituted in an expression.
//
// Use the : (colon) character in an expression to dereference an attribute value.
// For example, suppose that you wanted to check whether the value of the
// ProductStatus attribute was one of the following:
//
// Available | Backordered | Discontinued
//
// You would first need to specify ExpressionAttributeValues as follows:
//
// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} }
//
// You could then use these values in an expression, such as this:
//
// ProductStatus IN (:avail, :back, :disc)
//
// For more information on expression attribute values, see [Condition Expressions] in the Amazon
// DynamoDB Developer Guide.
//
// [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ExpressionAttributeValues map[string]types.AttributeValue
// A string that contains conditions that DynamoDB applies after the Scan
// operation, but before the data is returned to you. Items that do not satisfy the
// FilterExpression criteria are not returned. A FilterExpression is applied after
// the items have already been read; the process of filtering does not consume any
// additional read capacity units. For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression)
// in the Amazon DynamoDB Developer Guide.
// FilterExpression criteria are not returned.
//
// A FilterExpression is applied after the items have already been read; the
// process of filtering does not consume any additional read capacity units.
//
// For more information, see [Filter Expressions] in the Amazon DynamoDB Developer Guide.
//
// [Filter Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression
FilterExpression *string
// The name of a secondary index to scan. This index can be any local secondary
@ -156,92 +207,120 @@ type ScanInput struct {
// dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the
// operation and returns the matching values up to the limit, and a key in
// LastEvaluatedKey to apply in a subsequent operation to continue the operation.
// For more information, see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
// in the Amazon DynamoDB Developer Guide.
// For more information, see [Working with Queries]in the Amazon DynamoDB Developer Guide.
//
// [Working with Queries]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html
Limit *int32
// A string that identifies one or more attributes to retrieve from the specified
// table or index. These attributes can include scalars, sets, or elements of a
// JSON document. The attributes in the expression must be separated by commas. If
// no attribute names are specified, then all attributes will be returned. If any
// of the requested attributes are not found, they will not appear in the result.
// For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// JSON document. The attributes in the expression must be separated by commas.
//
// If no attribute names are specified, then all attributes will be returned. If
// any of the requested attributes are not found, they will not appear in the
// result.
//
// For more information, see [Specifying Item Attributes] in the Amazon DynamoDB Developer Guide.
//
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ProjectionExpression *string
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
// This is a legacy parameter. Use FilterExpression instead. For more information,
// see ScanFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html)
// in the Amazon DynamoDB Developer Guide.
// see [ScanFilter]in the Amazon DynamoDB Developer Guide.
//
// [ScanFilter]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html
ScanFilter map[string]types.Condition
// For a parallel Scan request, Segment identifies an individual segment to be
// scanned by an application worker. Segment IDs are zero-based, so the first
// segment is always 0. For example, if you want to use four application threads to
// scan a table or an index, then the first thread specifies a Segment value of 0,
// the second thread specifies 1, and so on. The value of LastEvaluatedKey
// returned from a parallel Scan request must be used as ExclusiveStartKey with
// the same segment ID in a subsequent Scan operation. The value for Segment must
// be greater than or equal to 0, and less than the value provided for
// TotalSegments . If you provide Segment , you must also provide TotalSegments .
// scanned by an application worker.
//
// Segment IDs are zero-based, so the first segment is always 0. For example, if
// you want to use four application threads to scan a table or an index, then the
// first thread specifies a Segment value of 0, the second thread specifies 1, and
// so on.
//
// The value of LastEvaluatedKey returned from a parallel Scan request must be
// used as ExclusiveStartKey with the same segment ID in a subsequent Scan
// operation.
//
// The value for Segment must be greater than or equal to 0, and less than the
// value provided for TotalSegments .
//
// If you provide Segment , you must also provide TotalSegments .
Segment *int32
// The attributes to be returned in the result. You can retrieve all item
// attributes, specific item attributes, the count of matching items, or in the
// case of an index, some or all of the attributes projected into the index.
//
// - ALL_ATTRIBUTES - Returns all of the item attributes from the specified table
// or index. If you query a local secondary index, then for each matching item in
// the index, DynamoDB fetches the entire item from the parent table. If the index
// is configured to project all item attributes, then all of the data can be
// obtained from the local secondary index, and no fetching is required.
//
// - ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves
// all attributes that have been projected into the index. If the index is
// configured to project all attributes, this return value is equivalent to
// specifying ALL_ATTRIBUTES .
//
// - COUNT - Returns the number of matching items, rather than the matching items
// themselves. Note that this uses the same quantity of read capacity units as
// getting the items, and is subject to the same item size calculations.
//
// - SPECIFIC_ATTRIBUTES - Returns only the attributes listed in
// ProjectionExpression . This return value is equivalent to specifying
// ProjectionExpression without specifying any value for Select . If you query or
// scan a local secondary index and request only attributes that are projected into
// that index, the operation reads only the index and not the table. If any of the
// requested attributes are not projected into the local secondary index, DynamoDB
// fetches each of these attributes from the parent table. This extra fetching
// incurs additional throughput cost and latency. If you query or scan a global
// secondary index, you can only request attributes that are projected into the
// index. Global secondary index queries cannot fetch attributes from the parent
// table.
// ProjectionExpression without specifying any value for Select .
//
// If you query or scan a local secondary index and request only attributes that
// are projected into that index, the operation reads only the index and not the
// table. If any of the requested attributes are not projected into the local
// secondary index, DynamoDB fetches each of these attributes from the parent
// table. This extra fetching incurs additional throughput cost and latency.
//
// If you query or scan a global secondary index, you can only request attributes
// that are projected into the index. Global secondary index queries cannot fetch
// attributes from the parent table.
//
// If neither Select nor ProjectionExpression are specified, DynamoDB defaults to
// ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
// accessing an index. You cannot use both Select and ProjectionExpression
// together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES
// . (This usage is equivalent to specifying ProjectionExpression without any
// value for Select .) If you use the ProjectionExpression parameter, then the
// value for Select can only be SPECIFIC_ATTRIBUTES . Any other value for Select
// will return an error.
// value for Select .)
//
// If you use the ProjectionExpression parameter, then the value for Select can
// only be SPECIFIC_ATTRIBUTES . Any other value for Select will return an error.
Select types.Select
// For a parallel Scan request, TotalSegments represents the total number of
// segments into which the Scan operation will be divided. The value of
// TotalSegments corresponds to the number of application workers that will perform
// the parallel scan. For example, if you want to use four application threads to
// scan a table or an index, specify a TotalSegments value of 4. The value for
// TotalSegments must be greater than or equal to 1, and less than or equal to
// 1000000. If you specify a TotalSegments value of 1, the Scan operation will be
// sequential rather than parallel. If you specify TotalSegments , you must also
// specify Segment .
// scan a table or an index, specify a TotalSegments value of 4.
//
// The value for TotalSegments must be greater than or equal to 1, and less than
// or equal to 1000000. If you specify a TotalSegments value of 1, the Scan
// operation will be sequential rather than parallel.
//
// If you specify TotalSegments , you must also specify Segment .
TotalSegments *int32
noSmithyDocumentSerde
@ -253,15 +332,20 @@ type ScanOutput struct {
// The capacity units consumed by the Scan 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 ReturnConsumedCapacity parameter was specified. For more information, see
// Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads)
// the ReturnConsumedCapacity parameter was specified. For more information, see [Capacity unit consumption for read operations]
// in the Amazon DynamoDB Developer Guide.
//
// [Capacity unit consumption for read operations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption
ConsumedCapacity *types.ConsumedCapacity
// The number of items in the response. If you set ScanFilter in the request, then
// Count is the number of items returned after the filter was applied, and
// ScannedCount is the number of matching items before the filter was applied. If
// you did not use a filter in the request, then Count is the same as ScannedCount .
// The number of items in the response.
//
// If you set ScanFilter in the request, then Count is the number of items
// returned after the filter was applied, and ScannedCount is the number of
// matching items before the filter was applied.
//
// If you did not use a filter in the request, then Count is the same as
// ScannedCount .
Count int32
// An array of item attributes that match the scan criteria. Each element in this
@ -270,18 +354,24 @@ type ScanOutput struct {
// The primary key of the item where the operation stopped, inclusive of the
// previous result set. Use this value to start a new operation, excluding this
// value in the new request. If LastEvaluatedKey is empty, then the "last page" of
// results has been processed and there is no more data to be retrieved. If
// LastEvaluatedKey is not empty, it does not necessarily mean that there is more
// data in the result set. The only way to know when you have reached the end of
// the result set is when LastEvaluatedKey is empty.
// value in the new request.
//
// If LastEvaluatedKey is empty, then the "last page" of results has been
// processed and there is no more data to be retrieved.
//
// If LastEvaluatedKey is not empty, it does not necessarily mean that there is
// more data in the result set. The only way to know when you have reached the end
// of the result set is when LastEvaluatedKey is empty.
LastEvaluatedKey map[string]types.AttributeValue
// The number of items evaluated, before any ScanFilter is applied. A high
// ScannedCount value with few, or no, Count results indicates an inefficient Scan
// operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count)
// in the Amazon DynamoDB Developer Guide. If you did not use a filter in the
// request, then ScannedCount is the same as Count .
// operation. For more information, see [Count and ScannedCount]in the Amazon DynamoDB Developer Guide.
//
// If you did not use a filter in the request, then ScannedCount is the same as
// Count .
//
// [Count and ScannedCount]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count
ScannedCount int32
// Metadata pertaining to the operation's result.
@ -438,8 +528,9 @@ type ScanPaginatorOptions struct {
// dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the
// operation and returns the matching values up to the limit, and a key in
// LastEvaluatedKey to apply in a subsequent operation to continue the operation.
// For more information, see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
// in the Amazon DynamoDB Developer Guide.
// For more information, see [Working with Queries]in the Amazon DynamoDB Developer Guide.
//
// [Working with Queries]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html
Limit int32
}

9
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_TagResource.go generated vendored
View file

@ -15,9 +15,12 @@ import (
// Associate a set of tags with an Amazon DynamoDB resource. You can then activate
// these user-defined tags so that they appear on the Billing and Cost Management
// console for cost allocation tracking. You can call TagResource up to five times
// per second, per account. For an overview on tagging DynamoDB resources, see
// Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
// in the Amazon DynamoDB Developer Guide.
// per second, per account.
//
// For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the Amazon DynamoDB
// Developer Guide.
//
// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) {
if params == nil {
params = &TagResourceInput{}

19
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_TransactGetItems.go generated vendored
View file

@ -18,12 +18,18 @@ import (
// each of which contains a Get structure that specifies an item to retrieve from
// a table in the account and Region. A call to TransactGetItems cannot retrieve
// items from tables in more than one Amazon Web Services account or Region. The
// aggregate size of the items in the transaction cannot exceed 4 MB. DynamoDB
// rejects the entire TransactGetItems request if any of the following is true:
// aggregate size of the items in the transaction cannot exceed 4 MB.
//
// DynamoDB rejects the entire TransactGetItems request if any of the following is
// true:
//
// - A conflicting operation is in the process of updating an item to be read.
//
// - There is insufficient provisioned capacity for the transaction to be
// completed.
//
// - There is a user error, such as an invalid data format.
//
// - The aggregate size of the items in the transaction exceeded 4 MB.
func (c *Client) TransactGetItems(ctx context.Context, params *TransactGetItemsInput, optFns ...func(*Options)) (*TransactGetItemsOutput, error) {
if params == nil {
@ -67,10 +73,11 @@ type TransactGetItemsOutput struct {
// An ordered array of up to 100 ItemResponse objects, each of which corresponds
// to the TransactGetItem object in the same position in the TransactItems array.
// Each ItemResponse object contains a Map of the name-value pairs that are the
// projected attributes of the requested item. If a requested item could not be
// retrieved, the corresponding ItemResponse object is Null, or if the requested
// item has no projected attributes, the corresponding ItemResponse object is an
// empty Map.
// projected attributes of the requested item.
//
// If a requested item could not be retrieved, the corresponding ItemResponse
// object is Null, or if the requested item has no projected attributes, the
// corresponding ItemResponse object is an empty Map.
Responses []types.ItemResponse
// Metadata pertaining to the operation's result.

44
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_TransactWriteItems.go generated vendored
View file

@ -16,25 +16,30 @@ import (
// action requests. These actions can target items in different tables, but not in
// different Amazon Web Services accounts or Regions, and no two actions can target
// the same item. For example, you cannot both ConditionCheck and Update the same
// item. The aggregate size of the items in the transaction cannot exceed 4 MB. The
// actions are completed atomically so that either all of them succeed, or all of
// them fail. They are defined by the following objects:
// item. The aggregate size of the items in the transaction cannot exceed 4 MB.
//
// The actions are completed atomically so that either all of them succeed, or all
// of them fail. They are defined by the following objects:
//
// - Put — Initiates a PutItem operation to write a new item. This structure
// specifies the primary key of the item to be written, the name of the table to
// write it in, an optional condition expression that must be satisfied for the
// write to succeed, a list of the item's attributes, and a field indicating
// whether to retrieve the item's attributes if the condition is not met.
//
// - Update — Initiates an UpdateItem operation to update an existing item. This
// structure specifies the primary key of the item to be updated, the name of the
// table where it resides, an optional condition expression that must be satisfied
// for the update to succeed, an expression that defines one or more attributes to
// be updated, and a field indicating whether to retrieve the item's attributes if
// the condition is not met.
//
// - Delete — Initiates a DeleteItem operation to delete an existing item. This
// structure specifies the primary key of the item to be deleted, the name of the
// table where it resides, an optional condition expression that must be satisfied
// for the deletion to succeed, and a field indicating whether to retrieve the
// item's attributes if the condition is not met.
//
// - ConditionCheck — Applies a condition to an item that is not being modified
// by the transaction. This structure specifies the primary key of the item to be
// checked, the name of the table where it resides, a condition expression that
@ -43,14 +48,20 @@ import (
//
// DynamoDB rejects the entire TransactWriteItems request if any of the following
// is true:
//
// - A condition in one of the condition expressions is not met.
//
// - An ongoing operation is in the process of updating the same item.
//
// - There is insufficient provisioned capacity for the transaction to be
// completed.
//
// - An item size becomes too large (bigger than 400 KB), a local secondary
// index (LSI) becomes too large, or a similar validation error occurs because of
// changes made by the transaction.
//
// - The aggregate size of the items in the transaction exceeds 4 MB.
//
// - There is a user error, such as an invalid data format.
func (c *Client) TransactWriteItems(ctx context.Context, params *TransactWriteItemsInput, optFns ...func(*Options)) (*TransactWriteItemsOutput, error) {
if params == nil {
@ -79,30 +90,39 @@ type TransactWriteItemsInput struct {
// Providing a ClientRequestToken makes the call to TransactWriteItems idempotent,
// meaning that multiple identical calls have the same effect as one single call.
//
// Although multiple identical calls using the same client request token produce
// the same result on the server (no side effects), the responses to the calls
// might not be the same. If the ReturnConsumedCapacity parameter is set, then the
// initial TransactWriteItems call returns the amount of write capacity units
// consumed in making the changes. Subsequent TransactWriteItems calls with the
// same client token return the number of read capacity units consumed in reading
// the item. A client request token is valid for 10 minutes after the first request
// that uses it is completed. After 10 minutes, any request with the same client
// token is treated as a new request. Do not resubmit the same request with the
// same client token for more than 10 minutes, or the result might not be
// idempotent. If you submit a request with the same client token but a change in
// other parameters within the 10-minute idempotency window, DynamoDB returns an
// the item.
//
// A client request token is valid for 10 minutes after the first request that
// uses it is completed. After 10 minutes, any request with the same client token
// is treated as a new request. Do not resubmit the same request with the same
// client token for more than 10 minutes, or the result might not be idempotent.
//
// If you submit a request with the same client token but a change in other
// parameters within the 10-minute idempotency window, DynamoDB returns an
// IdempotentParameterMismatch exception.
ClientRequestToken *string
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity

9
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UntagResource.go generated vendored
View file

@ -12,9 +12,12 @@ import (
)
// Removes the association of tags from an Amazon DynamoDB resource. You can call
// UntagResource up to five times per second, per account. For an overview on
// tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
// in the Amazon DynamoDB Developer Guide.
// UntagResource up to five times per second, per account.
//
// For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the Amazon DynamoDB
// Developer Guide.
//
// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) {
if params == nil {
params = &UntagResourceInput{}

13
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UpdateContinuousBackups.go generated vendored
View file

@ -16,11 +16,14 @@ import (
// specified table. A successful UpdateContinuousBackups call returns the current
// ContinuousBackupsDescription . Continuous backups are ENABLED on all tables at
// table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus
// will be set to ENABLED. Once continuous backups and point in time recovery are
// enabled, you can restore to any point in time within EarliestRestorableDateTime
// and LatestRestorableDateTime . LatestRestorableDateTime is typically 5 minutes
// before the current time. You can restore your table to any point in time during
// the last 35 days.
// will be set to ENABLED.
//
// Once continuous backups and point in time recovery are enabled, you can restore
// to any point in time within EarliestRestorableDateTime and
// LatestRestorableDateTime .
//
// LatestRestorableDateTime is typically 5 minutes before the current time. You
// can restore your table to any point in time during the last 35 days.
func (c *Client) UpdateContinuousBackups(ctx context.Context, params *UpdateContinuousBackupsInput, optFns ...func(*Options)) (*UpdateContinuousBackupsOutput, error) {
if params == nil {
params = &UpdateContinuousBackupsInput{}

38
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UpdateGlobalTable.go generated vendored
View file

@ -16,25 +16,37 @@ import (
// already exist to be able to use this operation. Any replica to be added must be
// empty, have the same name as the global table, have the same key schema, have
// DynamoDB Streams enabled, and have the same provisioned and maximum write
// capacity units. This operation only applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html)
// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// when creating new global tables, as it provides greater flexibility, higher
// capacity units.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version), as it provides greater flexibility, higher
// efficiency and consumes less write capacity than 2017.11.29 (Legacy). To
// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html)
// . To update existing global tables from version 2017.11.29 (Legacy) to version
// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html)
// . This operation only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html)
// of global tables. If you are using global tables Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// you can use UpdateTable (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html)
// instead. Although you can use UpdateGlobalTable to add replicas and remove
// replicas in a single request, for simplicity we recommend that you issue
// separate requests for adding or removing replicas. If global secondary indexes
// are specified, then the following conditions must also be met:
// determine which version you are using, see [Determining the version]. To update existing global tables
// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables].
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version). If you are using global tables [Version 2019.11.21]you can use [UpdateTable]
// instead.
//
// Although you can use UpdateGlobalTable to add replicas and remove replicas in a
// single request, for simplicity we recommend that you issue separate requests for
// adding or removing replicas.
//
// If global secondary indexes are specified, then the following conditions must
// also be met:
//
// - The global secondary indexes must have the same name.
//
// - The global secondary indexes must have the same hash key and sort key (if
// present).
//
// - The global secondary indexes must have the same provisioned and maximum
// write capacity units.
//
// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html
// [UpdateTable]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html
// [Version 2019.11.21]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html
// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html
func (c *Client) UpdateGlobalTable(ctx context.Context, params *UpdateGlobalTableInput, optFns ...func(*Options)) (*UpdateGlobalTableOutput, error) {
if params == nil {
params = &UpdateGlobalTableInput{}

28
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UpdateGlobalTableSettings.go generated vendored
View file

@ -12,15 +12,16 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates settings for a global table. This operation only applies to Version
// 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html)
// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// when creating new global tables, as it provides greater flexibility, higher
// Updates settings for a global table.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version), as it provides greater flexibility, higher
// efficiency and consumes less write capacity than 2017.11.29 (Legacy). To
// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html)
// . To update existing global tables from version 2017.11.29 (Legacy) to version
// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html)
// .
// determine which version you are using, see [Determining the version]. To update existing global tables
// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables].
//
// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html
// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html
func (c *Client) UpdateGlobalTableSettings(ctx context.Context, params *UpdateGlobalTableSettingsInput, optFns ...func(*Options)) (*UpdateGlobalTableSettingsOutput, error) {
if params == nil {
params = &UpdateGlobalTableSettingsInput{}
@ -45,12 +46,15 @@ type UpdateGlobalTableSettingsInput struct {
// The billing mode of the global table. If GlobalTableBillingMode is not
// specified, the global table defaults to PROVISIONED capacity billing mode.
//
// - PROVISIONED - We recommend using PROVISIONED for predictable workloads.
// PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)
// .
// PROVISIONED sets the billing mode to [Provisioned capacity mode].
//
// - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
// workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)
// .
// workloads. PAY_PER_REQUEST sets the billing mode to [On-demand capacity mode].
//
// [Provisioned capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html
// [On-demand capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html
GlobalTableBillingMode types.BillingMode
// Represents the settings of a global secondary index for a global table that

242
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UpdateItem.go generated vendored
View file

@ -16,9 +16,10 @@ import (
// not already exist. You can put, delete, or add attribute values. You can also
// perform a conditional update on an existing item (insert a new attribute
// name-value pair if it doesn't exist, or replace an existing name-value pair if
// it has certain expected attribute values). You can also return the item's
// attribute values in the same UpdateItem operation using the ReturnValues
// parameter.
// it has certain expected attribute values).
//
// You can also return the item's attribute values in the same UpdateItem
// operation using the ReturnValues parameter.
func (c *Client) UpdateItem(ctx context.Context, params *UpdateItemInput, optFns ...func(*Options)) (*UpdateItemOutput, error) {
if params == nil {
params = &UpdateItemInput{}
@ -38,10 +39,12 @@ func (c *Client) UpdateItem(ctx context.Context, params *UpdateItemInput, optFns
type UpdateItemInput struct {
// The primary key of the item to be updated. Each element consists of an
// attribute name and a value for that attribute. For the primary key, you must
// provide all of the attributes. For example, with a simple primary key, you only
// need to provide a value for the partition key. For a composite primary key, you
// must provide values for both the partition key and the sort key.
// attribute name and a value for that attribute.
//
// For the primary key, you must provide all of the attributes. For example, with
// a simple primary key, you only need to provide a value for the partition key.
// For a composite primary key, you must provide values for both the partition key
// and the sort key.
//
// This member is required.
Key map[string]types.AttributeValue
@ -53,75 +56,116 @@ type UpdateItemInput struct {
TableName *string
// This is a legacy parameter. Use UpdateExpression instead. For more information,
// see AttributeUpdates (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html)
// in the Amazon DynamoDB Developer Guide.
// see [AttributeUpdates]in the Amazon DynamoDB Developer Guide.
//
// [AttributeUpdates]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html
AttributeUpdates map[string]types.AttributeValueUpdate
// A condition that must be satisfied in order for a conditional update to
// succeed. An expression can contain any of the following:
// A condition that must be satisfied in order for a conditional update to succeed.
//
// An expression can contain any of the following:
//
// - Functions: attribute_exists | attribute_not_exists | attribute_type |
// contains | begins_with | size These function names are case-sensitive.
// contains | begins_with | size
//
// These function names are case-sensitive.
//
// - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
//
// - Logical operators: AND | OR | NOT
// For more information about condition expressions, see Specifying Conditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
//
// For more information about condition expressions, see [Specifying Conditions] in the Amazon DynamoDB
// Developer Guide.
//
// [Specifying Conditions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ConditionExpression *string
// This is a legacy parameter. Use ConditionExpression instead. For more
// information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [ConditionalOperator]in the Amazon DynamoDB Developer Guide.
//
// [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html
ConditionalOperator types.ConditionalOperator
// This is a legacy parameter. Use ConditionExpression instead. For more
// information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
// in the Amazon DynamoDB Developer Guide.
// information, see [Expected]in the Amazon DynamoDB Developer Guide.
//
// [Expected]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html
Expected map[string]types.ExpectedAttributeValue
// One or more substitution tokens for attribute names in an expression. The
// following are some use cases for using ExpressionAttributeNames :
//
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
//
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
//
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression.
//
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
//
// - Percentile
//
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see
// Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide.) To work around this, you could specify
// the following for ExpressionAttributeNames :
// directly in an expression. (For the complete list of reserved words, see [Reserved Words]in the
// Amazon DynamoDB Developer Guide.) To work around this, you could specify the
// following for ExpressionAttributeNames :
//
// - {"#P":"Percentile"}
//
// You could then use this substitution in an expression, as in this example:
//
// - #P = :val
//
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime. For more information about
// expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
// are placeholders for the actual value at runtime.
//
// For more information about expression attribute names, see [Specifying Item Attributes] in the Amazon
// DynamoDB Developer Guide.
//
// [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html
// [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression. Use the : (colon)
// character in an expression to dereference an attribute value. For example,
// suppose that you wanted to check whether the value of the ProductStatus
// attribute was one of the following: Available | Backordered | Discontinued You
// would first need to specify ExpressionAttributeValues as follows: {
// ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} } You could then use these values in an expression,
// such as this: ProductStatus IN (:avail, :back, :disc) For more information on
// expression attribute values, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
// in the Amazon DynamoDB Developer Guide.
// One or more values that can be substituted in an expression.
//
// Use the : (colon) character in an expression to dereference an attribute value.
// For example, suppose that you wanted to check whether the value of the
// ProductStatus attribute was one of the following:
//
// Available | Backordered | Discontinued
//
// You would first need to specify ExpressionAttributeValues as follows:
//
// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"},
// ":disc":{"S":"Discontinued"} }
//
// You could then use these values in an expression, such as this:
//
// ProductStatus IN (:avail, :back, :disc)
//
// For more information on expression attribute values, see [Condition Expressions] in the Amazon
// DynamoDB Developer Guide.
//
// [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html
ExpressionAttributeValues map[string]types.AttributeValue
// Determines the level of detail about either provisioned or on-demand 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).
// 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.
ReturnConsumedCapacity types.ReturnConsumedCapacity
@ -133,78 +177,110 @@ type UpdateItemInput struct {
// Use ReturnValues if you want to get the item attributes as they appear before
// or after they are successfully updated. For UpdateItem , the valid values are:
//
// - NONE - If ReturnValues is not specified, or if its value is NONE , then
// nothing is returned. (This setting is the default for ReturnValues .)
//
// - ALL_OLD - Returns all of the attributes of the item, as they appeared before
// the UpdateItem operation.
//
// - UPDATED_OLD - Returns only the updated attributes, as they appeared before
// the UpdateItem operation.
//
// - ALL_NEW - Returns all of the attributes of the item, as they appear after
// the UpdateItem operation.
//
// - UPDATED_NEW - Returns only the updated attributes, as they appear after the
// UpdateItem operation.
//
// There is no additional cost associated with requesting a return value aside
// from the small network and processing overhead of receiving a larger response.
// No read capacity units are consumed. The values returned are strongly
// consistent.
// No read capacity units are consumed.
//
// The values returned are strongly consistent.
ReturnValues types.ReturnValue
// An optional parameter that returns the item attributes for an UpdateItem
// operation that failed a condition check. There is no additional cost associated
// with requesting a return value aside from the small network and processing
// overhead of receiving a larger response. No read capacity units are consumed.
// operation that failed a condition check.
//
// There is no additional cost associated with requesting a return value aside
// from the small network and processing overhead of receiving a larger response.
// No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure
// An expression that defines one or more attributes to be updated, the action to
// be performed on them, and new values for them. The following action values are
// available for UpdateExpression .
// be performed on them, and new values for them.
//
// The following action values are available for UpdateExpression .
//
// - SET - Adds one or more attributes and values to an item. If any of these
// attributes already exist, they are replaced by the new values. You can also use
// SET to add or subtract from an attribute that is of type Number. For example:
// SET myNum = myNum + :val SET supports the following functions:
// SET myNum = myNum + :val
//
// SET supports the following functions:
//
// - if_not_exists (path, operand) - if the item does not contain an attribute at
// the specified path, then if_not_exists evaluates to operand; otherwise, it
// evaluates to path. You can use this function to avoid overwriting an attribute
// that may already be present in the item.
//
// - list_append (operand, operand) - evaluates to a list with a new element
// added to it. You can append the new element to the start or the end of the list
// by reversing the order of the operands. These function names are
// case-sensitive.
// by reversing the order of the operands.
//
// These function names are case-sensitive.
//
// - REMOVE - Removes one or more attributes from an item.
//
// - ADD - Adds the specified value to the item, if the attribute does not
// already exist. If the attribute does exist, then the behavior of ADD depends
// on the data type of the attribute:
//
// - If the existing attribute is a number, and if Value is also a number, then
// Value is mathematically added to the existing attribute. If Value is a
// negative number, then it is subtracted from the existing attribute. If you use
// ADD to increment or decrement a number value for an item that doesn't exist
// before the update, DynamoDB uses 0 as the initial value. Similarly, if you use
// ADD for an existing item to increment or decrement an attribute value that
// doesn't exist before the update, DynamoDB uses 0 as the initial value. For
// example, suppose that the item you want to update doesn't have an attribute
// named itemcount , but you decide to ADD the number 3 to this attribute anyway.
// DynamoDB will create the itemcount attribute, set its initial value to 0 , and
// finally add 3 to it. The result will be a new itemcount attribute in the item,
// with a value of 3 .
// negative number, then it is subtracted from the existing attribute.
//
// If you use ADD to increment or decrement a number value for an item that doesn't
// exist before the update, DynamoDB uses 0 as the initial value.
//
// Similarly, if you use ADD for an existing item to increment or decrement an
// attribute value that doesn't exist before the update, DynamoDB uses 0 as the
// initial value. For example, suppose that the item you want to update doesn't
// have an attribute named itemcount , but you decide to ADD the number 3 to this
// attribute anyway. DynamoDB will create the itemcount attribute, set its
// initial value to 0 , and finally add 3 to it. The result will be a new
// itemcount attribute in the item, with a value of 3 .
//
// - If the existing data type is a set and if Value is also a set, then Value is
// added to the existing set. For example, if the attribute value is the set
// [1,2] , and the ADD action specified [3] , then the final attribute value is
// [1,2,3] . An error occurs if an ADD action is specified for a set attribute
// and the attribute type specified does not match the existing set type. Both sets
// must have the same primitive data type. For example, if the existing data type
// is a set of strings, the Value must also be a set of strings. The ADD action
// only supports Number and set data types. In addition, ADD can only be used on
// top-level attributes, not nested attributes.
// - DELETE - Deletes an element from a set. If a set of values is specified,
// then those values are subtracted from the old set. For example, if the attribute
// value was the set [a,b,c] and the DELETE action specifies [a,c] , then the
// final attribute value is [b] . Specifying an empty set is an error. The DELETE
// action only supports set data types. In addition, DELETE can only be used on
// top-level attributes, not nested attributes.
// and the attribute type specified does not match the existing set type.
//
// Both sets must have the same primitive data type. For example, if the existing
// data type is a set of strings, the Value must also be a set of strings.
//
// The ADD action only supports Number and set data types. In addition, ADD can
// only be used on top-level attributes, not nested attributes.
//
// - DELETE - Deletes an element from a set.
//
// If a set of values is specified, then those values are subtracted from the old
// set. For example, if the attribute value was the set [a,b,c] and the DELETE
// action specifies [a,c] , then the final attribute value is [b] . Specifying an
// empty set is an error.
//
// The DELETE action only supports set data types. In addition, DELETE can only be
// used on top-level attributes, not nested attributes.
//
// You can have many actions in a single expression, such as the following: SET
// a=:value1, b=:value2 DELETE :value3, :value4, :value5 For more information on
// update expressions, see Modifying Items and Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html)
// in the Amazon DynamoDB Developer Guide.
// a=:value1, b=:value2 DELETE :value3, :value4, :value5
//
// For more information on update expressions, see [Modifying Items and Attributes] in the Amazon DynamoDB
// Developer Guide.
//
// [Modifying Items and Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html
UpdateExpression *string
noSmithyDocumentSerde
@ -214,33 +290,41 @@ type UpdateItemInput struct {
type UpdateItemOutput struct {
// A map of attribute values as they appear before or after the UpdateItem
// operation, as determined by the ReturnValues parameter. The Attributes map is
// only present if the update was successful and ReturnValues was specified as
// something other than NONE in the request. Each element represents one attribute.
// operation, as determined by the ReturnValues parameter.
//
// The Attributes map is only present if the update was successful and ReturnValues
// was specified as something other than NONE in the request. Each element
// represents one attribute.
Attributes map[string]types.AttributeValue
// The capacity units consumed by the UpdateItem 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 ReturnConsumedCapacity parameter was specified. For more
// information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads)
// in the Amazon DynamoDB Developer Guide.
// information, see [Capacity unity consumption for write operations]in the Amazon DynamoDB Developer Guide.
//
// [Capacity unity consumption for write operations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption
ConsumedCapacity *types.ConsumedCapacity
// Information about item collections, if any, that were affected by the UpdateItem
// operation. ItemCollectionMetrics is only returned if the
// ReturnItemCollectionMetrics parameter was specified. If the table does not have
// any local secondary indexes, this information is not returned in the response.
//
// Each ItemCollectionMetrics element consists of:
//
// - ItemCollectionKey - The partition key value of the item collection. This is
// the same as the partition key value of the item itself.
//
// - SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
// This value is a two-element array containing a lower bound and an upper bound
// for the estimate. The estimate includes the size of all the items in the table,
// plus the size of all attributes projected into all of the local secondary
// indexes on that table. Use this estimate to measure whether a local secondary
// index is approaching its size limit. The estimate is subject to change over
// time; therefore, do not rely on the precision or accuracy of the estimate.
// index is approaching its size limit.
//
// The estimate is subject to change over time; therefore, do not rely on the
// precision or accuracy of the estimate.
ItemCollectionMetrics *types.ItemCollectionMetrics
// Metadata pertaining to the operation's result.

47
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UpdateTable.go generated vendored
View file

@ -13,11 +13,17 @@ import (
)
// Modifies the provisioned throughput settings, global secondary indexes, or
// DynamoDB Streams settings for a given table. This operation only applies to
// Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// of global tables. You can only perform one of the following operations at once:
// DynamoDB Streams settings for a given table.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version).
//
// You can only perform one of the following operations at once:
//
// - Modify the provisioned throughput settings of the table.
//
// - Remove a global secondary index from the table.
//
// - Create a new global secondary index on the table. After the index begins
// backfilling, you can use UpdateTable to perform other operations.
//
@ -59,12 +65,15 @@ type UpdateTableInput struct {
// provisioned capacity values must be set. The initial provisioned capacity values
// are estimated based on the consumed read and write capacity of your table and
// global secondary indexes over the past 30 minutes.
//
// - PROVISIONED - We recommend using PROVISIONED for predictable workloads.
// PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)
// .
// PROVISIONED sets the billing mode to [Provisioned capacity mode].
//
// - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
// workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)
// .
// workloads. PAY_PER_REQUEST sets the billing mode to [On-demand capacity mode].
//
// [Provisioned capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html
// [On-demand capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html
BillingMode types.BillingMode
// Indicates whether deletion protection is to be enabled (true) or disabled
@ -73,13 +82,20 @@ type UpdateTableInput struct {
// An array of one or more global secondary indexes for the table. For each index
// in the array, you can request one action:
//
// - Create - add a new global secondary index to the table.
//
// - Update - modify the provisioned throughput settings of an existing global
// secondary index.
//
// - Delete - remove a global secondary index from the table.
//
// You can create or delete only one global secondary index per UpdateTable
// operation. For more information, see Managing Global Secondary Indexes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html)
// in the Amazon DynamoDB Developer Guide.
// operation.
//
// For more information, see [Managing Global Secondary Indexes] in the Amazon DynamoDB Developer Guide.
//
// [Managing Global Secondary Indexes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html
GlobalSecondaryIndexUpdates []types.GlobalSecondaryIndexUpdate
// Updates the maximum number of read and write units for the specified table in
@ -91,16 +107,19 @@ type UpdateTableInput struct {
ProvisionedThroughput *types.ProvisionedThroughput
// A list of replica update actions (create, delete, or update) for the table.
// This property only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// of global tables.
//
// For global tables, this property only applies to global tables using Version
// 2019.11.21 (Current version).
ReplicaUpdates []types.ReplicationGroupUpdate
// The new server-side encryption settings for the specified table.
SSESpecification *types.SSESpecification
// Represents the DynamoDB Streams configuration for the table. You receive a
// ValidationException if you try to enable a stream on a table that already has a
// stream, or if you try to disable a stream on a table that doesn't have a stream.
// Represents the DynamoDB Streams configuration for the table.
//
// You receive a ValidationException if you try to enable a stream on a table that
// already has a stream, or if you try to disable a stream on a table that doesn't
// have a stream.
StreamSpecification *types.StreamSpecification
// The table class of the table to be updated. Valid values are STANDARD and

7
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go generated vendored
View file

@ -11,9 +11,10 @@ import (
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates auto scaling settings on your global tables at once. This operation
// only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
// of global tables.
// Updates auto scaling settings on your global tables at once.
//
// For global tables, this operation only applies to global tables using Version
// 2019.11.21 (Current version).
func (c *Client) UpdateTableReplicaAutoScaling(ctx context.Context, params *UpdateTableReplicaAutoScalingInput, optFns ...func(*Options)) (*UpdateTableReplicaAutoScalingOutput, error) {
if params == nil {
params = &UpdateTableReplicaAutoScalingInput{}

37
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/api_op_UpdateTimeToLive.go generated vendored
View file

@ -16,20 +16,31 @@ import (
// specified table. A successful UpdateTimeToLive call returns the current
// TimeToLiveSpecification . It can take up to one hour for the change to fully
// process. Any additional UpdateTimeToLive calls for the same table during this
// one hour duration result in a ValidationException . TTL compares the current
// time in epoch time format to the time stored in the TTL attribute of an item. If
// the epoch time value stored in the attribute is less than the current time, the
// item is marked as expired and subsequently deleted. The epoch time format is the
// number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC. DynamoDB
// deletes expired items on a best-effort basis to ensure availability of
// throughput for other data operations. DynamoDB typically deletes expired items
// within two days of expiration. The exact duration within which an item gets
// deleted after expiration is specific to the nature of the workload. Items that
// have expired and not been deleted will still show up in reads, queries, and
// scans. As items are deleted, they are removed from any local secondary index and
// one hour duration result in a ValidationException .
//
// TTL compares the current time in epoch time format to the time stored in the
// TTL attribute of an item. If the epoch time value stored in the attribute is
// less than the current time, the item is marked as expired and subsequently
// deleted.
//
// The epoch time format is the number of seconds elapsed since 12:00:00 AM
// January 1, 1970 UTC.
//
// DynamoDB deletes expired items on a best-effort basis to ensure availability of
// throughput for other data operations.
//
// DynamoDB typically deletes expired items within two days of expiration. The
// exact duration within which an item gets deleted after expiration is specific to
// the nature of the workload. Items that have expired and not been deleted will
// still show up in reads, queries, and scans.
//
// As items are deleted, they are removed from any local secondary index and
// global secondary index immediately in the same eventually consistent way as a
// standard delete operation. For more information, see Time To Live (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html)
// in the Amazon DynamoDB Developer Guide.
// standard delete operation.
//
// For more information, see [Time To Live] in the Amazon DynamoDB Developer Guide.
//
// [Time To Live]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html
func (c *Client) UpdateTimeToLive(ctx context.Context, params *UpdateTimeToLiveInput, optFns ...func(*Options)) (*UpdateTimeToLiveOutput, error) {
if params == nil {
params = &UpdateTimeToLiveInput{}

9
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/deserializers.go generated vendored
View file

@ -20,8 +20,17 @@ import (
"io/ioutil"
"math"
"strings"
"time"
)
func deserializeS3Expires(v string) (*time.Time, error) {
t, err := smithytime.ParseHTTPDate(v)
if err != nil {
return nil, nil
}
return &t, nil
}
type awsAwsjson10_deserializeOpBatchExecuteStatement struct {
}

35
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/doc.go generated vendored
View file

@ -3,19 +3,24 @@
// Package dynamodb provides the API client, operations, and parameter types for
// Amazon DynamoDB.
//
// 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 Amazon Web Services 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 Amazon Web
// Services Region, providing built-in high availability and data durability.
// # 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 Amazon Web Services 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 Amazon Web Services Region, providing built-in high
// availability and data durability.
package dynamodb

2
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/go_module_metadata.go generated vendored
View file

@ -3,4 +3,4 @@
package dynamodb
// goModuleVersion is the tagged release for this module
const goModuleVersion = "1.32.0"
const goModuleVersion = "1.32.5"

31
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/options.go generated vendored
View file

@ -61,8 +61,10 @@ type Options struct {
// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
// value for this field will likely prevent you from using any endpoint-related
// service features released after the introduction of EndpointResolverV2 and
// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
// endpoint, set the client option BaseEndpoint instead.
// BaseEndpoint.
//
// To migrate an EndpointResolver implementation that uses a custom endpoint, set
// the client option BaseEndpoint instead.
EndpointResolver EndpointResolver
// Resolves the endpoint used for a particular service operation. This should be
@ -85,17 +87,20 @@ type Options struct {
// RetryMaxAttempts specifies the maximum number attempts an API client will call
// an operation that fails with a retryable error. A value of 0 is ignored, and
// will not be used to configure the API client created default retryer, or modify
// per operation call's retry max attempts. If specified in an operation call's
// functional options with a value that is different than the constructed client's
// Options, the Client's Retryer will be wrapped to use the operation's specific
// RetryMaxAttempts value.
// per operation call's retry max attempts.
//
// If specified in an operation call's functional options with a value that is
// different than the constructed client's Options, the Client's Retryer will be
// wrapped to use the operation's specific RetryMaxAttempts value.
RetryMaxAttempts int
// RetryMode specifies the retry mode the API client will be created with, if
// Retryer option is not also specified. When creating a new API Clients this
// member will only be used if the Retryer Options member is nil. This value will
// be ignored if Retryer is not nil. Currently does not support per operation call
// overrides, may in the future.
// Retryer option is not also specified.
//
// When creating a new API Clients this member will only be used if the Retryer
// Options member is nil. This value will be ignored if Retryer is not nil.
//
// Currently does not support per operation call overrides, may in the future.
RetryMode aws.RetryMode
// Retryer guides how HTTP requests should be retried in case of recoverable
@ -112,8 +117,9 @@ type Options struct {
// The initial DefaultsMode used when the client options were constructed. If the
// DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved
// value was at that point in time. Currently does not support per operation call
// overrides, may in the future.
// value was at that point in time.
//
// Currently does not support per operation call overrides, may in the future.
resolvedDefaultsMode aws.DefaultsMode
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
@ -158,6 +164,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) {
// Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for
// this field will likely prevent you from using any endpoint-related service
// features released after the introduction of EndpointResolverV2 and BaseEndpoint.
//
// To migrate an EndpointResolver implementation that uses a custom endpoint, set
// the client option BaseEndpoint instead.
func WithEndpointResolver(v EndpointResolver) func(*Options) {

175
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/types/enums.go generated vendored
View file

@ -12,8 +12,9 @@ const (
// Values returns all known values for ApproximateCreationDateTimePrecision. Note
// that this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
// client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ApproximateCreationDateTimePrecision) Values() []ApproximateCreationDateTimePrecision {
return []ApproximateCreationDateTimePrecision{
"MILLISECOND",
@ -31,8 +32,9 @@ const (
)
// Values returns all known values for AttributeAction. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (AttributeAction) Values() []AttributeAction {
return []AttributeAction{
"ADD",
@ -51,8 +53,9 @@ const (
)
// Values returns all known values for BackupStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (BackupStatus) Values() []BackupStatus {
return []BackupStatus{
"CREATING",
@ -71,8 +74,9 @@ const (
)
// Values returns all known values for BackupType. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (BackupType) Values() []BackupType {
return []BackupType{
"USER",
@ -92,8 +96,9 @@ const (
)
// Values returns all known values for BackupTypeFilter. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (BackupTypeFilter) Values() []BackupTypeFilter {
return []BackupTypeFilter{
"USER",
@ -122,6 +127,7 @@ const (
// Values returns all known values for BatchStatementErrorCodeEnum. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (BatchStatementErrorCodeEnum) Values() []BatchStatementErrorCodeEnum {
return []BatchStatementErrorCodeEnum{
@ -148,8 +154,9 @@ const (
)
// Values returns all known values for BillingMode. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (BillingMode) Values() []BillingMode {
return []BillingMode{
"PROVISIONED",
@ -177,8 +184,9 @@ const (
)
// Values returns all known values for ComparisonOperator. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ComparisonOperator) Values() []ComparisonOperator {
return []ComparisonOperator{
"EQ",
@ -206,8 +214,9 @@ const (
)
// Values returns all known values for ConditionalOperator. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ConditionalOperator) Values() []ConditionalOperator {
return []ConditionalOperator{
"AND",
@ -224,8 +233,9 @@ const (
)
// Values returns all known values for ContinuousBackupsStatus. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// be expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ContinuousBackupsStatus) Values() []ContinuousBackupsStatus {
return []ContinuousBackupsStatus{
"ENABLED",
@ -243,6 +253,7 @@ const (
// Values returns all known values for ContributorInsightsAction. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ContributorInsightsAction) Values() []ContributorInsightsAction {
return []ContributorInsightsAction{
@ -264,6 +275,7 @@ const (
// Values returns all known values for ContributorInsightsStatus. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ContributorInsightsStatus) Values() []ContributorInsightsStatus {
return []ContributorInsightsStatus{
@ -288,8 +300,9 @@ const (
)
// Values returns all known values for DestinationStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (DestinationStatus) Values() []DestinationStatus {
return []DestinationStatus{
"ENABLING",
@ -310,8 +323,9 @@ const (
)
// Values returns all known values for ExportFormat. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ExportFormat) Values() []ExportFormat {
return []ExportFormat{
"DYNAMODB_JSON",
@ -329,8 +343,9 @@ const (
)
// Values returns all known values for ExportStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ExportStatus) Values() []ExportStatus {
return []ExportStatus{
"IN_PROGRESS",
@ -348,8 +363,9 @@ const (
)
// Values returns all known values for ExportType. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ExportType) Values() []ExportType {
return []ExportType{
"FULL_EXPORT",
@ -366,8 +382,9 @@ const (
)
// Values returns all known values for ExportViewType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ExportViewType) Values() []ExportViewType {
return []ExportViewType{
"NEW_IMAGE",
@ -386,8 +403,9 @@ const (
)
// Values returns all known values for GlobalTableStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (GlobalTableStatus) Values() []GlobalTableStatus {
return []GlobalTableStatus{
"CREATING",
@ -409,8 +427,9 @@ const (
)
// Values returns all known values for ImportStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ImportStatus) Values() []ImportStatus {
return []ImportStatus{
"IN_PROGRESS",
@ -432,8 +451,9 @@ const (
)
// Values returns all known values for IndexStatus. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (IndexStatus) Values() []IndexStatus {
return []IndexStatus{
"CREATING",
@ -453,8 +473,9 @@ const (
)
// Values returns all known values for InputCompressionType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (InputCompressionType) Values() []InputCompressionType {
return []InputCompressionType{
"GZIP",
@ -473,8 +494,9 @@ const (
)
// Values returns all known values for InputFormat. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (InputFormat) Values() []InputFormat {
return []InputFormat{
"DYNAMODB_JSON",
@ -492,8 +514,9 @@ const (
)
// Values returns all known values for KeyType. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
// the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (KeyType) Values() []KeyType {
return []KeyType{
"HASH",
@ -511,6 +534,7 @@ const (
// Values returns all known values for PointInTimeRecoveryStatus. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (PointInTimeRecoveryStatus) Values() []PointInTimeRecoveryStatus {
return []PointInTimeRecoveryStatus{
@ -529,8 +553,9 @@ const (
)
// Values returns all known values for ProjectionType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ProjectionType) Values() []ProjectionType {
return []ProjectionType{
"ALL",
@ -553,8 +578,9 @@ const (
)
// Values returns all known values for ReplicaStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ReplicaStatus) Values() []ReplicaStatus {
return []ReplicaStatus{
"CREATING",
@ -577,8 +603,9 @@ const (
)
// Values returns all known values for ReturnConsumedCapacity. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// be expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ReturnConsumedCapacity) Values() []ReturnConsumedCapacity {
return []ReturnConsumedCapacity{
"INDEXES",
@ -597,6 +624,7 @@ const (
// Values returns all known values for ReturnItemCollectionMetrics. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ReturnItemCollectionMetrics) Values() []ReturnItemCollectionMetrics {
return []ReturnItemCollectionMetrics{
@ -617,8 +645,9 @@ const (
)
// Values returns all known values for ReturnValue. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ReturnValue) Values() []ReturnValue {
return []ReturnValue{
"NONE",
@ -639,8 +668,9 @@ const (
// Values returns all known values for ReturnValuesOnConditionCheckFailure. Note
// that this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
// client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ReturnValuesOnConditionCheckFailure) Values() []ReturnValuesOnConditionCheckFailure {
return []ReturnValuesOnConditionCheckFailure{
"ALL_OLD",
@ -657,8 +687,9 @@ const (
)
// Values returns all known values for S3SseAlgorithm. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (S3SseAlgorithm) Values() []S3SseAlgorithm {
return []S3SseAlgorithm{
"AES256",
@ -676,8 +707,9 @@ const (
)
// Values returns all known values for ScalarAttributeType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (ScalarAttributeType) Values() []ScalarAttributeType {
return []ScalarAttributeType{
"S",
@ -697,8 +729,9 @@ const (
)
// Values returns all known values for Select. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
// the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (Select) Values() []Select {
return []Select{
"ALL_ATTRIBUTES",
@ -720,8 +753,9 @@ const (
)
// Values returns all known values for SSEStatus. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (SSEStatus) Values() []SSEStatus {
return []SSEStatus{
"ENABLING",
@ -741,8 +775,9 @@ const (
)
// Values returns all known values for SSEType. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
// the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (SSEType) Values() []SSEType {
return []SSEType{
"AES256",
@ -761,8 +796,9 @@ const (
)
// Values returns all known values for StreamViewType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (StreamViewType) Values() []StreamViewType {
return []StreamViewType{
"NEW_IMAGE",
@ -781,8 +817,9 @@ const (
)
// Values returns all known values for TableClass. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (TableClass) Values() []TableClass {
return []TableClass{
"STANDARD",
@ -804,8 +841,9 @@ const (
)
// Values returns all known values for TableStatus. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
// in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (TableStatus) Values() []TableStatus {
return []TableStatus{
"CREATING",
@ -829,8 +867,9 @@ const (
)
// Values returns all known values for TimeToLiveStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
// expanded in the future, and so it is only as up to date as the client.
//
// The ordering of this slice is not guaranteed to be stable across updates.
func (TimeToLiveStatus) Values() []TimeToLiveStatus {
return []TimeToLiveStatus{
"ENABLING",

219
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/types/errors.go generated vendored
View file

@ -116,7 +116,8 @@ func (e *ContinuousBackupsUnavailableException) ErrorFault() smithy.ErrorFault {
return smithy.FaultClient
}
// There was an attempt to insert an item with the same primary key as an item
// There was an attempt to insert an item with the same primary key as an item
//
// that already exists in the DynamoDB table.
type DuplicateItemException struct {
Message *string
@ -276,7 +277,8 @@ func (e *IdempotentParameterMismatchException) ErrorFault() smithy.ErrorFault {
return smithy.FaultClient
}
// There was a conflict when importing from the specified S3 source. This can
// There was a conflict when importing from the specified S3 source. This can
//
// occur when the current import conflicts with a previous import request that had
// the same client token.
type ImportConflictException struct {
@ -490,17 +492,26 @@ func (e *ItemCollectionSizeLimitExceededException) ErrorFault() smithy.ErrorFaul
}
// There is no limit to the number of daily on-demand backups that can be taken.
//
// For most purposes, up to 500 simultaneous table operations are allowed per
// account. These operations include CreateTable , UpdateTable , DeleteTable ,
// UpdateTimeToLive , RestoreTableFromBackup , and RestoreTableToPointInTime . When
// you are creating a table with one or more secondary indexes, you can have up to
// 250 such requests running at a time. However, if the table or index
// UpdateTimeToLive , RestoreTableFromBackup , and RestoreTableToPointInTime .
//
// When you are creating a table with one or more secondary indexes, you can have
// up to 250 such requests running at a time. However, if the table or index
// specifications are complex, then DynamoDB might temporarily reduce the number of
// concurrent operations. When importing into DynamoDB, up to 50 simultaneous
// import table operations are allowed per account. There is a soft account quota
// of 2,500 tables. GetRecords was called with a value of more than 1000 for the
// limit request parameter. More than 2 processes are reading from the same streams
// shard at the same time. Exceeding this limit may result in request throttling.
// concurrent operations.
//
// When importing into DynamoDB, up to 50 simultaneous import table operations are
// allowed per account.
//
// There is a soft account quota of 2,500 tables.
//
// GetRecords was called with a value of more than 1000 for the limit request
// parameter.
//
// More than 2 processes are reading from the same streams shard at the same time.
// Exceeding this limit may result in request throttling.
type LimitExceededException struct {
Message *string
@ -554,9 +565,10 @@ func (e *PointInTimeRecoveryUnavailableException) ErrorFault() smithy.ErrorFault
return smithy.FaultClient
}
// The operation tried to access a nonexistent resource-based policy. If you
// specified an ExpectedRevisionId , it's possible that a policy is present for the
// resource but its revision ID didn't match the expected value.
// The operation tried to access a nonexistent resource-based policy.
//
// If you specified an ExpectedRevisionId , it's possible that a policy is present
// for the resource but its revision ID didn't match the expected value.
type PolicyNotFoundException struct {
Message *string
@ -586,8 +598,9 @@ func (e *PolicyNotFoundException) ErrorFault() smithy.ErrorFault { return smithy
// 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff)
// in the Amazon DynamoDB Developer Guide.
// to [Error Retries and Exponential Backoff]in the Amazon DynamoDB Developer Guide.
//
// [Error Retries and Exponential Backoff]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff
type ProvisionedThroughputExceededException struct {
Message *string
@ -668,8 +681,9 @@ func (e *ReplicaNotFoundException) ErrorCode() string {
func (e *ReplicaNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// Throughput exceeds the current throughput quota for your account. Please
// contact Amazon Web Services Support (https://aws.amazon.com/support) to request
// a quota increase.
// contact [Amazon Web Services Support]to request a quota increase.
//
// [Amazon Web Services Support]: https://aws.amazon.com/support
type RequestLimitExceeded struct {
Message *string
@ -830,92 +844,150 @@ func (e *TableNotFoundException) ErrorCode() string {
}
func (e *TableNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// The entire transaction request was canceled. DynamoDB cancels a
// TransactWriteItems request under the following circumstances:
// The entire transaction request was canceled.
//
// DynamoDB cancels a TransactWriteItems request under the following circumstances:
//
// - A condition in one of the condition expressions is not met.
//
// - A table in the TransactWriteItems request is in a different account or
// region.
//
// - More than one action in the TransactWriteItems operation targets the same
// item.
//
// - There is insufficient provisioned capacity for the transaction to be
// completed.
//
// - An item size becomes too large (larger than 400 KB), or a local secondary
// index (LSI) becomes too large, or a similar validation error occurs because of
// changes made by the transaction.
//
// - There is a user error, such as an invalid data format.
//
// - There is an ongoing TransactWriteItems operation that conflicts with a
// concurrent TransactWriteItems request. In this case the TransactWriteItems
// operation fails with a TransactionCanceledException .
//
// DynamoDB cancels a TransactGetItems request under the following circumstances:
//
// - There is an ongoing TransactGetItems operation that conflicts with a
// concurrent PutItem , UpdateItem , DeleteItem or TransactWriteItems request. In
// this case the TransactGetItems operation fails with a
// TransactionCanceledException .
//
// - A table in the TransactGetItems request is in a different account or region.
//
// - There is insufficient provisioned capacity for the transaction to be
// completed.
//
// - There is a user error, such as an invalid data format.
//
// If using Java, DynamoDB lists the cancellation reasons on the
// CancellationReasons property. This property is not set for other languages.
// Transaction cancellation reasons are ordered in the order of requested items, if
// an item has no error it will have None code and Null message. Cancellation
// reason codes and possible error messages:
// an item has no error it will have None code and Null message.
//
// Cancellation reason codes and possible error messages:
//
// - No Errors:
//
// - Code: None
//
// - Message: null
//
// - Conditional Check Failed:
//
// - Code: ConditionalCheckFailed
//
// - Message: The conditional request failed.
//
// - Item Collection Size Limit Exceeded:
//
// - Code: ItemCollectionSizeLimitExceeded
//
// - Message: Collection size exceeded.
//
// - Transaction Conflict:
//
// - Code: TransactionConflict
//
// - Message: Transaction is ongoing for the item.
//
// - Provisioned Throughput Exceeded:
//
// - Code: ProvisionedThroughputExceeded
//
// - Messages:
//
// - The level of configured provisioned throughput for the table was exceeded.
// Consider increasing your provisioning level with the UpdateTable API. This
// Message is received when provisioned throughput is exceeded is on a provisioned
// DynamoDB table.
// - The level of configured provisioned throughput for one or more global
// secondary indexes of the table was exceeded. Consider increasing your
// provisioning level for the under-provisioned global secondary indexes with the
// UpdateTable API. This message is returned when provisioned throughput is
// exceeded is on a provisioned GSI.
// - Throttling Error:
// - Code: ThrottlingError
// - Messages:
// - Throughput exceeds the current capacity of your table or index. DynamoDB is
// automatically scaling your table or index so please try again shortly. If
// exceptions persist, check if you have a hot key:
// https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
// This message is returned when writes get throttled on an On-Demand table as
// DynamoDB is automatically scaling the table.
// - Throughput exceeds the current capacity for one or more global secondary
// indexes. DynamoDB is automatically scaling your index so please try again
// shortly. This message is returned when writes get throttled on an On-Demand GSI
// as DynamoDB is automatically scaling the GSI.
// - Validation Error:
// - Code: ValidationError
// - Messages:
// - One or more parameter values were invalid.
// - The update expression attempted to update the secondary index key beyond
// allowed size limits.
// - The update expression attempted to update the secondary index key to
// unsupported type.
// - An operand in the update expression has an incorrect data type.
// - Item size to update has exceeded the maximum allowed size.
// - Number overflow. Attempting to store a number with magnitude larger than
// supported range.
// - Type mismatch for attribute to update.
// - Nesting Levels have exceeded supported limits.
// - The document path provided in the update expression is invalid for update.
// - The provided expression refers to an attribute that does not exist in the
// item.
// Consider increasing your provisioning level with the UpdateTable API.
//
// This Message is received when provisioned throughput is exceeded is on a
//
// provisioned DynamoDB table.
//
// - The level of configured provisioned throughput for one or more global
// secondary indexes of the table was exceeded. Consider increasing your
// provisioning level for the under-provisioned global secondary indexes with the
// UpdateTable API.
//
// This message is returned when provisioned throughput is exceeded is on a
//
// provisioned GSI.
//
// - Throttling Error:
//
// - Code: ThrottlingError
//
// - Messages:
//
// - Throughput exceeds the current capacity of your table or index. DynamoDB is
// automatically scaling your table or index so please try again shortly. If
// exceptions persist, check if you have a hot key:
// https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
//
// This message is returned when writes get throttled on an On-Demand table as
//
// DynamoDB is automatically scaling the table.
//
// - Throughput exceeds the current capacity for one or more global secondary
// indexes. DynamoDB is automatically scaling your index so please try again
// shortly.
//
// This message is returned when writes get throttled on an On-Demand GSI as
//
// DynamoDB is automatically scaling the GSI.
//
// - Validation Error:
//
// - Code: ValidationError
//
// - Messages:
//
// - One or more parameter values were invalid.
//
// - The update expression attempted to update the secondary index key beyond
// allowed size limits.
//
// - The update expression attempted to update the secondary index key to
// unsupported type.
//
// - An operand in the update expression has an incorrect data type.
//
// - Item size to update has exceeded the maximum allowed size.
//
// - Number overflow. Attempting to store a number with magnitude larger than
// supported range.
//
// - Type mismatch for attribute to update.
//
// - Nesting Levels have exceeded supported limits.
//
// - The document path provided in the update expression is invalid for update.
//
// - The provided expression refers to an attribute that does not exist in the
// item.
type TransactionCanceledException struct {
Message *string
@ -970,31 +1042,48 @@ func (e *TransactionConflictException) ErrorCode() string {
func (e *TransactionConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// The transaction with the given request token is already in progress.
// Recommended Settings This is a general recommendation for handling the
// TransactionInProgressException . These settings help ensure that the client
// retries will trigger completion of the ongoing TransactWriteItems request.
//
// # Recommended Settings
//
// This is a general recommendation for handling the TransactionInProgressException
// . These settings help ensure that the client retries will trigger completion of
// the ongoing TransactWriteItems request.
//
// - Set clientExecutionTimeout to a value that allows at least one retry to be
// processed after 5 seconds have elapsed since the first attempt for the
// TransactWriteItems operation.
//
// - Set socketTimeout to a value a little lower than the requestTimeout setting.
//
// - requestTimeout should be set based on the time taken for the individual
// retries of a single HTTP request for your use case, but setting it to 1 second
// or higher should work well to reduce chances of retries and
// TransactionInProgressException errors.
//
// - Use exponential backoff when retrying and tune backoff if needed.
//
// Assuming default retry policy (https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97)
// , example timeout settings based on the guidelines above are as follows: Example
// timeline:
// Assuming [default retry policy], example timeout settings based on the guidelines above are as
// follows:
//
// Example timeline:
//
// - 0-1000 first attempt
//
// - 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay
// for 4xx errors)
//
// - 1500-2500 second attempt
//
// - 2500-3500 second sleep/delay (500 * 2, exponential backoff)
//
// - 3500-4500 third attempt
//
// - 4500-6500 third sleep/delay (500 * 2^2)
//
// - 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds
// have elapsed since the first attempt reached TC)
//
// [default retry policy]: https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97
type TransactionInProgressException struct {
Message *string

1295
vendor/github.com/aws/aws-sdk-go-v2/service/dynamodb/types/types.go generated vendored
View file

File diff suppressed because it is too large Load diff

4
vendor/modules.txt vendored
View file

@ -58,7 +58,7 @@ github.com/aws/aws-sdk-go-v2/credentials/endpointcreds/internal/client
github.com/aws/aws-sdk-go-v2/credentials/processcreds
github.com/aws/aws-sdk-go-v2/credentials/ssocreds
github.com/aws/aws-sdk-go-v2/credentials/stscreds
# github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.14
# github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue v1.13.19
## explicit; go 1.20
github.com/aws/aws-sdk-go-v2/feature/dynamodb/attributevalue
# github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.3
@ -74,7 +74,7 @@ github.com/aws/aws-sdk-go-v2/internal/endpoints/v2
# github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0
## explicit; go 1.20
github.com/aws/aws-sdk-go-v2/internal/ini
# github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.0
# github.com/aws/aws-sdk-go-v2/service/dynamodb v1.32.5
## explicit; go 1.20
github.com/aws/aws-sdk-go-v2/service/dynamodb
github.com/aws/aws-sdk-go-v2/service/dynamodb/internal/customizations