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

ListDataLakeDatasets

Enables you to programmatically view the list of AWS Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.

Request Syntax


GET /api/datalake/instance/instanceId/namespaces/namespace/datasets?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

The max number of datasets to fetch in this paginated request.

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

namespace

The namespace of the dataset. The available values are:

asc: for AWS Supply Chain supported datasets .
default: for datasets with custom user-defined schemas.

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

Pattern: [a-z]+

Required: Yes

nextToken

The pagination token to fetch next page of datasets.

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

{
   "datasets": [ 
      { 
         "arn": "string",
         "createdTime": number,
         "description": "string",
         "instanceId": "string",
         "lastModifiedTime": number,
         "name": "string",
         "namespace": "string",
         "schema": { 
            "fields": [ 
               { 
                  "isRequired": boolean,
                  "name": "string",
                  "type": "string"
               }
            ],
            "name": "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.

datasets

The list of fetched dataset details.

Type: Array of DataLakeDataset objects

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

nextToken

The pagination token to fetch next page of datasets.

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