Skip to content

Type definitions#

Index > AppSync > Type definitions

Auto-generated documentation for AppSync type annotations stubs module mypy-boto3-appsync.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

CognitoUserPoolConfigTypeDef#

# CognitoUserPoolConfigTypeDef definition

class CognitoUserPoolConfigTypeDef(TypedDict):
    userPoolId: str,
    awsRegion: str,
    appIdClientRegex: NotRequired[str],

LambdaAuthorizerConfigTypeDef#

# LambdaAuthorizerConfigTypeDef definition

class LambdaAuthorizerConfigTypeDef(TypedDict):
    authorizerUri: str,
    authorizerResultTtlInSeconds: NotRequired[int],
    identityValidationExpression: NotRequired[str],

OpenIDConnectConfigTypeDef#

# OpenIDConnectConfigTypeDef definition

class OpenIDConnectConfigTypeDef(TypedDict):
    issuer: str,
    clientId: NotRequired[str],
    iatTTL: NotRequired[int],
    authTTL: NotRequired[int],

ApiAssociationTypeDef#

# ApiAssociationTypeDef definition

class ApiAssociationTypeDef(TypedDict):
    domainName: NotRequired[str],
    apiId: NotRequired[str],
    associationStatus: NotRequired[AssociationStatusType],  # (1)
    deploymentDetail: NotRequired[str],
  1. See AssociationStatusType

ApiCacheTypeDef#

# ApiCacheTypeDef definition

class ApiCacheTypeDef(TypedDict):
    ttl: NotRequired[int],
    apiCachingBehavior: NotRequired[ApiCachingBehaviorType],  # (1)
    transitEncryptionEnabled: NotRequired[bool],
    atRestEncryptionEnabled: NotRequired[bool],
    type: NotRequired[ApiCacheTypeType],  # (2)
    status: NotRequired[ApiCacheStatusType],  # (3)
  1. See ApiCachingBehaviorType
  2. See ApiCacheTypeType
  3. See ApiCacheStatusType

ApiKeyTypeDef#

# ApiKeyTypeDef definition

class ApiKeyTypeDef(TypedDict):
    id: NotRequired[str],
    description: NotRequired[str],
    expires: NotRequired[int],
    deletes: NotRequired[int],

AppSyncRuntimeTypeDef#

# AppSyncRuntimeTypeDef definition

class AppSyncRuntimeTypeDef(TypedDict):
    name: RuntimeNameType,  # (1)
    runtimeVersion: str,
  1. See RuntimeNameType

AssociateApiRequestRequestTypeDef#

# AssociateApiRequestRequestTypeDef definition

class AssociateApiRequestRequestTypeDef(TypedDict):
    domainName: str,
    apiId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

SourceApiAssociationConfigTypeDef#

# SourceApiAssociationConfigTypeDef definition

class SourceApiAssociationConfigTypeDef(TypedDict):
    mergeType: NotRequired[MergeTypeType],  # (1)
  1. See MergeTypeType

AwsIamConfigTypeDef#

# AwsIamConfigTypeDef definition

class AwsIamConfigTypeDef(TypedDict):
    signingRegion: NotRequired[str],
    signingServiceName: NotRequired[str],

CachingConfigPaginatorTypeDef#

# CachingConfigPaginatorTypeDef definition

class CachingConfigPaginatorTypeDef(TypedDict):
    ttl: int,
    cachingKeys: NotRequired[List[str]],

CachingConfigTypeDef#

# CachingConfigTypeDef definition

class CachingConfigTypeDef(TypedDict):
    ttl: int,
    cachingKeys: NotRequired[Sequence[str]],

CodeErrorLocationTypeDef#

# CodeErrorLocationTypeDef definition

class CodeErrorLocationTypeDef(TypedDict):
    line: NotRequired[int],
    column: NotRequired[int],
    span: NotRequired[int],

CreateApiCacheRequestRequestTypeDef#

# CreateApiCacheRequestRequestTypeDef definition

class CreateApiCacheRequestRequestTypeDef(TypedDict):
    apiId: str,
    ttl: int,
    apiCachingBehavior: ApiCachingBehaviorType,  # (1)
    type: ApiCacheTypeType,  # (2)
    transitEncryptionEnabled: NotRequired[bool],
    atRestEncryptionEnabled: NotRequired[bool],
  1. See ApiCachingBehaviorType
  2. See ApiCacheTypeType

CreateApiKeyRequestRequestTypeDef#

# CreateApiKeyRequestRequestTypeDef definition

class CreateApiKeyRequestRequestTypeDef(TypedDict):
    apiId: str,
    description: NotRequired[str],
    expires: NotRequired[int],

