- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteDataSourceCommand
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, DeleteDataSourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DeleteDataSourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // DeleteDataSourceRequest
AwsAccountId: "STRING_VALUE", // required
DataSourceId: "STRING_VALUE", // required
};
const command = new DeleteDataSourceCommand(input);
const response = await client.send(command);
// { // DeleteDataSourceResponse
// Arn: "STRING_VALUE",
// DataSourceId: "STRING_VALUE",
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
DeleteDataSourceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The Amazon Web Services account ID. |
DataSourceId Required | string | undefined | The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
DeleteDataSourceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Arn | string | undefined | The Amazon Resource Name (ARN) of the data source that you deleted. |
DataSourceId | string | undefined | The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials. |
InternalFailureException | server | An internal failure occurred. |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
ResourceNotFoundException | client | One or more resources can't be found. |
ThrottlingException | client | Access is throttled. |
QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |