Cloudera DataCatalog Service

assets
required

List of assets to be added to the Data Share.

< AssetRequest > array

dataShareId
required

The unique identifier of the Data Share to which assets will be added.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

assets
optional

List of assets added to the Data Share.

< AssetResponse > array

columns
optional

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

< string > array

databaseName
required

The name of the database containing the asset.

string

guid
optional

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

string

tableName
required

The name of the table containing the asset.

string

columns
optional

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

< string > array

createTime
optional

The date and time when the asset was created.

string (date-time)

createdBy
optional

The user who created the asset.

string

databaseName
optional

The name of the database containing the asset.

string

guid
optional

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

string

resourceId
optional

The unique identifier of the resource.

string

tableName
optional

The name of the table containing the asset.

string

updateTime
optional

The date and time when the asset was last updated.

string (date-time)

updatedBy
optional

The user who last updated the asset.

string

qualifiedName
required

The fully qualified name of the asset.

string

tags
required

List of tags to be reviewed.

< string > array

cloudPlatform
optional

The cloud platform.

string

clusterName
optional

The name of the cluster.

string

clusterStatus
optional

The status of the cluster.

string

clusterTemplateCrn
optional

The CRN of the cluster template used for the cluster creation.

string

creationDate
optional

The date when the cluster was created.

string (date-time)

credentialCrn
optional

The CRN of the credential.

string

crn
optional

The CRN of the cluster.

string

datalakeCrn
optional

The CRN of the attached datalake.

string

environmentCrn
optional

The CRN of the environment.

string

imageDetails
optional

The image details.

ImageDetails

nodeCount
optional

The cluster node count.

integer (int32)

workloadType
optional

The workload type for the cluster.

string

assets
required

List of assets to be included in the Data Share.

< AssetRequest > array

dataShareName
required

The name of the Data Share to be created (Max length is 512 characters).
Maximal length : 512

string

datalakeCrn
required

The CRN of the Data Lake where the Data Share will be created.

string

environmentCrn
required

The CRN of the Environment where the Data Share will be created.

string

expiryTime
optional

The date and time when the Data Share will expire.

string (date-time)

externalUsers
optional

List of external users to be granted access to the Data Share.

< ExternalUserAccessUpdate > array

keywords
optional

List of keywords associated with the Data Share.

< string > array

summary
optional

A brief summary of the Data Share.

string

termsOfUse
optional

The terms of use for the Data Share.

string

dataShareId
optional

The unique identifier of the created Data Share.

string

dataShareName
optional

The name of the created Data Share.

string

datalakeCrn
optional

The CRN of the Data Lake where the Data Share was created.

string

companyName
required

The company name of the External user.

string

email
required

The email address of the External user.

string

username
required

The username of the External user.

string

datalakeCrn
required

The CRN of the Data lake where the external users will be created.

string

environmentCrn
required

The CRN of the Environment where the external users will be created.

string

externalUsers
required

List of external users to be created.

< CreateExternalUser > array

externalUsers
optional

List of external users created.

< ExternalUser > array

clientId
optional

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

string

companyName
optional

The company name of the external user.

string

permissions
optional

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

< string > array

sharedOn
optional

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

string (date-time)

userId
optional

The unique identifier of the external user.

integer (int64)

username
optional

The username of the external user.

string

validTill
optional

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

string (date-time)

createdAt
optional

The date and time when the Data Share was created.

string (date-time)

createdBy
optional

The CDP user who created the Data Share.

string

dataShareId
optional

The unique identifier of the Data Share.

string

dataShareName
optional

The name of the Data Share.

string

expiryTime
optional

The date and time when the Data Share will expire.

string (date-time)

isShared
optional

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

boolean

keywords
optional

List of keywords associated with the Data Share.

< string > array

dataShareId
required

The unique identifier of the Data Share to be deleted.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

datalakeCrn
required

The CRN of the Data Lake where the external user will be deleted.

string

environmentCrn
required

The CRN of the Environment where the external user will be deleted.

string

externalUserId
required

The unique identifier of the external user to be deleted.

integer (int64)

success
optional

Indicates whether the external user was successfully deleted.

boolean

code
optional

The error code.

string

message
optional

The error message.

string

clientId
optional

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

string

companyName
optional

The company name of the external user.

string

createdAt
optional

The date and time when the external user was created.

string (date-time)

email
optional

The email address of the external user.

string

error
optional

Error message if any occurred during the creation of the external user.

string

expiryTime
optional

The date and time when the external user will expire.

string (date-time)

secret
optional

The Secret of the external user that will be used for authentication to external services.

string

userId
optional

The unique identifier of the external user.

integer (int64)

username
optional

The username of the external user.

string

expiryTime
optional

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

string (date-time)

externalUserId
optional

The unique identifier of the external user.

integer (int64)

clientId
optional

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

string

companyName
optional

The company name of the external user.

string

createdAt
optional

The date and time when the external user was created.

string (date-time)

email
optional

The email address of the external user.

string

isActive
optional

Indicates whether the external user’s credentials are revoked or not.

boolean

userId
optional

The unique identifier of the external user.

integer (int64)

username
optional

The username of the external user.

string

dataShareId
required

The unique identifier of the Data Share to be retrieved.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

assets
optional

List of assets included in the Data Share.

< AssetResponse > array

createdAt
optional

The date and time when the Data Share was created.

string (date-time)

createdBy
optional

The CDP user who created the Data Share.

string

dataShareId
optional

The unique identifier of the Data Share.

