AWS CLI Command Reference

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

create-data-set

Description

This operation creates a data set.

See also: AWS API Documentation

Synopsis

  create-data-set
--asset-type <value>
--description <value>
--name <value>
[--tags <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

--asset-type (string)

The type of asset that is added to a data set.

Possible values:

  • S3_SNAPSHOT
  • REDSHIFT_DATA_SHARE
  • API_GATEWAY_API
  • S3_DATA_ACCESS
  • LAKE_FORMATION_DATA_PERMISSION

--description (string)

A description for the data set. This value can be up to 16,348 characters long.

--name (string)

The name of the data set.

--tags (map)

A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

Output

Arn -> (string)

The ARN for the data set.

AssetType -> (string)

The type of asset that is added to a data set.

CreatedAt -> (timestamp)

The date and time that the data set was created, in ISO 8601 format.

Description -> (string)

The description for the data set.

Id -> (string)

The unique identifier for the data set.

Name -> (string)

The name of the data set.

Origin -> (string)

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

OriginDetails -> (structure)

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

ProductId -> (string)

The product ID of the origin of the data set.

DataGrantId -> (string)

The ID of the data grant.

SourceId -> (string)

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

Tags -> (map)

The tags for the data set.

key -> (string)

value -> (string)

UpdatedAt -> (timestamp)

The date and time that the data set was last updated, in ISO 8601 format.