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

Description

Creates an asset in Amazon DataZone catalog.

Before creating assets, make sure that the following requirements are met:

  • --domain-identifier must refer to an existing domain.
  • --owning-project-identifier must be a valid project within the domain.
  • Asset type must be created beforehand using create-asset-type , or be a supported system-defined type. For more information, see create-asset-type .
  • --type-revision (if used) must match a valid revision of the asset type.
  • formsInput is required when it is associated as required in the asset-type . For more information, see create-form-type .
  • Form content must include all required fields as per the form schema (e.g., bucketArn ).

You must invoke the following pre-requisite commands before invoking this API:

See also: AWS API Documentation

Synopsis

  create-asset
--name <value>
--domain-identifier <value>
[--external-identifier <value>]
--type-identifier <value>
[--type-revision <value>]
[--description <value>]
[--glossary-terms <value>]
[--forms-input <value>]
--owning-project-identifier <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)

Asset name.

--domain-identifier (string)

Amazon DataZone domain where the asset is created.

--external-identifier (string)

The external identifier of the asset.

If the value for the externalIdentifier parameter is specified, it must be a unique value.

--type-identifier (string)

The unique identifier of this asset’s type.

--type-revision (string)

The revision of this asset’s type.

--description (string)

Asset description.

--glossary-terms (list)

Glossary terms attached to the asset.

(string)

Syntax:

"string" "string" ...

--forms-input (list)

Metadata forms attached to the asset.

(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"
  }
  ...
]

--owning-project-identifier (string)

The unique identifier of the project that owns this asset.

--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 created asset.

name -> (string)

The name of the created asset.

typeIdentifier -> (string)

The identifier of the created asset 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 description of the created asset.

createdAt -> (timestamp)

The timestamp of when the asset was created.

createdBy -> (string)

The Amazon DataZone user that created this asset in the catalog.

firstRevisionCreatedAt -> (timestamp)

The timestamp of when the first revision of the asset took place.

firstRevisionCreatedBy -> (string)

The Amazon DataZone user that made the first revision of the asset.

glossaryTerms -> (list)

The glossary terms that are attached to the created asset.

(string)

governedGlossaryTerms -> (list)

The glossary terms in a restricted glossary.

(string)

owningProjectId -> (string)

The ID of the Amazon DataZone project that owns the created asset.

domainId -> (string)

The ID of the Amazon DataZone domain in which the asset was created.

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 are attached to the created asset.

(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 are attached to the created asset.

(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.