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
Usage
Code samples can be found in Examples.
DirectoryServiceClient
Type annotations and code completion for boto3.client("ds")
as DirectoryServiceClient
boto3 documentation
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("...")
.
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.
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.
Usage example
from mypy_boto3_ds.type_defs import AcceptSharedDirectoryRequestRequestTypeDef
def get_value() -> AcceptSharedDirectoryRequestRequestTypeDef:
return {
"SharedDirectoryId": ...,
}
- AcceptSharedDirectoryRequestRequestTypeDef
- ResponseMetadataTypeDef
- SharedDirectoryTypeDef
- IpRouteTypeDef
- DirectoryVpcSettingsTypeDef
- TagTypeDef
- AttributeTypeDef
- CancelSchemaExtensionRequestRequestTypeDef
- CertificateInfoTypeDef
- ClientCertAuthSettingsTypeDef
- ClientAuthenticationSettingInfoTypeDef
- ConditionalForwarderTypeDef
- DirectoryConnectSettingsTypeDef
- CreateAliasRequestRequestTypeDef
- CreateConditionalForwarderRequestRequestTypeDef
- CreateLogSubscriptionRequestRequestTypeDef
- CreateSnapshotRequestRequestTypeDef
- CreateTrustRequestRequestTypeDef
- DeleteConditionalForwarderRequestRequestTypeDef
- DeleteDirectoryRequestRequestTypeDef
- DeleteLogSubscriptionRequestRequestTypeDef
- DeleteSnapshotRequestRequestTypeDef
- DeleteTrustRequestRequestTypeDef
- DeregisterCertificateRequestRequestTypeDef
- DeregisterEventTopicRequestRequestTypeDef
- DescribeCertificateRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeClientAuthenticationSettingsRequestRequestTypeDef
- DescribeConditionalForwardersRequestRequestTypeDef
- DescribeDirectoriesRequestRequestTypeDef
- DescribeDomainControllersRequestRequestTypeDef
- DomainControllerTypeDef
- DescribeEventTopicsRequestRequestTypeDef
- EventTopicTypeDef
- DescribeLDAPSSettingsRequestRequestTypeDef
- LDAPSSettingInfoTypeDef
- DescribeRegionsRequestRequestTypeDef
- DescribeSettingsRequestRequestTypeDef
- SettingEntryTypeDef
- DescribeSharedDirectoriesRequestRequestTypeDef
- DescribeSnapshotsRequestRequestTypeDef
- SnapshotTypeDef
- DescribeTrustsRequestRequestTypeDef
- TrustTypeDef
- DescribeUpdateDirectoryRequestRequestTypeDef
- DirectoryConnectSettingsDescriptionTypeDef
- DirectoryVpcSettingsDescriptionTypeDef
- RadiusSettingsTypeDef
- RegionsInfoTypeDef
- DirectoryLimitsTypeDef
- DisableClientAuthenticationRequestRequestTypeDef
- DisableLDAPSRequestRequestTypeDef
- DisableRadiusRequestRequestTypeDef
- DisableSsoRequestRequestTypeDef
- EnableClientAuthenticationRequestRequestTypeDef
- EnableLDAPSRequestRequestTypeDef
- EnableSsoRequestRequestTypeDef
- GetSnapshotLimitsRequestRequestTypeDef
- SnapshotLimitsTypeDef
- IpRouteInfoTypeDef
- ListCertificatesRequestRequestTypeDef
- ListIpRoutesRequestRequestTypeDef
- ListLogSubscriptionsRequestRequestTypeDef
- LogSubscriptionTypeDef
- ListSchemaExtensionsRequestRequestTypeDef
- SchemaExtensionInfoTypeDef
- ListTagsForResourceRequestRequestTypeDef
- OSUpdateSettingsTypeDef
- RegisterEventTopicRequestRequestTypeDef
- RejectSharedDirectoryRequestRequestTypeDef
- RemoveIpRoutesRequestRequestTypeDef
- RemoveRegionRequestRequestTypeDef
- RemoveTagsFromResourceRequestRequestTypeDef
- ResetUserPasswordRequestRequestTypeDef
- RestoreFromSnapshotRequestRequestTypeDef
- SettingTypeDef
- ShareTargetTypeDef
- StartSchemaExtensionRequestRequestTypeDef
- UnshareTargetTypeDef
- UpdateConditionalForwarderRequestRequestTypeDef
- UpdateNumberOfDomainControllersRequestRequestTypeDef
- UpdateTrustRequestRequestTypeDef
- VerifyTrustRequestRequestTypeDef
- ConnectDirectoryResultTypeDef
- CreateAliasResultTypeDef
- CreateDirectoryResultTypeDef
- CreateMicrosoftADResultTypeDef
- CreateSnapshotResultTypeDef
- CreateTrustResultTypeDef
- DeleteDirectoryResultTypeDef
- DeleteSnapshotResultTypeDef
- DeleteTrustResultTypeDef
- RegisterCertificateResultTypeDef
- RejectSharedDirectoryResultTypeDef
- ShareDirectoryResultTypeDef
- StartSchemaExtensionResultTypeDef
- UnshareDirectoryResultTypeDef
- UpdateSettingsResultTypeDef
- UpdateTrustResultTypeDef
- VerifyTrustResultTypeDef
- AcceptSharedDirectoryResultTypeDef
- DescribeSharedDirectoriesResultTypeDef
- AddIpRoutesRequestRequestTypeDef
- AddRegionRequestRequestTypeDef
- RegionDescriptionTypeDef
- AddTagsToResourceRequestRequestTypeDef
- CreateDirectoryRequestRequestTypeDef
- CreateMicrosoftADRequestRequestTypeDef
- ListTagsForResourceResultTypeDef
- ComputerTypeDef
- CreateComputerRequestRequestTypeDef
- ListCertificatesResultTypeDef
- CertificateTypeDef
- RegisterCertificateRequestRequestTypeDef
- DescribeClientAuthenticationSettingsResultTypeDef
- DescribeConditionalForwardersResultTypeDef
- ConnectDirectoryRequestRequestTypeDef
- DescribeClientAuthenticationSettingsRequestDescribeClientAuthenticationSettingsPaginateTypeDef
- DescribeDirectoriesRequestDescribeDirectoriesPaginateTypeDef
- DescribeDomainControllersRequestDescribeDomainControllersPaginateTypeDef
- DescribeLDAPSSettingsRequestDescribeLDAPSSettingsPaginateTypeDef
- DescribeRegionsRequestDescribeRegionsPaginateTypeDef
- DescribeSharedDirectoriesRequestDescribeSharedDirectoriesPaginateTypeDef
- DescribeSnapshotsRequestDescribeSnapshotsPaginateTypeDef
- DescribeTrustsRequestDescribeTrustsPaginateTypeDef
- DescribeUpdateDirectoryRequestDescribeUpdateDirectoryPaginateTypeDef
- ListCertificatesRequestListCertificatesPaginateTypeDef
- ListIpRoutesRequestListIpRoutesPaginateTypeDef
- ListLogSubscriptionsRequestListLogSubscriptionsPaginateTypeDef
- ListSchemaExtensionsRequestListSchemaExtensionsPaginateTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- 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