DirectoryService module#
Index > DirectoryService
Auto-generated documentation for DirectoryService type annotations stubs module types-boto3-ds.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
DirectoryService
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and DirectoryService
.
From PyPI with pip#
Install types-boto3
for DirectoryService
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[ds]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[ds]'
# standalone installation
python -m pip install types-boto3-ds
How to uninstall#
python -m pip uninstall -y types-boto3-ds
Usage#
Code samples can be found in Examples.
DirectoryServiceClient#
Type annotations and code completion for boto3.client("ds")
as DirectoryServiceClient
boto3 documentation
# DirectoryServiceClient usage example
from boto3.session import Session
from types_boto3_ds.client import DirectoryServiceClient
def get_client() -> DirectoryServiceClient:
return Session().client("ds")
Paginators#
Type annotations and code completion for paginators
from boto3.client("ds").get_paginator("...")
.
# DescribeClientAuthenticationSettingsPaginator usage example
from boto3.session import Session
from types_boto3_ds.paginator import DescribeClientAuthenticationSettingsPaginator
def get_describe_client_authentication_settings_paginator() -> DescribeClientAuthenticationSettingsPaginator:
return Session().client("ds").get_paginator("describe_client_authentication_settings"))
- DescribeClientAuthenticationSettingsPaginator
- DescribeDirectoriesPaginator
- DescribeDomainControllersPaginator
- DescribeLDAPSSettingsPaginator
- DescribeRegionsPaginator
- DescribeSharedDirectoriesPaginator
- DescribeSnapshotsPaginator
- DescribeTrustsPaginator
- DescribeUpdateDirectoryPaginator
- ListCertificatesPaginator
- ListIpRoutesPaginator
- ListLogSubscriptionsPaginator
- ListSchemaExtensionsPaginator
- ListTagsForResourcePaginator
Literals#
Type annotations for literals used in methods and schema.
# CertificateStateType usage example
from types_boto3_ds.literals import CertificateStateType
def get_value() -> CertificateStateType:
return "DeregisterFailed"
- CertificateStateType
- CertificateTypeType
- ClientAuthenticationStatusType
- ClientAuthenticationTypeType
- DataAccessStatusType
- DescribeClientAuthenticationSettingsPaginatorName
- DescribeDirectoriesPaginatorName
- DescribeDomainControllersPaginatorName
- DescribeLDAPSSettingsPaginatorName
- DescribeRegionsPaginatorName
- DescribeSharedDirectoriesPaginatorName
- DescribeSnapshotsPaginatorName
- DescribeTrustsPaginatorName
- DescribeUpdateDirectoryPaginatorName
- DirectoryConfigurationStatusType
- DirectoryEditionType
- DirectorySizeType
- DirectoryStageType
- DirectoryTypeType
- DomainControllerStatusType
- IpRouteStatusMsgType
- LDAPSStatusType
- LDAPSTypeType
- ListCertificatesPaginatorName
- ListIpRoutesPaginatorName
- ListLogSubscriptionsPaginatorName
- ListSchemaExtensionsPaginatorName
- ListTagsForResourcePaginatorName
- OSVersionType
- RadiusAuthenticationProtocolType
- RadiusStatusType
- RegionTypeType
- ReplicationScopeType
- SchemaExtensionStatusType
- SelectiveAuthType
- ShareMethodType
- ShareStatusType
- SnapshotStatusType
- SnapshotTypeType
- TargetTypeType
- TopicStatusType
- TrustDirectionType
- TrustStateType
- TrustTypeType
- UpdateStatusType
- UpdateTypeType
- DirectoryServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AcceptSharedDirectoryRequestTypeDef
- ResponseMetadataTypeDef
- SharedDirectoryTypeDef
- IpRouteTypeDef
- TagTypeDef
- AttributeTypeDef
- CancelSchemaExtensionRequestTypeDef
- CertificateInfoTypeDef
- ClientCertAuthSettingsTypeDef
- ClientAuthenticationSettingInfoTypeDef
- ConditionalForwarderTypeDef
- DirectoryConnectSettingsTypeDef
- CreateAliasRequestTypeDef
- CreateConditionalForwarderRequestTypeDef
- CreateLogSubscriptionRequestTypeDef
- CreateSnapshotRequestTypeDef
- CreateTrustRequestTypeDef
- DeleteConditionalForwarderRequestTypeDef
- DeleteDirectoryRequestTypeDef
- DeleteLogSubscriptionRequestTypeDef
- DeleteSnapshotRequestTypeDef
- DeleteTrustRequestTypeDef
- DeregisterCertificateRequestTypeDef
- DeregisterEventTopicRequestTypeDef
- DescribeCertificateRequestTypeDef
- PaginatorConfigTypeDef
- DescribeClientAuthenticationSettingsRequestTypeDef
- DescribeConditionalForwardersRequestTypeDef
- DescribeDirectoriesRequestTypeDef
- DescribeDirectoryDataAccessRequestTypeDef
- DescribeDomainControllersRequestTypeDef
- DomainControllerTypeDef
- DescribeEventTopicsRequestTypeDef
- EventTopicTypeDef
- DescribeLDAPSSettingsRequestTypeDef
- LDAPSSettingInfoTypeDef
- DescribeRegionsRequestTypeDef
- DescribeSettingsRequestTypeDef
- SettingEntryTypeDef
- DescribeSharedDirectoriesRequestTypeDef
- DescribeSnapshotsRequestTypeDef
- SnapshotTypeDef
- DescribeTrustsRequestTypeDef
- TrustTypeDef
- DescribeUpdateDirectoryRequestTypeDef
- DirectoryConnectSettingsDescriptionTypeDef
- DirectoryVpcSettingsDescriptionTypeDef
- RadiusSettingsOutputTypeDef
- RegionsInfoTypeDef
- DirectoryLimitsTypeDef
- DirectoryVpcSettingsOutputTypeDef
- DirectoryVpcSettingsTypeDef
- DisableClientAuthenticationRequestTypeDef
- DisableDirectoryDataAccessRequestTypeDef
- DisableLDAPSRequestTypeDef
- DisableRadiusRequestTypeDef
- DisableSsoRequestTypeDef
- EnableClientAuthenticationRequestTypeDef
- EnableDirectoryDataAccessRequestTypeDef
- EnableLDAPSRequestTypeDef
- EnableSsoRequestTypeDef
- GetSnapshotLimitsRequestTypeDef
- SnapshotLimitsTypeDef
- IpRouteInfoTypeDef
- ListCertificatesRequestTypeDef
- ListIpRoutesRequestTypeDef
- ListLogSubscriptionsRequestTypeDef
- LogSubscriptionTypeDef
- ListSchemaExtensionsRequestTypeDef
- SchemaExtensionInfoTypeDef
- ListTagsForResourceRequestTypeDef
- OSUpdateSettingsTypeDef
- RadiusSettingsTypeDef
- RegisterEventTopicRequestTypeDef
- RejectSharedDirectoryRequestTypeDef
- RemoveIpRoutesRequestTypeDef
- RemoveRegionRequestTypeDef
- RemoveTagsFromResourceRequestTypeDef
- ResetUserPasswordRequestTypeDef
- RestoreFromSnapshotRequestTypeDef
- SettingTypeDef
- ShareTargetTypeDef
- StartSchemaExtensionRequestTypeDef
- UnshareTargetTypeDef
- UpdateConditionalForwarderRequestTypeDef
- UpdateNumberOfDomainControllersRequestTypeDef
- UpdateTrustRequestTypeDef
- VerifyTrustRequestTypeDef
- ConnectDirectoryResultTypeDef
- CreateAliasResultTypeDef
- CreateDirectoryResultTypeDef
- CreateMicrosoftADResultTypeDef
- CreateSnapshotResultTypeDef
- CreateTrustResultTypeDef
- DeleteDirectoryResultTypeDef
- DeleteSnapshotResultTypeDef
- DeleteTrustResultTypeDef
- DescribeDirectoryDataAccessResultTypeDef
- RegisterCertificateResultTypeDef
- RejectSharedDirectoryResultTypeDef
- ShareDirectoryResultTypeDef
- StartSchemaExtensionResultTypeDef
- UnshareDirectoryResultTypeDef
- UpdateSettingsResultTypeDef
- UpdateTrustResultTypeDef
- VerifyTrustResultTypeDef
- AcceptSharedDirectoryResultTypeDef
- DescribeSharedDirectoriesResultTypeDef
- AddIpRoutesRequestTypeDef
- AddTagsToResourceRequestTypeDef
- ListTagsForResourceResultTypeDef
- ComputerTypeDef
- CreateComputerRequestTypeDef
- ListCertificatesResultTypeDef
- CertificateTypeDef
- RegisterCertificateRequestTypeDef
- DescribeClientAuthenticationSettingsResultTypeDef
- DescribeConditionalForwardersResultTypeDef
- ConnectDirectoryRequestTypeDef
- DescribeClientAuthenticationSettingsRequestPaginateTypeDef
- DescribeDirectoriesRequestPaginateTypeDef
- DescribeDomainControllersRequestPaginateTypeDef
- DescribeLDAPSSettingsRequestPaginateTypeDef
- DescribeRegionsRequestPaginateTypeDef
- DescribeSharedDirectoriesRequestPaginateTypeDef
- DescribeSnapshotsRequestPaginateTypeDef
- DescribeTrustsRequestPaginateTypeDef
- DescribeUpdateDirectoryRequestPaginateTypeDef
- ListCertificatesRequestPaginateTypeDef
- ListIpRoutesRequestPaginateTypeDef
- ListLogSubscriptionsRequestPaginateTypeDef
- ListSchemaExtensionsRequestPaginateTypeDef
- ListTagsForResourceRequestPaginateTypeDef
- DescribeDomainControllersResultTypeDef
- DescribeEventTopicsResultTypeDef
- DescribeLDAPSSettingsResultTypeDef
- DescribeSettingsResultTypeDef
- DescribeSnapshotsResultTypeDef
- DescribeTrustsResultTypeDef
- OwnerDirectoryDescriptionTypeDef
- GetDirectoryLimitsResultTypeDef
- RegionDescriptionTypeDef
- DirectoryVpcSettingsUnionTypeDef
- GetSnapshotLimitsResultTypeDef
- ListIpRoutesResultTypeDef
- ListLogSubscriptionsResultTypeDef
- ListSchemaExtensionsResultTypeDef
- UpdateDirectorySetupRequestTypeDef
- UpdateValueTypeDef
- RadiusSettingsUnionTypeDef
- UpdateSettingsRequestTypeDef
- ShareDirectoryRequestTypeDef
- UnshareDirectoryRequestTypeDef
- CreateComputerResultTypeDef
- DescribeCertificateResultTypeDef
- DirectoryDescriptionTypeDef
- DescribeRegionsResultTypeDef
- AddRegionRequestTypeDef
- CreateDirectoryRequestTypeDef
- CreateMicrosoftADRequestTypeDef
- UpdateInfoEntryTypeDef
- EnableRadiusRequestTypeDef
- UpdateRadiusRequestTypeDef
- DescribeDirectoriesResultTypeDef
- DescribeUpdateDirectoryResultTypeDef