Skip to content

Type definitions#

Index > Schemas > Type definitions

Auto-generated documentation for Schemas type annotations stubs module mypy-boto3-schemas.

CreateDiscovererRequestRequestTypeDef#

# CreateDiscovererRequestRequestTypeDef definition

class CreateDiscovererRequestRequestTypeDef(TypedDict):
    SourceArn: str,
    Description: NotRequired[str],
    CrossAccount: NotRequired[bool],
    Tags: NotRequired[Mapping[str, str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateRegistryRequestRequestTypeDef#

# CreateRegistryRequestRequestTypeDef definition

class CreateRegistryRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],

CreateSchemaRequestRequestTypeDef#

# CreateSchemaRequestRequestTypeDef definition

class CreateSchemaRequestRequestTypeDef(TypedDict):
    Content: str,
    RegistryName: str,
    SchemaName: str,
    Type: TypeType,  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See TypeType

DeleteDiscovererRequestRequestTypeDef#

# DeleteDiscovererRequestRequestTypeDef definition

class DeleteDiscovererRequestRequestTypeDef(TypedDict):
    DiscovererId: str,

DeleteRegistryRequestRequestTypeDef#

# DeleteRegistryRequestRequestTypeDef definition

class DeleteRegistryRequestRequestTypeDef(TypedDict):
    RegistryName: str,

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    RegistryName: NotRequired[str],

DeleteSchemaRequestRequestTypeDef#

# DeleteSchemaRequestRequestTypeDef definition

class DeleteSchemaRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    SchemaName: str,

DeleteSchemaVersionRequestRequestTypeDef#

# DeleteSchemaVersionRequestRequestTypeDef definition

class DeleteSchemaVersionRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeCodeBindingRequestRequestTypeDef#

# DescribeCodeBindingRequestRequestTypeDef definition

class DescribeCodeBindingRequestRequestTypeDef(TypedDict):
    Language: str,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: NotRequired[str],

DescribeDiscovererRequestRequestTypeDef#

# DescribeDiscovererRequestRequestTypeDef definition

class DescribeDiscovererRequestRequestTypeDef(TypedDict):
    DiscovererId: str,

DescribeRegistryRequestRequestTypeDef#

# DescribeRegistryRequestRequestTypeDef definition

class DescribeRegistryRequestRequestTypeDef(TypedDict):
    RegistryName: str,

DescribeSchemaRequestRequestTypeDef#

# DescribeSchemaRequestRequestTypeDef definition

class DescribeSchemaRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: NotRequired[str],

DiscovererSummaryTypeDef#

# DiscovererSummaryTypeDef definition

class DiscovererSummaryTypeDef(TypedDict):
    DiscovererArn: NotRequired[str],
    DiscovererId: NotRequired[str],
    SourceArn: NotRequired[str],
    State: NotRequired[DiscovererStateType],  # (1)
    CrossAccount: NotRequired[bool],
    Tags: NotRequired[Dict[str, str]],
  1. See DiscovererStateType

ExportSchemaRequestRequestTypeDef#

# ExportSchemaRequestRequestTypeDef definition

class ExportSchemaRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    SchemaName: str,
    Type: str,
    SchemaVersion: NotRequired[str],

GetCodeBindingSourceRequestRequestTypeDef#

# GetCodeBindingSourceRequestRequestTypeDef definition

class GetCodeBindingSourceRequestRequestTypeDef(TypedDict):
    Language: str,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: NotRequired[str],

GetDiscoveredSchemaRequestRequestTypeDef#

# GetDiscoveredSchemaRequestRequestTypeDef definition

class GetDiscoveredSchemaRequestRequestTypeDef(TypedDict):
    Events: Sequence[str],
    Type: TypeType,  # (1)
  1. See TypeType

GetResourcePolicyRequestRequestTypeDef#

# GetResourcePolicyRequestRequestTypeDef definition

class GetResourcePolicyRequestRequestTypeDef(TypedDict):
    RegistryName: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListDiscoverersRequestRequestTypeDef#

# ListDiscoverersRequestRequestTypeDef definition

class ListDiscoverersRequestRequestTypeDef(TypedDict):
    DiscovererIdPrefix: NotRequired[str],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],
    SourceArnPrefix: NotRequired[str],

