Skip to content

Type definitions#

Index > ServiceDiscovery > Type definitions

Auto-generated documentation for ServiceDiscovery type annotations stubs module mypy-boto3-servicediscovery.

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

HealthCheckConfigTypeDef#

# HealthCheckConfigTypeDef definition

class HealthCheckConfigTypeDef(TypedDict):
    Type: HealthCheckTypeType,  # (1)
    ResourcePath: NotRequired[str],
    FailureThreshold: NotRequired[int],
  1. See HealthCheckTypeType

HealthCheckCustomConfigTypeDef#

# HealthCheckCustomConfigTypeDef definition

class HealthCheckCustomConfigTypeDef(TypedDict):
    FailureThreshold: NotRequired[int],

DeleteNamespaceRequestRequestTypeDef#

# DeleteNamespaceRequestRequestTypeDef definition

class DeleteNamespaceRequestRequestTypeDef(TypedDict):
    Id: str,

DeleteServiceRequestRequestTypeDef#

# DeleteServiceRequestRequestTypeDef definition

class DeleteServiceRequestRequestTypeDef(TypedDict):
    Id: str,

DeregisterInstanceRequestRequestTypeDef#

# DeregisterInstanceRequestRequestTypeDef definition

class DeregisterInstanceRequestRequestTypeDef(TypedDict):
    ServiceId: str,
    InstanceId: str,

DiscoverInstancesRequestRequestTypeDef#

# DiscoverInstancesRequestRequestTypeDef definition

class DiscoverInstancesRequestRequestTypeDef(TypedDict):
    NamespaceName: str,
    ServiceName: str,
    MaxResults: NotRequired[int],
    QueryParameters: NotRequired[Mapping[str, str]],
    OptionalParameters: NotRequired[Mapping[str, str]],
    HealthStatus: NotRequired[HealthStatusFilterType],  # (1)
  1. See HealthStatusFilterType

HttpInstanceSummaryTypeDef#

# HttpInstanceSummaryTypeDef definition

class HttpInstanceSummaryTypeDef(TypedDict):
    InstanceId: NotRequired[str],
    NamespaceName: NotRequired[str],
    ServiceName: NotRequired[str],
    HealthStatus: NotRequired[HealthStatusType],  # (1)
    Attributes: NotRequired[Dict[str, str]],
  1. See HealthStatusType

DiscoverInstancesRevisionRequestRequestTypeDef#

# DiscoverInstancesRevisionRequestRequestTypeDef definition

class DiscoverInstancesRevisionRequestRequestTypeDef(TypedDict):
    NamespaceName: str,
    ServiceName: str,

DnsRecordTypeDef#

# DnsRecordTypeDef definition

class DnsRecordTypeDef(TypedDict):
    Type: RecordTypeType,  # (1)
    TTL: int,
  1. See RecordTypeType

SOATypeDef#

# SOATypeDef definition

class SOATypeDef(TypedDict):
    TTL: int,

GetInstanceRequestRequestTypeDef#

# GetInstanceRequestRequestTypeDef definition

class GetInstanceRequestRequestTypeDef(TypedDict):
    ServiceId: str,
    InstanceId: str,

InstanceTypeDef#

# InstanceTypeDef definition

class InstanceTypeDef(TypedDict):
    Id: str,
    CreatorRequestId: NotRequired[str],
    Attributes: NotRequired[Dict[str, str]],

GetInstancesHealthStatusRequestRequestTypeDef#

# GetInstancesHealthStatusRequestRequestTypeDef definition

class GetInstancesHealthStatusRequestRequestTypeDef(TypedDict):
    ServiceId: str,
    Instances: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetNamespaceRequestRequestTypeDef#

# GetNamespaceRequestRequestTypeDef definition

class GetNamespaceRequestRequestTypeDef(TypedDict):
    Id: str,

GetOperationRequestRequestTypeDef#

# GetOperationRequestRequestTypeDef definition

