GetDataSetCommand

Suggest an Edit

This operation returns information about a data set.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataExchangeClient, GetDataSetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import
// const { DataExchangeClient, GetDataSetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import
const client = new DataExchangeClient(config);
const input = { // GetDataSetRequest
  DataSetId: "STRING_VALUE", // required
};
const command = new GetDataSetCommand(input);
const response = await client.send(command);
// { // GetDataSetResponse
//   Arn: "STRING_VALUE",
//   AssetType: "STRING_VALUE",
//   CreatedAt: new Date("TIMESTAMP"),
//   Description: "STRING_VALUE",
//   Id: "STRING_VALUE",
//   Name: "STRING_VALUE",
//   Origin: "STRING_VALUE",
//   OriginDetails: { // OriginDetails
//     ProductId: "STRING_VALUE",
//     DataGrantId: "STRING_VALUE",
//   },
//   SourceId: "STRING_VALUE",
//   Tags: { // MapOf__string
//     "<keys>": "STRING_VALUE",
//   },
//   UpdatedAt: new Date("TIMESTAMP"),
// };

GetDataSetCommand Input

See GetDataSetCommandInput for more details

Parameter
Type
Description
DataSetId
Required
string | undefined

The unique identifier for a data set.

GetDataSetCommand Output

See GetDataSetCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The ARN for the data set.

AssetType
AssetType | undefined

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

CreatedAt
Date | undefined

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

Description
string | undefined

The description for the data set.

Id
string | undefined

The unique identifier for the data set.

Name
string | undefined

The name of the data set.

Origin
Origin | undefined

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

OriginDetails
OriginDetails | undefined

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

SourceId
string | undefined

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
Record<string, string> | undefined

The tags for the data set.

UpdatedAt
Date | undefined

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

Throws

Name
Fault
Details
InternalServerException
server

An exception occurred with the service.

ResourceNotFoundException
client

The resource couldn't be found.

ThrottlingException
client

The limit on the number of requests per second was exceeded.

ValidationException
client

The request was invalid.

DataExchangeServiceException
Base exception class for all service exceptions from DataExchange service.