ElasticsearchDataSourceConfigTypeDef#

# ElasticsearchDataSourceConfigTypeDef definition

class ElasticsearchDataSourceConfigTypeDef(TypedDict):
    endpoint: str,
    awsRegion: str,

EventBridgeDataSourceConfigTypeDef#

# EventBridgeDataSourceConfigTypeDef definition

class EventBridgeDataSourceConfigTypeDef(TypedDict):
    eventBusArn: str,

LambdaDataSourceConfigTypeDef#

# LambdaDataSourceConfigTypeDef definition

class LambdaDataSourceConfigTypeDef(TypedDict):
    lambdaFunctionArn: str,

OpenSearchServiceDataSourceConfigTypeDef#

# OpenSearchServiceDataSourceConfigTypeDef definition

class OpenSearchServiceDataSourceConfigTypeDef(TypedDict):
    endpoint: str,
    awsRegion: str,

CreateDomainNameRequestRequestTypeDef#

# CreateDomainNameRequestRequestTypeDef definition

class CreateDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,
    certificateArn: str,
    description: NotRequired[str],

DomainNameConfigTypeDef#

# DomainNameConfigTypeDef definition

class DomainNameConfigTypeDef(TypedDict):
    domainName: NotRequired[str],
    description: NotRequired[str],
    certificateArn: NotRequired[str],
    appsyncDomainName: NotRequired[str],
    hostedZoneId: NotRequired[str],

LogConfigTypeDef#

# LogConfigTypeDef definition

class LogConfigTypeDef(TypedDict):
    fieldLogLevel: FieldLogLevelType,  # (1)
    cloudWatchLogsRoleArn: str,
    excludeVerboseContent: NotRequired[bool],
  1. See FieldLogLevelType

UserPoolConfigTypeDef#

# UserPoolConfigTypeDef definition

class UserPoolConfigTypeDef(TypedDict):
    userPoolId: str,
    awsRegion: str,
    defaultAction: DefaultActionType,  # (1)
    appIdClientRegex: NotRequired[str],
  1. See DefaultActionType

PipelineConfigTypeDef#

# PipelineConfigTypeDef definition

class PipelineConfigTypeDef(TypedDict):
    functions: NotRequired[Sequence[str]],

CreateTypeRequestRequestTypeDef#

# CreateTypeRequestRequestTypeDef definition

class CreateTypeRequestRequestTypeDef(TypedDict):
    apiId: str,
    definition: str,
    format: TypeDefinitionFormatType,  # (1)
  1. See TypeDefinitionFormatType

TypeTypeDef#

# TypeTypeDef definition

class TypeTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    arn: NotRequired[str],
    definition: NotRequired[str],
    format: NotRequired[TypeDefinitionFormatType],  # (1)
  1. See TypeDefinitionFormatType

DeleteApiCacheRequestRequestTypeDef#

# DeleteApiCacheRequestRequestTypeDef definition

class DeleteApiCacheRequestRequestTypeDef(TypedDict):
    apiId: str,

DeleteApiKeyRequestRequestTypeDef#

# DeleteApiKeyRequestRequestTypeDef definition

class DeleteApiKeyRequestRequestTypeDef(TypedDict):
    apiId: str,
    id: str,

DeleteDataSourceRequestRequestTypeDef#

# DeleteDataSourceRequestRequestTypeDef definition

class DeleteDataSourceRequestRequestTypeDef(TypedDict):
    apiId: str,
    name: str,

DeleteDomainNameRequestRequestTypeDef#

# DeleteDomainNameRequestRequestTypeDef definition

class DeleteDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,

DeleteFunctionRequestRequestTypeDef#

# DeleteFunctionRequestRequestTypeDef definition

class DeleteFunctionRequestRequestTypeDef(TypedDict):
    apiId: str,
    functionId: str,

DeleteGraphqlApiRequestRequestTypeDef#

# DeleteGraphqlApiRequestRequestTypeDef definition

class DeleteGraphqlApiRequestRequestTypeDef(TypedDict):
    apiId: str,

DeleteResolverRequestRequestTypeDef#

# DeleteResolverRequestRequestTypeDef definition

class DeleteResolverRequestRequestTypeDef(TypedDict):
    apiId: str,
    typeName: str,
    fieldName: str,

DeleteTypeRequestRequestTypeDef#

# DeleteTypeRequestRequestTypeDef definition

class DeleteTypeRequestRequestTypeDef(TypedDict):
    apiId: str,
    typeName: str,

DeltaSyncConfigTypeDef#

# DeltaSyncConfigTypeDef definition