class GetOperationRequestRequestTypeDef(TypedDict):
    OperationId: str,

OperationTypeDef#

# OperationTypeDef definition

class OperationTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[OperationTypeType],  # (1)
    Status: NotRequired[OperationStatusType],  # (2)
    ErrorMessage: NotRequired[str],
    ErrorCode: NotRequired[str],
    CreateDate: NotRequired[datetime],
    UpdateDate: NotRequired[datetime],
    Targets: NotRequired[Dict[OperationTargetTypeType, str]],  # (3)
  1. See OperationTypeType
  2. See OperationStatusType
  3. See OperationTargetTypeType

GetServiceRequestRequestTypeDef#

# GetServiceRequestRequestTypeDef definition

class GetServiceRequestRequestTypeDef(TypedDict):
    Id: str,

HttpNamespaceChangeTypeDef#

# HttpNamespaceChangeTypeDef definition

class HttpNamespaceChangeTypeDef(TypedDict):
    Description: str,

HttpPropertiesTypeDef#

# HttpPropertiesTypeDef definition

class HttpPropertiesTypeDef(TypedDict):
    HttpName: NotRequired[str],

InstanceSummaryTypeDef#

# InstanceSummaryTypeDef definition

class InstanceSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Attributes: NotRequired[Dict[str, str]],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListInstancesRequestRequestTypeDef#

# ListInstancesRequestRequestTypeDef definition

class ListInstancesRequestRequestTypeDef(TypedDict):
    ServiceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

NamespaceFilterTypeDef#

# NamespaceFilterTypeDef definition

class NamespaceFilterTypeDef(TypedDict):
    Name: NamespaceFilterNameType,  # (1)
    Values: Sequence[str],
    Condition: NotRequired[FilterConditionType],  # (2)
  1. See NamespaceFilterNameType
  2. See FilterConditionType

OperationFilterTypeDef#

# OperationFilterTypeDef definition

class OperationFilterTypeDef(TypedDict):
    Name: OperationFilterNameType,  # (1)
    Values: Sequence[str],
    Condition: NotRequired[FilterConditionType],  # (2)
  1. See OperationFilterNameType
  2. See FilterConditionType

OperationSummaryTypeDef#

# OperationSummaryTypeDef definition

class OperationSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Status: NotRequired[OperationStatusType],  # (1)
  1. See OperationStatusType

ServiceFilterTypeDef#

# ServiceFilterTypeDef definition

class ServiceFilterTypeDef(TypedDict):
    Name: ServiceFilterNameType,  # (1)
    Values: Sequence[str],
    Condition: NotRequired[FilterConditionType],  # (2)
  1. See ServiceFilterNameType
  2. See FilterConditionType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

SOAChangeTypeDef#

# SOAChangeTypeDef definition

class SOAChangeTypeDef(TypedDict):
    TTL: int,

RegisterInstanceRequestRequestTypeDef#

# RegisterInstanceRequestRequestTypeDef definition

class RegisterInstanceRequestRequestTypeDef(TypedDict):
    ServiceId: str,
    InstanceId: str,
    Attributes: Mapping[str, str],
    CreatorRequestId: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateInstanceCustomHealthStatusRequestRequestTypeDef#

# UpdateInstanceCustomHealthStatusRequestRequestTypeDef definition

class UpdateInstanceCustomHealthStatusRequestRequestTypeDef(TypedDict):
    ServiceId: str,
    InstanceId: str,
    Status: CustomHealthStatusType,  # (1)
  1. See CustomHealthStatusType

CreateHttpNamespaceRequestRequestTypeDef#

# CreateHttpNamespaceRequestRequestTypeDef definition

class CreateHttpNamespaceRequestRequestTypeDef(TypedDict):
    Name: str,
    CreatorRequestId: NotRequired[str],
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateHttpNamespaceResponseTypeDef#

# CreateHttpNamespaceResponseTypeDef definition

class CreateHttpNamespaceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePrivateDnsNamespaceResponseTypeDef#

# CreatePrivateDnsNamespaceResponseTypeDef definition

class CreatePrivateDnsNamespaceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePublicDnsNamespaceResponseTypeDef#

# CreatePublicDnsNamespaceResponseTypeDef definition

class CreatePublicDnsNamespaceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteNamespaceResponseTypeDef#

# DeleteNamespaceResponseTypeDef definition

class DeleteNamespaceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeregisterInstanceResponseTypeDef#

# DeregisterInstanceResponseTypeDef definition

class DeregisterInstanceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DiscoverInstancesRevisionResponseTypeDef#

# DiscoverInstancesRevisionResponseTypeDef definition

class DiscoverInstancesRevisionResponseTypeDef(TypedDict):
    InstancesRevision: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetInstancesHealthStatusResponseTypeDef#

# GetInstancesHealthStatusResponseTypeDef definition

class GetInstancesHealthStatusResponseTypeDef(TypedDict):
    Status: Dict[str, HealthStatusType],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HealthStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

RegisterInstanceResponseTypeDef#

# RegisterInstanceResponseTypeDef definition

class RegisterInstanceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateHttpNamespaceResponseTypeDef#

# UpdateHttpNamespaceResponseTypeDef definition

class UpdateHttpNamespaceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePrivateDnsNamespaceResponseTypeDef#

# UpdatePrivateDnsNamespaceResponseTypeDef definition

class UpdatePrivateDnsNamespaceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePublicDnsNamespaceResponseTypeDef#

# UpdatePublicDnsNamespaceResponseTypeDef definition

class UpdatePublicDnsNamespaceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateServiceResponseTypeDef#

# UpdateServiceResponseTypeDef definition

class UpdateServiceResponseTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DiscoverInstancesResponseTypeDef#

# DiscoverInstancesResponseTypeDef definition

class DiscoverInstancesResponseTypeDef(TypedDict):
    Instances: List[HttpInstanceSummaryTypeDef],  # (1)
    InstancesRevision: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HttpInstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

DnsConfigChangeTypeDef#

# DnsConfigChangeTypeDef definition

class DnsConfigChangeTypeDef(TypedDict):
    DnsRecords: Sequence[DnsRecordTypeDef],  # (1)
  1. See DnsRecordTypeDef

DnsConfigPaginatorTypeDef#

# DnsConfigPaginatorTypeDef definition

class DnsConfigPaginatorTypeDef(TypedDict):
    DnsRecords: List[DnsRecordTypeDef],  # (2)
    NamespaceId: NotRequired[str],
    RoutingPolicy: NotRequired[RoutingPolicyType],  # (1)
  1. See RoutingPolicyType
  2. See DnsRecordTypeDef

DnsConfigTypeDef#

# DnsConfigTypeDef definition

class DnsConfigTypeDef(TypedDict):
    DnsRecords: Sequence[DnsRecordTypeDef],  # (2)
    NamespaceId: NotRequired[str],
    RoutingPolicy: NotRequired[RoutingPolicyType],  # (1)
  1. See RoutingPolicyType
  2. See DnsRecordTypeDef

DnsPropertiesTypeDef#

# DnsPropertiesTypeDef definition

class DnsPropertiesTypeDef(TypedDict):
    HostedZoneId: NotRequired[str],
    SOA: NotRequired[SOATypeDef],  # (1)
  1. See SOATypeDef

PrivateDnsPropertiesMutableTypeDef#

# PrivateDnsPropertiesMutableTypeDef definition

class PrivateDnsPropertiesMutableTypeDef(TypedDict):
    SOA: SOATypeDef,  # (1)
  1. See SOATypeDef

PublicDnsPropertiesMutableTypeDef#

# PublicDnsPropertiesMutableTypeDef definition

class PublicDnsPropertiesMutableTypeDef(TypedDict):
    SOA: SOATypeDef,  # (1)
  1. See SOATypeDef

