DirectoryService module#
Index > DirectoryService
Auto-generated documentation for DirectoryService type annotations stubs module mypy-boto3-ds.
How to install#
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 boto3-stubs
for DirectoryService
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ds]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ds]'
# standalone installation
python -m pip install mypy-boto3-ds
How to uninstall#
python -m pip uninstall -y mypy-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 mypy_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 mypy_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 schemas.
# CertificateStateType usage example
from mypy_boto3_ds.literals import CertificateStateType
def get_value() -> CertificateStateType:
return "DeregisterFailed"
- CertificateStateType
- CertificateTypeType
- ClientAuthenticationStatusType
- ClientAuthenticationTypeType
- 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
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AcceptSharedDirectoryRequestRequestTypeDef usage example
from mypy_boto3_ds.type_defs import AcceptSharedDirectoryRequestRequestTypeDef
def get_value() -> AcceptSharedDirectoryRequestRequestTypeDef:
return {
"SharedDirectoryId": ...,
}
- AcceptSharedDirectoryRequestRequestTypeDef
- SharedDirectoryTypeDef
- IpRouteTypeDef
- DirectoryVpcSettingsTypeDef
- TagTypeDef
- AttributeTypeDef
- CancelSchemaExtensionRequestRequestTypeDef
- CertificateInfoTypeDef
- ClientCertAuthSettingsTypeDef
- ClientAuthenticationSettingInfoTypeDef
- ConditionalForwarderTypeDef
- DirectoryConnectSettingsTypeDef
- ConnectDirectoryResultTypeDef
- CreateAliasRequestRequestTypeDef
- CreateAliasResultTypeDef
- CreateConditionalForwarderRequestRequestTypeDef
- CreateDirectoryResultTypeDef
- CreateLogSubscriptionRequestRequestTypeDef
- CreateMicrosoftADResultTypeDef
- CreateSnapshotRequestRequestTypeDef
- CreateSnapshotResultTypeDef
- CreateTrustRequestRequestTypeDef
- CreateTrustResultTypeDef
- DeleteConditionalForwarderRequestRequestTypeDef
- DeleteDirectoryRequestRequestTypeDef
- DeleteDirectoryResultTypeDef
- DeleteLogSubscriptionRequestRequestTypeDef
- DeleteSnapshotRequestRequestTypeDef
- DeleteSnapshotResultTypeDef
- DeleteTrustRequestRequestTypeDef
- DeleteTrustResultTypeDef
- DeregisterCertificateRequestRequestTypeDef
- DeregisterEventTopicRequestRequestTypeDef
- DescribeCertificateRequestRequestTypeDef
- DescribeClientAuthenticationSettingsRequestDescribeClientAuthenticationSettingsPaginateTypeDef
- DescribeClientAuthenticationSettingsRequestRequestTypeDef
- DescribeConditionalForwardersRequestRequestTypeDef
- DescribeDirectoriesRequestDescribeDirectoriesPaginateTypeDef
- DescribeDirectoriesRequestRequestTypeDef
- DescribeDomainControllersRequestDescribeDomainControllersPaginateTypeDef
- DescribeDomainControllersRequestRequestTypeDef
- DomainControllerTypeDef
- DescribeEventTopicsRequestRequestTypeDef
- EventTopicTypeDef
- DescribeLDAPSSettingsRequestDescribeLDAPSSettingsPaginateTypeDef
- DescribeLDAPSSettingsRequestRequestTypeDef
- LDAPSSettingInfoTypeDef
- DescribeRegionsRequestDescribeRegionsPaginateTypeDef
- DescribeRegionsRequestRequestTypeDef
- DescribeSettingsRequestRequestTypeDef
- SettingEntryTypeDef
- DescribeSharedDirectoriesRequestDescribeSharedDirectoriesPaginateTypeDef
- DescribeSharedDirectoriesRequestRequestTypeDef
- DescribeSnapshotsRequestDescribeSnapshotsPaginateTypeDef
- DescribeSnapshotsRequestRequestTypeDef
- SnapshotTypeDef
- DescribeTrustsRequestDescribeTrustsPaginateTypeDef
- DescribeTrustsRequestRequestTypeDef
- TrustTypeDef
- DescribeUpdateDirectoryRequestDescribeUpdateDirectoryPaginateTypeDef
- DescribeUpdateDirectoryRequestRequestTypeDef
- DirectoryConnectSettingsDescriptionTypeDef
- DirectoryVpcSettingsDescriptionTypeDef
- RadiusSettingsTypeDef
- RegionsInfoTypeDef
- DirectoryLimitsTypeDef
- DisableClientAuthenticationRequestRequestTypeDef
- DisableLDAPSRequestRequestTypeDef
- DisableRadiusRequestRequestTypeDef
- DisableSsoRequestRequestTypeDef
- EnableClientAuthenticationRequestRequestTypeDef
- EnableLDAPSRequestRequestTypeDef
- EnableSsoRequestRequestTypeDef
- GetSnapshotLimitsRequestRequestTypeDef
- SnapshotLimitsTypeDef
- IpRouteInfoTypeDef
- ListCertificatesRequestListCertificatesPaginateTypeDef
- ListCertificatesRequestRequestTypeDef
- ListIpRoutesRequestListIpRoutesPaginateTypeDef
- ListIpRoutesRequestRequestTypeDef
- ListLogSubscriptionsRequestListLogSubscriptionsPaginateTypeDef
- ListLogSubscriptionsRequestRequestTypeDef
- LogSubscriptionTypeDef
- ListSchemaExtensionsRequestListSchemaExtensionsPaginateTypeDef
- ListSchemaExtensionsRequestRequestTypeDef
- SchemaExtensionInfoTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListTagsForResourceRequestRequestTypeDef
- OSUpdateSettingsTypeDef
- PaginatorConfigTypeDef
- RegisterCertificateResultTypeDef
- RegisterEventTopicRequestRequestTypeDef
- RejectSharedDirectoryRequestRequestTypeDef
- RejectSharedDirectoryResultTypeDef
- RemoveIpRoutesRequestRequestTypeDef
- RemoveRegionRequestRequestTypeDef
- RemoveTagsFromResourceRequestRequestTypeDef
- ResetUserPasswordRequestRequestTypeDef
- ResponseMetadataTypeDef
- RestoreFromSnapshotRequestRequestTypeDef
- SettingTypeDef
- ShareTargetTypeDef
- ShareDirectoryResultTypeDef
- StartSchemaExtensionRequestRequestTypeDef
- StartSchemaExtensionResultTypeDef
- UnshareTargetTypeDef
- UnshareDirectoryResultTypeDef
- UpdateConditionalForwarderRequestRequestTypeDef
- UpdateNumberOfDomainControllersRequestRequestTypeDef
- UpdateSettingsResultTypeDef
- UpdateTrustRequestRequestTypeDef
- UpdateTrustResultTypeDef
- VerifyTrustRequestRequestTypeDef
- VerifyTrustResultTypeDef
- AcceptSharedDirectoryResultTypeDef
- DescribeSharedDirectoriesResultTypeDef
- AddIpRoutesRequestRequestTypeDef
- AddRegionRequestRequestTypeDef
- RegionDescriptionTypeDef
- AddTagsToResourceRequestRequestTypeDef
- CreateDirectoryRequestRequestTypeDef
- CreateMicrosoftADRequestRequestTypeDef
- ListTagsForResourceResultTypeDef
- ComputerTypeDef
- CreateComputerRequestRequestTypeDef
- ListCertificatesResultTypeDef
- CertificateTypeDef
- RegisterCertificateRequestRequestTypeDef
- DescribeClientAuthenticationSettingsResultTypeDef
- DescribeConditionalForwardersResultTypeDef
- ConnectDirectoryRequestRequestTypeDef
- DescribeDomainControllersResultTypeDef
- DescribeEventTopicsResultTypeDef
- DescribeLDAPSSettingsResultTypeDef
- DescribeSettingsResultTypeDef
- DescribeSnapshotsResultTypeDef
- DescribeTrustsResultTypeDef
- EnableRadiusRequestRequestTypeDef
- OwnerDirectoryDescriptionTypeDef
- UpdateRadiusRequestRequestTypeDef
- GetDirectoryLimitsResultTypeDef
- GetSnapshotLimitsResultTypeDef
- ListIpRoutesResultTypeDef
- ListLogSubscriptionsResultTypeDef
- ListSchemaExtensionsResultTypeDef
- UpdateDirectorySetupRequestRequestTypeDef
- UpdateValueTypeDef
- UpdateSettingsRequestRequestTypeDef
- ShareDirectoryRequestRequestTypeDef
- UnshareDirectoryRequestRequestTypeDef
- DescribeRegionsResultTypeDef
- CreateComputerResultTypeDef
- DescribeCertificateResultTypeDef
- DirectoryDescriptionTypeDef
- UpdateInfoEntryTypeDef
- DescribeDirectoriesResultTypeDef
- DescribeUpdateDirectoryResultTypeDef