Appsync

create_api_cache(api_caching_behavior, api_id, ttl, type)
create_api_cache(api_caching_behavior, api_id, ttl, type, params::Dict{String,<:Any})

Creates a cache for the GraphQL API.

Arguments

• api_caching_behavior: Caching behavior. FULLREQUESTCACHING: All requests are fully cached. PERRESOLVERCACHING: Individual resolvers that you specify are cached.
• api_id: The GraphQL API Id.
• ttl: TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
• type: The cache instance type. Valid values are SMALL MEDIUM LARGE XLARGE LARGE2X LARGE4X LARGE8X (not available in all regions) LARGE12X Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used. The following legacy instance types are available, but their use is discouraged: T2SMALL: A t2.small instance type. T2MEDIUM: A t2.medium instance type. R4LARGE: A r4.large instance type. R4XLARGE: A r4.xlarge instance type. R42XLARGE: A r4.2xlarge instance type. R44XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "atRestEncryptionEnabled": At rest encryption flag for cache. This setting cannot be updated after creation.
• "transitEncryptionEnabled": Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

create_api_key(api_id)
create_api_key(api_id, params::Dict{String,<:Any})

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

Arguments

• api_id: The ID for your GraphQL API.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description of the purpose of the API key.
• "expires": The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

create_data_source(api_id, name, type)
create_data_source(api_id, name, type, params::Dict{String,<:Any})

Creates a DataSource object.

Arguments

• api_id: The API ID for the GraphQL API for the DataSource.
• name: A user-supplied name for the DataSource.
• type: The type of the DataSource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description of the DataSource.
• "dynamodbConfig": Amazon DynamoDB settings.
• "elasticsearchConfig": Amazon Elasticsearch Service settings.
• "httpConfig": HTTP endpoint settings.
• "lambdaConfig": AWS Lambda settings.
• "relationalDatabaseConfig": Relational database settings.
• "serviceRoleArn": The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.

create_function(api_id, data_source_name, function_version, name)
create_function(api_id, data_source_name, function_version, name, params::Dict{String,<:Any})

Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

Arguments

• api_id: The GraphQL API ID.
• data_source_name: The Function DataSource name.
• function_version: The version of the request mapping template. Currently the supported value is 2018-05-29.
• name: The Function name. The function name does not have to be unique.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The Function description.
• "requestMappingTemplate": The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
• "responseMappingTemplate": The Function response mapping template.
• "syncConfig":

create_graphql_api(authentication_type, name)
create_graphql_api(authentication_type, name, params::Dict{String,<:Any})

Creates a GraphqlApi object.

Arguments

• authentication_type: The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
• name: A user-supplied name for the GraphqlApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "additionalAuthenticationProviders": A list of additional authentication providers for the GraphqlApi API.
• "logConfig": The Amazon CloudWatch Logs configuration.
• "openIDConnectConfig": The OpenID Connect configuration.
• "tags": A TagMap object.
• "userPoolConfig": The Amazon Cognito user pool configuration.
• "xrayEnabled": A flag indicating whether to enable X-Ray tracing for the GraphqlApi.

create_resolver(api_id, field_name, type_name)
create_resolver(api_id, field_name, type_name, params::Dict{String,<:Any})

Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.

Arguments

• api_id: The ID for the GraphQL API for which the resolver is being created.
• field_name: The name of the field to attach the resolver to.
• type_name: The name of the Type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "cachingConfig": The caching configuration for the resolver.
• "dataSourceName": The name of the data source for which the resolver is being created.
• "kind": The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
• "pipelineConfig": The PipelineConfig.
• "requestMappingTemplate": The mapping template to be used for requests. A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL). VTL request mapping templates are optional when using a Lambda data source. For all other data sources, VTL request and response mapping templates are required.
• "responseMappingTemplate": The mapping template to be used for responses from the data source.
• "syncConfig": The SyncConfig for a resolver attached to a versioned datasource.

create_type(api_id, definition, format)
create_type(api_id, definition, format, params::Dict{String,<:Any})

Creates a Type object.

Arguments

• api_id: The API ID.
• definition: The type definition, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation.
• format: The type format: SDL or JSON.

delete_api_cache(api_id)
delete_api_cache(api_id, params::Dict{String,<:Any})

Deletes an ApiCache object.

Arguments

• api_id: The API ID.

delete_api_key(api_id, id)
delete_api_key(api_id, id, params::Dict{String,<:Any})

Deletes an API key.

Arguments

• api_id: The API ID.
• id: The ID for the API key.

delete_data_source(api_id, name)
delete_data_source(api_id, name, params::Dict{String,<:Any})