ListRegistriesRequestRequestTypeDef#

# ListRegistriesRequestRequestTypeDef definition

class ListRegistriesRequestRequestTypeDef(TypedDict):
    Limit: NotRequired[int],
    NextToken: NotRequired[str],
    RegistryNamePrefix: NotRequired[str],
    Scope: NotRequired[str],

RegistrySummaryTypeDef#

# RegistrySummaryTypeDef definition

class RegistrySummaryTypeDef(TypedDict):
    RegistryArn: NotRequired[str],
    RegistryName: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],

ListSchemaVersionsRequestRequestTypeDef#

# ListSchemaVersionsRequestRequestTypeDef definition

class ListSchemaVersionsRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    SchemaName: str,
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

SchemaVersionSummaryTypeDef#

# SchemaVersionSummaryTypeDef definition

class SchemaVersionSummaryTypeDef(TypedDict):
    SchemaArn: NotRequired[str],
    SchemaName: NotRequired[str],
    SchemaVersion: NotRequired[str],
    Type: NotRequired[TypeType],  # (1)
  1. See TypeType

ListSchemasRequestRequestTypeDef#

# ListSchemasRequestRequestTypeDef definition

class ListSchemasRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    Limit: NotRequired[int],
    NextToken: NotRequired[str],
    SchemaNamePrefix: NotRequired[str],

SchemaSummaryTypeDef#

# SchemaSummaryTypeDef definition

class SchemaSummaryTypeDef(TypedDict):
    LastModified: NotRequired[datetime],
    SchemaArn: NotRequired[str],
    SchemaName: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
    VersionCount: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

PutCodeBindingRequestRequestTypeDef#

# PutCodeBindingRequestRequestTypeDef definition

class PutCodeBindingRequestRequestTypeDef(TypedDict):
    Language: str,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: NotRequired[str],

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef definition

class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    Policy: str,
    RegistryName: NotRequired[str],
    RevisionId: NotRequired[str],

SearchSchemaVersionSummaryTypeDef#

# SearchSchemaVersionSummaryTypeDef definition

class SearchSchemaVersionSummaryTypeDef(TypedDict):
    CreatedDate: NotRequired[datetime],
    SchemaVersion: NotRequired[str],
    Type: NotRequired[TypeType],  # (1)
  1. See TypeType

SearchSchemasRequestRequestTypeDef#

# SearchSchemasRequestRequestTypeDef definition

class SearchSchemasRequestRequestTypeDef(TypedDict):
    Keywords: str,
    RegistryName: str,
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

StartDiscovererRequestRequestTypeDef#

# StartDiscovererRequestRequestTypeDef definition

class StartDiscovererRequestRequestTypeDef(TypedDict):
    DiscovererId: str,

StopDiscovererRequestRequestTypeDef#

# StopDiscovererRequestRequestTypeDef definition

class StopDiscovererRequestRequestTypeDef(TypedDict):
    DiscovererId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateDiscovererRequestRequestTypeDef#

# UpdateDiscovererRequestRequestTypeDef definition

class UpdateDiscovererRequestRequestTypeDef(TypedDict):
    DiscovererId: str,
    Description: NotRequired[str],
    CrossAccount: NotRequired[bool],

UpdateRegistryRequestRequestTypeDef#

# UpdateRegistryRequestRequestTypeDef definition

class UpdateRegistryRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    Description: NotRequired[str],

UpdateSchemaRequestRequestTypeDef#

# UpdateSchemaRequestRequestTypeDef definition

class UpdateSchemaRequestRequestTypeDef(TypedDict):
    RegistryName: str,
    SchemaName: str,
    ClientTokenId: NotRequired[str],
    Content: NotRequired[str],
    Description: NotRequired[str],
    Type: NotRequired[TypeType],  # (1)
  1. See TypeType

CreateDiscovererResponseTypeDef#

# CreateDiscovererResponseTypeDef definition

