get-data-share¶

Description¶

Retrieve detailed information about a Data Share including its metadata, assets, external users, and configuration settings.

Synopsis¶

  get-data-share
--datalake-crn <value>
--environment-crn <value>
--data-share-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--datalake-crn (string)

The CRN of the Data Lake where the Data Share is located.

--environment-crn (string)

The CRN of the Environment where the Data Share is located.

--data-share-id (string)

The unique identifier of the Data Share to be retrieved.

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

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

dataShareId -> (string)

The unique identifier of the Data Share.

dataShareName -> (string)

The name of the Data Share.

isShared -> (boolean)

Indicates whether the Data Share is in Shared state or not.

createdAt -> (datetime)

The date and time when the Data Share was created.

updatedAt -> (datetime)

The date and time when the Data Share was last updated.

createdBy -> (string)

The CDP user who created the Data Share.

keywords -> (array)

List of keywords associated with the Data Share.

item -> (string)

tags -> (array)

List of the Atlas tags associated with the Data Share.

item -> (string)

expiryTime -> (datetime)

The date and time when the Data Share will expire.

assets -> (array)

List of assets included in the Data Share.

item -> (object)

Details of an asset to be included in the Data Share.

resourceId -> (string)

The unique identifier of the resource.

guid -> (string)

The unique identifier of the asset (asset guid from the Atlas).

createTime -> (datetime)

The date and time when the asset was created.

createdBy -> (string)

The user who created the asset.

updateTime -> (datetime)

The date and time when the asset was last updated.

updatedBy -> (string)

The user who last updated the asset.

databaseName -> (string)

The name of the database containing the asset.

tableName -> (string)

The name of the table containing the asset.

columns -> (array)

List of columns in the asset (default all is included).

item -> (string)

Name of the column.

externalUsers -> (array)

List of external users granted access to the Data Share.

item -> (object)

Details of an external user with access to a Data Share.

userId -> (integer)

The unique identifier of the external user.

username -> (string)

The username of the external user.

clientId -> (string)

The Client ID of the external user that will be used for authentication.

companyName -> (string)

The company name of the external user.

permissions -> (array)

List of permissions granted to the external user for the Data Share.

item -> (string)

sharedOn -> (datetime)

The date and time when the Data Share was shared with the external user.

validTill -> (datetime)

The date and time when the access of Data Share will expire for the external user.

summary -> (string)

A brief summary of the Data Share.

termsOfUse -> (string)

The terms of use for the Data Share.

Form Factors¶

public