AppSyncClient

Index > AppSync > AppSyncClient

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

AppSyncClient

Type annotations and code completion for boto3.client("appsync"). boto3 documentation

# AppSyncClient usage example

from boto3.session import Session
from mypy_boto3_appsync.client import AppSyncClient

def get_appsync_client() -> AppSyncClient:
    return Session().client("appsync")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("appsync").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("appsync")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ApiKeyLimitExceededException,
    client.exceptions.ApiKeyValidityOutOfBoundsException,
    client.exceptions.ApiLimitExceededException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.ConflictException,
    client.exceptions.GraphQLSchemaException,
    client.exceptions.InternalFailureException,
    client.exceptions.LimitExceededException,
    client.exceptions.NotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_appsync.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("appsync").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("appsync").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_api

Maps an endpoint to your custom domain.

Type annotations and code completion for boto3.client("appsync").associate_api method. boto3 documentation

# associate_api method definition

def associate_api(
    self,
    *,
    domainName: str,
    apiId: str,
) -> AssociateApiResponseTypeDef:  # (1)
    ...

1. See AssociateApiResponseTypeDef

# associate_api method usage example with argument unpacking

kwargs: AssociateApiRequestTypeDef = {  # (1)
    "domainName": ...,
    "apiId": ...,
}

parent.associate_api(**kwargs)

1. See AssociateApiRequestTypeDef

associate_merged_graphql_api

Creates an association between a Merged API and source API using the source API's identifier.

Type annotations and code completion for boto3.client("appsync").associate_merged_graphql_api method. boto3 documentation

# associate_merged_graphql_api method definition

def associate_merged_graphql_api(
    self,
    *,
    sourceApiIdentifier: str,
    mergedApiIdentifier: str,
    description: str = ...,
    sourceApiAssociationConfig: SourceApiAssociationConfigTypeDef = ...,  # (1)
) -> AssociateMergedGraphqlApiResponseTypeDef:  # (2)
    ...

1. See SourceApiAssociationConfigTypeDef
2. See AssociateMergedGraphqlApiResponseTypeDef

# associate_merged_graphql_api method usage example with argument unpacking

kwargs: AssociateMergedGraphqlApiRequestTypeDef = {  # (1)
    "sourceApiIdentifier": ...,
    "mergedApiIdentifier": ...,
}

parent.associate_merged_graphql_api(**kwargs)

1. See AssociateMergedGraphqlApiRequestTypeDef

associate_source_graphql_api

Creates an association between a Merged API and source API using the Merged API's identifier.

Type annotations and code completion for boto3.client("appsync").associate_source_graphql_api method. boto3 documentation

# associate_source_graphql_api method definition

def associate_source_graphql_api(
    self,
    *,
    mergedApiIdentifier: str,
    sourceApiIdentifier: str,
    description: str = ...,
    sourceApiAssociationConfig: SourceApiAssociationConfigTypeDef = ...,  # (1)
) -> AssociateSourceGraphqlApiResponseTypeDef:  # (2)
    ...

1. See SourceApiAssociationConfigTypeDef
2. See AssociateSourceGraphqlApiResponseTypeDef

# associate_source_graphql_api method usage example with argument unpacking

kwargs: AssociateSourceGraphqlApiRequestTypeDef = {  # (1)
    "mergedApiIdentifier": ...,
    "sourceApiIdentifier": ...,
}

parent.associate_source_graphql_api(**kwargs)

1. See AssociateSourceGraphqlApiRequestTypeDef

create_api

Creates an Api object.

Type annotations and code completion for boto3.client("appsync").create_api method. boto3 documentation

# create_api method definition

def create_api(
    self,
    *,
    name: str,
    ownerContact: str = ...,
    tags: Mapping[str, str] = ...,
    eventConfig: EventConfigUnionTypeDef = ...,  # (1)
) -> CreateApiResponseTypeDef:  # (2)
    ...

1. See EventConfigUnionTypeDef
2. See CreateApiResponseTypeDef

# create_api method usage example with argument unpacking

kwargs: CreateApiRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_api(**kwargs)

1. See CreateApiRequestTypeDef

create_api_cache

Creates a cache for the GraphQL API.

Type annotations and code completion for boto3.client("appsync").create_api_cache method. boto3 documentation

# create_api_cache method definition

def create_api_cache(
    self,
    *,
    apiId: str,
    ttl: int,
    apiCachingBehavior: ApiCachingBehaviorType,  # (1)
    type: ApiCacheTypeType,  # (2)
    transitEncryptionEnabled: bool = ...,
    atRestEncryptionEnabled: bool = ...,
    healthMetricsConfig: CacheHealthMetricsConfigType = ...,  # (3)
) -> CreateApiCacheResponseTypeDef:  # (4)
    ...

1. See ApiCachingBehaviorType
2. See ApiCacheTypeType
3. See CacheHealthMetricsConfigType
4. See CreateApiCacheResponseTypeDef

# create_api_cache method usage example with argument unpacking

kwargs: CreateApiCacheRequestTypeDef = {  # (1)
    "apiId": ...,
    "ttl": ...,
    "apiCachingBehavior": ...,
    "type": ...,
}

parent.create_api_cache(**kwargs)

1. See CreateApiCacheRequestTypeDef

create_api_key

Creates a unique key that you can distribute to clients who invoke your API.

Type annotations and code completion for boto3.client("appsync").create_api_key method. boto3 documentation

# create_api_key method definition

def create_api_key(
    self,
    *,
    apiId: str,
    description: str = ...,
    expires: int = ...,
) -> CreateApiKeyResponseTypeDef:  # (1)
    ...

1. See CreateApiKeyResponseTypeDef

# create_api_key method usage example with argument unpacking

kwargs: CreateApiKeyRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.create_api_key(**kwargs)

1. See CreateApiKeyRequestTypeDef

create_channel_namespace

Creates a ChannelNamespace for an Api.

Type annotations and code completion for boto3.client("appsync").create_channel_namespace method. boto3 documentation

# create_channel_namespace method definition

def create_channel_namespace(
    self,
    *,
    apiId: str,
    name: str,
    subscribeAuthModes: Sequence[AuthModeTypeDef] = ...,  # (1)
    publishAuthModes: Sequence[AuthModeTypeDef] = ...,  # (1)
    codeHandlers: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateChannelNamespaceResponseTypeDef:  # (3)
    ...

1. See Sequence[AuthModeTypeDef]
2. See Sequence[AuthModeTypeDef]
3. See CreateChannelNamespaceResponseTypeDef

# create_channel_namespace method usage example with argument unpacking

kwargs: CreateChannelNamespaceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
}

parent.create_channel_namespace(**kwargs)

1. See CreateChannelNamespaceRequestTypeDef

create_data_source

Creates a DataSource object.

Type annotations and code completion for boto3.client("appsync").create_data_source method. boto3 documentation

# create_data_source method definition

