X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Operation: Delete

With the Delete operation of the Amazon S3 DynamoDB Connector, you delete an element or a table according to the configured parameters.

For more information on other operations of the Amazon S3 DynamoDB Connector, see Amazon S3 DynamoDB Connector.

Note:

If the tableName and primary key elements are specified, the Delete operation deletes the specific element. If only the tableName is specified, the Delete operation deletes the table.

For more information on primary keys, see the corresponding Amazon DynamoDB documentation:

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

region

Region of the domains

Note:

Buckets created in a specific region cannot be invoked from another region. For more information, see Regions and Endpoints.

Possible values:

Any string with the name of the region, e.g. us-east-2

tableName
✳️

This parameter is required for this operation.

Table name

Possible values:

String with the table name according to the following name rules:

  • All names must be UTF-8 encoded

  • Table names are case-sensitive

  • Table names and index names must be between 3 and 255 characters long and must contain only the following characters:

    • a-z

    • A-Z

    • 0-9

    • _ (Underscore)

    • - (Hyphen)

    • . (period)

  • Attribute names must be between 1 and 255 characters long.

partitionKey, partitionType, and partitionKeyValue

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

Status values

1

The adapter operation was executed successfully

0

The element or table does not exist.

-1

The operation failed due to a technical error.

Output

The adapter deletes the element or table according to the configured parameters.