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

ListDiscoverableRegistryRecords

Lists the discoverable registry records in a registry. You can optionally filter and paginate the results.

Request Syntax


POST /registries/registryId/discoverable-records-list HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

registryId

The identifier of the registry whose discoverable records are listed. You can provide either the full Amazon Resource Name (ARN) or the registry ID.

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

Pattern: (arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}

Required: Yes

Request Body

The request accepts the following data in JSON format.

filters

The filters to apply to the discoverable registry record list.

Type: Array of RegistryRecordFilter objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

maxResults

The maximum number of records to return in a single page. Valid values are 1 through 100.

Type: Integer

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

Required: No

nextToken

The pagination token returned by a previous request. Use this value to retrieve the next page of results.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "registryRecords": [ 
      { 
         "createdAt": "string",
         "description": "string",
         "displayName": "string",
         "name": "string",
         "recordArn": "string",
         "recordId": "string",
         "recordType": "string",
         "recordVersion": "string",
         "registryArn": "string",
         "status": "string",
         "updatedAt": "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.

nextToken

The pagination token to pass to a subsequent request to retrieve the next page of results. This field is absent when there are no more results.

Type: String

registryRecords

The page of discoverable registry record summaries.

Type: Array of DiscoverableRegistryRecordSummary objects

Errors

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

AccessDeniedException

The caller is not authorized to perform the requested action.

HTTP Status Code: 403

InternalServerException

The request failed due to an unexpected internal error; the caller may retry.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling; the caller may retry after a delay.

HTTP Status Code: 429

UnauthorizedException

The request could not be authenticated.

HTTP Status Code: 401

ValidationException

The request failed validation of one or more input fields.

fieldList: The list of input fields that failed validation.
reason: The reason the request failed validation.

HTTP Status Code: 400