EnableDirectoryCommand

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

Example Syntax

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

import { CloudDirectoryClient, EnableDirectoryCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import
// const { CloudDirectoryClient, EnableDirectoryCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import
const client = new CloudDirectoryClient(config);
const input = { // EnableDirectoryRequest
  DirectoryArn: "STRING_VALUE", // required
};
const command = new EnableDirectoryCommand(input);
const response = await client.send(command);
// { // EnableDirectoryResponse
//   DirectoryArn: "STRING_VALUE", // required
// };

Example Usage

 Loading code editor

EnableDirectoryCommand Input

See EnableDirectoryCommandInput for more details

Parameter
Type
Description
DirectoryArn
Required
string | undefined

The ARN of the directory to enable.

EnableDirectoryCommand Output

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

The ARN of the enabled directory.

Throws

Name
Fault
Details
AccessDeniedException
client

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

DirectoryDeletedException
client

A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.

InternalServiceException
server

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard  site to see if there are any operational issues with the service.

InvalidArnException
client

Indicates that the provided ARN value is not valid.

LimitExceededException
client

Indicates that limits are exceeded. See Limits  for more information.

ResourceNotFoundException
client

The specified resource could not be found.

RetryableConflictException
client

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

ValidationException
client

Indicates that your request is malformed in some manner. See the exception message.

CloudDirectoryServiceException
Base exception class for all service exceptions from CloudDirectory service.