AppSyncClient

Index > AppSync > AppSyncClient

Auto-generated documentation for AppSync type annotations stubs module types-aiobotocore-appsync.

AppSyncClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_appsync.client import AppSyncClient

session = Session()
async with session.client("appsync") as client:
    client: AppSyncClient

Exceptions

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

Usage example

async with session.client("appsync") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ApiKeyLimitExceededException,
        client.ApiKeyValidityOutOfBoundsException,
        client.ApiLimitExceededException,
        client.BadRequestException,
        client.ClientError,
        client.ConcurrentModificationException,
        client.GraphQLSchemaException,
        client.InternalFailureException,
        client.LimitExceededException,
        client.NotFoundException,
        client.UnauthorizedException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_appsync.client import Exceptions

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

Methods

associate_api

Maps an endpoint to your custom domain.

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

Method definition

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

1. See AssociateApiResponseTypeDef

Usage example with kwargs

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

parent.associate_api(**kwargs)

1. See AssociateApiRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

await def close(
    self,
) -> None:
    ...

create_api_cache

Creates a cache for the GraphQL API.

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

Method definition

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

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

Usage example with kwargs

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

parent.create_api_cache(**kwargs)

1. See CreateApiCacheRequestRequestTypeDef

create_api_key

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

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

Method definition

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

1. See CreateApiKeyResponseTypeDef

Usage example with kwargs

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

parent.create_api_key(**kwargs)

1. See CreateApiKeyRequestRequestTypeDef

create_data_source

Creates a DataSource object.

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

Method definition

await 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)
) -> CreateDataSourceResponseTypeDef:  # (8)
    ...

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

Usage example with kwargs

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

parent.create_data_source(**kwargs)

1. See CreateDataSourceRequestRequestTypeDef

create_domain_name

Creates a custom DomainName object.

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

Method definition

await def create_domain_name(
    self,
    *,
    domainName: str,
    certificateArn: str,
    description: str = ...,
) -> CreateDomainNameResponseTypeDef:  # (1)
    ...

1. See CreateDomainNameResponseTypeDef

Usage example with kwargs

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

parent.create_domain_name(**kwargs)

1. See CreateDomainNameRequestRequestTypeDef

create_function

Creates a Function object.

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

Method definition

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

1. See SyncConfigTypeDef
2. See CreateFunctionResponseTypeDef

Usage example with kwargs

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

parent.create_function(**kwargs)

1. See CreateFunctionRequestRequestTypeDef

create_graphql_api

Creates a GraphqlApi object.

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

Method definition

await 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)
) -> CreateGraphqlApiResponseTypeDef:  # (7)
    ...

1. See AuthenticationTypeType
2. See LogConfigTypeDef
3. See UserPoolConfigTypeDef
4. See OpenIDConnectConfigTypeDef
5. See AdditionalAuthenticationProviderTypeDef
6. See LambdaAuthorizerConfigTypeDef
7. See CreateGraphqlApiResponseTypeDef

Usage example with kwargs

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

parent.create_graphql_api(**kwargs)

1. See CreateGraphqlApiRequestRequestTypeDef

create_resolver

Creates a Resolver object.

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

Method definition

await def create_resolver(
    self,
    *,
    apiId: str,
    typeName: str,
    fieldName: str,
    dataSourceName: str = ...,
    requestMappingTemplate: str = ...,
    responseMappingTemplate: str = ...,
    kind: ResolverKindType = ...,  # (1)
    pipelineConfig: PipelineConfigTypeDef = ...,  # (2)
    syncConfig: SyncConfigTypeDef = ...,  # (3)
    cachingConfig: CachingConfigTypeDef = ...,  # (4)
    maxBatchSize: int = ...,
) -> CreateResolverResponseTypeDef:  # (5)
    ...

1. See ResolverKindType
2. See PipelineConfigTypeDef
3. See SyncConfigTypeDef
4. See CachingConfigTypeDef
5. See CreateResolverResponseTypeDef

Usage example with kwargs

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

parent.create_resolver(**kwargs)

1. See CreateResolverRequestRequestTypeDef

create_type

Creates a Type object.

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

