DeleteTrailCommand

Suggest an Edit

Deletes a trail. This operation must be called from the Region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

Example Syntax

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

import { CloudTrailClient, DeleteTrailCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
// const { CloudTrailClient, DeleteTrailCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
const client = new CloudTrailClient(config);
const input = { // DeleteTrailRequest
  Name: "STRING_VALUE", // required
};
const command = new DeleteTrailCommand(input);
const response = await client.send(command);
// {};

DeleteTrailCommand Input

See DeleteTrailCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

DeleteTrailCommand Output

See DeleteTrailCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
CloudTrailARNInvalidException
client

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

ConflictException
client

This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.

InsufficientDependencyServiceAccessPermissionException
client

This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.

InvalidHomeRegionException
client

This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.

InvalidTrailNameException
client

This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

  • Not be in IP address format (for example, 192.168.5.4)

NoManagementAccountSLRExistsException
client

This exception is thrown when the management account does not have a service-linked role.

NotOrganizationMasterAccountException
client

This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization  or Organization event data stores .

OperationNotPermittedException
client

This exception is thrown when the requested operation is not permitted.

ThrottlingException
client

This exception is thrown when the request rate exceeds the limit.

TrailNotFoundException
client

This exception is thrown when the trail with the given name is not found.

UnsupportedOperationException
client

This exception is thrown when the requested operation is not supported.

CloudTrailServiceException
Base exception class for all service exceptions from CloudTrail service.