Skip to main content

Cyware Orchestrate

Amazon DynamoDB

App Vendor: Amazon

App Category: IT Services

Connector Version: 1.0.0

API Version: 1.0.0

About App

Amazon DynamoDB is a fully managed, serverless, key-value NoSQL database designed to run high-performance applications at any scale.

The Amazon DynamoDB app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Marshall JSON

This action converts a regular JSON format to an Amazon DynamoDB JSON format.

Query Data

This action queries data from Amazon DynamoDB.

Unmarshall JSON

This action converts a DynamoDB JSON to regular JSON.

Write Data

This action writes data to an Amazon DynamoDB table.

Configuration Parameters

The following configuration parameters are required for the Amazon DynamoDB app to communicate with the Amazon DynamoDB enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Access Key ID

Enter the access key to authenticate to the DynamoDB application.

Text

Required

Secret Access Key

Enter the secret key to authenticate to the DynamoDB application.

Password

Required

Action: Marshall JSON

This action converts a regular JSON format to an Amazon DynamoDB JSON format.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

JSON data

Enter the JSON data to convert.

Text

Required

Example Request

{
   "updated_at":146548182,
   "uuid":"foo",
   "status":"new
}
Action: Query Data

This action queries data from Amazon DynamoDB.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Key Name

Enter the primary key name to query.

Example:

"sampleKey"

Text

Required

Key Value

Enter the primary key value to query.

Example:

"samplekeyValue"

Text

Required

Table Name

Enter the table name to search values.

Example:

"sampleTableName"

Text

Required

Region Name

Enter the AWS region name.

Example:

"us-east-1"

Text

Optional

Default Value:

  • us-west-2

Example Request

{
   "key_name":"sampleKey",
   "key_value":"samplekeyValue",
   "table_name":"sampleTableName",
   "region_name": "us-east-1"
}
Action: Unmarshall JSON

This action converts a DynamoDB JSON to a regular JSON.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

DynamoDB JSON

Enter the DynamoDB JSON data to convert to regular JSON.

Text

Required

Example Request

{ 
      updated_at: { N: '146548182' },
      uuid: { S: 'foo' },
      status: { S: 'new' }
}
Action: Write Data

This action writes data to an Amazon DynamoDB table.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Data

Enter the data to add to the table in JSON format. If a record with this primary key exists, it will be overwritten.

Example:

"{'id': 123, 'name': 'john'}"

Text

Required

Table Name

Enter the table name to add data.

Example:

"sampleTableName"

Text

Required

Region Name

Enter the region name of the table.

Example:

"us-east-1"

Text

Optional

Default value:

  • us-west-2

Example Request

{
   "data":"{'id': 123, 'name': 'john'}",
   "table_name":"sampleTableName",
   "region_name":"us-east-1"
}