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

get-data-set-details

Description

Gets the details of a specific data set.

See also: AWS API Documentation

Synopsis

  get-data-set-details
--application-id <value>
--data-set-name <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

--application-id (string)

The unique identifier of the application that this data set is associated with.

--data-set-name (string)

The name of the data set.

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

blocksize -> (integer)

The size of the block on disk.

creationTime -> (timestamp)

The timestamp when the data set was created.

dataSetName -> (string)

The name of the data set.

dataSetOrg -> (tagged union structure)

The type of data set. The only supported value is VSAM.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: gdg, po, ps, vsam.

gdg -> (structure)

The generation data group of the data set.

limit -> (integer)

The maximum number of generation data sets, up to 255, in a GDG.

rollDisposition -> (string)

The disposition of the data set in the catalog.

po -> (structure)

The details of a PO type data set.

encoding -> (string)

The character set encoding of the data set.

format -> (string)

The format of the data set records.

ps -> (structure)

The details of a PS type data set.

encoding -> (string)

The character set encoding of the data set.

format -> (string)

The format of the data set records.

vsam -> (structure)

The details of a VSAM data set.

alternateKeys -> (list)

The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.

(structure)

Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.

allowDuplicates -> (boolean)

Indicates whether the alternate key values are supposed to be unique for the given data set.

length -> (integer)

A strictly positive integer value representing the length of the alternate key.

name -> (string)

The name of the alternate key.

offset -> (integer)

A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

cacheAtStartup -> (boolean)

If set to True, enforces loading the data set into cache before it’s used by the application.

compressed -> (boolean)

Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

encoding -> (string)

The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

primaryKey -> (structure)

The primary key of the data set.

length -> (integer)

A strictly positive integer value representing the length of the primary key.

name -> (string)

A name for the Primary Key.

offset -> (integer)

A positive integer value representing the offset to mark the start of the primary key in the record byte array.

recordFormat -> (string)

The record format of the data set.

fileSize -> (long)

File size of the dataset.

lastReferencedTime -> (timestamp)

The last time the data set was referenced.

lastUpdatedTime -> (timestamp)

The last time the data set was updated.

location -> (string)

The location where the data set is stored.

recordLength -> (integer)

The length of records in the data set.