Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateDataIntegrationFlow

Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined AWS Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.

Request Syntax


PATCH /api/data-integration/instance/instanceId/data-integration-flows/name HTTP/1.1
Content-type: application/json

{
   "sources": [ 
      { 
         "datasetSource": { 
            "datasetIdentifier": "string",
            "options": { 
               "dedupeRecords": boolean,
               "loadType": "string"
            }
         },
         "s3Source": { 
            "bucketName": "string",
            "options": { 
               "fileType": "string"
            },
            "prefix": "string"
         },
         "sourceName": "string",
         "sourceType": "string"
      }
   ],
   "target": { 
      "datasetTarget": { 
         "datasetIdentifier": "string",
         "options": { 
            "dedupeRecords": boolean,
            "loadType": "string"
         }
      },
      "s3Target": { 
         "bucketName": "string",
         "options": { 
            "fileType": "string"
         },
         "prefix": "string"
      },
      "targetType": "string"
   },
   "transformation": { 
      "sqlTransformation": { 
         "query": "string"
      },
      "transformationType": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

instanceId

The AWS Supply Chain instance identifier.

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

name

The name of the DataIntegrationFlow to be updated.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

sources

The new source configurations for the DataIntegrationFlow.

Type: Array of DataIntegrationFlowSource objects

Array Members: Minimum number of 1 item. Maximum number of 40 items.

Required: No

target

The new target configurations for the DataIntegrationFlow.

Type: DataIntegrationFlowTarget object

Required: No

transformation

The new transformation configurations for the DataIntegrationFlow.

Type: DataIntegrationFlowTransformation object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "flow": { 
      "createdTime": number,
      "instanceId": "string",
      "lastModifiedTime": number,
      "name": "string",
      "sources": [ 
         { 
            "datasetSource": { 
               "datasetIdentifier": "string",
               "options": { 
                  "dedupeRecords": boolean,
                  "loadType": "string"
               }
            },
            "s3Source": { 
               "bucketName": "string",
               "options": { 
                  "fileType": "string"
               },
               "prefix": "string"
            },
            "sourceName": "string",
            "sourceType": "string"
         }
      ],
      "target": { 
         "datasetTarget": { 
            "datasetIdentifier": "string",
            "options": { 
               "dedupeRecords": boolean,
               "loadType": "string"
            }
         },
         "s3Target": { 
            "bucketName": "string",
            "options": { 
               "fileType": "string"
            },
            "prefix": "string"
         },
         "targetType": "string"
      },
      "transformation": { 
         "sqlTransformation": { 
            "query": "string"
         },
         "transformationType": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

flow

The details of the updated DataIntegrationFlow.

Type: DataIntegrationFlow object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have the required privileges to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400