def create_data_source(
    self,
    *,
    apiId: str,
    name: str,
    type: DataSourceTypeType,  # (1)
    description: str = ...,
    serviceRoleArn: str = ...,
    dynamodbConfig: DynamodbDataSourceConfigTypeDef = ...,  # (2)
    lambdaConfig: LambdaDataSourceConfigTypeDef = ...,  # (3)
    elasticsearchConfig: ElasticsearchDataSourceConfigTypeDef = ...,  # (4)
    openSearchServiceConfig: OpenSearchServiceDataSourceConfigTypeDef = ...,  # (5)
    httpConfig: HttpDataSourceConfigTypeDef = ...,  # (6)
    relationalDatabaseConfig: RelationalDatabaseDataSourceConfigTypeDef = ...,  # (7)
    eventBridgeConfig: EventBridgeDataSourceConfigTypeDef = ...,  # (8)
    metricsConfig: DataSourceLevelMetricsConfigType = ...,  # (9)
) -> CreateDataSourceResponseTypeDef:  # (10)
    ...

1. See DataSourceTypeType
2. See DynamodbDataSourceConfigTypeDef
3. See LambdaDataSourceConfigTypeDef
4. See ElasticsearchDataSourceConfigTypeDef
5. See OpenSearchServiceDataSourceConfigTypeDef
6. See HttpDataSourceConfigTypeDef
7. See RelationalDatabaseDataSourceConfigTypeDef
8. See EventBridgeDataSourceConfigTypeDef
9. See DataSourceLevelMetricsConfigType
10. See CreateDataSourceResponseTypeDef

# create_data_source method usage example with argument unpacking

kwargs: CreateDataSourceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
    "type": ...,
}

parent.create_data_source(**kwargs)

1. See CreateDataSourceRequestTypeDef

create_domain_name

Creates a custom DomainName object.

Type annotations and code completion for boto3.client("appsync").create_domain_name method. boto3 documentation

# create_domain_name method definition

def create_domain_name(
    self,
    *,
    domainName: str,
    certificateArn: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateDomainNameResponseTypeDef:  # (1)
    ...

1. See CreateDomainNameResponseTypeDef

# create_domain_name method usage example with argument unpacking

kwargs: CreateDomainNameRequestTypeDef = {  # (1)
    "domainName": ...,
    "certificateArn": ...,
}

parent.create_domain_name(**kwargs)

1. See CreateDomainNameRequestTypeDef

create_function

Creates a Function object.

Type annotations and code completion for boto3.client("appsync").create_function method. boto3 documentation

# create_function method definition

def create_function(
    self,
    *,
    apiId: str,
    name: str,
    dataSourceName: str,
    description: str = ...,
    requestMappingTemplate: str = ...,
    responseMappingTemplate: str = ...,
    functionVersion: str = ...,
    syncConfig: SyncConfigTypeDef = ...,  # (1)
    maxBatchSize: int = ...,
    runtime: AppSyncRuntimeTypeDef = ...,  # (2)
    code: str = ...,
) -> CreateFunctionResponseTypeDef:  # (3)
    ...

1. See SyncConfigTypeDef
2. See AppSyncRuntimeTypeDef
3. See CreateFunctionResponseTypeDef

# create_function method usage example with argument unpacking

kwargs: CreateFunctionRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
    "dataSourceName": ...,
}

parent.create_function(**kwargs)

1. See CreateFunctionRequestTypeDef

create_graphql_api

Creates a GraphqlApi object.

Type annotations and code completion for boto3.client("appsync").create_graphql_api method. boto3 documentation

# create_graphql_api method definition

def create_graphql_api(
    self,
    *,
    name: str,
    authenticationType: AuthenticationTypeType,  # (1)
    logConfig: LogConfigTypeDef = ...,  # (2)
    userPoolConfig: UserPoolConfigTypeDef = ...,  # (3)
    openIDConnectConfig: OpenIDConnectConfigTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
    additionalAuthenticationProviders: Sequence[AdditionalAuthenticationProviderTypeDef] = ...,  # (5)
    xrayEnabled: bool = ...,
    lambdaAuthorizerConfig: LambdaAuthorizerConfigTypeDef = ...,  # (6)
    apiType: GraphQLApiTypeType = ...,  # (7)
    mergedApiExecutionRoleArn: str = ...,
    visibility: GraphQLApiVisibilityType = ...,  # (8)
    ownerContact: str = ...,
    introspectionConfig: GraphQLApiIntrospectionConfigType = ...,  # (9)
    queryDepthLimit: int = ...,
    resolverCountLimit: int = ...,
    enhancedMetricsConfig: EnhancedMetricsConfigTypeDef = ...,  # (10)
) -> CreateGraphqlApiResponseTypeDef:  # (11)
    ...

1. See AuthenticationTypeType
2. See LogConfigTypeDef
3. See UserPoolConfigTypeDef
4. See OpenIDConnectConfigTypeDef
5. See Sequence[AdditionalAuthenticationProviderTypeDef]
6. See LambdaAuthorizerConfigTypeDef
7. See GraphQLApiTypeType
8. See GraphQLApiVisibilityType
9. See GraphQLApiIntrospectionConfigType
10. See EnhancedMetricsConfigTypeDef
11. See CreateGraphqlApiResponseTypeDef

# create_graphql_api method usage example with argument unpacking

kwargs: CreateGraphqlApiRequestTypeDef = {  # (1)
    "name": ...,
    "authenticationType": ...,
}

parent.create_graphql_api(**kwargs)

1. See CreateGraphqlApiRequestTypeDef

create_resolver

Creates a Resolver object.

Type annotations and code completion for boto3.client("appsync").create_resolver method. boto3 documentation

# create_resolver method definition

def create_resolver(
    self,
    *,
    apiId: str,
    typeName: str,
    fieldName: str,
    dataSourceName: str = ...,
    requestMappingTemplate: str = ...,
    responseMappingTemplate: str = ...,
    kind: ResolverKindType = ...,  # (1)
    pipelineConfig: PipelineConfigUnionTypeDef = ...,  # (2)
    syncConfig: SyncConfigTypeDef = ...,  # (3)
    cachingConfig: CachingConfigUnionTypeDef = ...,  # (4)
    maxBatchSize: int = ...,
    runtime: AppSyncRuntimeTypeDef = ...,  # (5)
    code: str = ...,
    metricsConfig: ResolverLevelMetricsConfigType = ...,  # (6)
) -> CreateResolverResponseTypeDef:  # (7)
    ...

1. See ResolverKindType
2. See PipelineConfigUnionTypeDef
3. See SyncConfigTypeDef
4. See CachingConfigUnionTypeDef
5. See AppSyncRuntimeTypeDef
6. See ResolverLevelMetricsConfigType
7. See CreateResolverResponseTypeDef

# create_resolver method usage example with argument unpacking

kwargs: CreateResolverRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
    "fieldName": ...,
}

parent.create_resolver(**kwargs)

1. See CreateResolverRequestTypeDef

create_type

Creates a Type object.

Type annotations and code completion for boto3.client("appsync").create_type method. boto3 documentation

# create_type method definition

def create_type(
    self,
    *,
    apiId: str,
    definition: str,
    format: TypeDefinitionFormatType,  # (1)
) -> CreateTypeResponseTypeDef:  # (2)
    ...

1. See TypeDefinitionFormatType
2. See CreateTypeResponseTypeDef

# create_type method usage example with argument unpacking

kwargs: CreateTypeRequestTypeDef = {  # (1)
    "apiId": ...,
    "definition": ...,
    "format": ...,
}

parent.create_type(**kwargs)

1. See CreateTypeRequestTypeDef

delete_api

Deletes an Api object.

Type annotations and code completion for boto3.client("appsync").delete_api method. boto3 documentation

# delete_api method definition

def delete_api(
    self,
    *,
    apiId: str,
) -> Dict[str, Any]:
    ...

# delete_api method usage example with argument unpacking

kwargs: DeleteApiRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.delete_api(**kwargs)

1. See DeleteApiRequestTypeDef

delete_api_cache

Deletes an ApiCache object.

Type annotations and code completion for boto3.client("appsync").delete_api_cache method. boto3 documentation

# delete_api_cache method definition

def delete_api_cache(
    self,
    *,
    apiId: str,
) -> Dict[str, Any]:
    ...

# delete_api_cache method usage example with argument unpacking

kwargs: DeleteApiCacheRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.delete_api_cache(**kwargs)

1. See DeleteApiCacheRequestTypeDef

delete_api_key

Deletes an API key.

Type annotations and code completion for boto3.client("appsync").delete_api_key method. boto3 documentation

# delete_api_key method definition

def delete_api_key(
    self,
    *,
    apiId: str,
    id: str,
) -> Dict[str, Any]:
    ...

# delete_api_key method usage example with argument unpacking

kwargs: DeleteApiKeyRequestTypeDef = {  # (1)
    "apiId": ...,
    "id": ...,
}

parent.delete_api_key(**kwargs)

1. See DeleteApiKeyRequestTypeDef

delete_channel_namespace

Deletes a ChannelNamespace.

Type annotations and code completion for boto3.client("appsync").delete_channel_namespace method. boto3 documentation

# delete_channel_namespace method definition

def delete_channel_namespace(
    self,
    *,
    apiId: str,
    name: str,
) -> Dict[str, Any]:
    ...

# delete_channel_namespace method usage example with argument unpacking

kwargs: DeleteChannelNamespaceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
}

parent.delete_channel_namespace(**kwargs)

1. See DeleteChannelNamespaceRequestTypeDef

delete_data_source

Deletes a DataSource object.

Type annotations and code completion for boto3.client("appsync").delete_data_source method. boto3 documentation

# delete_data_source method definition

def delete_data_source(
    self,
    *,
    apiId: str,
    name: str,
) -> Dict[str, Any]:
    ...

# delete_data_source method usage example with argument unpacking

kwargs: DeleteDataSourceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
}

parent.delete_data_source(**kwargs)

1. See DeleteDataSourceRequestTypeDef

delete_domain_name

Deletes a custom DomainName object.

Type annotations and code completion for boto3.client("appsync").delete_domain_name method. boto3 documentation

# delete_domain_name method definition

def delete_domain_name(
    self,
    *,
    domainName: str,
) -> Dict[str, Any]:
    ...

# delete_domain_name method usage example with argument unpacking

kwargs: DeleteDomainNameRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.delete_domain_name(**kwargs)

1. See DeleteDomainNameRequestTypeDef

delete_function

Deletes a Function.

Type annotations and code completion for boto3.client("appsync").delete_function method. boto3 documentation

# delete_function method definition

def delete_function(
    self,
    *,
    apiId: str,
    functionId: str,
) -> Dict[str, Any]:
    ...

# delete_function method usage example with argument unpacking

kwargs: DeleteFunctionRequestTypeDef = {  # (1)
    "apiId": ...,
    "functionId": ...,
}

parent.delete_function(**kwargs)

1. See DeleteFunctionRequestTypeDef

delete_graphql_api

Deletes a GraphqlApi object.

Type annotations and code completion for boto3.client("appsync").delete_graphql_api method. boto3 documentation

# delete_graphql_api method definition

def delete_graphql_api(
    self,
    *,
    apiId: str,
) -> Dict[str, Any]:
    ...

# delete_graphql_api method usage example with argument unpacking

kwargs: DeleteGraphqlApiRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.delete_graphql_api(**kwargs)

1. See DeleteGraphqlApiRequestTypeDef

delete_resolver

Deletes a Resolver object.

Type annotations and code completion for boto3.client("appsync").delete_resolver method. boto3 documentation

# delete_resolver method definition

def delete_resolver(
    self,
    *,
    apiId: str,
    typeName: str,
    fieldName: str,
) -> Dict[str, Any]:
    ...

# delete_resolver method usage example with argument unpacking

kwargs: DeleteResolverRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
    "fieldName": ...,
}

parent.delete_resolver(**kwargs)

1. See DeleteResolverRequestTypeDef

delete_type

Deletes a Type object.

Type annotations and code completion for boto3.client("appsync").delete_type method. boto3 documentation

# delete_type method definition

def delete_type(
    self,
    *,
    apiId: str,
    typeName: str,
) -> Dict[str, Any]:
    ...

# delete_type method usage example with argument unpacking

kwargs: DeleteTypeRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
}

parent.delete_type(**kwargs)

1. See DeleteTypeRequestTypeDef

disassociate_api

Removes an ApiAssociation object from a custom domain.

Type annotations and code completion for boto3.client("appsync").disassociate_api method. boto3 documentation

# disassociate_api method definition

def disassociate_api(
    self,
    *,
    domainName: str,
) -> Dict[str, Any]:
    ...

# disassociate_api method usage example with argument unpacking

kwargs: DisassociateApiRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.disassociate_api(**kwargs)

1. See DisassociateApiRequestTypeDef

disassociate_merged_graphql_api

Deletes an association between a Merged API and source API using the source API's identifier and the association ID.

Type annotations and code completion for boto3.client("appsync").disassociate_merged_graphql_api method. boto3 documentation

# disassociate_merged_graphql_api method definition

def disassociate_merged_graphql_api(
    self,
    *,
    sourceApiIdentifier: str,
    associationId: str,
) -> DisassociateMergedGraphqlApiResponseTypeDef:  # (1)
    ...

1. See DisassociateMergedGraphqlApiResponseTypeDef

# disassociate_merged_graphql_api method usage example with argument unpacking

kwargs: DisassociateMergedGraphqlApiRequestTypeDef = {  # (1)
    "sourceApiIdentifier": ...,
    "associationId": ...,
}

parent.disassociate_merged_graphql_api(**kwargs)

1. See DisassociateMergedGraphqlApiRequestTypeDef

disassociate_source_graphql_api

Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.

Type annotations and code completion for boto3.client("appsync").disassociate_source_graphql_api method. boto3 documentation

# disassociate_source_graphql_api method definition

