Typed dictionaries
Index > DirectoryService > Typed dictionaries
Auto-generated documentation for DirectoryService type annotations stubs module mypy-boto3-ds.
AcceptSharedDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import AcceptSharedDirectoryRequestRequestTypeDef
def get_value() -> AcceptSharedDirectoryRequestRequestTypeDef:
return {
"SharedDirectoryId": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
SharedDirectoryTypeDef
Usage Example
from mypy_boto3_ds.type_defs import SharedDirectoryTypeDef
def get_value() -> SharedDirectoryTypeDef:
return {
"OwnerAccountId": ...,
}
Definition
class SharedDirectoryTypeDef(TypedDict):
OwnerAccountId: NotRequired[str],
OwnerDirectoryId: NotRequired[str],
ShareMethod: NotRequired[ShareMethodType], # (1)
SharedAccountId: NotRequired[str],
SharedDirectoryId: NotRequired[str],
ShareStatus: NotRequired[ShareStatusType], # (2)
ShareNotes: NotRequired[str],
CreatedDateTime: NotRequired[datetime],
LastUpdatedDateTime: NotRequired[datetime],
- See ShareMethodType
- See ShareStatusType
IpRouteTypeDef
Usage Example
from mypy_boto3_ds.type_defs import IpRouteTypeDef
def get_value() -> IpRouteTypeDef:
return {
"CidrIp": ...,
}
DirectoryVpcSettingsTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DirectoryVpcSettingsTypeDef
def get_value() -> DirectoryVpcSettingsTypeDef:
return {
"VpcId": ...,
"SubnetIds": ...,
}
TagTypeDef
Usage Example
from mypy_boto3_ds.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
AttributeTypeDef
Usage Example
from mypy_boto3_ds.type_defs import AttributeTypeDef
def get_value() -> AttributeTypeDef:
return {
"Name": ...,
}
CancelSchemaExtensionRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CancelSchemaExtensionRequestRequestTypeDef
def get_value() -> CancelSchemaExtensionRequestRequestTypeDef:
return {
"DirectoryId": ...,
"SchemaExtensionId": ...,
}
Definition
class CancelSchemaExtensionRequestRequestTypeDef(TypedDict):
DirectoryId: str,
SchemaExtensionId: str,
CertificateInfoTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CertificateInfoTypeDef
def get_value() -> CertificateInfoTypeDef:
return {
"CertificateId": ...,
}
Definition
class CertificateInfoTypeDef(TypedDict):
CertificateId: NotRequired[str],
CommonName: NotRequired[str],
State: NotRequired[CertificateStateType], # (1)
ExpiryDateTime: NotRequired[datetime],
Type: NotRequired[CertificateTypeType], # (2)
ClientCertAuthSettingsTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ClientCertAuthSettingsTypeDef
def get_value() -> ClientCertAuthSettingsTypeDef:
return {
"OCSPUrl": ...,
}
ClientAuthenticationSettingInfoTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ClientAuthenticationSettingInfoTypeDef
def get_value() -> ClientAuthenticationSettingInfoTypeDef:
return {
"Type": ...,
}
Definition
class ClientAuthenticationSettingInfoTypeDef(TypedDict):
Type: NotRequired[ClientAuthenticationTypeType], # (1)
Status: NotRequired[ClientAuthenticationStatusType], # (2)
LastUpdatedDateTime: NotRequired[datetime],
ConditionalForwarderTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ConditionalForwarderTypeDef
def get_value() -> ConditionalForwarderTypeDef:
return {
"RemoteDomainName": ...,
}
Definition
class ConditionalForwarderTypeDef(TypedDict):
RemoteDomainName: NotRequired[str],
DnsIpAddrs: NotRequired[List[str]],
ReplicationScope: NotRequired[ReplicationScopeType], # (1)
DirectoryConnectSettingsTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DirectoryConnectSettingsTypeDef
def get_value() -> DirectoryConnectSettingsTypeDef:
return {
"VpcId": ...,
"SubnetIds": ...,
"CustomerDnsIps": ...,
"CustomerUserName": ...,
}
Definition
class DirectoryConnectSettingsTypeDef(TypedDict):
VpcId: str,
SubnetIds: Sequence[str],
CustomerDnsIps: Sequence[str],
CustomerUserName: str,
CreateAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateAliasRequestRequestTypeDef
def get_value() -> CreateAliasRequestRequestTypeDef:
return {
"DirectoryId": ...,
"Alias": ...,
}
CreateConditionalForwarderRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateConditionalForwarderRequestRequestTypeDef
def get_value() -> CreateConditionalForwarderRequestRequestTypeDef:
return {
"DirectoryId": ...,
"RemoteDomainName": ...,
"DnsIpAddrs": ...,
}
Definition
class CreateConditionalForwarderRequestRequestTypeDef(TypedDict):
DirectoryId: str,
RemoteDomainName: str,
DnsIpAddrs: Sequence[str],
CreateLogSubscriptionRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateLogSubscriptionRequestRequestTypeDef
def get_value() -> CreateLogSubscriptionRequestRequestTypeDef:
return {
"DirectoryId": ...,
"LogGroupName": ...,
}
Definition
class CreateLogSubscriptionRequestRequestTypeDef(TypedDict):
DirectoryId: str,
LogGroupName: str,
CreateSnapshotRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateSnapshotRequestRequestTypeDef
def get_value() -> CreateSnapshotRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class CreateSnapshotRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Name: NotRequired[str],
CreateTrustRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateTrustRequestRequestTypeDef
def get_value() -> CreateTrustRequestRequestTypeDef:
return {
"DirectoryId": ...,
"RemoteDomainName": ...,
"TrustPassword": ...,
"TrustDirection": ...,
}
Definition
class CreateTrustRequestRequestTypeDef(TypedDict):
DirectoryId: str,
RemoteDomainName: str,
TrustPassword: str,
TrustDirection: TrustDirectionType, # (1)
TrustType: NotRequired[TrustTypeType], # (2)
ConditionalForwarderIpAddrs: NotRequired[Sequence[str]],
SelectiveAuth: NotRequired[SelectiveAuthType], # (3)
- See TrustDirectionType
- See TrustTypeType
- See SelectiveAuthType
DeleteConditionalForwarderRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteConditionalForwarderRequestRequestTypeDef
def get_value() -> DeleteConditionalForwarderRequestRequestTypeDef:
return {
"DirectoryId": ...,
"RemoteDomainName": ...,
}
Definition
class DeleteConditionalForwarderRequestRequestTypeDef(TypedDict):
DirectoryId: str,
RemoteDomainName: str,
DeleteDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteDirectoryRequestRequestTypeDef
def get_value() -> DeleteDirectoryRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
DeleteLogSubscriptionRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteLogSubscriptionRequestRequestTypeDef
def get_value() -> DeleteLogSubscriptionRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
DeleteSnapshotRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteSnapshotRequestRequestTypeDef
def get_value() -> DeleteSnapshotRequestRequestTypeDef:
return {
"SnapshotId": ...,
}
DeleteTrustRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteTrustRequestRequestTypeDef
def get_value() -> DeleteTrustRequestRequestTypeDef:
return {
"TrustId": ...,
}
Definition
class DeleteTrustRequestRequestTypeDef(TypedDict):
TrustId: str,
DeleteAssociatedConditionalForwarder: NotRequired[bool],
DeregisterCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeregisterCertificateRequestRequestTypeDef
def get_value() -> DeregisterCertificateRequestRequestTypeDef:
return {
"DirectoryId": ...,
"CertificateId": ...,
}
Definition
class DeregisterCertificateRequestRequestTypeDef(TypedDict):
DirectoryId: str,
CertificateId: str,
DeregisterEventTopicRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeregisterEventTopicRequestRequestTypeDef
def get_value() -> DeregisterEventTopicRequestRequestTypeDef:
return {
"DirectoryId": ...,
"TopicName": ...,
}
Definition
class DeregisterEventTopicRequestRequestTypeDef(TypedDict):
DirectoryId: str,
TopicName: str,
DescribeCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeCertificateRequestRequestTypeDef
def get_value() -> DescribeCertificateRequestRequestTypeDef:
return {
"DirectoryId": ...,
"CertificateId": ...,
}
Definition
class DescribeCertificateRequestRequestTypeDef(TypedDict):
DirectoryId: str,
CertificateId: str,
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_ds.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeClientAuthenticationSettingsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeClientAuthenticationSettingsRequestRequestTypeDef
def get_value() -> DescribeClientAuthenticationSettingsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeClientAuthenticationSettingsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Type: NotRequired[ClientAuthenticationTypeType], # (1)
NextToken: NotRequired[str],
Limit: NotRequired[int],
DescribeConditionalForwardersRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeConditionalForwardersRequestRequestTypeDef
def get_value() -> DescribeConditionalForwardersRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeConditionalForwardersRequestRequestTypeDef(TypedDict):
DirectoryId: str,
RemoteDomainNames: NotRequired[Sequence[str]],
DescribeDirectoriesRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeDirectoriesRequestRequestTypeDef
def get_value() -> DescribeDirectoriesRequestRequestTypeDef:
return {
"DirectoryIds": ...,
}
Definition
class DescribeDirectoriesRequestRequestTypeDef(TypedDict):
DirectoryIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
Limit: NotRequired[int],
DescribeDomainControllersRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeDomainControllersRequestRequestTypeDef
def get_value() -> DescribeDomainControllersRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeDomainControllersRequestRequestTypeDef(TypedDict):
DirectoryId: str,
DomainControllerIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
Limit: NotRequired[int],
DomainControllerTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DomainControllerTypeDef
def get_value() -> DomainControllerTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DomainControllerTypeDef(TypedDict):
DirectoryId: NotRequired[str],
DomainControllerId: NotRequired[str],
DnsIpAddr: NotRequired[str],
VpcId: NotRequired[str],
SubnetId: NotRequired[str],
AvailabilityZone: NotRequired[str],
Status: NotRequired[DomainControllerStatusType], # (1)
StatusReason: NotRequired[str],
LaunchTime: NotRequired[datetime],
StatusLastUpdatedDateTime: NotRequired[datetime],
DescribeEventTopicsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeEventTopicsRequestRequestTypeDef
def get_value() -> DescribeEventTopicsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeEventTopicsRequestRequestTypeDef(TypedDict):
DirectoryId: NotRequired[str],
TopicNames: NotRequired[Sequence[str]],
EventTopicTypeDef
Usage Example
from mypy_boto3_ds.type_defs import EventTopicTypeDef
def get_value() -> EventTopicTypeDef:
return {
"DirectoryId": ...,
}
Definition
class EventTopicTypeDef(TypedDict):
DirectoryId: NotRequired[str],
TopicName: NotRequired[str],
TopicArn: NotRequired[str],
CreatedDateTime: NotRequired[datetime],
Status: NotRequired[TopicStatusType], # (1)
- See TopicStatusType
DescribeLDAPSSettingsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeLDAPSSettingsRequestRequestTypeDef
def get_value() -> DescribeLDAPSSettingsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeLDAPSSettingsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Type: NotRequired[LDAPSTypeType], # (1)
NextToken: NotRequired[str],
Limit: NotRequired[int],
- See LDAPSTypeType
LDAPSSettingInfoTypeDef
Usage Example
from mypy_boto3_ds.type_defs import LDAPSSettingInfoTypeDef
def get_value() -> LDAPSSettingInfoTypeDef:
return {
"LDAPSStatus": ...,
}
Definition
class LDAPSSettingInfoTypeDef(TypedDict):
LDAPSStatus: NotRequired[LDAPSStatusType], # (1)
LDAPSStatusReason: NotRequired[str],
LastUpdatedDateTime: NotRequired[datetime],
- See LDAPSStatusType
DescribeRegionsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeRegionsRequestRequestTypeDef
def get_value() -> DescribeRegionsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeRegionsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
RegionName: NotRequired[str],
NextToken: NotRequired[str],
DescribeSettingsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeSettingsRequestRequestTypeDef
def get_value() -> DescribeSettingsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeSettingsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Status: NotRequired[DirectoryConfigurationStatusType], # (1)
NextToken: NotRequired[str],
SettingEntryTypeDef
Usage Example
from mypy_boto3_ds.type_defs import SettingEntryTypeDef
def get_value() -> SettingEntryTypeDef:
return {
"Type": ...,
}
Definition
class SettingEntryTypeDef(TypedDict):
Type: NotRequired[str],
Name: NotRequired[str],
AllowedValues: NotRequired[str],
AppliedValue: NotRequired[str],
RequestedValue: NotRequired[str],
RequestStatus: NotRequired[DirectoryConfigurationStatusType], # (1)
RequestDetailedStatus: NotRequired[Dict[str, DirectoryConfigurationStatusType]], # (2)
RequestStatusMessage: NotRequired[str],
LastUpdatedDateTime: NotRequired[datetime],
LastRequestedDateTime: NotRequired[datetime],
DescribeSharedDirectoriesRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeSharedDirectoriesRequestRequestTypeDef
def get_value() -> DescribeSharedDirectoriesRequestRequestTypeDef:
return {
"OwnerDirectoryId": ...,
}
Definition
class DescribeSharedDirectoriesRequestRequestTypeDef(TypedDict):
OwnerDirectoryId: str,
SharedDirectoryIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
Limit: NotRequired[int],
DescribeSnapshotsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeSnapshotsRequestRequestTypeDef
def get_value() -> DescribeSnapshotsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeSnapshotsRequestRequestTypeDef(TypedDict):
DirectoryId: NotRequired[str],
SnapshotIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
Limit: NotRequired[int],
SnapshotTypeDef
Usage Example
from mypy_boto3_ds.type_defs import SnapshotTypeDef
def get_value() -> SnapshotTypeDef:
return {
"DirectoryId": ...,
}
Definition
class SnapshotTypeDef(TypedDict):
DirectoryId: NotRequired[str],
SnapshotId: NotRequired[str],
Type: NotRequired[SnapshotTypeType], # (1)
Name: NotRequired[str],
Status: NotRequired[SnapshotStatusType], # (2)
StartTime: NotRequired[datetime],
- See SnapshotTypeType
- See SnapshotStatusType
DescribeTrustsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeTrustsRequestRequestTypeDef
def get_value() -> DescribeTrustsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DescribeTrustsRequestRequestTypeDef(TypedDict):
DirectoryId: NotRequired[str],
TrustIds: NotRequired[Sequence[str]],
NextToken: NotRequired[str],
Limit: NotRequired[int],
TrustTypeDef
Usage Example
from mypy_boto3_ds.type_defs import TrustTypeDef
def get_value() -> TrustTypeDef:
return {
"DirectoryId": ...,
}
Definition
class TrustTypeDef(TypedDict):
DirectoryId: NotRequired[str],
TrustId: NotRequired[str],
RemoteDomainName: NotRequired[str],
TrustType: NotRequired[TrustTypeType], # (1)
TrustDirection: NotRequired[TrustDirectionType], # (2)
TrustState: NotRequired[TrustStateType], # (3)
CreatedDateTime: NotRequired[datetime],
LastUpdatedDateTime: NotRequired[datetime],
StateLastUpdatedDateTime: NotRequired[datetime],
TrustStateReason: NotRequired[str],
SelectiveAuth: NotRequired[SelectiveAuthType], # (4)
- See TrustTypeType
- See TrustDirectionType
- See TrustStateType
- See SelectiveAuthType
DescribeUpdateDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeUpdateDirectoryRequestRequestTypeDef
def get_value() -> DescribeUpdateDirectoryRequestRequestTypeDef:
return {
"DirectoryId": ...,
"UpdateType": ...,
}
Definition
class DescribeUpdateDirectoryRequestRequestTypeDef(TypedDict):
DirectoryId: str,
UpdateType: UpdateTypeType, # (1)
RegionName: NotRequired[str],
NextToken: NotRequired[str],
- See UpdateTypeType
DirectoryConnectSettingsDescriptionTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DirectoryConnectSettingsDescriptionTypeDef
def get_value() -> DirectoryConnectSettingsDescriptionTypeDef:
return {
"VpcId": ...,
}
Definition
class DirectoryConnectSettingsDescriptionTypeDef(TypedDict):
VpcId: NotRequired[str],
SubnetIds: NotRequired[List[str]],
CustomerUserName: NotRequired[str],
SecurityGroupId: NotRequired[str],
AvailabilityZones: NotRequired[List[str]],
ConnectIps: NotRequired[List[str]],
DirectoryVpcSettingsDescriptionTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DirectoryVpcSettingsDescriptionTypeDef
def get_value() -> DirectoryVpcSettingsDescriptionTypeDef:
return {
"VpcId": ...,
}
Definition
class DirectoryVpcSettingsDescriptionTypeDef(TypedDict):
VpcId: NotRequired[str],
SubnetIds: NotRequired[List[str]],
SecurityGroupId: NotRequired[str],
AvailabilityZones: NotRequired[List[str]],
RadiusSettingsTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RadiusSettingsTypeDef
def get_value() -> RadiusSettingsTypeDef:
return {
"RadiusServers": ...,
}
Definition
class RadiusSettingsTypeDef(TypedDict):
RadiusServers: NotRequired[List[str]],
RadiusPort: NotRequired[int],
RadiusTimeout: NotRequired[int],
RadiusRetries: NotRequired[int],
SharedSecret: NotRequired[str],
AuthenticationProtocol: NotRequired[RadiusAuthenticationProtocolType], # (1)
DisplayLabel: NotRequired[str],
UseSameUsername: NotRequired[bool],
RegionsInfoTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RegionsInfoTypeDef
def get_value() -> RegionsInfoTypeDef:
return {
"PrimaryRegion": ...,
}
Definition
class RegionsInfoTypeDef(TypedDict):
PrimaryRegion: NotRequired[str],
AdditionalRegions: NotRequired[List[str]],
DirectoryLimitsTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DirectoryLimitsTypeDef
def get_value() -> DirectoryLimitsTypeDef:
return {
"CloudOnlyDirectoriesLimit": ...,
}
Definition
class DirectoryLimitsTypeDef(TypedDict):
CloudOnlyDirectoriesLimit: NotRequired[int],
CloudOnlyDirectoriesCurrentCount: NotRequired[int],
CloudOnlyDirectoriesLimitReached: NotRequired[bool],
CloudOnlyMicrosoftADLimit: NotRequired[int],
CloudOnlyMicrosoftADCurrentCount: NotRequired[int],
CloudOnlyMicrosoftADLimitReached: NotRequired[bool],
ConnectedDirectoriesLimit: NotRequired[int],
ConnectedDirectoriesCurrentCount: NotRequired[int],
ConnectedDirectoriesLimitReached: NotRequired[bool],
DisableClientAuthenticationRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DisableClientAuthenticationRequestRequestTypeDef
def get_value() -> DisableClientAuthenticationRequestRequestTypeDef:
return {
"DirectoryId": ...,
"Type": ...,
}
Definition
class DisableClientAuthenticationRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Type: ClientAuthenticationTypeType, # (1)
DisableLDAPSRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DisableLDAPSRequestRequestTypeDef
def get_value() -> DisableLDAPSRequestRequestTypeDef:
return {
"DirectoryId": ...,
"Type": ...,
}
Definition
class DisableLDAPSRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Type: LDAPSTypeType, # (1)
- See LDAPSTypeType
DisableRadiusRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DisableRadiusRequestRequestTypeDef
def get_value() -> DisableRadiusRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
DisableSsoRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DisableSsoRequestRequestTypeDef
def get_value() -> DisableSsoRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class DisableSsoRequestRequestTypeDef(TypedDict):
DirectoryId: str,
UserName: NotRequired[str],
Password: NotRequired[str],
EnableClientAuthenticationRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import EnableClientAuthenticationRequestRequestTypeDef
def get_value() -> EnableClientAuthenticationRequestRequestTypeDef:
return {
"DirectoryId": ...,
"Type": ...,
}
Definition
class EnableClientAuthenticationRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Type: ClientAuthenticationTypeType, # (1)
EnableLDAPSRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import EnableLDAPSRequestRequestTypeDef
def get_value() -> EnableLDAPSRequestRequestTypeDef:
return {
"DirectoryId": ...,
"Type": ...,
}
Definition
class EnableLDAPSRequestRequestTypeDef(TypedDict):
DirectoryId: str,
Type: LDAPSTypeType, # (1)
- See LDAPSTypeType
EnableSsoRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import EnableSsoRequestRequestTypeDef
def get_value() -> EnableSsoRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class EnableSsoRequestRequestTypeDef(TypedDict):
DirectoryId: str,
UserName: NotRequired[str],
Password: NotRequired[str],
GetSnapshotLimitsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import GetSnapshotLimitsRequestRequestTypeDef
def get_value() -> GetSnapshotLimitsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
SnapshotLimitsTypeDef
Usage Example
from mypy_boto3_ds.type_defs import SnapshotLimitsTypeDef
def get_value() -> SnapshotLimitsTypeDef:
return {
"ManualSnapshotsLimit": ...,
}
Definition
class SnapshotLimitsTypeDef(TypedDict):
ManualSnapshotsLimit: NotRequired[int],
ManualSnapshotsCurrentCount: NotRequired[int],
ManualSnapshotsLimitReached: NotRequired[bool],
IpRouteInfoTypeDef
Usage Example
from mypy_boto3_ds.type_defs import IpRouteInfoTypeDef
def get_value() -> IpRouteInfoTypeDef:
return {
"DirectoryId": ...,
}
Definition
class IpRouteInfoTypeDef(TypedDict):
DirectoryId: NotRequired[str],
CidrIp: NotRequired[str],
IpRouteStatusMsg: NotRequired[IpRouteStatusMsgType], # (1)
AddedDateTime: NotRequired[datetime],
IpRouteStatusReason: NotRequired[str],
Description: NotRequired[str],
ListCertificatesRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ListCertificatesRequestRequestTypeDef
def get_value() -> ListCertificatesRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class ListCertificatesRequestRequestTypeDef(TypedDict):
DirectoryId: str,
NextToken: NotRequired[str],
Limit: NotRequired[int],
ListIpRoutesRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ListIpRoutesRequestRequestTypeDef
def get_value() -> ListIpRoutesRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class ListIpRoutesRequestRequestTypeDef(TypedDict):
DirectoryId: str,
NextToken: NotRequired[str],
Limit: NotRequired[int],
ListLogSubscriptionsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ListLogSubscriptionsRequestRequestTypeDef
def get_value() -> ListLogSubscriptionsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class ListLogSubscriptionsRequestRequestTypeDef(TypedDict):
DirectoryId: NotRequired[str],
NextToken: NotRequired[str],
Limit: NotRequired[int],
LogSubscriptionTypeDef
Usage Example
from mypy_boto3_ds.type_defs import LogSubscriptionTypeDef
def get_value() -> LogSubscriptionTypeDef:
return {
"DirectoryId": ...,
}
Definition
class LogSubscriptionTypeDef(TypedDict):
DirectoryId: NotRequired[str],
LogGroupName: NotRequired[str],
SubscriptionCreatedDateTime: NotRequired[datetime],
ListSchemaExtensionsRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ListSchemaExtensionsRequestRequestTypeDef
def get_value() -> ListSchemaExtensionsRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
Definition
class ListSchemaExtensionsRequestRequestTypeDef(TypedDict):
DirectoryId: str,
NextToken: NotRequired[str],
Limit: NotRequired[int],
SchemaExtensionInfoTypeDef
Usage Example
from mypy_boto3_ds.type_defs import SchemaExtensionInfoTypeDef
def get_value() -> SchemaExtensionInfoTypeDef:
return {
"DirectoryId": ...,
}
Definition
class SchemaExtensionInfoTypeDef(TypedDict):
DirectoryId: NotRequired[str],
SchemaExtensionId: NotRequired[str],
Description: NotRequired[str],
SchemaExtensionStatus: NotRequired[SchemaExtensionStatusType], # (1)
SchemaExtensionStatusReason: NotRequired[str],
StartDateTime: NotRequired[datetime],
EndDateTime: NotRequired[datetime],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceId": ...,
}
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceId: str,
NextToken: NotRequired[str],
Limit: NotRequired[int],
OSUpdateSettingsTypeDef
Usage Example
from mypy_boto3_ds.type_defs import OSUpdateSettingsTypeDef
def get_value() -> OSUpdateSettingsTypeDef:
return {
"OSVersion": ...,
}
- See OSVersionType
RegisterEventTopicRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RegisterEventTopicRequestRequestTypeDef
def get_value() -> RegisterEventTopicRequestRequestTypeDef:
return {
"DirectoryId": ...,
"TopicName": ...,
}
Definition
class RegisterEventTopicRequestRequestTypeDef(TypedDict):
DirectoryId: str,
TopicName: str,
RejectSharedDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RejectSharedDirectoryRequestRequestTypeDef
def get_value() -> RejectSharedDirectoryRequestRequestTypeDef:
return {
"SharedDirectoryId": ...,
}
RemoveIpRoutesRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RemoveIpRoutesRequestRequestTypeDef
def get_value() -> RemoveIpRoutesRequestRequestTypeDef:
return {
"DirectoryId": ...,
"CidrIps": ...,
}
Definition
class RemoveIpRoutesRequestRequestTypeDef(TypedDict):
DirectoryId: str,
CidrIps: Sequence[str],
RemoveRegionRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RemoveRegionRequestRequestTypeDef
def get_value() -> RemoveRegionRequestRequestTypeDef:
return {
"DirectoryId": ...,
}
RemoveTagsFromResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RemoveTagsFromResourceRequestRequestTypeDef
def get_value() -> RemoveTagsFromResourceRequestRequestTypeDef:
return {
"ResourceId": ...,
"TagKeys": ...,
}
Definition
class RemoveTagsFromResourceRequestRequestTypeDef(TypedDict):
ResourceId: str,
TagKeys: Sequence[str],
ResetUserPasswordRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ResetUserPasswordRequestRequestTypeDef
def get_value() -> ResetUserPasswordRequestRequestTypeDef:
return {
"DirectoryId": ...,
"UserName": ...,
"NewPassword": ...,
}
Definition
class ResetUserPasswordRequestRequestTypeDef(TypedDict):
DirectoryId: str,
UserName: str,
NewPassword: str,
RestoreFromSnapshotRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RestoreFromSnapshotRequestRequestTypeDef
def get_value() -> RestoreFromSnapshotRequestRequestTypeDef:
return {
"SnapshotId": ...,
}
SettingTypeDef
Usage Example
from mypy_boto3_ds.type_defs import SettingTypeDef
def get_value() -> SettingTypeDef:
return {
"Name": ...,
"Value": ...,
}
ShareTargetTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ShareTargetTypeDef
def get_value() -> ShareTargetTypeDef:
return {
"Id": ...,
"Type": ...,
}
- See TargetTypeType
StartSchemaExtensionRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import StartSchemaExtensionRequestRequestTypeDef
def get_value() -> StartSchemaExtensionRequestRequestTypeDef:
return {
"DirectoryId": ...,
"CreateSnapshotBeforeSchemaExtension": ...,
"LdifContent": ...,
"Description": ...,
}
Definition
class StartSchemaExtensionRequestRequestTypeDef(TypedDict):
DirectoryId: str,
CreateSnapshotBeforeSchemaExtension: bool,
LdifContent: str,
Description: str,
UnshareTargetTypeDef
Usage Example
from mypy_boto3_ds.type_defs import UnshareTargetTypeDef
def get_value() -> UnshareTargetTypeDef:
return {
"Id": ...,
"Type": ...,
}
- See TargetTypeType
UpdateConditionalForwarderRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import UpdateConditionalForwarderRequestRequestTypeDef
def get_value() -> UpdateConditionalForwarderRequestRequestTypeDef:
return {
"DirectoryId": ...,
"RemoteDomainName": ...,
"DnsIpAddrs": ...,
}
Definition
class UpdateConditionalForwarderRequestRequestTypeDef(TypedDict):
DirectoryId: str,
RemoteDomainName: str,
DnsIpAddrs: Sequence[str],
UpdateNumberOfDomainControllersRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import UpdateNumberOfDomainControllersRequestRequestTypeDef
def get_value() -> UpdateNumberOfDomainControllersRequestRequestTypeDef:
return {
"DirectoryId": ...,
"DesiredNumber": ...,
}
Definition
class UpdateNumberOfDomainControllersRequestRequestTypeDef(TypedDict):
DirectoryId: str,
DesiredNumber: int,
UpdateTrustRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import UpdateTrustRequestRequestTypeDef
def get_value() -> UpdateTrustRequestRequestTypeDef:
return {
"TrustId": ...,
}
Definition
class UpdateTrustRequestRequestTypeDef(TypedDict):
TrustId: str,
SelectiveAuth: NotRequired[SelectiveAuthType], # (1)
VerifyTrustRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import VerifyTrustRequestRequestTypeDef
def get_value() -> VerifyTrustRequestRequestTypeDef:
return {
"TrustId": ...,
}
ConnectDirectoryResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ConnectDirectoryResultTypeDef
def get_value() -> ConnectDirectoryResultTypeDef:
return {
"DirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class ConnectDirectoryResultTypeDef(TypedDict):
DirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAliasResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateAliasResultTypeDef
def get_value() -> CreateAliasResultTypeDef:
return {
"DirectoryId": ...,
"Alias": ...,
"ResponseMetadata": ...,
}
Definition
class CreateAliasResultTypeDef(TypedDict):
DirectoryId: str,
Alias: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDirectoryResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateDirectoryResultTypeDef
def get_value() -> CreateDirectoryResultTypeDef:
return {
"DirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDirectoryResultTypeDef(TypedDict):
DirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMicrosoftADResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateMicrosoftADResultTypeDef
def get_value() -> CreateMicrosoftADResultTypeDef:
return {
"DirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateMicrosoftADResultTypeDef(TypedDict):
DirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateSnapshotResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateSnapshotResultTypeDef
def get_value() -> CreateSnapshotResultTypeDef:
return {
"SnapshotId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateSnapshotResultTypeDef(TypedDict):
SnapshotId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTrustResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateTrustResultTypeDef
def get_value() -> CreateTrustResultTypeDef:
return {
"TrustId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateTrustResultTypeDef(TypedDict):
TrustId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDirectoryResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteDirectoryResultTypeDef
def get_value() -> DeleteDirectoryResultTypeDef:
return {
"DirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteDirectoryResultTypeDef(TypedDict):
DirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteSnapshotResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteSnapshotResultTypeDef
def get_value() -> DeleteSnapshotResultTypeDef:
return {
"SnapshotId": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteSnapshotResultTypeDef(TypedDict):
SnapshotId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTrustResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DeleteTrustResultTypeDef
def get_value() -> DeleteTrustResultTypeDef:
return {
"TrustId": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteTrustResultTypeDef(TypedDict):
TrustId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterCertificateResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RegisterCertificateResultTypeDef
def get_value() -> RegisterCertificateResultTypeDef:
return {
"CertificateId": ...,
"ResponseMetadata": ...,
}
Definition
class RegisterCertificateResultTypeDef(TypedDict):
CertificateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RejectSharedDirectoryResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RejectSharedDirectoryResultTypeDef
def get_value() -> RejectSharedDirectoryResultTypeDef:
return {
"SharedDirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class RejectSharedDirectoryResultTypeDef(TypedDict):
SharedDirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ShareDirectoryResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import ShareDirectoryResultTypeDef
def get_value() -> ShareDirectoryResultTypeDef:
return {
"SharedDirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class ShareDirectoryResultTypeDef(TypedDict):
SharedDirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartSchemaExtensionResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import StartSchemaExtensionResultTypeDef
def get_value() -> StartSchemaExtensionResultTypeDef:
return {
"SchemaExtensionId": ...,
"ResponseMetadata": ...,
}
Definition
class StartSchemaExtensionResultTypeDef(TypedDict):
SchemaExtensionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UnshareDirectoryResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import UnshareDirectoryResultTypeDef
def get_value() -> UnshareDirectoryResultTypeDef:
return {
"SharedDirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class UnshareDirectoryResultTypeDef(TypedDict):
SharedDirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateSettingsResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import UpdateSettingsResultTypeDef
def get_value() -> UpdateSettingsResultTypeDef:
return {
"DirectoryId": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateSettingsResultTypeDef(TypedDict):
DirectoryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTrustResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import UpdateTrustResultTypeDef
def get_value() -> UpdateTrustResultTypeDef:
return {
"RequestId": ...,
"TrustId": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateTrustResultTypeDef(TypedDict):
RequestId: str,
TrustId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
VerifyTrustResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import VerifyTrustResultTypeDef
def get_value() -> VerifyTrustResultTypeDef:
return {
"TrustId": ...,
"ResponseMetadata": ...,
}
Definition
class VerifyTrustResultTypeDef(TypedDict):
TrustId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AcceptSharedDirectoryResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import AcceptSharedDirectoryResultTypeDef
def get_value() -> AcceptSharedDirectoryResultTypeDef:
return {
"SharedDirectory": ...,
"ResponseMetadata": ...,
}
Definition
class AcceptSharedDirectoryResultTypeDef(TypedDict):
SharedDirectory: SharedDirectoryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeSharedDirectoriesResultTypeDef
Usage Example
from mypy_boto3_ds.type_defs import DescribeSharedDirectoriesResultTypeDef
def get_value() -> DescribeSharedDirectoriesResultTypeDef:
return {
"SharedDirectories": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeSharedDirectoriesResultTypeDef(TypedDict):
SharedDirectories: List[SharedDirectoryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AddIpRoutesRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import AddIpRoutesRequestRequestTypeDef
def get_value() -> AddIpRoutesRequestRequestTypeDef:
return {
"DirectoryId": ...,
"IpRoutes": ...,
}
Definition
class AddIpRoutesRequestRequestTypeDef(TypedDict):
DirectoryId: str,
IpRoutes: Sequence[IpRouteTypeDef], # (1)
UpdateSecurityGroupForDirectoryControllers: NotRequired[bool],
- See IpRouteTypeDef
AddRegionRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import AddRegionRequestRequestTypeDef
def get_value() -> AddRegionRequestRequestTypeDef:
return {
"DirectoryId": ...,
"RegionName": ...,
"VPCSettings": ...,
}
Definition
class AddRegionRequestRequestTypeDef(TypedDict):
DirectoryId: str,
RegionName: str,
VPCSettings: DirectoryVpcSettingsTypeDef, # (1)
RegionDescriptionTypeDef
Usage Example
from mypy_boto3_ds.type_defs import RegionDescriptionTypeDef
def get_value() -> RegionDescriptionTypeDef:
return {
"DirectoryId": ...,
}
Definition
class RegionDescriptionTypeDef(TypedDict):
DirectoryId: NotRequired[str],
RegionName: NotRequired[str],
RegionType: NotRequired[RegionTypeType], # (1)
Status: NotRequired[DirectoryStageType], # (2)
VpcSettings: NotRequired[DirectoryVpcSettingsTypeDef], # (3)
DesiredNumberOfDomainControllers: NotRequired[int],
LaunchTime: NotRequired[datetime],
StatusLastUpdatedDateTime: NotRequired[datetime],
LastUpdatedDateTime: NotRequired[datetime],
AddTagsToResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import AddTagsToResourceRequestRequestTypeDef
def get_value() -> AddTagsToResourceRequestRequestTypeDef:
return {
"ResourceId": ...,
"Tags": ...,
}
Definition
class AddTagsToResourceRequestRequestTypeDef(TypedDict):
ResourceId: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_ds.type_defs import CreateDirectoryRequestRequestTypeDef
def get_value() -> CreateDirectoryRequestRequestTypeDef:
return {
"Name": ...,
"Password": ...,
"Size": ...,
}
Definition
class CreateDirectoryRequestRequestTypeDef(TypedDict):
Name: str,
Password: str,
Size: DirectorySizeType, # (1)
ShortName: NotRequired[str],
Description: NotRequired[str],
VpcSettings: NotRequired[DirectoryVpcSettingsTypeDef], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See DirectorySizeType
- See