DeleteNamespaceCommand

Suggest an Edit

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

Example Syntax

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

import { QuickSightClient, DeleteNamespaceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DeleteNamespaceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // DeleteNamespaceRequest
  AwsAccountId: "STRING_VALUE", // required
  Namespace: "STRING_VALUE", // required
};
const command = new DeleteNamespaceCommand(input);
const response = await client.send(command);
// { // DeleteNamespaceResponse
//   RequestId: "STRING_VALUE",
//   Status: Number("int"),
// };

DeleteNamespaceCommand Input

See DeleteNamespaceCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

Namespace
Required
string | undefined

The namespace that you want to delete.

DeleteNamespaceCommand Output

See DeleteNamespaceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
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
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.

PreconditionNotMetException
client

One or more preconditions aren't met.

ResourceNotFoundException
client

One or more resources can't be found.

ResourceUnavailableException
server

This resource is currently unavailable.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.