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

ListDataAutomationLibraryEntities

Gets a list of data automation library entities.

Request Syntax


POST /data-automation-libraries/libraryArn/entityType/entityType/entities/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

entityType

The entity type.

Valid Values: VOCABULARY

Required: Yes

libraryArn

The library's ARN.

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of entities to return in one page of results.

Type: Integer

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

Required: No

nextToken

Specify the pagination token from a previous request to retrieve the next page of results.

Type: String

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

Pattern: \S*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

entities

A list of entity summaries.

Type: Array of DataAutomationLibraryEntitySummary objects

nextToken

A pagination token returned if more results are available.

Type: String

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

Pattern: \S*

Errors

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

AccessDeniedException

HTTP Status Code: 403

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 404

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400