class DeltaSyncConfigTypeDef(TypedDict):
    baseTableTTL: NotRequired[int],
    deltaSyncTableName: NotRequired[str],
    deltaSyncTableTTL: NotRequired[int],

DisassociateApiRequestRequestTypeDef#

# DisassociateApiRequestRequestTypeDef definition

class DisassociateApiRequestRequestTypeDef(TypedDict):
    domainName: str,

DisassociateMergedGraphqlApiRequestRequestTypeDef#

# DisassociateMergedGraphqlApiRequestRequestTypeDef definition

class DisassociateMergedGraphqlApiRequestRequestTypeDef(TypedDict):
    sourceApiIdentifier: str,
    associationId: str,

DisassociateSourceGraphqlApiRequestRequestTypeDef#

# DisassociateSourceGraphqlApiRequestRequestTypeDef definition

class DisassociateSourceGraphqlApiRequestRequestTypeDef(TypedDict):
    mergedApiIdentifier: str,
    associationId: str,

ErrorDetailTypeDef#

# ErrorDetailTypeDef definition

class ErrorDetailTypeDef(TypedDict):
    message: NotRequired[str],

EvaluateMappingTemplateRequestRequestTypeDef#

# EvaluateMappingTemplateRequestRequestTypeDef definition

class EvaluateMappingTemplateRequestRequestTypeDef(TypedDict):
    template: str,
    context: str,

FlushApiCacheRequestRequestTypeDef#

# FlushApiCacheRequestRequestTypeDef definition

class FlushApiCacheRequestRequestTypeDef(TypedDict):
    apiId: str,

GetApiAssociationRequestRequestTypeDef#

# GetApiAssociationRequestRequestTypeDef definition

class GetApiAssociationRequestRequestTypeDef(TypedDict):
    domainName: str,

GetApiCacheRequestRequestTypeDef#

# GetApiCacheRequestRequestTypeDef definition

class GetApiCacheRequestRequestTypeDef(TypedDict):
    apiId: str,

GetDataSourceRequestRequestTypeDef#

# GetDataSourceRequestRequestTypeDef definition

class GetDataSourceRequestRequestTypeDef(TypedDict):
    apiId: str,
    name: str,

GetDomainNameRequestRequestTypeDef#

# GetDomainNameRequestRequestTypeDef definition

class GetDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,

GetFunctionRequestRequestTypeDef#

# GetFunctionRequestRequestTypeDef definition

class GetFunctionRequestRequestTypeDef(TypedDict):
    apiId: str,
    functionId: str,

GetGraphqlApiRequestRequestTypeDef#

# GetGraphqlApiRequestRequestTypeDef definition

class GetGraphqlApiRequestRequestTypeDef(TypedDict):
    apiId: str,

GetIntrospectionSchemaRequestRequestTypeDef#

# GetIntrospectionSchemaRequestRequestTypeDef definition

class GetIntrospectionSchemaRequestRequestTypeDef(TypedDict):
    apiId: str,
    format: OutputTypeType,  # (1)
    includeDirectives: NotRequired[bool],
  1. See OutputTypeType

GetResolverRequestRequestTypeDef#

# GetResolverRequestRequestTypeDef definition

class GetResolverRequestRequestTypeDef(TypedDict):
    apiId: str,
    typeName: str,
    fieldName: str,

GetSchemaCreationStatusRequestRequestTypeDef#

# GetSchemaCreationStatusRequestRequestTypeDef definition

class GetSchemaCreationStatusRequestRequestTypeDef(TypedDict):
    apiId: str,

GetSourceApiAssociationRequestRequestTypeDef#

# GetSourceApiAssociationRequestRequestTypeDef definition

class GetSourceApiAssociationRequestRequestTypeDef(TypedDict):
    mergedApiIdentifier: str,
    associationId: str,

GetTypeRequestRequestTypeDef#

# GetTypeRequestRequestTypeDef definition

class GetTypeRequestRequestTypeDef(TypedDict):
    apiId: str,
    typeName: str,
    format: TypeDefinitionFormatType,  # (1)
  1. See TypeDefinitionFormatType

LambdaConflictHandlerConfigTypeDef#

# LambdaConflictHandlerConfigTypeDef definition

class LambdaConflictHandlerConfigTypeDef(TypedDict):
    lambdaConflictHandlerArn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListApiKeysRequestRequestTypeDef#

# ListApiKeysRequestRequestTypeDef definition

class ListApiKeysRequestRequestTypeDef(TypedDict):
    apiId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDataSourcesRequestRequestTypeDef#

# ListDataSourcesRequestRequestTypeDef definition

class ListDataSourcesRequestRequestTypeDef(TypedDict):
    apiId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDomainNamesRequestRequestTypeDef#

# ListDomainNamesRequestRequestTypeDef definition

class ListDomainNamesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListFunctionsRequestRequestTypeDef#

# ListFunctionsRequestRequestTypeDef definition

class ListFunctionsRequestRequestTypeDef(TypedDict):
    apiId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListGraphqlApisRequestRequestTypeDef#

# ListGraphqlApisRequestRequestTypeDef definition

class ListGraphqlApisRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    apiType: NotRequired[GraphQLApiTypeType],  # (1)
    owner: NotRequired[OwnershipType],  # (2)
  1. See GraphQLApiTypeType
  2. See OwnershipType

ListResolversByFunctionRequestRequestTypeDef#

# ListResolversByFunctionRequestRequestTypeDef definition

class ListResolversByFunctionRequestRequestTypeDef(TypedDict):
    apiId: str,
    functionId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListResolversRequestRequestTypeDef#

# ListResolversRequestRequestTypeDef definition

class ListResolversRequestRequestTypeDef(TypedDict):
    apiId: str,
    typeName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListSourceApiAssociationsRequestRequestTypeDef#

# ListSourceApiAssociationsRequestRequestTypeDef definition

class ListSourceApiAssociationsRequestRequestTypeDef(TypedDict):
    apiId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

SourceApiAssociationSummaryTypeDef#

# SourceApiAssociationSummaryTypeDef definition

class SourceApiAssociationSummaryTypeDef(TypedDict):
    associationId: NotRequired[str],
    associationArn: NotRequired[str],
    sourceApiId: NotRequired[str],
    sourceApiArn: NotRequired[str],
    mergedApiId: NotRequired[str],
    mergedApiArn: NotRequired[str],
    description: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTypesByAssociationRequestRequestTypeDef#

# ListTypesByAssociationRequestRequestTypeDef definition

class ListTypesByAssociationRequestRequestTypeDef(TypedDict):
    mergedApiIdentifier: str,
    associationId: str,
    format: TypeDefinitionFormatType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TypeDefinitionFormatType

ListTypesRequestRequestTypeDef#

# ListTypesRequestRequestTypeDef definition

class ListTypesRequestRequestTypeDef(TypedDict):
    apiId: str,
    format: TypeDefinitionFormatType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TypeDefinitionFormatType

PipelineConfigPaginatorTypeDef#

# PipelineConfigPaginatorTypeDef definition

class PipelineConfigPaginatorTypeDef(TypedDict):
    functions: NotRequired[List[str]],

RdsHttpEndpointConfigTypeDef#

# RdsHttpEndpointConfigTypeDef definition

class RdsHttpEndpointConfigTypeDef(TypedDict):
    awsRegion: NotRequired[str],
    dbClusterIdentifier: NotRequired[str],
    databaseName: NotRequired[str],
    schema: NotRequired[str],
    awsSecretStoreArn: NotRequired[str],

StartSchemaMergeRequestRequestTypeDef#

# StartSchemaMergeRequestRequestTypeDef definition

class StartSchemaMergeRequestRequestTypeDef(TypedDict):
    associationId: str,
    mergedApiIdentifier: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateApiCacheRequestRequestTypeDef#

# UpdateApiCacheRequestRequestTypeDef definition

class UpdateApiCacheRequestRequestTypeDef(TypedDict):
    apiId: str,
    ttl: int,
    apiCachingBehavior: ApiCachingBehaviorType,  # (1)
    type: ApiCacheTypeType,  # (2)
  1. See ApiCachingBehaviorType
  2. See ApiCacheTypeType

UpdateApiKeyRequestRequestTypeDef#

# UpdateApiKeyRequestRequestTypeDef definition

class UpdateApiKeyRequestRequestTypeDef(TypedDict):
    apiId: str,
    id: str,
    description: NotRequired[str],
    expires: NotRequired[int],

UpdateDomainNameRequestRequestTypeDef#

# UpdateDomainNameRequestRequestTypeDef definition

class UpdateDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,
    description: NotRequired[str],

UpdateTypeRequestRequestTypeDef#

# UpdateTypeRequestRequestTypeDef definition

class UpdateTypeRequestRequestTypeDef(TypedDict):
    apiId: str,
    typeName: str,
    format: TypeDefinitionFormatType,  # (1)
    definition: NotRequired[str],
  1. See TypeDefinitionFormatType

AdditionalAuthenticationProviderTypeDef#

# AdditionalAuthenticationProviderTypeDef definition