Method definition

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

1. See TypeDefinitionFormatType
2. See CreateTypeResponseTypeDef

Usage example with kwargs

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

parent.create_type(**kwargs)

1. See CreateTypeRequestRequestTypeDef

delete_api_cache

Deletes an ApiCache object.

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

Method definition

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

Usage example with kwargs

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

parent.delete_api_cache(**kwargs)

1. See DeleteApiCacheRequestRequestTypeDef

delete_api_key

Deletes an API key.

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

Method definition

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

Usage example with kwargs

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

parent.delete_api_key(**kwargs)

1. See DeleteApiKeyRequestRequestTypeDef

delete_data_source

Deletes a DataSource object.

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

Method definition

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

Usage example with kwargs

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

parent.delete_data_source(**kwargs)

1. See DeleteDataSourceRequestRequestTypeDef

delete_domain_name

Deletes a custom DomainName object.

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

Method definition

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

Usage example with kwargs

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

parent.delete_domain_name(**kwargs)

1. See DeleteDomainNameRequestRequestTypeDef

delete_function

Deletes a Function .

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

Method definition

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

Usage example with kwargs

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

parent.delete_function(**kwargs)

1. See DeleteFunctionRequestRequestTypeDef

delete_graphql_api

Deletes a GraphqlApi object.

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

Method definition

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

Usage example with kwargs

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

parent.delete_graphql_api(**kwargs)

1. See DeleteGraphqlApiRequestRequestTypeDef

delete_resolver

Deletes a Resolver object.

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

Method definition

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

Usage example with kwargs

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

parent.delete_resolver(**kwargs)

1. See DeleteResolverRequestRequestTypeDef

delete_type

Deletes a Type object.

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

Method definition

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

Usage example with kwargs

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

parent.delete_type(**kwargs)

1. See DeleteTypeRequestRequestTypeDef

disassociate_api

Removes an ApiAssociation object from a custom domain.

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

Method definition

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

Usage example with kwargs

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

parent.disassociate_api(**kwargs)

1. See DisassociateApiRequestRequestTypeDef

evaluate_mapping_template

Evaluates a given template and returns the response.

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

Method definition

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

1. See EvaluateMappingTemplateResponseTypeDef

Usage example with kwargs

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

parent.evaluate_mapping_template(**kwargs)

1. See EvaluateMappingTemplateRequestRequestTypeDef

flush_api_cache

Flushes an ApiCache object.

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

Method definition

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

Usage example with kwargs

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

parent.flush_api_cache(**kwargs)

1. See FlushApiCacheRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

get_api_association

Retrieves an ApiAssociation object.

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

Method definition

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

1. See GetApiAssociationResponseTypeDef

Usage example with kwargs

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

parent.get_api_association(**kwargs)

1. See GetApiAssociationRequestRequestTypeDef

get_api_cache

Retrieves an ApiCache object.

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

Method definition

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

1. See GetApiCacheResponseTypeDef

Usage example with kwargs

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

parent.get_api_cache(**kwargs)

1. See GetApiCacheRequestRequestTypeDef

get_data_source

Retrieves a DataSource object.

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

Method definition

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

1. See GetDataSourceResponseTypeDef

Usage example with kwargs

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

parent.get_data_source(**kwargs)

1. See GetDataSourceRequestRequestTypeDef

get_domain_name

Retrieves a custom DomainName object.

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

Method definition

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

1. See GetDomainNameResponseTypeDef

Usage example with kwargs

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

parent.get_domain_name(**kwargs)

1. See GetDomainNameRequestRequestTypeDef

get_function

Get a Function .

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

Method definition

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

1. See GetFunctionResponseTypeDef

Usage example with kwargs

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

parent.get_function(**kwargs)

1. See GetFunctionRequestRequestTypeDef

get_graphql_api

Retrieves a GraphqlApi object.

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

Method definition

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

1. See GetGraphqlApiResponseTypeDef

Usage example with kwargs

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

parent.get_graphql_api(**kwargs)

1. See GetGraphqlApiRequestRequestTypeDef

get_introspection_schema

Retrieves the introspection schema for a GraphQL API.

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