string

dataShareName
optional

The name of the Data Share.

string

expiryTime
optional

The date and time when the Data Share will expire.

string (date-time)

externalUsers
optional

List of external users granted access to the Data Share.

< DataShareExternalUser > array

isShared
optional

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

boolean

keywords
optional

List of keywords associated with the Data Share.

< string > array

summary
optional

A brief summary of the Data Share.

string

tags
optional

List of the Atlas tags associated with the Data Share.

< string > array

termsOfUse
optional

The terms of use for the Data Share.

string

updatedAt
optional

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

string (date-time)

columnFQN
optional

The fully qualified name of the column.

string

datalakeCrn
required

The CRN of the Datalake.

string

profiledSince
optional

Tags suggested by the profiler since this date.

string (date-time)

tableFQN
optional

The fully qualified name of the table.

string

suggestedTags
optional

List of suggested tags.

< suggestedTags > array

qualifiedName
optional

The fully qualified name of the asset.

string

tags
optional

List of suggested tags.

< string > array

dataShareId
required

The unique identifier of the Data Share for which external user access will be updated.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

externalUsers
required

List of external users with updated access permissions.

< ExternalUserAccessUpdate > array

catalogName
optional

The image catalog name.

string

catalogUrl
optional

The image catalog URL.

string

id
optional

The ID of the image used for cluster instances. This is internally generated by the cloud provider to uniquely identify the image.

string

name
optional

The name of the image used for cluster instances.

string

datalake
required

The CRN of the Datalake.

string

enableHA
optional

Enables High Availability (HA) for datacatalog profilers (default value is false). The High Availability (HA) Profiler cluster provides failure resilience and scalability but incurs additional cost.

boolean

instanceTypes
optional

List of instance types to be used for the auto-scaling node group setup (Applicable only for compute cluster enabled environments).

< string > array

maxNodes
optional

Maximum number of nodes that can be spawned inside the auto-scaling node group, in the range of 30 to 100 (both inclusive). (Applicable only for compute cluster enabled environments).

integer (int64)

profilers
optional

List of profiler names that need to be launched. (Applicable only for compute cluster enabled environments).

< string > array

datahubCluster
optional

Datahub cluster details.

Cluster

datalakeCrn
required

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

string

environmentCrn
required

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

string

name
optional

The name of the Data Share.

string

pageSize
optional

The size of each page.
Minimum value : 1
Maximum value : 100

integer (int32)

startingToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

dataShares
optional

List of Data Shares.

< DataShareResponse > array

nextToken
optional

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

string

datalakeCrn
required

The CRN of the Data Lake where the external users need to be listed.

string

environmentCrn
required

The CRN of the Environment where the external users need to be listed.

string

pageSize
optional

The size of each page.
Minimum value : 1
Maximum value : 100

integer (int32)

searchTerm
optional

A search term to filter the external users by username or email or companyName.

string

startingToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

externalUsers
optional

List of external users.

< ExternalUserListItem > array

nextToken
optional

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

string

datalakeCrn
required

The CRN of the Data Lake where the external user credentials will be regenerated.

string

environmentCrn
required

The CRN of the Environment where the external user credentials will be regenerated.

string

externalUserId
required

The unique identifier of the external user whose credentials are to be regenerated.

integer (int64)

externalUser
optional

The external user with regenerated credentials.

ExternalUser

dataShareId
required

The unique identifier of the Data Share from which external user access will be removed.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

externalUserIds
required

List of external user Ids whose access will be removed.

< integer (int64) > array

dataShareId
required

The unique identifier of the Data Share from which assets will be removed.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

resourceIds
required

List of asset resource IDs to be removed from the Data Share.

< string > array

action
required

Action to be taken on the suggested tags. (ACCEPT, REJECT)

enum (ACCEPT, REJECT)

assets
required

List of assets for which tags are being reviewed.

< AssetsToReviewRequest > array

datalakeCrn
required

The CRN of the Datalake.

string

reviewedTags
optional

List of reviewed tags.

< reviewedTags > array

qualifiedName
optional

The fully qualified name of the asset.

string

status
optional

The current status of the tags. (ACCEPTED, REJECTED, FAILED)

enum (ACCEPTED, REJECTED, FAILED)

tagsUpdated
optional

List of tags on which have been reviewed.

< string > array

datalakeCrn
required

The CRN of the Data Lake where the external user credentials will be revoked.

string

environmentCrn
required

The CRN of the Environment where the external user credentials will be revoked.

string

externalUserId
required

The unique identifier of the external user whose credentials are to be revoked.

integer (int64)

success
optional

Indicates whether the external user credentials were successfully revoked.

boolean

dataShareId
required

The unique identifier of the Data Share to be shared.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

success
optional

Indicates whether the Data Share was successfully shared with external users.

boolean

dataShareId
required

The unique identifier of the Data Share to be shared.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

dataShareId
required

The unique identifier of the Data Share for which external user access will be updated.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

externalUsers
required

List of external users with updated access permissions.

< ExternalUserAccessUpdate > array

dataShareId
required

The unique identifier of the Data Share to be updated.

string

dataShareName
optional

The name of the Data Share.

string

datalakeCrn
required

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

string

environmentCrn
required

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

string

expiryTime
optional

The date and time when the Data Share will expire.

string (date-time)

keywords
optional

List of keywords associated with the Data Share.

< string > array

summary
optional

A brief summary of the Data Share.

string

termsOfUse
optional

The terms of use for the Data Share.

string