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

ListDataSources

Lists data sources in Amazon DataZone.

Request Syntax


GET /v2/domains/domainIdentifier/data-sources?environmentIdentifier=environmentIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier&status=status&type=type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the Amazon DataZone domain in which to list the data sources.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

environmentIdentifier

The identifier of the environment in which to list the data sources.

maxResults

The maximum number of data sources to return in a single call to ListDataSources. When the number of data sources to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSources to list the next set of data sources.

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

name

The name of the data source.

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

nextToken

When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

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

projectIdentifier

The identifier of the project in which to list data sources.

Required: Yes

status

The status of the data source.

type

The type of the data source.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "dataSourceId": "string",
         "domainId": "string",
         "enableSetting": "string",
         "environmentId": "string",
         "lastRunAssetCount": number,
         "lastRunAt": "string",
         "lastRunErrorMessage": { 
            "errorDetail": "string",
            "errorType": "string"
         },
         "lastRunStatus": "string",
         "name": "string",
         "schedule": { 
            "schedule": "string",
            "timezone": "string"
         },
         "status": "string",
         "type": "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.

items

The results of the ListDataSources action.

Type: Array of DataSourceSummary objects

nextToken

Type: String

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

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400