Table of Contents
DirectoryService.Client¶A low-level client representing AWS Directory Service:
client = session.create_client('ds')
These are the available methods:
add_ip_routes()add_tags_to_resource()can_paginate()cancel_schema_extension()connect_directory()create_alias()create_computer()create_conditional_forwarder()create_directory()create_microsoft_ad()create_snapshot()create_trust()delete_conditional_forwarder()delete_directory()delete_snapshot()delete_trust()deregister_event_topic()describe_conditional_forwarders()describe_directories()describe_domain_controllers()describe_event_topics()describe_snapshots()describe_trusts()disable_radius()disable_sso()enable_radius()enable_sso()generate_presigned_url()get_directory_limits()get_paginator()get_snapshot_limits()get_waiter()list_ip_routes()list_schema_extensions()list_tags_for_resource()register_event_topic()remove_ip_routes()remove_tags_from_resource()restore_from_snapshot()start_schema_extension()update_conditional_forwarder()update_number_of_domain_controllers()update_radius()verify_trust()add_ip_routes(**kwargs)¶If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.
Before you call AddIpRoutes , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .
See also: AWS API Documentation
Request Syntax
response = client.add_ip_routes(
DirectoryId='string',
IpRoutes=[
{
'CidrIp': 'string',
'Description': 'string'
},
],
UpdateSecurityGroupForDirectoryControllers=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
cancel_schema_extension(**kwargs)¶Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing , CreatingSnapshot , and UpdatingSchema .
See also: AWS API Documentation
Request Syntax
response = client.cancel_schema_extension(
DirectoryId='string',
SchemaExtensionId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
connect_directory(**kwargs)¶Creates an AD Connector to connect to an on-premises directory.
Before you call ConnectDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .
See also: AWS API Documentation
Request Syntax
response = client.connect_directory(
Name='string',
ShortName='string',
Password='string',
Description='string',
Size='Small'|'Large',
ConnectSettings={
'VpcId': 'string',
'SubnetIds': [
'string',
],
'CustomerDnsIps': [
'string',
],
'CustomerUserName': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DirectoryId': 'string'
}
Response Structure
|
create_alias(**kwargs)¶Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://alias.awsapps.com .
Warning
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
See also: AWS API Documentation
Request Syntax
response = client.create_alias(
DirectoryId='string',
Alias='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DirectoryId': 'string',
'Alias': 'string'
}
Response Structure
|
create_computer(**kwargs)¶Creates a computer account in the specified directory, and joins the computer to the directory.
See also: AWS API Documentation
Request Syntax
response = client.create_computer(
DirectoryId='string',
ComputerName='string',
Password='string',
OrganizationalUnitDistinguishedName='string',
ComputerAttributes=[
{
'Name': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Computer': {
'ComputerId': 'string',
'ComputerName': 'string',
'ComputerAttributes': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
Response Structure
|
create_conditional_forwarder(**kwargs)¶Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
See also: AWS API Documentation
Request Syntax
response = client.create_conditional_forwarder(
DirectoryId='string',
RemoteDomainName='string',
DnsIpAddrs=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
create_directory(**kwargs)¶Creates a Simple AD directory.
Before you call CreateDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .
See also: AWS API Documentation
Request Syntax
response = client.create_directory(
Name='string',
ShortName='string',
Password='string',
Description='string',
Size='Small'|'Large',
VpcSettings={
'VpcId': 'string',
'SubnetIds': [
'string',
]
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DirectoryId': 'string'
}
Response Structure
|
create_microsoft_ad(**kwargs)¶Creates a Microsoft AD in the AWS cloud.
Before you call CreateMicrosoftAD , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .
See also: AWS API Documentation
Request Syntax
response = client.create_microsoft_ad(
Name='string',
ShortName='string',
Password='string',
Description='string',
VpcSettings={
'VpcId': 'string',
'SubnetIds': [
'string',
]
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DirectoryId': 'string'
}
Response Structure
|
create_snapshot(**kwargs)¶Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS 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: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'SnapshotId': 'string'
}
Response Structure
|
create_trust(**kwargs)¶AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
See also: AWS API Documentation
Request Syntax
response = client.create_trust(
DirectoryId='string',
RemoteDomainName='string',
TrustPassword='string',
TrustDirection='One-Way: Outgoing'|'One-Way: Incoming'|'Two-Way',
TrustType='Forest',
ConditionalForwarderIpAddrs=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TrustId': 'string'
}
Response Structure
|
delete_conditional_forwarder(**kwargs)¶Deletes a conditional forwarder that has been set up for your AWS directory.
See also: AWS API Documentation
Request Syntax
response = client.delete_conditional_forwarder(
DirectoryId='string',
RemoteDomainName='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
delete_directory(**kwargs)¶Deletes an AWS Directory Service directory.
Before you call DeleteDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .
See also: AWS API Documentation
Request Syntax
response = client.delete_directory(
DirectoryId='string'
)
| Parameters: | DirectoryId (string) – [REQUIRED] The identifier of the directory to delete. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'DirectoryId': 'string'
}
Response Structure
|
delete_snapshot(**kwargs)¶Deletes a directory snapshot.
See also: AWS API Documentation
Request Syntax
response = client.delete_snapshot(
SnapshotId='string'
)
| Parameters: | SnapshotId (string) – [REQUIRED] The identifier of the directory snapshot to be deleted. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'SnapshotId': 'string'
}
Response Structure
|
delete_trust(**kwargs)¶Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
See also: AWS API Documentation
Request Syntax
response = client.delete_trust(
TrustId='string',
DeleteAssociatedConditionalForwarder=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TrustId': 'string'
}
Response Structure
|
deregister_event_topic(**kwargs)¶Removes the specified directory as a publisher to the specified SNS topic.
See also: AWS API Documentation
Request Syntax
response = client.deregister_event_topic(
DirectoryId='string',
TopicName='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
describe_conditional_forwarders(**kwargs)¶Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
See also: AWS API Documentation
Request Syntax
response = client.describe_conditional_forwarders(
DirectoryId='string',
RemoteDomainNames=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ConditionalForwarders': [
{
'RemoteDomainName': 'string',
'DnsIpAddrs': [
'string',
],
'ReplicationScope': 'Domain'
},
]
}
Response Structure
|
describe_directories(**kwargs)¶Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
See also: AWS API Documentation
Request Syntax
response = client.describe_directories(
DirectoryIds=[
'string',
],
NextToken='string',
Limit=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DirectoryDescriptions': [
{
'DirectoryId': 'string',
'Name': 'string',
'ShortName': 'string',
'Size': 'Small'|'Large',
'Alias': 'string',
'AccessUrl': 'string',
'Description': 'string',
'DnsIpAddrs': [
'string',
],
'Stage': 'Requested'|'Creating'|'Created'|'Active'|'Inoperable'|'Impaired'|'Restoring'|'RestoreFailed'|'Deleting'|'Deleted'|'Failed',
'LaunchTime': datetime(2015, 1, 1),
'StageLastUpdatedDateTime': datetime(2015, 1, 1),
'Type': 'SimpleAD'|'ADConnector'|'MicrosoftAD',
'VpcSettings': {
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupId': 'string',
'AvailabilityZones': [
'string',
]
},
'ConnectSettings': {
'VpcId': 'string',
'SubnetIds': [
'string',
],
'CustomerUserName': 'string',
'SecurityGroupId': 'string',
'AvailabilityZones': [
'string',
],
'ConnectIps': [
'string',
]
},
'RadiusSettings': {
'RadiusServers': [
'string',
],
'RadiusPort': 123,
'RadiusTimeout': 123,
'RadiusRetries': 123,
'SharedSecret': 'string',
'AuthenticationProtocol': 'PAP'|'CHAP'|'MS-CHAPv1'|'MS-CHAPv2',
'DisplayLabel': 'string',
'UseSameUsername': True|False
},
'RadiusStatus': 'Creating'|'Completed'|'Failed',
'StageReason': 'string',
'SsoEnabled': True|False,
'DesiredNumberOfDomainControllers': 123
},
],
'NextToken': 'string'
}
Response Structure
|
describe_domain_controllers(**kwargs)¶Provides information about any domain controllers in your directory.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain_controllers(
DirectoryId='string',
DomainControllerIds=[
'string',
],
NextToken='string',
Limit=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DomainControllers': [
{
'DirectoryId': 'string',
'DomainControllerId': 'string',
'DnsIpAddr': 'string',
'VpcId': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'Status': 'Creating'|'Active'|'Impaired'|'Restoring'|'Deleting'|'Deleted'|'Failed',
'StatusReason': 'string',
'LaunchTime': datetime(2015, 1, 1),
'StatusLastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
|
describe_event_topics(**kwargs)¶Obtains information about which SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_topics(
DirectoryId='string',
TopicNames=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'EventTopics': [
{
'DirectoryId': 'string',
'TopicName': 'string',
'TopicArn': 'string',
'CreatedDateTime': datetime(2015, 1, 1),
'Status': 'Registered'|'Topic not found'|'Failed'|'Deleted'
},
]
}
Response Structure
|
describe_snapshots(**kwargs)¶Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
See also: AWS API Documentation
Request Syntax
response = client.describe_snapshots(
DirectoryId='string',
SnapshotIds=[
'string',
],
NextToken='string',
Limit=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Snapshots': [
{
'DirectoryId': 'string',
'SnapshotId': 'string',
'Type': 'Auto'|'Manual',
'Name': 'string',
'Status': 'Creating'|'Completed'|'Failed',
'StartTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
|
describe_trusts(**kwargs)¶Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
See also: AWS API Documentation
Request Syntax
response = client.describe_trusts(
DirectoryId='string',
TrustIds=[
'string',
],
NextToken='string',
Limit=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Trusts': [
{
'DirectoryId': 'string',
'TrustId': 'string',
'RemoteDomainName': 'string',
'TrustType': 'Forest',
'TrustDirection': 'One-Way: Outgoing'|'One-Way: Incoming'|'Two-Way',
'TrustState': 'Creating'|'Created'|'Verifying'|'VerifyFailed'|'Verified'|'Deleting'|'Deleted'|'Failed',
'CreatedDateTime': datetime(2015, 1, 1),
'LastUpdatedDateTime': datetime(2015, 1, 1),
'StateLastUpdatedDateTime': datetime(2015, 1, 1),
'TrustStateReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
disable_radius(**kwargs)¶Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
See also: AWS API Documentation
Request Syntax
response = client.disable_radius(
DirectoryId='string'
)
| Parameters: | DirectoryId (string) – [REQUIRED] The identifier of the directory for which to disable MFA. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
disable_sso(**kwargs)¶Disables single-sign on for a directory.
See also: AWS API Documentation
Request Syntax
response = client.disable_sso(
DirectoryId='string',
UserName='string',
Password='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
enable_radius(**kwargs)¶Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
See also: AWS API Documentation
Request Syntax
response = client.enable_radius(
DirectoryId='string',
RadiusSettings={
'RadiusServers': [
'string',
],
'RadiusPort': 123,
'RadiusTimeout': 123,
'RadiusRetries': 123,
'SharedSecret': 'string',
'AuthenticationProtocol': 'PAP'|'CHAP'|'MS-CHAPv1'|'MS-CHAPv2',
'DisplayLabel': 'string',
'UseSameUsername': True|False
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
enable_sso(**kwargs)¶Enables single sign-on for a directory.
See also: AWS API Documentation
Request Syntax
response = client.enable_sso(
DirectoryId='string',
UserName='string',
Password='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_directory_limits()¶Obtains directory limit information for the current region.
See also: AWS API Documentation
Request Syntax
response = client.get_directory_limits()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'DirectoryLimits': {
'CloudOnlyDirectoriesLimit': 123,
'CloudOnlyDirectoriesCurrentCount': 123,
'CloudOnlyDirectoriesLimitReached': True|False,
'CloudOnlyMicrosoftADLimit': 123,
'CloudOnlyMicrosoftADCurrentCount': 123,
'CloudOnlyMicrosoftADLimitReached': True|False,
'ConnectedDirectoriesLimit': 123,
'ConnectedDirectoriesCurrentCount': 123,
'ConnectedDirectoriesLimitReached': True|False
}
}
Response Structure
|
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_snapshot_limits(**kwargs)¶Obtains the manual snapshot limits for a directory.
See also: AWS API Documentation
Request Syntax
response = client.get_snapshot_limits(
DirectoryId='string'
)
| Parameters: | DirectoryId (string) – [REQUIRED] Contains the identifier of the directory to obtain the limits for. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'SnapshotLimits': {
'ManualSnapshotsLimit': 123,
'ManualSnapshotsCurrentCount': 123,
'ManualSnapshotsLimitReached': True|False
}
}
Response Structure
|
get_waiter(waiter_name)¶list_ip_routes(**kwargs)¶Lists the address blocks that you have added to a directory.
See also: AWS API Documentation
Request Syntax
response = client.list_ip_routes(
DirectoryId='string',
NextToken='string',
Limit=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'IpRoutesInfo': [
{
'DirectoryId': 'string',
'CidrIp': 'string',
'IpRouteStatusMsg': 'Adding'|'Added'|'Removing'|'Removed'|'AddFailed'|'RemoveFailed',
'AddedDateTime': datetime(2015, 1, 1),
'IpRouteStatusReason': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
list_schema_extensions(**kwargs)¶Lists all schema extensions applied to a Microsoft AD Directory.
See also: AWS API Documentation
Request Syntax
response = client.list_schema_extensions(
DirectoryId='string',
NextToken='string',
Limit=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'SchemaExtensionsInfo': [
{
'DirectoryId': 'string',
'SchemaExtensionId': 'string',
'Description': 'string',
'SchemaExtensionStatus': 'Initializing'|'CreatingSnapshot'|'UpdatingSchema'|'Replicating'|'CancelInProgress'|'RollbackInProgress'|'Cancelled'|'Failed'|'Completed',
'SchemaExtensionStatusReason': 'string',
'StartDateTime': datetime(2015, 1, 1),
'EndDateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
|
Lists all tags on a directory.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceId='string',
NextToken='string',
Limit=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
register_event_topic(**kwargs)¶Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
See also: AWS API Documentation
Request Syntax
response = client.register_event_topic(
DirectoryId='string',
TopicName='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
remove_ip_routes(**kwargs)¶Removes IP address blocks from a directory.
See also: AWS API Documentation
Request Syntax
response = client.remove_ip_routes(
DirectoryId='string',
CidrIps=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
Removes tags from a directory.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceId='string',
TagKeys=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
restore_from_snapshot(**kwargs)¶Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active , the restore operation is complete.
See also: AWS API Documentation
Request Syntax
response = client.restore_from_snapshot(
SnapshotId='string'
)
| Parameters: | SnapshotId (string) – [REQUIRED] The identifier of the snapshot to restore from. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
start_schema_extension(**kwargs)¶Applies a schema extension to a Microsoft AD directory.
See also: AWS API Documentation
Request Syntax
response = client.start_schema_extension(
DirectoryId='string',
CreateSnapshotBeforeSchemaExtension=True|False,
LdifContent='string',
Description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'SchemaExtensionId': 'string'
}
Response Structure
|
update_conditional_forwarder(**kwargs)¶Updates a conditional forwarder that has been set up for your AWS directory.
See also: AWS API Documentation
Request Syntax
response = client.update_conditional_forwarder(
DirectoryId='string',
RemoteDomainName='string',
DnsIpAddrs=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
update_number_of_domain_controllers(**kwargs)¶Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
See also: AWS API Documentation
Request Syntax
response = client.update_number_of_domain_controllers(
DirectoryId='string',
DesiredNumber=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
update_radius(**kwargs)¶Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
See also: AWS API Documentation
Request Syntax
response = client.update_radius(
DirectoryId='string',
RadiusSettings={
'RadiusServers': [
'string',
],
'RadiusPort': 123,
'RadiusTimeout': 123,
'RadiusRetries': 123,
'SharedSecret': 'string',
'AuthenticationProtocol': 'PAP'|'CHAP'|'MS-CHAPv1'|'MS-CHAPv2',
'DisplayLabel': 'string',
'UseSameUsername': True|False
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
verify_trust(**kwargs)¶AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.
See also: AWS API Documentation
Request Syntax
response = client.verify_trust(
TrustId='string'
)
| Parameters: | TrustId (string) – [REQUIRED] The unique Trust ID of the trust relationship to verify. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'TrustId': 'string'
}
Response Structure
|
The available paginators are: