AppSync module#
Index > AppSync
Auto-generated documentation for AppSync type annotations stubs module types-boto3-appsync.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
AppSync
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and AppSync
.
From PyPI with pip#
Install types-boto3
for AppSync
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[appsync]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[appsync]'
# standalone installation
python -m pip install types-boto3-appsync
How to uninstall#
python -m pip uninstall -y types-boto3-appsync
Usage#
Code samples can be found in Examples.
AppSyncClient#
Type annotations and code completion for boto3.client("appsync")
as AppSyncClient
boto3 documentation
# AppSyncClient usage example
from boto3.session import Session
from types_boto3_appsync.client import AppSyncClient
def get_client() -> AppSyncClient:
return Session().client("appsync")
Paginators#
Type annotations and code completion for paginators
from boto3.client("appsync").get_paginator("...")
.
# ListApiKeysPaginator usage example
from boto3.session import Session
from types_boto3_appsync.paginator import ListApiKeysPaginator
def get_list_api_keys_paginator() -> ListApiKeysPaginator:
return Session().client("appsync").get_paginator("list_api_keys"))
- ListApiKeysPaginator
- ListApisPaginator
- ListChannelNamespacesPaginator
- ListDataSourcesPaginator
- ListDomainNamesPaginator
- ListFunctionsPaginator
- ListGraphqlApisPaginator
- ListResolversByFunctionPaginator
- ListResolversPaginator
- ListSourceApiAssociationsPaginator
- ListTypesByAssociationPaginator
- ListTypesPaginator
Literals#
Type annotations for literals used in methods and schema.
# ApiCacheStatusType usage example
from types_boto3_appsync.literals import ApiCacheStatusType
def get_value() -> ApiCacheStatusType:
return "AVAILABLE"
- ApiCacheStatusType
- ApiCacheTypeType
- ApiCachingBehaviorType
- AssociationStatusType
- AuthenticationTypeType
- AuthorizationTypeType
- CacheHealthMetricsConfigType
- ConflictDetectionTypeType
- ConflictHandlerTypeType
- DataSourceIntrospectionStatusType
- DataSourceLevelMetricsBehaviorType
- DataSourceLevelMetricsConfigType
- DataSourceTypeType
- DefaultActionType
- EventLogLevelType
- FieldLogLevelType
- GraphQLApiIntrospectionConfigType
- GraphQLApiTypeType
- GraphQLApiVisibilityType
- ListApiKeysPaginatorName
- ListApisPaginatorName
- ListChannelNamespacesPaginatorName
- ListDataSourcesPaginatorName
- ListDomainNamesPaginatorName
- ListFunctionsPaginatorName
- ListGraphqlApisPaginatorName
- ListResolversByFunctionPaginatorName
- ListResolversPaginatorName
- ListSourceApiAssociationsPaginatorName
- ListTypesByAssociationPaginatorName
- ListTypesPaginatorName
- MergeTypeType
- OperationLevelMetricsConfigType
- OutputTypeType
- OwnershipType
- RelationalDatabaseSourceTypeType
- ResolverKindType
- ResolverLevelMetricsBehaviorType
- ResolverLevelMetricsConfigType
- RuntimeNameType
- SchemaStatusType
- SourceApiAssociationStatusType
- TypeDefinitionFormatType
- AppSyncServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- CognitoUserPoolConfigTypeDef
- LambdaAuthorizerConfigTypeDef
- OpenIDConnectConfigTypeDef
- ApiAssociationTypeDef
- ApiCacheTypeDef
- ApiKeyTypeDef
- AppSyncRuntimeTypeDef
- AssociateApiRequestTypeDef
- ResponseMetadataTypeDef
- SourceApiAssociationConfigTypeDef
- AuthModeTypeDef
- CognitoConfigTypeDef
- AwsIamConfigTypeDef
- BlobTypeDef
- CachingConfigOutputTypeDef
- CachingConfigTypeDef
- CodeErrorLocationTypeDef
- CreateApiCacheRequestTypeDef
- CreateApiKeyRequestTypeDef
- ElasticsearchDataSourceConfigTypeDef
- EventBridgeDataSourceConfigTypeDef
- LambdaDataSourceConfigTypeDef
- OpenSearchServiceDataSourceConfigTypeDef
- CreateDomainNameRequestTypeDef
- DomainNameConfigTypeDef
- EnhancedMetricsConfigTypeDef
- LogConfigTypeDef
- UserPoolConfigTypeDef
- CreateTypeRequestTypeDef
- TypeTypeDef
- DataSourceIntrospectionModelFieldTypeTypeDef
- DataSourceIntrospectionModelIndexTypeDef
- DeleteApiCacheRequestTypeDef
- DeleteApiKeyRequestTypeDef
- DeleteApiRequestTypeDef
- DeleteChannelNamespaceRequestTypeDef
- DeleteDataSourceRequestTypeDef
- DeleteDomainNameRequestTypeDef
- DeleteFunctionRequestTypeDef
- DeleteGraphqlApiRequestTypeDef
- DeleteResolverRequestTypeDef
- DeleteTypeRequestTypeDef
- DeltaSyncConfigTypeDef
- DisassociateApiRequestTypeDef
- DisassociateMergedGraphqlApiRequestTypeDef
- DisassociateSourceGraphqlApiRequestTypeDef
- ErrorDetailTypeDef
- EvaluateMappingTemplateRequestTypeDef
- EventLogConfigTypeDef
- FlushApiCacheRequestTypeDef
- GetApiAssociationRequestTypeDef
- GetApiCacheRequestTypeDef
- GetApiRequestTypeDef
- GetChannelNamespaceRequestTypeDef
- GetDataSourceIntrospectionRequestTypeDef
- GetDataSourceRequestTypeDef
- GetDomainNameRequestTypeDef
- GetFunctionRequestTypeDef
- GetGraphqlApiEnvironmentVariablesRequestTypeDef
- GetGraphqlApiRequestTypeDef
- GetIntrospectionSchemaRequestTypeDef
- GetResolverRequestTypeDef
- GetSchemaCreationStatusRequestTypeDef
- GetSourceApiAssociationRequestTypeDef
- GetTypeRequestTypeDef
- LambdaConflictHandlerConfigTypeDef
- PaginatorConfigTypeDef
- ListApiKeysRequestTypeDef
- ListApisRequestTypeDef
- ListChannelNamespacesRequestTypeDef
- ListDataSourcesRequestTypeDef
- ListDomainNamesRequestTypeDef
- ListFunctionsRequestTypeDef
- ListGraphqlApisRequestTypeDef
- ListResolversByFunctionRequestTypeDef
- ListResolversRequestTypeDef
- ListSourceApiAssociationsRequestTypeDef
- SourceApiAssociationSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- ListTypesByAssociationRequestTypeDef
- ListTypesRequestTypeDef
- PipelineConfigOutputTypeDef
- PipelineConfigTypeDef
- PutGraphqlApiEnvironmentVariablesRequestTypeDef
- RdsDataApiConfigTypeDef
- RdsHttpEndpointConfigTypeDef
- StartSchemaMergeRequestTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateApiCacheRequestTypeDef
- UpdateApiKeyRequestTypeDef
- UpdateDomainNameRequestTypeDef
- UpdateTypeRequestTypeDef
- AdditionalAuthenticationProviderTypeDef
- EvaluateCodeRequestTypeDef
- AssociateApiResponseTypeDef
- CreateApiCacheResponseTypeDef
- CreateApiKeyResponseTypeDef
- DisassociateMergedGraphqlApiResponseTypeDef
- DisassociateSourceGraphqlApiResponseTypeDef
- GetApiAssociationResponseTypeDef
- GetApiCacheResponseTypeDef
- GetGraphqlApiEnvironmentVariablesResponseTypeDef
- GetIntrospectionSchemaResponseTypeDef
- GetSchemaCreationStatusResponseTypeDef
- ListApiKeysResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutGraphqlApiEnvironmentVariablesResponseTypeDef
- StartDataSourceIntrospectionResponseTypeDef
- StartSchemaCreationResponseTypeDef
- StartSchemaMergeResponseTypeDef
- UpdateApiCacheResponseTypeDef
- UpdateApiKeyResponseTypeDef
- AssociateMergedGraphqlApiRequestTypeDef
- AssociateSourceGraphqlApiRequestTypeDef
- SourceApiAssociationTypeDef
- UpdateSourceApiAssociationRequestTypeDef
- ChannelNamespaceTypeDef
- CreateChannelNamespaceRequestTypeDef
- UpdateChannelNamespaceRequestTypeDef
- AuthProviderTypeDef
- AuthorizationConfigTypeDef
- StartSchemaCreationRequestTypeDef
- CachingConfigUnionTypeDef
- CodeErrorTypeDef
- CreateDomainNameResponseTypeDef
- GetDomainNameResponseTypeDef
- ListDomainNamesResponseTypeDef
- UpdateDomainNameResponseTypeDef
- CreateTypeResponseTypeDef
- GetTypeResponseTypeDef
- ListTypesByAssociationResponseTypeDef
- ListTypesResponseTypeDef
- UpdateTypeResponseTypeDef
- DataSourceIntrospectionModelFieldTypeDef
- DynamodbDataSourceConfigTypeDef
- EvaluateMappingTemplateResponseTypeDef
- SyncConfigTypeDef
- ListApiKeysRequestPaginateTypeDef
- ListApisRequestPaginateTypeDef
- ListChannelNamespacesRequestPaginateTypeDef
- ListDataSourcesRequestPaginateTypeDef
- ListDomainNamesRequestPaginateTypeDef
- ListFunctionsRequestPaginateTypeDef
- ListGraphqlApisRequestPaginateTypeDef
- ListResolversByFunctionRequestPaginateTypeDef
- ListResolversRequestPaginateTypeDef
- ListSourceApiAssociationsRequestPaginateTypeDef
- ListTypesByAssociationRequestPaginateTypeDef
- ListTypesRequestPaginateTypeDef
- ListSourceApiAssociationsResponseTypeDef
- PipelineConfigUnionTypeDef
- StartDataSourceIntrospectionRequestTypeDef
- RelationalDatabaseDataSourceConfigTypeDef
- CreateGraphqlApiRequestTypeDef
- GraphqlApiTypeDef
- UpdateGraphqlApiRequestTypeDef
- AssociateMergedGraphqlApiResponseTypeDef
- AssociateSourceGraphqlApiResponseTypeDef
- GetSourceApiAssociationResponseTypeDef
- UpdateSourceApiAssociationResponseTypeDef
- CreateChannelNamespaceResponseTypeDef
- GetChannelNamespaceResponseTypeDef
- ListChannelNamespacesResponseTypeDef
- UpdateChannelNamespaceResponseTypeDef
- EventConfigOutputTypeDef
- EventConfigTypeDef
- HttpDataSourceConfigTypeDef
- EvaluateCodeErrorDetailTypeDef
- DataSourceIntrospectionModelTypeDef
- CreateFunctionRequestTypeDef
- FunctionConfigurationTypeDef
- ResolverTypeDef
- UpdateFunctionRequestTypeDef
- CreateResolverRequestTypeDef
- UpdateResolverRequestTypeDef
- CreateGraphqlApiResponseTypeDef
- GetGraphqlApiResponseTypeDef
- ListGraphqlApisResponseTypeDef
- UpdateGraphqlApiResponseTypeDef
- ApiTypeDef
- EventConfigUnionTypeDef
- CreateDataSourceRequestTypeDef
- DataSourceTypeDef
- UpdateDataSourceRequestTypeDef
- EvaluateCodeResponseTypeDef
- DataSourceIntrospectionResultTypeDef
- CreateFunctionResponseTypeDef
- GetFunctionResponseTypeDef
- ListFunctionsResponseTypeDef
- UpdateFunctionResponseTypeDef
- CreateResolverResponseTypeDef
- GetResolverResponseTypeDef
- ListResolversByFunctionResponseTypeDef
- ListResolversResponseTypeDef
- UpdateResolverResponseTypeDef
- CreateApiResponseTypeDef
- GetApiResponseTypeDef
- ListApisResponseTypeDef
- UpdateApiResponseTypeDef
- CreateApiRequestTypeDef
- UpdateApiRequestTypeDef
- CreateDataSourceResponseTypeDef
- GetDataSourceResponseTypeDef
- ListDataSourcesResponseTypeDef
- UpdateDataSourceResponseTypeDef
- GetDataSourceIntrospectionResponseTypeDef