2017/07/06 - AWS Directory Service - 2 new1 updated api methods
Changes Update ds client to latest version
Provides information about any domain controllers in your directory.
See also: AWS API Documentation
Request Syntax
client.describe_domain_controllers(
DirectoryId='string',
DomainControllerIds=[
'string',
],
NextToken='string',
Limit=123
)
string
[REQUIRED]
Identifier of the directory for which to retrieve the domain controller information.
list
A list of identifiers for the domain controllers whose information will be provided.
(string) --
string
The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
integer
The maximum number of items to return.
dict
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
(dict) --
DomainControllers (list) --
List of the DomainController objects that were retrieved.
(dict) --
Contains information about the domain controllers for a specified directory.
DirectoryId (string) --
Identifier of the directory where the domain controller resides.
DomainControllerId (string) --
Identifies a specific domain controller in the directory.
DnsIpAddr (string) --
The IP address of the domain controller.
VpcId (string) --
The identifier of the VPC that contains the domain controller.
SubnetId (string) --
Identifier of the subnet in the VPC that contains the domain controller.
AvailabilityZone (string) --
The Availability Zone where the domain controller is located.
Status (string) --
The status of the domain controller.
StatusReason (string) --
A description of the domain controller state.
LaunchTime (datetime) --
Specifies when the domain controller was created.
StatusLastUpdatedDateTime (datetime) --
The date and time that the status was last updated.
NextToken (string) --
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.
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
client.update_number_of_domain_controllers(
DirectoryId='string',
DesiredNumber=123
)
string
[REQUIRED]
Identifier of the directory to which the domain controllers will be added or removed.
integer
[REQUIRED]
The number of domain controllers desired in the directory.
dict
Response Syntax
{}
Response Structure
(dict) --
{'DirectoryDescriptions': {'DesiredNumberOfDomainControllers': 'integer'}}
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
client.describe_directories(
DirectoryIds=[
'string',
],
NextToken='string',
Limit=123
)
list
A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.
An empty list results in an InvalidParameterException being thrown.
(string) --
string
The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
integer
The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
dict
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
(dict) --
Contains the results of the DescribeDirectories operation.
DirectoryDescriptions (list) --
The list of DirectoryDescription objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
(dict) --
Contains information about an AWS Directory Service directory.
DirectoryId (string) --
The directory identifier.
Name (string) --
The fully-qualified name of the directory.
ShortName (string) --
The short name of the directory.
Size (string) --
The directory size.
Alias (string) --
The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
AccessUrl (string) --
The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.
Description (string) --
The textual description for the directory.
DnsIpAddrs (list) --
The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.
(string) --
Stage (string) --
The current stage of the directory.
LaunchTime (datetime) --
Specifies when the directory was created.
StageLastUpdatedDateTime (datetime) --
The date and time that the stage was last updated.
Type (string) --
The directory size.
VpcSettings (dict) --
A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.
VpcId (string) --
The identifier of the VPC that the directory is in.
SubnetIds (list) --
The identifiers of the subnets for the directory servers.
(string) --
SecurityGroupId (string) --
The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null.
AvailabilityZones (list) --
The list of Availability Zones that the directory is in.
(string) --
ConnectSettings (dict) --
A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.
VpcId (string) --
The identifier of the VPC that the AD Connector is in.
SubnetIds (list) --
A list of subnet identifiers in the VPC that the AD connector is in.
(string) --
CustomerUserName (string) --
The username of the service account in the on-premises directory.
SecurityGroupId (string) --
The security group identifier for the AD Connector directory.
AvailabilityZones (list) --
A list of the Availability Zones that the directory is in.
(string) --
ConnectIps (list) --
The IP addresses of the AD Connector servers.
(string) --
RadiusSettings (dict) --
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
RadiusServers (list) --
An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.
(string) --
RadiusPort (integer) --
The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.
RadiusTimeout (integer) --
The amount of time, in seconds, to wait for the RADIUS server to respond.
RadiusRetries (integer) --
The maximum number of times that communication with the RADIUS server is attempted.
SharedSecret (string) --
Not currently used.
AuthenticationProtocol (string) --
The protocol specified for your RADIUS endpoints.
DisplayLabel (string) --
Not currently used.
UseSameUsername (boolean) --
Not currently used.
RadiusStatus (string) --
The status of the RADIUS MFA server connection.
StageReason (string) --
Additional information about the directory stage.
SsoEnabled (boolean) --
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
DesiredNumberOfDomainControllers (integer) --
The desired number of domain controllers in the directory if the directory is Microsoft AD.
NextToken (string) --
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.