class CreateDiscovererResponseTypeDef(TypedDict):
    Description: str,
    DiscovererArn: str,
    DiscovererId: str,
    SourceArn: str,
    State: DiscovererStateType,  # (1)
    CrossAccount: bool,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscovererStateType
  2. See ResponseMetadataTypeDef

CreateRegistryResponseTypeDef#

# CreateRegistryResponseTypeDef definition

class CreateRegistryResponseTypeDef(TypedDict):
    Description: str,
    RegistryArn: str,
    RegistryName: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSchemaResponseTypeDef#

# CreateSchemaResponseTypeDef definition

class CreateSchemaResponseTypeDef(TypedDict):
    Description: str,
    LastModified: datetime,
    SchemaArn: str,
    SchemaName: str,
    SchemaVersion: str,
    Tags: Dict[str, str],
    Type: str,
    VersionCreatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeCodeBindingResponseTypeDef#

# DescribeCodeBindingResponseTypeDef definition

class DescribeCodeBindingResponseTypeDef(TypedDict):
    CreationDate: datetime,
    LastModified: datetime,
    SchemaVersion: str,
    Status: CodeGenerationStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CodeGenerationStatusType
  2. See ResponseMetadataTypeDef

DescribeDiscovererResponseTypeDef#

# DescribeDiscovererResponseTypeDef definition

class DescribeDiscovererResponseTypeDef(TypedDict):
    Description: str,
    DiscovererArn: str,
    DiscovererId: str,
    SourceArn: str,
    State: DiscovererStateType,  # (1)
    CrossAccount: bool,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscovererStateType
  2. See ResponseMetadataTypeDef

DescribeRegistryResponseTypeDef#

# DescribeRegistryResponseTypeDef definition

class DescribeRegistryResponseTypeDef(TypedDict):
    Description: str,
    RegistryArn: str,
    RegistryName: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeSchemaResponseTypeDef#

# DescribeSchemaResponseTypeDef definition

class DescribeSchemaResponseTypeDef(TypedDict):
    Content: str,
    Description: str,
    LastModified: datetime,
    SchemaArn: str,
    SchemaName: str,
    SchemaVersion: str,
    Tags: Dict[str, str],
    Type: str,
    VersionCreatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ExportSchemaResponseTypeDef#

# ExportSchemaResponseTypeDef definition

class ExportSchemaResponseTypeDef(TypedDict):
    Content: str,
    SchemaArn: str,
    SchemaName: str,
    SchemaVersion: str,
    Type: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCodeBindingSourceResponseTypeDef#

# GetCodeBindingSourceResponseTypeDef definition

class GetCodeBindingSourceResponseTypeDef(TypedDict):
    Body: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDiscoveredSchemaResponseTypeDef#

# GetDiscoveredSchemaResponseTypeDef definition

class GetDiscoveredSchemaResponseTypeDef(TypedDict):
    Content: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetResourcePolicyResponseTypeDef#

# GetResourcePolicyResponseTypeDef definition

class GetResourcePolicyResponseTypeDef(TypedDict):
    Policy: str,
    RevisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutCodeBindingResponseTypeDef#

# PutCodeBindingResponseTypeDef definition

class PutCodeBindingResponseTypeDef(TypedDict):
    CreationDate: datetime,
    LastModified: datetime,
    SchemaVersion: str,
    Status: CodeGenerationStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CodeGenerationStatusType
  2. See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef definition

class PutResourcePolicyResponseTypeDef(TypedDict):
    Policy: str,
    RevisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartDiscovererResponseTypeDef#

# StartDiscovererResponseTypeDef definition

class StartDiscovererResponseTypeDef(TypedDict):
    DiscovererId: str,
    State: DiscovererStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscovererStateType
  2. See ResponseMetadataTypeDef

StopDiscovererResponseTypeDef#

# StopDiscovererResponseTypeDef definition

class StopDiscovererResponseTypeDef(TypedDict):
    DiscovererId: str,
    State: DiscovererStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscovererStateType
  2. See ResponseMetadataTypeDef

UpdateDiscovererResponseTypeDef#

# UpdateDiscovererResponseTypeDef definition

