AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

create-asset-revision

Description

Creates a revision of the asset.

Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary.

Prerequisites:

  • Asset must already exist in the domain with identifier.
  • formsInput is required when asset has the form type. typeRevision should be the latest version of form type.
  • The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm ).
  • The owning project of the original asset must still exist and be active.
  • User must have write access to the project and domain.

See also: AWS API Documentation

Synopsis

  create-asset-revision
--name <value>
--domain-identifier <value>
--identifier <value>
[--type-revision <value>]
[--description <value>]
[--glossary-terms <value>]
[--forms-input <value>]
[--prediction-configuration <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--name (string)

Te revised name of the asset.

--domain-identifier (string)

The unique identifier of the domain where the asset is being revised.

--identifier (string)

The identifier of the asset.

--type-revision (string)

The revision type of the asset.

--description (string)

The revised description of the asset.

--glossary-terms (list)

The glossary terms to be attached to the asset as part of asset revision.

(string)

Syntax:

"string" "string" ...

--forms-input (list)

The metadata forms to be attached to the asset as part of asset revision.

(structure)

The details of a metadata form.

formName -> (string)

The name of the metadata form.

typeIdentifier -> (string)

The ID of the metadata form type.

typeRevision -> (string)

The revision of the metadata form type.

content -> (string)

The content of the metadata form.

Shorthand Syntax:

formName=string,typeIdentifier=string,typeRevision=string,content=string ...

JSON Syntax:

[
  {
    "formName": "string",
    "typeIdentifier": "string",
    "typeRevision": "string",
    "content": "string"
  }
  ...
]

--prediction-configuration (structure)

The configuration of the automatically generated business-friendly metadata for the asset.

businessNameGeneration -> (structure)

The business name generation mechanism.

enabled -> (boolean)

Specifies whether the business name generation is enabled.

Shorthand Syntax:

businessNameGeneration={enabled=boolean}

JSON Syntax:

{
  "businessNameGeneration": {
    "enabled": true|false
  }
}

--client-token (string)

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

id -> (string)

The unique identifier of the asset revision.

name -> (string)

The revised name of the asset.

typeIdentifier -> (string)

The identifier of the revision type.

typeRevision -> (string)

The revision type of the asset.

externalIdentifier -> (string)

The external identifier of the asset.

revision -> (string)

The revision of the asset.

description -> (string)

The revised asset description.

createdAt -> (timestamp)

The timestamp of when the asset revision occured.

createdBy -> (string)

The Amazon DataZone user who performed the asset revision.

firstRevisionCreatedAt -> (timestamp)

The timestamp of when the first asset revision occured.

firstRevisionCreatedBy -> (string)

The Amazon DataZone user who performed the first asset revision.

glossaryTerms -> (list)

The glossary terms that were attached to the asset as part of asset revision.

(string)

governedGlossaryTerms -> (list)

The glossary terms in a restricted glossary.

(string)

owningProjectId -> (string)

The unique identifier of the revised project that owns the asset.

domainId -> (string)

The unique identifier of the Amazon DataZone domain where the asset was revised.

listing -> (structure)

The details of an asset published in an Amazon DataZone catalog.

listingId -> (string)

The identifier of an asset published in an Amazon DataZone catalog.

listingStatus -> (string)

The status of an asset published in an Amazon DataZone catalog.

formsOutput -> (list)

The metadata forms that were attached to the asset as part of the asset revision.

(structure)

The details of a metadata form.

formName -> (string)

The name of the metadata form.

typeName -> (string)

The name of the metadata form type.

typeRevision -> (string)

The revision of the metadata form type.

content -> (string)

The content of the metadata form.

readOnlyFormsOutput -> (list)

The read-only metadata forms that were attached to the asset as part of the asset revision.

(structure)

The details of a metadata form.

formName -> (string)

The name of the metadata form.

typeName -> (string)

The name of the metadata form type.

typeRevision -> (string)

The revision of the metadata form type.

content -> (string)

The content of the metadata form.

latestTimeSeriesDataPointFormsOutput -> (list)

The latest data point that was imported into the time series form for the asset.

(structure)

The summary of the time series data points form.

formName -> (string)

The name of the time series data points summary form.

typeIdentifier -> (string)

The type ID of the time series data points summary form.

typeRevision -> (string)

The type revision of the time series data points summary form.

timestamp -> (timestamp)

The timestamp of the time series data points summary form.

contentSummary -> (string)

The content of the summary of the time series data points form.

id -> (string)

The ID of the time series data points summary form.

predictionConfiguration -> (structure)

The configuration of the automatically generated business-friendly metadata for the asset.

businessNameGeneration -> (structure)

The business name generation mechanism.

enabled -> (boolean)

Specifies whether the business name generation is enabled.