X4 Produktdokumentation

Operation: UpdateTable

With the UpdateTable operation of the Amazon S3 DynamoDB Connector, you update an existing table and change the Read/Write capacity units.

Parameters

keyID

Access key ID for requests to Amazon Web Services (AWS)

Note:

The credentials are sent to the adapter via parameters. There are various configuration options. For more information, see Setting Up Credentials.

Possible values:

Any string with the access key ID, e.g. AKIAIOSFODNN7EXAMPLE

secretKey

Secret access key for requests to AWS

Note:

The credentials are sent to the adapter via parameters. There are various configuration options. For more information, see Setting Up Credentials.

Possible values:

Any string with the secret access key, e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

partitionKey, partitionType, and partitionKeyValue

✳️

The partitionKey parameter is required for this operation

Elements of the primary table key

Possible values:

  • PartitionKey: Name of the partition key

  • PartitionType: Partition type

    • S: The attribute is a string

    • N: The attribute is a number

    • B: The attribute is of the Binary type

  • PartitionKeyValue: Value of the element

sortKey, sortType, and sortKeyValue

Elements of the primary table key

Possible values:

  • SortKey: Name of the sort key

  • SortType: Sort type

    • S: The attribute is a string

    • N: The attribute is a number

    • B: The attribute is of the Binary type

  • SortKeyValue: Value of the element

readCapacityUnits, writeCapacitiyUnits

✳️

These parameters are required for this operation.

Read/Write capacity units

Possible values:

  • Integer capacity units

scalableType

Defines the scalability type for autoScaling.

Possible values:

  • ReadCapacity

  • WriteCapacity

autoScaling

Specifies that the table is created using AutoScaling. In the case of a check, all scaling parameters must be specified.

Possible values:

  • true

  • false

scalingMinCapacity, scalingMaxCapacity, scalingTargetValue, scalingInCooldown, scalingOutCooldown

Defines the scaling parameters for AutoScaling.

Possible values:

For more information, see AutoScaling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.Console.html#AutoScaling.Console.ExistingTable).

arnRole

ARN of the role that is authorized to apply AutoScaling to the table resource.

Possible values:

For more information, see Amazon Resource Names (ARN) (https://docs.aws.amazon.com/de_de/general/latest/gr/aws-arns-and-namespaces.html).

consistentRead

DynamoDB uses eventually consistent reads unless otherwise specified. Read operations such as GetItem and Query provide a ConsistentRead parameter. If this parameter is set to true, DynamoDB uses strongly consistent reads during operation.

Status values

1

The adapter operation was executed successfully

0

The operation was not completed, but no error occurred.

-1

The operation failed due to a technical error.

Output

The adapter updates the existing table and changes the Read/Write capacity units.