Commands

Documentation for `scw annotations`

The CLI documentation pages are currently under construction

The content is up to date. We're making improvements to the site over the next few weeks for a better experience.

Annotations API

Annotation binding management commands

Annotation binding management commands.

Attach a value to a resource. Fails if the resource already has a value for this key.

Usage:

Code
scw annotations binding create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
target-srn	SRN of the resource to attach the value to.
value-id	ID of the value to associate.

Detach an annotation from a resource.

Usage:

Code
scw annotations binding delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
binding-id	ID of the binding to delete.	Required

Delete ALL bindings associated with a Scaleway Resource Name.

Usage:

Code
scw annotations binding delete-all-matching-srn [arg=value ...]

Arguments:

Name	Description	Argument Specifications
target-srn	SRN of the resource for which all bindings should be deleted.
organization-id	Organization ID to use. If none is passed the default organization ID will be used

Delete ALL bindings associated with a value.

Usage:

Code
scw annotations binding delete-all-matching-value [arg=value ...]

Arguments:

Name	Description	Argument Specifications
value-id	ID of the value for which all bindings should be deleted.

List all bindings, or filter by Scaleway Resource Name or value ID. Response order by ID.

Usage:

Code
scw annotations binding list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
target-srn	SRN of the resource for which to list all bindings.
value-id	Value ID for which to list all bindings.
organization-id	Organization ID to use. If none is passed the default organization ID will be used

Annotation key management commands

Annotation key management commands.

Create an annotation key.

Usage:

Code
scw annotations key create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
name	Name of the annotation key.
description	Description of the annotation key.
organization-id	Organization ID to use. If none is passed the default organization ID will be used

Delete a key definition. Fails if the key has any associated values.

Usage:

Code
scw annotations key delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
key-id	ID of the key to delete.	Required

Retrieve a specific key.

Usage:

Code
scw annotations key get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
key-id	ID of the key to retrieve.	Required

List all keys, sorted alphabetically by name.

Usage:

Code
scw annotations key list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
organization-id	Organization ID to use. If none is passed the default organization ID will be used

Update name or description. All associated resources will immediately display the new name.

Usage:

Code
scw annotations key update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
key-id	ID of the key to update.	Required
name	New name of the key.
description	New description of the key.

Combined keys and values management commands

Combined keys and values management commands.

List all keys and values for an organization, sorted alphabetically by key name and value name.

Usage:

Code
scw annotations key-value list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
organization-id	Organization ID to use. If none is passed the default organization ID will be used

Annotation value management commands

Annotation value management commands.

Add a value definition to a key.

Usage:

Code
scw annotations value create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
key-id	ID of the key the value will be bound to.
name	Name of the value.
description	Description of the value.

Delete a value definition. Fails if the value is currently bound to any resource.

Usage:

Code
scw annotations value delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
value-id	ID of the value to delete.	Required

Delete ALL values associated with a key. Fails if any of these values are currently bound to any resource.

Usage:

Code
scw annotations value delete-all-matching-key [arg=value ...]

Arguments:

Name	Description	Argument Specifications
key-id	ID of the key for which to delete all values.

Retrieve a specific value.

Usage:

Code
scw annotations value get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
value-id	ID of the value to retrieve.	Required

List all values, sorted alphabetically by name.

Usage:

Code
scw annotations value list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
key-id	ID of the key to list the values for.
organization-id	Organization ID to use. If none is passed the default organization ID will be used

Update name or description.

Usage:

Code
scw annotations value update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
value-id	ID of the value to update.	Required
name	New name of the value.
description	New description of the value.