create_snapshot

DirectoryService.Client.create_snapshot(**kwargs)

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

Note

You cannot take snapshots of AD Connector directories.

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot(
    DirectoryId='string',
    Name='string'
)

Parameters

• DirectoryId (string) --

  [REQUIRED]

  The identifier of the directory of which to take a snapshot.

• Name (string) -- The descriptive name to apply to the snapshot.

Return type

dict

Returns

Response Syntax

{
    'SnapshotId': 'string'
}

Response Structure

• (dict) --

  Contains the results of the CreateSnapshot operation.

  • SnapshotId (string) --

    The identifier of the snapshot that was created.

Exceptions

• DirectoryService.Client.exceptions.EntityDoesNotExistException
• DirectoryService.Client.exceptions.InvalidParameterException
• DirectoryService.Client.exceptions.SnapshotLimitExceededException
• DirectoryService.Client.exceptions.ClientException
• DirectoryService.Client.exceptions.ServiceException