Reference based catalog management for custom slots CLI

Custom Slot Type CLI reference CLI

Overview

Catalog management includes new CLI commands that can be used with custom slot types.

Task CLI Command
A catalog is created with a catalog ID. create-model-catalog
A catalog version is created. create-model-catalog-version
Track the status of the catalog creation. get-model-catalog-update-status
View catalog data. get-model-catalog
Use this command to retrieve catalog version data. get-model-catalog-version
Use this command to update the catalog. update-model-catalog
Use this command to update the catalog version update-model-catalog-version
A catalogue version is created. get-model-catalog-values
A catalogue version is created. list-model-catalogs
A catalogue version is created. list-model-catalog-versions
A catalogue version is created. delete-model-catalog
A catalogue version is created. delete-model-catalog-version

Create a catalog

Use the following 2 commands to create your catalog.

create model catalog

You can use this command to create a catalog and catalog ID.
create-model-catalog
POST /v1/skills/api/custom/interactionModel/catalogs/

Create a catalog version

Use create-model-catalog-version to create a version of your catalog.

create model catalog version

You can use this command to create a catalog version.

create-model-catalog-version
POST /skills/api/custom/interactionModel/catalogs/{catalogId}/versions

Update your catalog

Use get-model-catalog-update-status or get-model-catalog to update your catalog.

get model catalog update status

You can use this command to track the status of the catalog creation.
get-model-catalog-update-status
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/updateRequest/{updateRequestId}

Get catalog metadata

Use get-model-catalog or get-model-catalog-version to get metadata about your catalog.

get model catalog

You can use this command to see the catalog name, description, date created, number of versions in a catalog.
get-model-catalog
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}

get model catalog version

Use this command to get the catalogID, version, and description.
get-model-catalog-version
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}

Update catalog metadata

Use update-model-catalog or update-model-catalog-version to update the catalog metadata with new values.

update model catalog

The catalog metadata is updated with new values.
update-model-catalog
POST /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/update

update model catalog version

The catalog description metadata is updated with new values.
update-model-catalog-version
POST /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}/update

Get catalog values

Use get-model-catalog-values to get the values of a catalog.

get model catalog values

Use this command to get the catalog values.
get-model-catalog-values
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}/values?nextToken={nextToken}&maxResults={num}

List catalogs

Use these commands to get lists of your catalogs.

list model catalogs

You can use this command to get a list of all available catalogs.
list-model-catalogs
GET /v1/skills/api/custom/interactionModel/catalogs/?maxResults={num}&nextToken={nextToken}&sortDirection={sortDirection}

list model catalog versions

Use this command to list all the versions of a catalog ID.
list-model-catalog-versions
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions?maxResults={num}&nextToken={nextToken}&sortDirection={sortDirection}&sortField={sortField}

Delete a catalog

You can use one of the following commands to delete your catalog.

delete model catalog

Use this command to delete a specific version of a catalog.
delete-model-catalog
DELETE /v1/skills/api/custom/interactionModel/catalogs/{catalogId}

delete model catalog version

Use this command to delete all versions of a catalog.
delete-model-catalog-version
DELETE /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}