class UpdateDiscovererResponseTypeDef(TypedDict):
    Description: str,
    DiscovererArn: str,
    DiscovererId: str,
    SourceArn: str,
    State: DiscovererStateType,  # (1)
    CrossAccount: bool,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscovererStateType
  2. See ResponseMetadataTypeDef

UpdateRegistryResponseTypeDef#

# UpdateRegistryResponseTypeDef definition

class UpdateRegistryResponseTypeDef(TypedDict):
    Description: str,
    RegistryArn: str,
    RegistryName: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSchemaResponseTypeDef#

# UpdateSchemaResponseTypeDef definition

class UpdateSchemaResponseTypeDef(TypedDict):
    Description: str,
    LastModified: datetime,
    SchemaArn: str,
    SchemaName: str,
    SchemaVersion: str,
    Tags: Dict[str, str],
    Type: str,
    VersionCreatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeCodeBindingRequestCodeBindingExistsWaitTypeDef#

# DescribeCodeBindingRequestCodeBindingExistsWaitTypeDef definition

class DescribeCodeBindingRequestCodeBindingExistsWaitTypeDef(TypedDict):
    Language: str,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

ListDiscoverersResponseTypeDef#

# ListDiscoverersResponseTypeDef definition

class ListDiscoverersResponseTypeDef(TypedDict):
    Discoverers: List[DiscovererSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscovererSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDiscoverersRequestListDiscoverersPaginateTypeDef#

# ListDiscoverersRequestListDiscoverersPaginateTypeDef definition

class ListDiscoverersRequestListDiscoverersPaginateTypeDef(TypedDict):
    DiscovererIdPrefix: NotRequired[str],
    SourceArnPrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRegistriesRequestListRegistriesPaginateTypeDef#

# ListRegistriesRequestListRegistriesPaginateTypeDef definition

class ListRegistriesRequestListRegistriesPaginateTypeDef(TypedDict):
    RegistryNamePrefix: NotRequired[str],
    Scope: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchemaVersionsRequestListSchemaVersionsPaginateTypeDef#

# ListSchemaVersionsRequestListSchemaVersionsPaginateTypeDef definition

class ListSchemaVersionsRequestListSchemaVersionsPaginateTypeDef(TypedDict):
    RegistryName: str,
    SchemaName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchemasRequestListSchemasPaginateTypeDef#

# ListSchemasRequestListSchemasPaginateTypeDef definition

class ListSchemasRequestListSchemasPaginateTypeDef(TypedDict):
    RegistryName: str,
    SchemaNamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

SearchSchemasRequestSearchSchemasPaginateTypeDef#

# SearchSchemasRequestSearchSchemasPaginateTypeDef definition

class SearchSchemasRequestSearchSchemasPaginateTypeDef(TypedDict):
    Keywords: str,
    RegistryName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRegistriesResponseTypeDef#

# ListRegistriesResponseTypeDef definition

class ListRegistriesResponseTypeDef(TypedDict):
    NextToken: str,
    Registries: List[RegistrySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RegistrySummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSchemaVersionsResponseTypeDef#

# ListSchemaVersionsResponseTypeDef definition

class ListSchemaVersionsResponseTypeDef(TypedDict):
    NextToken: str,
    SchemaVersions: List[SchemaVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSchemasResponseTypeDef#

# ListSchemasResponseTypeDef definition

class ListSchemasResponseTypeDef(TypedDict):
    NextToken: str,
    Schemas: List[SchemaSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchSchemaSummaryTypeDef#

# SearchSchemaSummaryTypeDef definition

class SearchSchemaSummaryTypeDef(TypedDict):
    RegistryName: NotRequired[str],
    SchemaArn: NotRequired[str],
    SchemaName: NotRequired[str],
    SchemaVersions: NotRequired[List[SearchSchemaVersionSummaryTypeDef]],  # (1)
  1. See SearchSchemaVersionSummaryTypeDef

SearchSchemasResponseTypeDef#

# SearchSchemasResponseTypeDef definition

class SearchSchemasResponseTypeDef(TypedDict):
    NextToken: str,
    Schemas: List[SearchSchemaSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SearchSchemaSummaryTypeDef
  2. See ResponseMetadataTypeDef