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

ListDataIntegrationFlows

Enables you to programmatically list all data pipelines for the provided AWS Supply Chain instance.

Request Syntax


GET /api/data-integration/instance/instanceId/data-integration-flows?maxResults=maxResults&nextToken=nextToken HTTP/1.1

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

maxResults

Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.

Valid Range: Minimum value of 0. Maximum value of 20.

nextToken

The pagination token to fetch the next page of the DataIntegrationFlows.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "flows": [ 
      { 
         "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"
         }
      }
   ],
   "nextToken": "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.

flows

The response parameters for ListDataIntegrationFlows.

Type: Array of DataIntegrationFlow objects

nextToken

The pagination token to fetch the next page of the DataIntegrationFlows.

Type: String

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

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