Commands

vws

Manage a Vuforia Web Services cloud database.

vws [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

add-target

Add a target.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#add

vws add-target [OPTIONS]

Options

--width <width>

Required The width of the target in the Vuforia database.

--application-metadata <application_metadata>

The base64 encoded application metadata associated with the target.

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--name <name>

Required The name of the target in the Vuforia database.

--image <image_file_path>

Required The path to an image to upload and set as the target image.

--active-flag <active_flag_choice>

Whether or not the target is active for query.

Default:

true

Options:

true | false

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

delete-target

Delete a target.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#delete.

vws delete-target [OPTIONS]

Options

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

get-database-summary-report

Get a database summary report.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#summary-report.

vws get-database-summary-report [OPTIONS]

Options

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

get-duplicate-targets

Get a list of potential duplicate targets.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#check.

vws get-duplicate-targets [OPTIONS]

Options

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

get-target-record

Get a target record.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#target-record.

vws get-target-record [OPTIONS]

Options

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

get-target-summary-report

Get a target summary report.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#retrieve-report.

vws get-target-summary-report [OPTIONS]

Options

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

list-targets

List targets.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#details-list.

vws list-targets [OPTIONS]

Options

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

update-target

Update a target.

See

https://library.vuforia.com/web-api/cloud-targets-web-services-api#update

vws update-target [OPTIONS]

Options

--width <width>

The width of the target in the Vuforia database.

--application-metadata <application_metadata>

The base64 encoded application metadata associated with the target.

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--name <name>

The name of the target in the Vuforia database.

--image <image_file_path>

The path to an image to upload and set as the target image.

--active-flag <active_flag_choice>

Whether or not the target is active for query.

Options:

true | false

--target-id <target_id>

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

wait-for-target-processed

Wait for a target to be “processed”. This is done by polling the VWS API.

vws wait-for-target-processed [OPTIONS]

Options

--seconds-between-requests <seconds_between_requests>

The number of seconds to wait between requests made while polling the target status. We wait 0.2 seconds by default, rather than less, than that to decrease the number of calls made to the API, to decrease the likelihood of hitting the request quota.

Default:

0.2

--timeout-seconds <timeout_seconds>

The maximum number of seconds to wait for the target to be processed.

Default:

300

--server-access-key <server_access_key>

Required A Vuforia server access key to use to access the Vuforia Web Services API.

--server-secret-key <server_secret_key>

Required A Vuforia server secret key to use to access the Vuforia Web Services API.

--target-id <target_id>

Required The ID of a target in the Vuforia database.

--base-vws-url <base_vws_url>

The base URL for the VWS API.

Default:

https://vws.vuforia.com

Environment variables

VUFORIA_SERVER_ACCESS_KEY

Provide a default for --server-access-key

VUFORIA_SERVER_SECRET_KEY

Provide a default for --server-secret-key

vuforia-cloud-reco

Make a request to the Vuforia Cloud Recognition Service API.

vuforia-cloud-reco [OPTIONS] IMAGE

Options

--client-access-key <client_access_key>

Required A Vuforia client access key to use to access the Vuforia Cloud Recognition API.

--client-secret-key <client_secret_key>

Required A Vuforia client secret key to use to access the Vuforia Cloud Recognition API.

--include-target-data <include_target_data>

Whether target_data records shall be returned for the matched targets. Accepted values are top (default value, only return target_data for top ranked match), none (return no target_data), all (for all matched targets).

Default:

top

Options:

top | none | all

--max-num-results <max_num_results>

The maximum number of matching targets to be returned. Must be <= 50.

Default:

1

--base-vwq-url <base_vwq_url>

The base URL for the VWQ API.

Default:

https://cloudreco.vuforia.com

--version

Show the version and exit.

Arguments

IMAGE

Required argument

Environment variables

VUFORIA_CLIENT_ACCESS_KEY

Provide a default for --client-access-key

VUFORIA_CLIENT_SECRET_KEY

Provide a default for --client-secret-key