Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class DeleteAccountAliasCommandProtected

Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide.

Example

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

import { IAMClient, DeleteAccountAliasCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, DeleteAccountAliasCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // DeleteAccountAliasRequest
AccountAlias: "STRING_VALUE", // required
};
const command = new DeleteAccountAliasCommand(input);
const response = await client.send(command);
// {};

Param

DeleteAccountAliasCommandInput

Returns

DeleteAccountAliasCommandOutput

See

Throws

LimitExceededException (client fault)

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To delete an account alias

// The following command removes the alias mycompany from the current AWS account:
const input = {
"AccountAlias": "mycompany"
};
const command = new DeleteAccountAliasCommand(input);
await client.send(command);
// example id: 7abeca65-04a8-4500-a890-47f1092bf766

Hierarchy

Constructors

Properties

Methods