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

ListDataSets

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order.

Request Syntax


GET /v1/data-sets?maxResults=MaxResults&nextToken=NextToken&origin=Origin HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results returned by a single call.

Valid Range: Minimum value of 1. Maximum value of 200.

NextToken

The token value retrieved from a previous call to access the next page of results.

Origin

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DataSets": [ 
      { 
         "Arn": "string",
         "AssetType": "string",
         "CreatedAt": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "Origin": "string",
         "OriginDetails": { 
            "DataGrantId": "string",
            "ProductId": "string"
         },
         "SourceId": "string",
         "UpdatedAt": "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 data set objects listed by the request.

Type: Array of DataSetEntry objects

NextToken

The token value retrieved from a previous call to access the next page of results.

Type: String

Errors

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

InternalServerException

An exception occurred with the service.

Message: The message identifying the service exception that occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

Message: The resource couldn't be found.
ResourceId: The unique identifier for the resource that couldn't be found.
ResourceType: The type of resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

Message: The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request was invalid.

ExceptionCause: The unique identifier for the resource that couldn't be found.
Message: The message that informs you about what was invalid about the request.

HTTP Status Code: 400