Method definition

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

1. See OutputTypeType
2. See GetIntrospectionSchemaResponseTypeDef

Usage example with kwargs

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

parent.get_introspection_schema(**kwargs)

1. See GetIntrospectionSchemaRequestRequestTypeDef

get_resolver

Retrieves a Resolver object.

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

Method definition

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

1. See GetResolverResponseTypeDef

Usage example with kwargs

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

parent.get_resolver(**kwargs)

1. See GetResolverRequestRequestTypeDef

get_schema_creation_status

Retrieves the current status of a schema creation operation.

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

Method definition

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

1. See GetSchemaCreationStatusResponseTypeDef

Usage example with kwargs

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

parent.get_schema_creation_status(**kwargs)

1. See GetSchemaCreationStatusRequestRequestTypeDef

get_type

Retrieves a Type object.

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

Method definition

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

1. See TypeDefinitionFormatType
2. See GetTypeResponseTypeDef

Usage example with kwargs

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

parent.get_type(**kwargs)

1. See GetTypeRequestRequestTypeDef

list_api_keys

Lists the API keys for a given API.

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

Method definition

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

1. See ListApiKeysResponseTypeDef

Usage example with kwargs

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

parent.list_api_keys(**kwargs)

1. See ListApiKeysRequestRequestTypeDef

list_data_sources

Lists the data sources for a given API.

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

Method definition

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

1. See ListDataSourcesResponseTypeDef

Usage example with kwargs

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

parent.list_data_sources(**kwargs)

1. See ListDataSourcesRequestRequestTypeDef

list_domain_names

Lists multiple custom domain names.

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

Method definition

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

1. See ListDomainNamesResponseTypeDef

Usage example with kwargs

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

parent.list_domain_names(**kwargs)

1. See ListDomainNamesRequestRequestTypeDef

list_functions

List multiple functions.

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

Method definition

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

1. See ListFunctionsResponseTypeDef

Usage example with kwargs

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

parent.list_functions(**kwargs)

1. See ListFunctionsRequestRequestTypeDef

list_graphql_apis

Lists your GraphQL APIs.

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

Method definition

await def list_graphql_apis(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListGraphqlApisResponseTypeDef:  # (1)
    ...

1. See ListGraphqlApisResponseTypeDef

Usage example with kwargs

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

parent.list_graphql_apis(**kwargs)

1. See ListGraphqlApisRequestRequestTypeDef

list_resolvers

Lists the resolvers for a given API and type.

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

Method definition

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

1. See ListResolversResponseTypeDef

Usage example with kwargs

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

parent.list_resolvers(**kwargs)

1. See ListResolversRequestRequestTypeDef

list_resolvers_by_function

List the resolvers that are associated with a specific function.

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

Method definition

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

1. See ListResolversByFunctionResponseTypeDef

Usage example with kwargs

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

parent.list_resolvers_by_function(**kwargs)

1. See ListResolversByFunctionRequestRequestTypeDef

list_tags_for_resource

Lists the tags for a resource.

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

Method definition

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

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_types

Lists the types for a given API.

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

Method definition

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

1. See TypeDefinitionFormatType
2. See ListTypesResponseTypeDef

Usage example with kwargs

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

parent.list_types(**kwargs)

1. See ListTypesRequestRequestTypeDef

start_schema_creation

Adds a new schema to your GraphQL API.

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

Method definition

await def start_schema_creation(
    self,
    *,
    apiId: str,
    definition: Union[str, bytes, IO[Any], StreamingBody],
) -> StartSchemaCreationResponseTypeDef:  # (1)
    ...

1. See StartSchemaCreationResponseTypeDef

Usage example with kwargs

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

parent.start_schema_creation(**kwargs)

1. See StartSchemaCreationRequestRequestTypeDef

tag_resource

Tags a resource with user-supplied tags.

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

Method definition

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

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Untags a resource.

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

Method definition

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

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_api_cache

Updates the cache for the GraphQL API.

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

Method definition

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

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

Usage example with kwargs

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

parent.update_api_cache(**kwargs)

1. See UpdateApiCacheRequestRequestTypeDef

update_api_key

Updates an API key.

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

Method definition

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

1. See UpdateApiKeyResponseTypeDef

Usage example with kwargs

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

parent.update_api_key(**kwargs)

1. See UpdateApiKeyRequestRequestTypeDef

update_data_source

Updates a DataSource object.

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

Method definition

await 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)
) -> UpdateDataSourceResponseTypeDef:  # (8)
    ...

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

