Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. 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.

See also: AWS API Documentation

Synopsis

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

Options

--client-token (string)

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

--description (string)

Asset description.

--domain-identifier (string)

Amazon DataZone domain where the asset is created.

--external-identifier (string)

The external identifier of the asset.

--forms-input (list)

Metadata forms attached to the asset.

(structure)

The details of a metadata form.

content -> (string)

The content of the 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.

Shorthand Syntax:

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

JSON Syntax:

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

--glossary-terms (list)

Glossary terms attached to the asset.

(string)

Syntax:

"string" "string" ...

--name (string)

Asset name.

--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
  }
}

--type-identifier (string)

The unique identifier of this asset's type.

--type-revision (string)

The revision of this asset's type.

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

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

Output

createdAt -> (timestamp)

The timestamp of when the asset was created.

createdBy -> (string)

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

description -> (string)

The description of the created asset.

domainId -> (string)

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

externalIdentifier -> (string)

The external identifier of the asset.

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.

formsOutput -> (list)

The metadata forms that are attached to the created asset.

(structure)

The details of a metadata form.

content -> (string)

The content of the 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.

glossaryTerms -> (list)

The glossary terms that are attached to the created asset.

(string)

id -> (string)

The unique identifier of the created asset.

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.

contentSummary -> (string)

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

formName -> (string)

The name of the time series data points summary form.

id -> (string)

The ID of the time series data points summary form.

timestamp -> (timestamp)

The timestamp 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.

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.

name -> (string)

The name of the created asset.

owningProjectId -> (string)

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

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.

readOnlyFormsOutput -> (list)

The read-only metadata forms that are attached to the created asset.

(structure)

The details of a metadata form.

content -> (string)

The content of the 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.

revision -> (string)

The revision of the asset.

typeIdentifier -> (string)

The identifier of the created asset type.

typeRevision -> (string)

The revision type of the asset.