def disassociate_source_graphql_api(
    self,
    *,
    mergedApiIdentifier: str,
    associationId: str,
) -> DisassociateSourceGraphqlApiResponseTypeDef:  # (1)
    ...

1. See DisassociateSourceGraphqlApiResponseTypeDef

# disassociate_source_graphql_api method usage example with argument unpacking

kwargs: DisassociateSourceGraphqlApiRequestTypeDef = {  # (1)
    "mergedApiIdentifier": ...,
    "associationId": ...,
}

parent.disassociate_source_graphql_api(**kwargs)

1. See DisassociateSourceGraphqlApiRequestTypeDef

evaluate_code

Evaluates the given code and returns the response.

Type annotations and code completion for boto3.client("appsync").evaluate_code method. boto3 documentation

# evaluate_code method definition

def evaluate_code(
    self,
    *,
    runtime: AppSyncRuntimeTypeDef,  # (1)
    code: str,
    context: str,
    function: str = ...,
) -> EvaluateCodeResponseTypeDef:  # (2)
    ...

1. See AppSyncRuntimeTypeDef
2. See EvaluateCodeResponseTypeDef

# evaluate_code method usage example with argument unpacking

kwargs: EvaluateCodeRequestTypeDef = {  # (1)
    "runtime": ...,
    "code": ...,
    "context": ...,
}

parent.evaluate_code(**kwargs)

1. See EvaluateCodeRequestTypeDef

evaluate_mapping_template

Evaluates a given template and returns the response.

Type annotations and code completion for boto3.client("appsync").evaluate_mapping_template method. boto3 documentation

# evaluate_mapping_template method definition

def evaluate_mapping_template(
    self,
    *,
    template: str,
    context: str,
) -> EvaluateMappingTemplateResponseTypeDef:  # (1)
    ...

1. See EvaluateMappingTemplateResponseTypeDef

# evaluate_mapping_template method usage example with argument unpacking

kwargs: EvaluateMappingTemplateRequestTypeDef = {  # (1)
    "template": ...,
    "context": ...,
}

parent.evaluate_mapping_template(**kwargs)

1. See EvaluateMappingTemplateRequestTypeDef

flush_api_cache

Flushes an ApiCache object.

Type annotations and code completion for boto3.client("appsync").flush_api_cache method. boto3 documentation

# flush_api_cache method definition

def flush_api_cache(
    self,
    *,
    apiId: str,
) -> Dict[str, Any]:
    ...

# flush_api_cache method usage example with argument unpacking

kwargs: FlushApiCacheRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.flush_api_cache(**kwargs)

1. See FlushApiCacheRequestTypeDef

get_api

Retrieves an Api object.

Type annotations and code completion for boto3.client("appsync").get_api method. boto3 documentation

# get_api method definition

def get_api(
    self,
    *,
    apiId: str,
) -> GetApiResponseTypeDef:  # (1)
    ...

1. See GetApiResponseTypeDef

# get_api method usage example with argument unpacking

kwargs: GetApiRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.get_api(**kwargs)

1. See GetApiRequestTypeDef

get_api_association

Retrieves an ApiAssociation object.

Type annotations and code completion for boto3.client("appsync").get_api_association method. boto3 documentation

# get_api_association method definition

def get_api_association(
    self,
    *,
    domainName: str,
) -> GetApiAssociationResponseTypeDef:  # (1)
    ...

1. See GetApiAssociationResponseTypeDef

# get_api_association method usage example with argument unpacking

kwargs: GetApiAssociationRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.get_api_association(**kwargs)

1. See GetApiAssociationRequestTypeDef

get_api_cache

Retrieves an ApiCache object.

Type annotations and code completion for boto3.client("appsync").get_api_cache method. boto3 documentation

# get_api_cache method definition

def get_api_cache(
    self,
    *,
    apiId: str,
) -> GetApiCacheResponseTypeDef:  # (1)
    ...

1. See GetApiCacheResponseTypeDef

# get_api_cache method usage example with argument unpacking

kwargs: GetApiCacheRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.get_api_cache(**kwargs)

1. See GetApiCacheRequestTypeDef

get_channel_namespace

Retrieves the channel namespace for a specified Api.

Type annotations and code completion for boto3.client("appsync").get_channel_namespace method. boto3 documentation

# get_channel_namespace method definition

def get_channel_namespace(
    self,
    *,
    apiId: str,
    name: str,
) -> GetChannelNamespaceResponseTypeDef:  # (1)
    ...

1. See GetChannelNamespaceResponseTypeDef

# get_channel_namespace method usage example with argument unpacking

kwargs: GetChannelNamespaceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
}

parent.get_channel_namespace(**kwargs)

1. See GetChannelNamespaceRequestTypeDef

get_data_source

Retrieves a DataSource object.

Type annotations and code completion for boto3.client("appsync").get_data_source method. boto3 documentation

# get_data_source method definition

def get_data_source(
    self,
    *,
    apiId: str,
    name: str,
) -> GetDataSourceResponseTypeDef:  # (1)
    ...

1. See GetDataSourceResponseTypeDef

# get_data_source method usage example with argument unpacking

kwargs: GetDataSourceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
}

parent.get_data_source(**kwargs)

1. See GetDataSourceRequestTypeDef

get_data_source_introspection

Retrieves the record of an existing introspection.

Type annotations and code completion for boto3.client("appsync").get_data_source_introspection method. boto3 documentation

# get_data_source_introspection method definition