class AdditionalAuthenticationProviderTypeDef(TypedDict):
    authenticationType: NotRequired[AuthenticationTypeType],  # (1)
    openIDConnectConfig: NotRequired[OpenIDConnectConfigTypeDef],  # (2)
    userPoolConfig: NotRequired[CognitoUserPoolConfigTypeDef],  # (3)
    lambdaAuthorizerConfig: NotRequired[LambdaAuthorizerConfigTypeDef],  # (4)
  1. See AuthenticationTypeType
  2. See OpenIDConnectConfigTypeDef
  3. See CognitoUserPoolConfigTypeDef
  4. See LambdaAuthorizerConfigTypeDef

EvaluateCodeRequestRequestTypeDef#

# EvaluateCodeRequestRequestTypeDef definition

class EvaluateCodeRequestRequestTypeDef(TypedDict):
    runtime: AppSyncRuntimeTypeDef,  # (1)
    code: str,
    context: str,
    function: NotRequired[str],
  1. See AppSyncRuntimeTypeDef

AssociateApiResponseTypeDef#

# AssociateApiResponseTypeDef definition

class AssociateApiResponseTypeDef(TypedDict):
    apiAssociation: ApiAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiAssociationTypeDef
  2. See ResponseMetadataTypeDef

CreateApiCacheResponseTypeDef#

# CreateApiCacheResponseTypeDef definition

class CreateApiCacheResponseTypeDef(TypedDict):
    apiCache: ApiCacheTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiCacheTypeDef
  2. See ResponseMetadataTypeDef

CreateApiKeyResponseTypeDef#

# CreateApiKeyResponseTypeDef definition

class CreateApiKeyResponseTypeDef(TypedDict):
    apiKey: ApiKeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiKeyTypeDef
  2. See ResponseMetadataTypeDef

DisassociateMergedGraphqlApiResponseTypeDef#

# DisassociateMergedGraphqlApiResponseTypeDef definition

class DisassociateMergedGraphqlApiResponseTypeDef(TypedDict):
    sourceApiAssociationStatus: SourceApiAssociationStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SourceApiAssociationStatusType
  2. See ResponseMetadataTypeDef

DisassociateSourceGraphqlApiResponseTypeDef#

# DisassociateSourceGraphqlApiResponseTypeDef definition

class DisassociateSourceGraphqlApiResponseTypeDef(TypedDict):
    sourceApiAssociationStatus: SourceApiAssociationStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SourceApiAssociationStatusType
  2. See ResponseMetadataTypeDef

GetApiAssociationResponseTypeDef#

# GetApiAssociationResponseTypeDef definition

class GetApiAssociationResponseTypeDef(TypedDict):
    apiAssociation: ApiAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiAssociationTypeDef
  2. See ResponseMetadataTypeDef

GetApiCacheResponseTypeDef#

# GetApiCacheResponseTypeDef definition

class GetApiCacheResponseTypeDef(TypedDict):
    apiCache: ApiCacheTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiCacheTypeDef
  2. See ResponseMetadataTypeDef

GetIntrospectionSchemaResponseTypeDef#

# GetIntrospectionSchemaResponseTypeDef definition

class GetIntrospectionSchemaResponseTypeDef(TypedDict):
    schema: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSchemaCreationStatusResponseTypeDef#

# GetSchemaCreationStatusResponseTypeDef definition

class GetSchemaCreationStatusResponseTypeDef(TypedDict):
    status: SchemaStatusType,  # (1)
    details: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaStatusType
  2. See ResponseMetadataTypeDef

ListApiKeysResponseTypeDef#

# ListApiKeysResponseTypeDef definition