GetInstanceResponseTypeDef#

# GetInstanceResponseTypeDef definition

class GetInstanceResponseTypeDef(TypedDict):
    Instance: InstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDef
  2. See ResponseMetadataTypeDef

GetOperationResponseTypeDef#

# GetOperationResponseTypeDef definition

class GetOperationResponseTypeDef(TypedDict):
    Operation: OperationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OperationTypeDef
  2. See ResponseMetadataTypeDef

UpdateHttpNamespaceRequestRequestTypeDef#

# UpdateHttpNamespaceRequestRequestTypeDef definition

class UpdateHttpNamespaceRequestRequestTypeDef(TypedDict):
    Id: str,
    Namespace: HttpNamespaceChangeTypeDef,  # (1)
    UpdaterRequestId: NotRequired[str],
  1. See HttpNamespaceChangeTypeDef

ListInstancesResponseTypeDef#

# ListInstancesResponseTypeDef definition

class ListInstancesResponseTypeDef(TypedDict):
    Instances: List[InstanceSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListInstancesRequestListInstancesPaginateTypeDef#

# ListInstancesRequestListInstancesPaginateTypeDef definition

class ListInstancesRequestListInstancesPaginateTypeDef(TypedDict):
    ServiceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListNamespacesRequestListNamespacesPaginateTypeDef#

# ListNamespacesRequestListNamespacesPaginateTypeDef definition

class ListNamespacesRequestListNamespacesPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[NamespaceFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See NamespaceFilterTypeDef
  2. See PaginatorConfigTypeDef

ListNamespacesRequestRequestTypeDef#

# ListNamespacesRequestRequestTypeDef definition

class ListNamespacesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[NamespaceFilterTypeDef]],  # (1)
  1. See NamespaceFilterTypeDef

ListOperationsRequestListOperationsPaginateTypeDef#

# ListOperationsRequestListOperationsPaginateTypeDef definition

class ListOperationsRequestListOperationsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[OperationFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OperationFilterTypeDef
  2. See PaginatorConfigTypeDef

ListOperationsRequestRequestTypeDef#

# ListOperationsRequestRequestTypeDef definition

class ListOperationsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[OperationFilterTypeDef]],  # (1)
  1. See OperationFilterTypeDef

ListOperationsResponseTypeDef#

# ListOperationsResponseTypeDef definition

class ListOperationsResponseTypeDef(TypedDict):
    Operations: List[OperationSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OperationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListServicesRequestListServicesPaginateTypeDef#

# ListServicesRequestListServicesPaginateTypeDef definition

class ListServicesRequestListServicesPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[ServiceFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ServiceFilterTypeDef
  2. See PaginatorConfigTypeDef

ListServicesRequestRequestTypeDef#

# ListServicesRequestRequestTypeDef definition

class ListServicesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[ServiceFilterTypeDef]],  # (1)
  1. See ServiceFilterTypeDef

PrivateDnsPropertiesMutableChangeTypeDef#

# PrivateDnsPropertiesMutableChangeTypeDef definition

class PrivateDnsPropertiesMutableChangeTypeDef(TypedDict):
    SOA: SOAChangeTypeDef,  # (1)
  1. See SOAChangeTypeDef

PublicDnsPropertiesMutableChangeTypeDef#

# PublicDnsPropertiesMutableChangeTypeDef definition

class PublicDnsPropertiesMutableChangeTypeDef(TypedDict):
    SOA: SOAChangeTypeDef,  # (1)
  1. See SOAChangeTypeDef

ServiceChangeTypeDef#

# ServiceChangeTypeDef definition

class ServiceChangeTypeDef(TypedDict):
    Description: NotRequired[str],
    DnsConfig: NotRequired[DnsConfigChangeTypeDef],  # (1)
    HealthCheckConfig: NotRequired[HealthCheckConfigTypeDef],  # (2)
  1. See DnsConfigCh