def get_data_source_introspection(
    self,
    *,
    introspectionId: str,
    includeModelsSDL: bool = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetDataSourceIntrospectionResponseTypeDef:  # (1)
    ...

1. See GetDataSourceIntrospectionResponseTypeDef

# get_data_source_introspection method usage example with argument unpacking

kwargs: GetDataSourceIntrospectionRequestTypeDef = {  # (1)
    "introspectionId": ...,
}

parent.get_data_source_introspection(**kwargs)

1. See GetDataSourceIntrospectionRequestTypeDef

get_domain_name

Retrieves a custom DomainName object.

Type annotations and code completion for boto3.client("appsync").get_domain_name method. boto3 documentation

# get_domain_name method definition

def get_domain_name(
    self,
    *,
    domainName: str,
) -> GetDomainNameResponseTypeDef:  # (1)
    ...

1. See GetDomainNameResponseTypeDef

# get_domain_name method usage example with argument unpacking

kwargs: GetDomainNameRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.get_domain_name(**kwargs)

1. See GetDomainNameRequestTypeDef

get_function

Get a Function.

Type annotations and code completion for boto3.client("appsync").get_function method. boto3 documentation

# get_function method definition

def get_function(
    self,
    *,
    apiId: str,
    functionId: str,
) -> GetFunctionResponseTypeDef:  # (1)
    ...

1. See GetFunctionResponseTypeDef

# get_function method usage example with argument unpacking

kwargs: GetFunctionRequestTypeDef = {  # (1)
    "apiId": ...,
    "functionId": ...,
}

parent.get_function(**kwargs)

1. See GetFunctionRequestTypeDef

get_graphql_api

Retrieves a GraphqlApi object.

Type annotations and code completion for boto3.client("appsync").get_graphql_api method. boto3 documentation

# get_graphql_api method definition

def get_graphql_api(
    self,
    *,
    apiId: str,
) -> GetGraphqlApiResponseTypeDef:  # (1)
    ...

1. See GetGraphqlApiResponseTypeDef

# get_graphql_api method usage example with argument unpacking

kwargs: GetGraphqlApiRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.get_graphql_api(**kwargs)

1. See GetGraphqlApiRequestTypeDef

get_graphql_api_environment_variables

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

Type annotations and code completion for boto3.client("appsync").get_graphql_api_environment_variables method. boto3 documentation

# get_graphql_api_environment_variables method definition

def get_graphql_api_environment_variables(
    self,
    *,
    apiId: str,
) -> GetGraphqlApiEnvironmentVariablesResponseTypeDef:  # (1)
    ...

1. See GetGraphqlApiEnvironmentVariablesResponseTypeDef

# get_graphql_api_environment_variables method usage example with argument unpacking

kwargs: GetGraphqlApiEnvironmentVariablesRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.get_graphql_api_environment_variables(**kwargs)

1. See GetGraphqlApiEnvironmentVariablesRequestTypeDef

get_introspection_schema

Retrieves the introspection schema for a GraphQL API.

Type annotations and code completion for boto3.client("appsync").get_introspection_schema method. boto3 documentation

# get_introspection_schema method definition

def get_introspection_schema(
    self,
    *,
    apiId: str,
    format: OutputTypeType,  # (1)
    includeDirectives: bool = ...,
) -> GetIntrospectionSchemaResponseTypeDef:  # (2)
    ...

1. See OutputTypeType
2. See GetIntrospectionSchemaResponseTypeDef

# get_introspection_schema method usage example with argument unpacking

kwargs: GetIntrospectionSchemaRequestTypeDef = {  # (1)
    "apiId": ...,
    "format": ...,
}

parent.get_introspection_schema(**kwargs)

1. See GetIntrospectionSchemaRequestTypeDef

get_resolver

Retrieves a Resolver object.

Type annotations and code completion for boto3.client("appsync").get_resolver method. boto3 documentation

# get_resolver method definition

def get_resolver(
    self,
    *,
    apiId: str,
    typeName: str,
    fieldName: str,
) -> GetResolverResponseTypeDef:  # (1)
    ...

1. See GetResolverResponseTypeDef

# get_resolver method usage example with argument unpacking

kwargs: GetResolverRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
    "fieldName": ...,
}

parent.get_resolver(**kwargs)

1. See GetResolverRequestTypeDef

get_schema_creation_status

Retrieves the current status of a schema creation operation.

Type annotations and code completion for boto3.client("appsync").get_schema_creation_status method. boto3 documentation

# get_schema_creation_status method definition

def get_schema_creation_status(
    self,
    *,
    apiId: str,
) -> GetSchemaCreationStatusResponseTypeDef:  # (1)
    ...

1. See GetSchemaCreationStatusResponseTypeDef

# get_schema_creation_status method usage example with argument unpacking

kwargs: GetSchemaCreationStatusRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.get_schema_creation_status(**kwargs)

1. See GetSchemaCreationStatusRequestTypeDef

get_source_api_association

Retrieves a SourceApiAssociation object.

Type annotations and code completion for boto3.client("appsync").get_source_api_association method. boto3 documentation

# get_source_api_association method definition

def get_source_api_association(
    self,
    *,
    mergedApiIdentifier: str,
    associationId: str,
) -> GetSourceApiAssociationResponseTypeDef:  # (1)
    ...

1. See GetSourceApiAssociationResponseTypeDef

# get_source_api_association method usage example with argument unpacking

kwargs: GetSourceApiAssociationRequestTypeDef = {  # (1)
    "mergedApiIdentifier": ...,
    "associationId": ...,
}

parent.get_source_api_association(**kwargs)

1. See GetSourceApiAssociationRequestTypeDef

get_type

Retrieves a Type object.

Type annotations and code completion for boto3.client("appsync").get_type method. boto3 documentation

# get_type method definition

def get_type(
    self,
    *,
    apiId: str,
    typeName: str,
    format: TypeDefinitionFormatType,  # (1)
) -> GetTypeResponseTypeDef:  # (2)
    ...

1. See TypeDefinitionFormatType
2. See GetTypeResponseTypeDef

# get_type method usage example with argument unpacking

kwargs: GetTypeRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
    "format": ...,
}

parent.get_type(**kwargs)

1. See GetTypeRequestTypeDef

list_api_keys

Lists the API keys for a given API.

Type annotations and code completion for boto3.client("appsync").list_api_keys method. boto3 documentation

# list_api_keys method definition