class ListApiKeysResponseTypeDef(TypedDict):
    apiKeys: List[ApiKeyTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiKeyTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

StartSchemaCreationResponseTypeDef#

# StartSchemaCreationResponseTypeDef definition

class StartSchemaCreationResponseTypeDef(TypedDict):
    status: SchemaStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaStatusType
  2. See ResponseMetadataTypeDef

StartSchemaMergeResponseTypeDef#

# StartSchemaMergeResponseTypeDef definition

class StartSchemaMergeResponseTypeDef(TypedDict):
    sourceApiAssociationStatus: SourceApiAssociationStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SourceApiAssociationStatusType
  2. See ResponseMetadataTypeDef

UpdateApiCacheResponseTypeDef#

# UpdateApiCacheResponseTypeDef definition

class UpdateApiCacheResponseTypeDef(TypedDict):
    apiCache: ApiCacheTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiCacheTypeDef
  2. See ResponseMetadataTypeDef

UpdateApiKeyResponseTypeDef#

# UpdateApiKeyResponseTypeDef definition

class UpdateApiKeyResponseTypeDef(TypedDict):
    apiKey: ApiKeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiKeyTypeDef
  2. See ResponseMetadataTypeDef

AssociateMergedGraphqlApiRequestRequestTypeDef#

# AssociateMergedGraphqlApiRequestRequestTypeDef definition

class AssociateMergedGraphqlApiRequestRequestTypeDef(TypedDict):
    sourceApiIdentifier: str,
    mergedApiIdentifier: str,
    description: NotRequired[str],
    sourceApiAssociationConfig: NotRequired[SourceApiAssociationConfigTypeDef],  # (1)
  1. See SourceApiAssociationConfigTypeDef

AssociateSourceGraphqlApiRequestRequestTypeDef#

# AssociateSourceGraphqlApiRequestRequestTypeDef definition

class AssociateSourceGraphqlApiRequestRequestTypeDef(TypedDict):
    mergedApiIdentifier: str,
    sourceApiIdentifier: str,
    description: NotRequired[str],
    sourceApiAssociationConfig: NotRequired[SourceApiAssociationConfigTypeDef],  # (1)
  1. See SourceApiAssociationConfigTypeDef

SourceApiAssociationTypeDef#

# SourceApiAssociationTypeDef definition

class SourceApiAssociationTypeDef(TypedDict):
    associationId: NotRequired[str],
    associationArn: NotRequired[str],
    sourceApiId: NotRequired[str],
    sourceApiArn: NotRequired[str],
    mergedApiArn: NotRequired[str],
    mergedApiId: NotRequired[str],
    description: NotRequired[str],
    sourceApiAssociationConfig: NotRequired[SourceApiAssociationConfigTypeDef],  # (1)
    sourceApiAssociationStatus: NotRequired[SourceApiAssociationStatusType],  # (2)
    sourceApiAssociationStatusDetail: NotRequired[str],
    lastSuccessfulMergeDate: NotRequired[datetime],
  1. See SourceApiAssociationConfigTypeDef
  2. See SourceApiAssociationStatusType

UpdateSourceApiAssociationRequestRequestTypeDef#

# UpdateSourceApiAssociationRequestRequestTypeDef definition

class UpdateSourceApiAssociationRequestRequestTypeDef(TypedDict):
    associationId: str,
    mergedApiIdentifier: str,
    description: NotRequired[str],
    sourceApiAssociationConfig: NotRequired[SourceApiAssociationConfigTypeDef],  # (1)
  1. See SourceApiAssociationConfigTypeDef

AuthorizationConfigTypeDef#

# AuthorizationConfigTypeDef definition

class AuthorizationConfigTypeDef(TypedDict):
    authorizationType: AuthorizationTypeType,  # (1)
    awsIamConfig: NotRequired[AwsIamConfigTypeDef],  # (2)
  1. See AuthorizationTypeType
  2. See AwsIamConfigTypeDef

StartSchemaCreationRequestRequestTypeDef#

# StartSchemaCreationRequestRequestTypeDef definition

class StartSchemaCreationRequestRequestTypeDef(TypedDict):
    apiId: str,
    definition: Union[str, bytes, IO[Any], StreamingBody],

CodeErrorTypeDef#

# CodeErrorTypeDef definition

class CodeErrorTypeDef(TypedDict):
    errorType: NotRequired[str],
    value: NotRequired[str],
    location: NotRequired[CodeErrorLocationTypeDef],  # (1)
  1. See CodeErrorLocationTypeDef

CreateDomainNameResponseTypeDef#

# CreateDomainNameResponseTypeDef definition

class CreateDomainNameResponseTypeDef(TypedDict):
    domainNameConfig: DomainNameConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNameConfigTypeDef
  2. See ResponseMetadataTypeDef

GetDomainNameResponseTypeDef#

# GetDomainNameResponseTypeDef definition

class GetDomainNameResponseTypeDef(TypedDict):
    domainNameConfig: DomainNameConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNameConfigTypeDef
  2. See ResponseMetadataTypeDef

ListDomainNamesResponseTypeDef#

# ListDomainNamesResponseTypeDef definition

class ListDomainNamesResponseTypeDef(TypedDict):
    domainNameConfigs: List[DomainNameConfigTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNameConfigTypeDef
  2. See ResponseMetadataTypeDef

UpdateDomainNameResponseTypeDef#

# UpdateDomainNameResponseTypeDef definition

class UpdateDomainNameResponseTypeDef(TypedDict):
    domainNameConfig: DomainNameConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNameConfigTypeDef
  2. See ResponseMetadataTypeDef

CreateTypeResponseTypeDef#

# CreateTypeResponseTypeDef definition

class CreateTypeResponseTypeDef(TypedDict):
    type: TypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TypeTypeDef
  2. See ResponseMetadataTypeDef

GetTypeResponseTypeDef#

# GetTypeResponseTypeDef definition

class GetTypeResponseTypeDef(TypedDict):
    type: TypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TypeTypeDef
  2. See ResponseMetadataTypeDef

ListTypesByAssociationResponseTypeDef#

# ListTypesByAssociationResponseTypeDef definition

class ListTypesByAssociationResponseTypeDef(TypedDict):
    types: List[TypeTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TypeTypeDef
  2. See ResponseMetadataTypeDef

ListTypesResponseTypeDef#

# ListTypesResponseTypeDef definition

class ListTypesResponseTypeDef(TypedDict):
    types: List[TypeTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TypeTypeDef
  2. See ResponseMetadataTypeDef

UpdateTypeResponseTypeDef#

# UpdateTypeResponseTypeDef definition

class UpdateTypeResponseTypeDef(TypedDict):
    type: TypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TypeTypeDef
  2. See ResponseMetadataTypeDef

DynamodbDataSourceConfigTypeDef#

# DynamodbDataSourceConfigTypeDef definition

class DynamodbDataSourceConfigTypeDef(TypedDict):
    tableName: str,
    awsRegion: str,
    useCallerCredentials: NotRequired[bool],
    deltaSyncConfig: NotRequired[DeltaSyncConfigTypeDef],  # (1)
    versioned: NotRequired[bool],
  1. See DeltaSyncConfigTypeDef

EvaluateMappingTemplateResponseTypeDef#

# EvaluateMappingTemplateResponseTypeDef definition

class EvaluateMappingTemplateResponseTypeDef(TypedDict):
    evaluationResult: str,
    error: ErrorDetailTypeDef,  # (1)
    logs: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ErrorDetailTypeDef
  2. See ResponseMetadataTypeDef

SyncConfigTypeDef#

# SyncConfigTypeDef definition

class SyncConfigTypeDef(TypedDict):
    conflictHandler: NotRequired[ConflictHandlerTypeType],  # (1)
    conflictDetection: NotRequired[ConflictDetectionTypeType],  # (2)
    lambdaConflictHandlerConfig: NotRequired[LambdaConflictHandlerConfigTypeDef],  # (3)
  1. See ConflictHandlerTypeType
  2. See ConflictDetectionTypeType
  3. See LambdaConflictHandlerConfigTypeDef

ListApiKeysRequestListApiKeysPaginateTypeDef#

# ListApiKeysRequestListApiKeysPaginateTypeDef definition

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

ListDataSourcesRequestListDataSourcesPaginateTypeDef#

# ListDataSourcesRequestListDataSourcesPaginateTypeDef definition

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

ListFunctionsRequestListFunctionsPaginateTypeDef#

# ListFunctionsRequestListFunctionsPaginateTypeDef definition

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

ListGraphqlApisRequestListGraphqlApisPaginateTypeDef#

# ListGraphqlApisRequestListGraphqlApisPaginateTypeDef definition

class ListGraphqlApisRequestListGraphqlApisPaginateTypeDef(TypedDict):
    apiType: NotRequired[GraphQLApiTypeType],  # (1)
    owner: NotRequired[OwnershipType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See GraphQLApiTypeType
  2. See OwnershipType
  3. See PaginatorConfigTypeDef

ListResolversByFunctionRequestListResolversByFunctionPaginateTypeDef#

# ListResolversByFunctionRequestListResolversByFunctionPaginateTypeDef definition

class ListResolversByFunctionRequestListResolversByFunctionPaginateTypeDef(TypedDict):
    apiId: str,
    functionId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListResolversRequestListResolversPaginateTypeDef#

# ListResolversRequestListResolversPaginateTypeDef definition

class ListResolversRequestListResolversPaginateTypeDef(TypedDict):
    apiId: str,
    typeName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTypesRequestListTypesPaginateTypeDef#

# ListTypesRequestListTypesPaginateTypeDef definition

class ListTypesRequestListTypesPaginateTypeDef(TypedDict):
    apiId: str,
    format: TypeDefinitionFormatType,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TypeDefinitionFormatType
  2. See PaginatorConfigTypeDef

ListSourceApiAssociationsResponseTypeDef#

# ListSourceApiAssociationsResponseTypeDef definition

class ListSourceApiAssociationsResponseTypeDef(TypedDict):
    sourceApiAssociationSummaries: List[SourceApiAssociationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SourceApiAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

RelationalDatabaseDataSourceConfigTypeDef#

# RelationalDatabaseDataSourceConfigTypeDef definition

class RelationalDatabaseDataSourceConfigTypeDef(TypedDict):
    relationalDatabaseSourceType: NotRequired[RelationalDatabaseSourceTypeType],  # (1)
    rdsHttpEndpointConfig: NotRequired[RdsHttpEndpointConfigTypeDef],  # (2)
  1. See RelationalDatabaseSourceTypeType
  2. See RdsHttpEndpointConfigTypeDef

CreateGraphqlApiRequestRequestTypeDef#

# CreateGraphqlApiRequestRequestTypeDef definition

class CreateGraphqlApiRequestRequestTypeDef(TypedDict):
    name: str,
    authenticationType: AuthenticationTypeType,  # (1)
    logConfig: NotRequired[LogConfigTypeDef],  # (2)
    userPoolConfig: NotRequired[UserPoolConfigTypeDef],  # (3)
    openIDConnectConfig: NotRequired[OpenIDConnectConfigTypeDef],  # (4)
    tags: NotRequired[Mapping[str, str]],
    additionalAuthenticationProviders: NotRequired[Sequence[AdditionalAuthenticationProviderTypeDef]],  # (5)
    xrayEnabled: NotRequired[bool],
    lambdaAuthorizerConfig: NotRequired[LambdaAuthorizerConfigTypeDef],  # (6)
    visibility: NotRequired[GraphQLApiVisibilityType],  # (7)
    apiType: NotRequired[GraphQLApiTypeType],  # (8)
    mergedApiExecutionRoleArn: NotRequired[str],
    ownerContact: NotRequired[str],
  1. See AuthenticationTypeType
  2. See LogConfigTypeDef
  3. See UserPoolConfigTypeDef
  4. See OpenIDConnectConfigTypeDef
  5. See AdditionalAuthenticationProviderTypeDef
  6. See LambdaAuthorizerConfigTypeDef
  7. See GraphQLApiVisibilityType
  8. See GraphQLApiTypeType

GraphqlApiTypeDef#

# GraphqlApiTypeDef definition

class GraphqlApiTypeDef(TypedDict):
    name: NotRequired[str],
    apiId: NotRequired[str],
    authenticationType: NotRequired[AuthenticationTypeType],  # (1)
    logConfig: NotRequired[LogConfigTypeDef],  # (2)
    userPoolConfig: NotRequired[UserPoolConfigTypeDef],  # (3)
    openIDConnectConfig: NotRequired[OpenIDConnectConfigTypeDef],  # (4)
    arn: NotRequired[str],
    uris: NotRequired[Dict[str, str]],
    tags: NotRequired[Dict[str, str]],
    additionalAuthenticationProviders: NotRequired[List[AdditionalAuthenticationProviderTypeDef]],  # (5)
    xrayEnabled: NotRequired[bool],
    wafWebAclArn: NotRequired[str],
    lambdaAuthorizerConfig: NotRequired[LambdaAuthorizerConfigTypeDef],  # (6)
    dns: NotRequired[Dict[str, str]],
    visibility: NotRequired[GraphQLApiVisibilityType],  # (7)
    apiType: NotRequired[GraphQLApiTypeType],  # (8)
    mergedApiExecutionRoleArn: NotRequired[str],
    owner: NotRequired[str],
    ownerContact: NotRequired[str],
  1. See AuthenticationTypeType
  2. See LogConfigTypeDef
  3. See UserPoolConfigTypeDef
  4. See OpenIDConnectConfigTypeDef
  5. See AdditionalAuthenticationProviderTypeDef
  6. See LambdaAuthorizerConfigTypeDef
  7. See GraphQLApiVisibilityType
  8. See GraphQLApiTypeType

UpdateGraphqlApiRequestRequestTypeDef#

# UpdateGraphqlApiRequestRequestTypeDef definition

class UpdateGraphqlApiRequestRequestTypeDef(TypedDict):
    apiId: str,
    name: str,
    logConfig: NotRequired[LogConfigTypeDef],  # (1)
    authenticationType: NotRequired[AuthenticationTypeType],  # (2)
    userPoolConfig: NotRequired[UserPoolConfigTypeDef],  # (3)
    openIDConnectConfig: NotRequired[OpenIDConnectConfigTypeDef],  # (4)
    additionalAuthenticationProviders: NotRequired[Sequence[AdditionalAuthenticationProviderTypeDef]],  # (5)
    xrayEnabled: NotRequired[bool],
    lambdaAuthorizerConfig: NotRequired[LambdaAuthorizerConfigTypeDef],  # (6)
    mergedApiExecutionRoleArn: NotRequired[str],
    ownerContact: NotRequired[str],
  1. See LogConfigTypeDef
  2. See AuthenticationTypeType
  3. See UserPoolConfigTypeDef
  4. See OpenIDConnectConfigTypeDef
  5. See </