Deletes a DataSource object.

Arguments

• api_id: The API ID.
• name: The name of the data source.

delete_function(api_id, function_id)
delete_function(api_id, function_id, params::Dict{String,<:Any})

Deletes a Function.

Arguments

• api_id: The GraphQL API ID.
• function_id: The Function ID.

delete_graphql_api(api_id)
delete_graphql_api(api_id, params::Dict{String,<:Any})

Deletes a GraphqlApi object.

Arguments

• api_id: The API ID.

delete_resolver(api_id, field_name, type_name)
delete_resolver(api_id, field_name, type_name, params::Dict{String,<:Any})

Deletes a Resolver object.

Arguments

• api_id: The API ID.
• field_name: The resolver field name.
• type_name: The name of the resolver type.

delete_type(api_id, type_name)
delete_type(api_id, type_name, params::Dict{String,<:Any})

Deletes a Type object.

Arguments

• api_id: The API ID.
• type_name: The type name.

flush_api_cache(api_id)
flush_api_cache(api_id, params::Dict{String,<:Any})

Flushes an ApiCache object.

Arguments

• api_id: The API ID.

get_api_cache(api_id)
get_api_cache(api_id, params::Dict{String,<:Any})

Retrieves an ApiCache object.

Arguments

• api_id: The API ID.

get_data_source(api_id, name)
get_data_source(api_id, name, params::Dict{String,<:Any})

Retrieves a DataSource object.

Arguments

• api_id: The API ID.
• name: The name of the data source.

get_function(api_id, function_id)
get_function(api_id, function_id, params::Dict{String,<:Any})

Get a Function.

Arguments

• api_id: The GraphQL API ID.
• function_id: The Function ID.

get_graphql_api(api_id)
get_graphql_api(api_id, params::Dict{String,<:Any})

Retrieves a GraphqlApi object.

Arguments

• api_id: The API ID for the GraphQL API.

get_introspection_schema(api_id, format)
get_introspection_schema(api_id, format, params::Dict{String,<:Any})

Retrieves the introspection schema for a GraphQL API.

Arguments

• api_id: The API ID.
• format: The schema format: SDL or JSON.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "includeDirectives": A flag that specifies whether the schema introspection should contain directives.

get_resolver(api_id, field_name, type_name)
get_resolver(api_id, field_name, type_name, params::Dict{String,<:Any})

Retrieves a Resolver object.

Arguments

• api_id: The API ID.
• field_name: The resolver field name.
• type_name: The resolver type name.

get_schema_creation_status(api_id)
get_schema_creation_status(api_id, params::Dict{String,<:Any})

Retrieves the current status of a schema creation operation.

Arguments

• api_id: The API ID.

get_type(api_id, format, type_name)
get_type(api_id, format, type_name, params::Dict{String,<:Any})

Retrieves a Type object.

Arguments

• api_id: The API ID.
• format: The type format: SDL or JSON.
• type_name: The type name.

list_api_keys(api_id)
list_api_keys(api_id, params::Dict{String,<:Any})

Lists the API keys for a given API. API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.

Arguments

• api_id: The API ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results you want the request to return.
• "nextToken": An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

list_data_sources(api_id)
list_data_sources(api_id, params::Dict{String,<:Any})

Lists the data sources for a given API.

Arguments

• api_id: The API ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results you want the request to return.
• "nextToken": An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

list_functions(api_id)
list_functions(api_id, params::Dict{String,<:Any})

List multiple functions.

Arguments

• api_id: The GraphQL API ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results you want the request to return.
• "nextToken": An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

list_graphql_apis()
list_graphql_apis(params::Dict{String,<:Any})

Lists your GraphQL APIs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results you want the request to return.
• "nextToken": An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

list_resolvers(api_id, type_name)
list_resolvers(api_id, type_name, params::Dict{String,<:Any})

Lists the resolvers for a given API and type.

Arguments

• api_id: The API ID.
• type_name: The type name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results you want the request to return.
• "nextToken": An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

list_resolvers_by_function(api_id, function_id)
list_resolvers_by_function(api_id, function_id, params::Dict{String,<:Any})

List the resolvers that are associated with a specific function.

Arguments

• api_id: The API ID.
• function_id: The Function ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results you want the request to return.
• "nextToken": An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags for a resource.

Arguments

• resource_arn: The GraphqlApi ARN.

list_types(api_id, format)
list_types(api_id, format, params::Dict{String,<:Any})

Lists the types for a given API.

Arguments

• api_id: The API ID.
• format: The type format: SDL or JSON.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results you want the request to return.
• "nextToken": An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