def list_api_keys(
    self,
    *,
    apiId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListApiKeysResponseTypeDef:  # (1)
    ...

1. See ListApiKeysResponseTypeDef

# list_api_keys method usage example with argument unpacking

kwargs: ListApiKeysRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.list_api_keys(**kwargs)

1. See ListApiKeysRequestTypeDef

list_apis

Lists the APIs in your AppSync account.

Type annotations and code completion for boto3.client("appsync").list_apis method. boto3 documentation

# list_apis method definition

def list_apis(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListApisResponseTypeDef:  # (1)
    ...

1. See ListApisResponseTypeDef

# list_apis method usage example with argument unpacking

kwargs: ListApisRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_apis(**kwargs)

1. See ListApisRequestTypeDef

list_channel_namespaces

Lists the channel namespaces for a specified Api.

Type annotations and code completion for boto3.client("appsync").list_channel_namespaces method. boto3 documentation

# list_channel_namespaces method definition

def list_channel_namespaces(
    self,
    *,
    apiId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListChannelNamespacesResponseTypeDef:  # (1)
    ...

1. See ListChannelNamespacesResponseTypeDef

# list_channel_namespaces method usage example with argument unpacking

kwargs: ListChannelNamespacesRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.list_channel_namespaces(**kwargs)

1. See ListChannelNamespacesRequestTypeDef

list_data_sources

Lists the data sources for a given API.

Type annotations and code completion for boto3.client("appsync").list_data_sources method. boto3 documentation

# list_data_sources method definition

def list_data_sources(
    self,
    *,
    apiId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDataSourcesResponseTypeDef:  # (1)
    ...

1. See ListDataSourcesResponseTypeDef

# list_data_sources method usage example with argument unpacking

kwargs: ListDataSourcesRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.list_data_sources(**kwargs)

1. See ListDataSourcesRequestTypeDef

list_domain_names

Lists multiple custom domain names.

Type annotations and code completion for boto3.client("appsync").list_domain_names method. boto3 documentation

# list_domain_names method definition

def list_domain_names(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDomainNamesResponseTypeDef:  # (1)
    ...

1. See ListDomainNamesResponseTypeDef

# list_domain_names method usage example with argument unpacking

kwargs: ListDomainNamesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_domain_names(**kwargs)

1. See ListDomainNamesRequestTypeDef

list_functions

List multiple functions.

Type annotations and code completion for boto3.client("appsync").list_functions method. boto3 documentation

# list_functions method definition

def list_functions(
    self,
    *,
    apiId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFunctionsResponseTypeDef:  # (1)
    ...

1. See ListFunctionsResponseTypeDef

# list_functions method usage example with argument unpacking

kwargs: ListFunctionsRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.list_functions(**kwargs)

1. See ListFunctionsRequestTypeDef

list_graphql_apis

Lists your GraphQL APIs.

Type annotations and code completion for boto3.client("appsync").list_graphql_apis method. boto3 documentation

# list_graphql_apis method definition

def list_graphql_apis(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    apiType: GraphQLApiTypeType = ...,  # (1)
    owner: OwnershipType = ...,  # (2)
) -> ListGraphqlApisResponseTypeDef:  # (3)
    ...

1. See GraphQLApiTypeType
2. See OwnershipType
3. See ListGraphqlApisResponseTypeDef

# list_graphql_apis method usage example with argument unpacking

kwargs: ListGraphqlApisRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_graphql_apis(**kwargs)

1. See ListGraphqlApisRequestTypeDef

list_resolvers

Lists the resolvers for a given API and type.

Type annotations and code completion for boto3.client("appsync").list_resolvers method. boto3 documentation

# list_resolvers method definition

def list_resolvers(
    self,
    *,
    apiId: str,
    typeName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListResolversResponseTypeDef:  # (1)
    ...

1. See ListResolversResponseTypeDef

# list_resolvers method usage example with argument unpacking

kwargs: ListResolversRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
}

parent.list_resolvers(**kwargs)

1. See ListResolversRequestTypeDef

list_resolvers_by_function

List the resolvers that are associated with a specific function.

Type annotations and code completion for boto3.client("appsync").list_resolvers_by_function method. boto3 documentation

# list_resolvers_by_function method definition

def list_resolvers_by_function(
    self,
    *,
    apiId: str,
    functionId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListResolversByFunctionResponseTypeDef:  # (1)
    ...

1. See ListResolversByFunctionResponseTypeDef

# list_resolvers_by_function method usage example with argument unpacking

kwargs: ListResolversByFunctionRequestTypeDef = {  # (1)
    "apiId": ...,
    "functionId": ...,
}

parent.list_resolvers_by_function(**kwargs)

1. See ListResolversByFunctionRequestTypeDef

list_source_api_associations

Lists the SourceApiAssociationSummary data.

Type annotations and code completion for boto3.client("appsync").list_source_api_associations method. boto3 documentation

# list_source_api_associations method definition

def list_source_api_associations(
    self,
    *,
    apiId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSourceApiAssociationsResponseTypeDef:  # (1)
    ...

1. See ListSourceApiAssociationsResponseTypeDef

# list_source_api_associations method usage example with argument unpacking

kwargs: ListSourceApiAssociationsRequestTypeDef = {  # (1)
    "apiId": ...,
}

parent.list_source_api_associations(**kwargs)

1. See ListSourceApiAssociationsRequestTypeDef

list_tags_for_resource

Lists the tags for a resource.

Type annotations and code completion for boto3.client("appsync").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_types

Lists the types for a given API.

Type annotations and code completion for boto3.client("appsync").list_types method. boto3 documentation

# list_types method definition

def list_types(
    self,
    *,
    apiId: str,
    format: TypeDefinitionFormatType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTypesResponseTypeDef:  # (2)
    ...

1. See TypeDefinitionFormatType
2. See ListTypesResponseTypeDef

# list_types method usage example with argument unpacking

kwargs: ListTypesRequestTypeDef = {  # (1)
    "apiId": ...,
    "format": ...,
}

parent.list_types(**kwargs)

1. See ListTypesRequestTypeDef

list_types_by_association

Lists Type objects by the source API association ID.

Type annotations and code completion for boto3.client("appsync").list_types_by_association method. boto3 documentation

# list_types_by_association method definition

def list_types_by_association(
    self,
    *,
    mergedApiIdentifier: str,
    associationId: str,
    format: TypeDefinitionFormatType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTypesByAssociationResponseTypeDef:  # (2)
    ...

1. See TypeDefinitionFormatType
2. See ListTypesByAssociationResponseTypeDef

# list_types_by_association method usage example with argument unpacking

kwargs: ListTypesByAssociationRequestTypeDef = {  # (1)
    "mergedApiIdentifier": ...,
    "associationId": ...,
    "format": ...,
}

parent.list_types_by_association(**kwargs)

1. See ListTypesByAssociationRequestTypeDef

put_graphql_api_environment_variables

Creates a list of environmental variables in an API by its ID value.

Type annotations and code completion for boto3.client("appsync").put_graphql_api_environment_variables method. boto3 documentation

# put_graphql_api_environment_variables method definition

def put_graphql_api_environment_variables(
    self,
    *,
    apiId: str,
    environmentVariables: Mapping[str, str],
) -> PutGraphqlApiEnvironmentVariablesResponseTypeDef:  # (1)
    ...

1. See PutGraphqlApiEnvironmentVariablesResponseTypeDef

# put_graphql_api_environment_variables method usage example with argument unpacking

kwargs: PutGraphqlApiEnvironmentVariablesRequestTypeDef = {  # (1)
    "apiId": ...,
    "environmentVariables": ...,
}

parent.put_graphql_api_environment_variables(**kwargs)

1. See PutGraphqlApiEnvironmentVariablesRequestTypeDef

start_data_source_introspection

Creates a new introspection.

Type annotations and code completion for boto3.client("appsync").start_data_source_introspection method. boto3 documentation

# start_data_source_introspection method definition

def start_data_source_introspection(
    self,
    *,
    rdsDataApiConfig: RdsDataApiConfigTypeDef = ...,  # (1)
) -> StartDataSourceIntrospectionResponseTypeDef:  # (2)
    ...

1. See RdsDataApiConfigTypeDef
2. See StartDataSourceIntrospectionResponseTypeDef

# start_data_source_introspection method usage example with argument unpacking

kwargs: StartDataSourceIntrospectionRequestTypeDef = {  # (1)
    "rdsDataApiConfig": ...,
}

parent.start_data_source_introspection(**kwargs)

1. See StartDataSourceIntrospectionRequestTypeDef

start_schema_creation

Adds a new schema to your GraphQL API.

Type annotations and code completion for boto3.client("appsync").start_schema_creation method. boto3 documentation

# start_schema_creation method definition

def start_schema_creation(
    self,
    *,
    apiId: str,
    definition: BlobTypeDef,
) -> StartSchemaCreationResponseTypeDef:  # (1)
    ...

1. See StartSchemaCreationResponseTypeDef

# start_schema_creation method usage example with argument unpacking

kwargs: StartSchemaCreationRequestTypeDef = {  # (1)
    "apiId": ...,
    "definition": ...,
}

parent.start_schema_creation(**kwargs)

1. See StartSchemaCreationRequestTypeDef

start_schema_merge

Initiates a merge operation.

Type annotations and code completion for boto3.client("appsync").start_schema_merge method. boto3 documentation

# start_schema_merge method definition

def start_schema_merge(
    self,
    *,
    associationId: str,
    mergedApiIdentifier: str,
) -> StartSchemaMergeResponseTypeDef:  # (1)
    ...

1. See StartSchemaMergeResponseTypeDef

# start_schema_merge method usage example with argument unpacking

kwargs: StartSchemaMergeRequestTypeDef = {  # (1)
    "associationId": ...,
    "mergedApiIdentifier": ...,
}

parent.start_schema_merge(**kwargs)

1. See StartSchemaMergeRequestTypeDef

tag_resource

Tags a resource with user-supplied tags.

Type annotations and code completion for boto3.client("appsync").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Untags a resource.

Type annotations and code completion for boto3.client("appsync").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_api

Updates an Api.

Type annotations and code completion for boto3.client("appsync").update_api method. boto3 documentation

# update_api method definition

def update_api(
    self,
    *,
    apiId: str,
    name: str,
    ownerContact: str = ...,
    eventConfig: EventConfigUnionTypeDef = ...,  # (1)
) -> UpdateApiResponseTypeDef:  # (2)
    ...

1. See EventConfigUnionTypeDef
2. See UpdateApiResponseTypeDef

# update_api method usage example with argument unpacking

kwargs: UpdateApiRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
}

parent.update_api(**kwargs)

1. See UpdateApiRequestTypeDef

update_api_cache

Updates the cache for the GraphQL API.

Type annotations and code completion for boto3.client("appsync").update_api_cache method. boto3 documentation

# update_api_cache method definition

def update_api_cache(
    self,
    *,
    apiId: str,
    ttl: int,
    apiCachingBehavior: ApiCachingBehaviorType,  # (1)
    type: ApiCacheTypeType,  # (2)
    healthMetricsConfig: CacheHealthMetricsConfigType = ...,  # (3)
) -> UpdateApiCacheResponseTypeDef:  # (4)
    ...

1. See ApiCachingBehaviorType
2. See ApiCacheTypeType
3. See CacheHealthMetricsConfigType
4. See UpdateApiCacheResponseTypeDef

# update_api_cache method usage example with argument unpacking

kwargs: UpdateApiCacheRequestTypeDef = {  # (1)
    "apiId": ...,
    "ttl": ...,
    "apiCachingBehavior": ...,
    "type": ...,
}

parent.update_api_cache(**kwargs)

1. See UpdateApiCacheRequestTypeDef

update_api_key

Updates an API key.

Type annotations and code completion for boto3.client("appsync").update_api_key method. boto3 documentation

# update_api_key method definition

def update_api_key(
    self,
    *,
    apiId: str,
    id: str,
    description: str = ...,
    expires: int = ...,
) -> UpdateApiKeyResponseTypeDef:  # (1)
    ...

1. See UpdateApiKeyResponseTypeDef

# update_api_key method usage example with argument unpacking

kwargs: UpdateApiKeyRequestTypeDef = {  # (1)
    "apiId": ...,
    "id": ...,
}

parent.update_api_key(**kwargs)

1. See UpdateApiKeyRequestTypeDef

update_channel_namespace

Updates a ChannelNamespace associated with an Api.

Type annotations and code completion for boto3.client("appsync").update_channel_namespace method. boto3 documentation

# update_channel_namespace method definition

def update_channel_namespace(
    self,
    *,
    apiId: str,
    name: str,
    subscribeAuthModes: Sequence[AuthModeTypeDef] = ...,  # (1)
    publishAuthModes: Sequence[AuthModeTypeDef] = ...,  # (1)
    codeHandlers: str = ...,
) -> UpdateChannelNamespaceResponseTypeDef:  # (3)
    ...

1. See Sequence[AuthModeTypeDef]
2. See Sequence[AuthModeTypeDef]
3. See UpdateChannelNamespaceResponseTypeDef

# update_channel_namespace method usage example with argument unpacking

kwargs: UpdateChannelNamespaceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
}

parent.update_channel_namespace(**kwargs)

1. See UpdateChannelNamespaceRequestTypeDef

update_data_source

Updates a DataSource object.

Type annotations and code completion for boto3.client("appsync").update_data_source method. boto3 documentation

# update_data_source method definition

def update_data_source(
    self,
    *,
    apiId: str,
    name: str,
    type: DataSourceTypeType,  # (1)
    description: str = ...,
    serviceRoleArn: str = ...,
    dynamodbConfig: DynamodbDataSourceConfigTypeDef = ...,  # (2)
    lambdaConfig: LambdaDataSourceConfigTypeDef = ...,  # (3)
    elasticsearchConfig: ElasticsearchDataSourceConfigTypeDef = ...,  # (4)
    openSearchServiceConfig: OpenSearchServiceDataSourceConfigTypeDef = ...,  # (5)
    httpConfig: HttpDataSourceConfigTypeDef = ...,  # (6)
    relationalDatabaseConfig: RelationalDatabaseDataSourceConfigTypeDef = ...,  # (7)
    eventBridgeConfig: EventBridgeDataSourceConfigTypeDef = ...,  # (8)
    metricsConfig: DataSourceLevelMetricsConfigType = ...,  # (9)
) -> UpdateDataSourceResponseTypeDef:  # (10)
    ...

1. See DataSourceTypeType
2. See DynamodbDataSourceConfigTypeDef
3. See LambdaDataSourceConfigTypeDef
4. See ElasticsearchDataSourceConfigTypeDef
5. See OpenSearchServiceDataSourceConfigTypeDef
6. See HttpDataSourceConfigTypeDef
7. See RelationalDatabaseDataSourceConfigTypeDef
8. See EventBridgeDataSourceConfigTypeDef
9. See DataSourceLevelMetricsConfigType
10. See UpdateDataSourceResponseTypeDef

# update_data_source method usage example with argument unpacking

kwargs: UpdateDataSourceRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
    "type": ...,
}

parent.update_data_source(**kwargs)

1. See UpdateDataSourceRequestTypeDef

update_domain_name

Updates a custom DomainName object.

Type annotations and code completion for boto3.client("appsync").update_domain_name method. boto3 documentation

# update_domain_name method definition

def update_domain_name(
    self,
    *,
    domainName: str,
    description: str = ...,
) -> UpdateDomainNameResponseTypeDef:  # (1)
    ...

1. See UpdateDomainNameResponseTypeDef

# update_domain_name method usage example with argument unpacking

kwargs: UpdateDomainNameRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.update_domain_name(**kwargs)

1. See UpdateDomainNameRequestTypeDef

update_function

Updates a Function object.

Type annotations and code completion for boto3.client("appsync").update_function method. boto3 documentation

# update_function method definition

def update_function(
    self,
    *,
    apiId: str,
    name: str,
    functionId: str,
    dataSourceName: str,
    description: str = ...,
    requestMappingTemplate: str = ...,
    responseMappingTemplate: str = ...,
    functionVersion: str = ...,
    syncConfig: SyncConfigTypeDef = ...,  # (1)
    maxBatchSize: int = ...,
    runtime: AppSyncRuntimeTypeDef = ...,  # (2)
    code: str = ...,
) -> UpdateFunctionResponseTypeDef:  # (3)
    ...

1. See SyncConfigTypeDef
2. See AppSyncRuntimeTypeDef
3. See UpdateFunctionResponseTypeDef

# update_function method usage example with argument unpacking

kwargs: UpdateFunctionRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
    "functionId": ...,
    "dataSourceName": ...,
}

parent.update_function(**kwargs)

1. See UpdateFunctionRequestTypeDef

update_graphql_api

Updates a GraphqlApi object.

Type annotations and code completion for boto3.client("appsync").update_graphql_api method. boto3 documentation

# update_graphql_api method definition

def update_graphql_api(
    self,
    *,
    apiId: str,
    name: str,
    authenticationType: AuthenticationTypeType,  # (1)
    logConfig: LogConfigTypeDef = ...,  # (2)
    userPoolConfig: UserPoolConfigTypeDef = ...,  # (3)
    openIDConnectConfig: OpenIDConnectConfigTypeDef = ...,  # (4)
    additionalAuthenticationProviders: Sequence[AdditionalAuthenticationProviderTypeDef] = ...,  # (5)
    xrayEnabled: bool = ...,
    lambdaAuthorizerConfig: LambdaAuthorizerConfigTypeDef = ...,  # (6)
    mergedApiExecutionRoleArn: str = ...,
    ownerContact: str = ...,
    introspectionConfig: GraphQLApiIntrospectionConfigType = ...,  # (7)
    queryDepthLimit: int = ...,
    resolverCountLimit: int = ...,
    enhancedMetricsConfig: EnhancedMetricsConfigTypeDef = ...,  # (8)
) -> UpdateGraphqlApiResponseTypeDef:  # (9)
    ...

1. See AuthenticationTypeType
2. See LogConfigTypeDef
3. See UserPoolConfigTypeDef
4. See OpenIDConnectConfigTypeDef
5. See Sequence[AdditionalAuthenticationProviderTypeDef]
6. See LambdaAuthorizerConfigTypeDef
7. See GraphQLApiIntrospectionConfigType
8. See EnhancedMetricsConfigTypeDef
9. See UpdateGraphqlApiResponseTypeDef

# update_graphql_api method usage example with argument unpacking

kwargs: UpdateGraphqlApiRequestTypeDef = {  # (1)
    "apiId": ...,
    "name": ...,
    "authenticationType": ...,
}

parent.update_graphql_api(**kwargs)

1. See UpdateGraphqlApiRequestTypeDef

update_resolver

Updates a Resolver object.

Type annotations and code completion for boto3.client("appsync").update_resolver method. boto3 documentation

# update_resolver method definition

def update_resolver(
    self,
    *,
    apiId: str,
    typeName: str,
    fieldName: str,
    dataSourceName: str = ...,
    requestMappingTemplate: str = ...,
    responseMappingTemplate: str = ...,
    kind: ResolverKindType = ...,  # (1)
    pipelineConfig: PipelineConfigUnionTypeDef = ...,  # (2)
    syncConfig: SyncConfigTypeDef = ...,  # (3)
    cachingConfig: CachingConfigUnionTypeDef = ...,  # (4)
    maxBatchSize: int = ...,
    runtime: AppSyncRuntimeTypeDef = ...,  # (5)
    code: str = ...,
    metricsConfig: ResolverLevelMetricsConfigType = ...,  # (6)
) -> UpdateResolverResponseTypeDef:  # (7)
    ...

1. See ResolverKindType
2. See PipelineConfigUnionTypeDef
3. See SyncConfigTypeDef
4. See CachingConfigUnionTypeDef
5. See AppSyncRuntimeTypeDef
6. See ResolverLevelMetricsConfigType
7. See UpdateResolverResponseTypeDef

# update_resolver method usage example with argument unpacking

kwargs: UpdateResolverRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
    "fieldName": ...,
}

parent.update_resolver(**kwargs)

1. See UpdateResolverRequestTypeDef

update_source_api_association

Updates some of the configuration choices of a particular source API association.

Type annotations and code completion for boto3.client("appsync").update_source_api_association method. boto3 documentation

# update_source_api_association method definition

def update_source_api_association(
    self,
    *,
    associationId: str,
    mergedApiIdentifier: str,
    description: str = ...,
    sourceApiAssociationConfig: SourceApiAssociationConfigTypeDef = ...,  # (1)
) -> UpdateSourceApiAssociationResponseTypeDef:  # (2)
    ...

1. See SourceApiAssociationConfigTypeDef
2. See UpdateSourceApiAssociationResponseTypeDef

# update_source_api_association method usage example with argument unpacking

kwargs: UpdateSourceApiAssociationRequestTypeDef = {  # (1)
    "associationId": ...,
    "mergedApiIdentifier": ...,
}

parent.update_source_api_association(**kwargs)

1. See UpdateSourceApiAssociationRequestTypeDef

update_type

Updates a Type object.

Type annotations and code completion for boto3.client("appsync").update_type method. boto3 documentation

# update_type method definition

def update_type(
    self,
    *,
    apiId: str,
    typeName: str,
    format: TypeDefinitionFormatType,  # (1)
    definition: str = ...,
) -> UpdateTypeResponseTypeDef:  # (2)
    ...

1. See TypeDefinitionFormatType
2. See UpdateTypeResponseTypeDef

# update_type method usage example with argument unpacking

kwargs: UpdateTypeRequestTypeDef = {  # (1)
    "apiId": ...,
    "typeName": ...,
    "format": ...,
}

parent.update_type(**kwargs)

1. See UpdateTypeRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("appsync").get_paginator method with overloads.

• client.get_paginator("list_api_keys") -> ListApiKeysPaginator
• client.get_paginator("list_apis") -> ListApisPaginator
• client.get_paginator("list_channel_namespaces") -> ListChannelNamespacesPaginator
• client.get_paginator("list_data_sources") -> ListDataSourcesPaginator
• client.get_paginator("list_domain_names") -> ListDomainNamesPaginator
• client.get_paginator("list_functions") -> ListFunctionsPaginator
• client.get_paginator("list_graphql_apis") -> ListGraphqlApisPaginator
• client.get_paginator("list_resolvers_by_function") -> ListResolversByFunctionPaginator
• client.get_paginator("list_resolvers") -> ListResolversPaginator
• client.get_paginator("list_source_api_associations") -> ListSourceApiAssociationsPaginator
• client.get_paginator("list_types_by_association") -> ListTypesByAssociationPaginator
• client.get_paginator("list_types") -> ListTypesPaginator