Usage example with kwargs

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

parent.update_data_source(**kwargs)

1. See UpdateDataSourceRequestRequestTypeDef

update_domain_name

Updates a custom DomainName object.

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

Method definition

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

1. See UpdateDomainNameResponseTypeDef

Usage example with kwargs

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

parent.update_domain_name(**kwargs)

1. See UpdateDomainNameRequestRequestTypeDef

update_function

Updates a Function object.

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

Method definition

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

1. See SyncConfigTypeDef
2. See UpdateFunctionResponseTypeDef

Usage example with kwargs

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

parent.update_function(**kwargs)

1. See UpdateFunctionRequestRequestTypeDef

update_graphql_api

Updates a GraphqlApi object.

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

Method definition

await def update_graphql_api(
    self,
    *,
    apiId: str,
    name: str,
    logConfig: LogConfigTypeDef = ...,  # (1)
    authenticationType: AuthenticationTypeType = ...,  # (2)
    userPoolConfig: UserPoolConfigTypeDef = ...,  # (3)
    openIDConnectConfig: OpenIDConnectConfigTypeDef = ...,  # (4)
    additionalAuthenticationProviders: Sequence[AdditionalAuthenticationProviderTypeDef] = ...,  # (5)
    xrayEnabled: bool = ...,
    lambdaAuthorizerConfig: LambdaAuthorizerConfigTypeDef = ...,  # (6)
) -> UpdateGraphqlApiResponseTypeDef:  # (7)
    ...

1. See LogConfigTypeDef
2. See AuthenticationTypeType
3. See UserPoolConfigTypeDef
4. See OpenIDConnectConfigTypeDef
5. See AdditionalAuthenticationProviderTypeDef
6. See LambdaAuthorizerConfigTypeDef
7. See UpdateGraphqlApiResponseTypeDef

Usage example with kwargs

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

parent.update_graphql_api(**kwargs)

1. See UpdateGraphqlApiRequestRequestTypeDef

update_resolver

Updates a Resolver object.

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

Method definition

await def update_resolver(
    self,
    *,
    apiId: str,
    typeName: str,
    fieldName: str,
    dataSourceName: str = ...,
    requestMappingTemplate: str = ...,
    responseMappingTemplate: str = ...,
    kind: ResolverKindType = ...,  # (1)
    pipelineConfig: PipelineConfigTypeDef = ...,  # (2)
    syncConfig: SyncConfigTypeDef = ...,  # (3)
    cachingConfig: CachingConfigTypeDef = ...,  # (4)
    maxBatchSize: int = ...,
) -> UpdateResolverResponseTypeDef:  # (5)
    ...

1. See ResolverKindType
2. See PipelineConfigTypeDef
3. See SyncConfigTypeDef
4. See CachingConfigTypeDef
5. See UpdateResolverResponseTypeDef

Usage example with kwargs

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

parent.update_resolver(**kwargs)

1. See UpdateResolverRequestRequestTypeDef

update_type

Updates a Type object.

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

Method definition

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

1. See TypeDefinitionFormatType
2. See UpdateTypeResponseTypeDef

Usage example with kwargs

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

parent.update_type(**kwargs)

1. See UpdateTypeRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> AppSyncClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

• client.get_paginator("list_api_keys") -> ListApiKeysPaginator
• client.get_paginator("list_data_sources") -> ListDataSourcesPaginator
• client.get_paginator("list_functions") -> ListFunctionsPaginator
• client.get_paginator("list_graphql_apis") -> ListGraphqlApisPaginator
• client.get_paginator("list_resolvers") -> ListResolversPaginator
• client.get_paginator("list_resolvers_by_function") -> ListResolversByFunctionPaginator
• client.get_paginator("list_types") -> ListTypesPaginator