start_schema_creation(api_id, definition)
start_schema_creation(api_id, definition, params::Dict{String,<:Any})

Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.

Arguments

• api_id: The API ID.
• definition: The schema definition, in GraphQL schema language format.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Tags a resource with user-supplied tags.

Arguments

• resource_arn: The GraphqlApi ARN.
• tags: A TagMap object.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Untags a resource.

Arguments

• resource_arn: The GraphqlApi ARN.
• tag_keys: A list of TagKey objects.

update_api_cache(api_caching_behavior, api_id, ttl, type)
update_api_cache(api_caching_behavior, api_id, ttl, type, params::Dict{String,<:Any})

Updates the cache for the GraphQL API.

Arguments

• api_caching_behavior: Caching behavior. FULLREQUESTCACHING: All requests are fully cached. PERRESOLVERCACHING: Individual resolvers that you specify are cached.
• api_id: The GraphQL API Id.
• ttl: TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
• type: The cache instance type. Valid values are SMALL MEDIUM LARGE XLARGE LARGE2X LARGE4X LARGE8X (not available in all regions) LARGE12X Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used. The following legacy instance types are available, but their use is discouraged: T2SMALL: A t2.small instance type. T2MEDIUM: A t2.medium instance type. R4LARGE: A r4.large instance type. R4XLARGE: A r4.xlarge instance type. R42XLARGE: A r4.2xlarge instance type. R44XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.

update_api_key(api_id, id)
update_api_key(api_id, id, params::Dict{String,<:Any})

Updates an API key. The key can be updated while it is not deleted.

Arguments

• api_id: The ID for the GraphQL API.
• id: The API key ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description of the purpose of the API key.
• "expires": The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

update_data_source(api_id, name, type)
update_data_source(api_id, name, type, params::Dict{String,<:Any})

Updates a DataSource object.

Arguments

• api_id: The API ID.
• name: The new name for the data source.
• type: The new data source type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The new description for the data source.
• "dynamodbConfig": The new Amazon DynamoDB configuration.
• "elasticsearchConfig": The new Elasticsearch Service configuration.
• "httpConfig": The new HTTP endpoint configuration.
• "lambdaConfig": The new AWS Lambda configuration.
• "relationalDatabaseConfig": The new relational database configuration.
• "serviceRoleArn": The new service role ARN for the data source.

update_function(api_id, data_source_name, function_id, function_version, name)
update_function(api_id, data_source_name, function_id, function_version, name, params::Dict{String,<:Any})

Updates a Function object.

Arguments

• api_id: The GraphQL API ID.
• data_source_name: The Function DataSource name.
• function_id: The function ID.
• function_version: The version of the request mapping template. Currently the supported value is 2018-05-29.
• name: The Function name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The Function description.
• "requestMappingTemplate": The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
• "responseMappingTemplate": The Function request mapping template.
• "syncConfig":

update_graphql_api(api_id, name)
update_graphql_api(api_id, name, params::Dict{String,<:Any})

Updates a GraphqlApi object.

Arguments

• api_id: The API ID.
• name: The new name for the GraphqlApi object.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "additionalAuthenticationProviders": A list of additional authentication providers for the GraphqlApi API.
• "authenticationType": The new authentication type for the GraphqlApi object.
• "logConfig": The Amazon CloudWatch Logs configuration for the GraphqlApi object.
• "openIDConnectConfig": The OpenID Connect configuration for the GraphqlApi object.
• "userPoolConfig": The new Amazon Cognito user pool configuration for the GraphqlApi object.
• "xrayEnabled": A flag indicating whether to enable X-Ray tracing for the GraphqlApi.

update_resolver(api_id, field_name, type_name)
update_resolver(api_id, field_name, type_name, params::Dict{String,<:Any})

Updates a Resolver object.

Arguments

• api_id: The API ID.
• field_name: The new field name.
• type_name: The new type name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "cachingConfig": The caching configuration for the resolver.
• "dataSourceName": The new data source name.
• "kind": The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
• "pipelineConfig": The PipelineConfig.
• "requestMappingTemplate": The new request mapping template. A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL). VTL request mapping templates are optional when using a Lambda data source. For all other data sources, VTL request and response mapping templates are required.
• "responseMappingTemplate": The new response mapping template.
• "syncConfig": The SyncConfig for a resolver attached to a versioned datasource.

update_type(api_id, format, type_name)
update_type(api_id, format, type_name, params::Dict{String,<:Any})

Updates a Type object.

Arguments

• api_id: The API ID.
• format: The new type format: SDL or JSON.
• type_name: The new type name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "definition": The new definition.