Class: Aws::AppSync::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppSync::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb
Overview
An API client for AppSync. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::AppSync::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_api(params = {}) ⇒ Types::AssociateApiResponse
Maps an endpoint to your custom domain.
-
#associate_merged_graphql_api(params = {}) ⇒ Types::AssociateMergedGraphqlApiResponse
Creates an association between a Merged API and source API using the source API's identifier.
-
#associate_source_graphql_api(params = {}) ⇒ Types::AssociateSourceGraphqlApiResponse
Creates an association between a Merged API and source API using the Merged API's identifier.
-
#create_api_cache(params = {}) ⇒ Types::CreateApiCacheResponse
Creates a cache for the GraphQL API.
-
#create_api_key(params = {}) ⇒ Types::CreateApiKeyResponse
Creates a unique key that you can distribute to clients who invoke your API.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a
DataSource
object. -
#create_domain_name(params = {}) ⇒ Types::CreateDomainNameResponse
Creates a custom
DomainName
object. -
#create_function(params = {}) ⇒ Types::CreateFunctionResponse
Creates a
Function
object. -
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a
GraphqlApi
object. -
#create_resolver(params = {}) ⇒ Types::CreateResolverResponse
Creates a
Resolver
object. -
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a
Type
object. -
#delete_api_cache(params = {}) ⇒ Struct
Deletes an
ApiCache
object. -
#delete_api_key(params = {}) ⇒ Struct
Deletes an API key.
-
#delete_data_source(params = {}) ⇒ Struct
Deletes a
DataSource
object. -
#delete_domain_name(params = {}) ⇒ Struct
Deletes a custom
DomainName
object. -
#delete_function(params = {}) ⇒ Struct
Deletes a
Function
. -
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a
GraphqlApi
object. -
#delete_resolver(params = {}) ⇒ Struct
Deletes a
Resolver
object. -
#delete_type(params = {}) ⇒ Struct
Deletes a
Type
object. -
#disassociate_api(params = {}) ⇒ Struct
Removes an
ApiAssociation
object from a custom domain. -
#disassociate_merged_graphql_api(params = {}) ⇒ Types::DisassociateMergedGraphqlApiResponse
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
-
#disassociate_source_graphql_api(params = {}) ⇒ Types::DisassociateSourceGraphqlApiResponse
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
-
#evaluate_code(params = {}) ⇒ Types::EvaluateCodeResponse
Evaluates the given code and returns the response.
-
#evaluate_mapping_template(params = {}) ⇒ Types::EvaluateMappingTemplateResponse
Evaluates a given template and returns the response.
-
#flush_api_cache(params = {}) ⇒ Struct
Flushes an
ApiCache
object. -
#get_api_association(params = {}) ⇒ Types::GetApiAssociationResponse
Retrieves an
ApiAssociation
object. -
#get_api_cache(params = {}) ⇒ Types::GetApiCacheResponse
Retrieves an
ApiCache
object. -
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Retrieves a
DataSource
object. -
#get_data_source_introspection(params = {}) ⇒ Types::GetDataSourceIntrospectionResponse
Retrieves the record of an existing introspection.
-
#get_domain_name(params = {}) ⇒ Types::GetDomainNameResponse
Retrieves a custom
DomainName
object. -
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a
Function
. -
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a
GraphqlApi
object. -
#get_graphql_api_environment_variables(params = {}) ⇒ Types::GetGraphqlApiEnvironmentVariablesResponse
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
-
#get_introspection_schema(params = {}) ⇒ Types::GetIntrospectionSchemaResponse
Retrieves the introspection schema for a GraphQL API.
-
#get_resolver(params = {}) ⇒ Types::GetResolverResponse
Retrieves a
Resolver
object. -
#get_schema_creation_status(params = {}) ⇒ Types::GetSchemaCreationStatusResponse
Retrieves the current status of a schema creation operation.
-
#get_source_api_association(params = {}) ⇒ Types::GetSourceApiAssociationResponse
Retrieves a
SourceApiAssociation
object. -
#get_type(params = {}) ⇒ Types::GetTypeResponse
Retrieves a
Type
object. -
#list_api_keys(params = {}) ⇒ Types::ListApiKeysResponse
Lists the API keys for a given API.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists the data sources for a given API.
-
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Lists multiple custom domain names.
-
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
List multiple functions.
-
#list_graphql_apis(params = {}) ⇒ Types::ListGraphqlApisResponse
Lists your GraphQL APIs.
-
#list_resolvers(params = {}) ⇒ Types::ListResolversResponse
Lists the resolvers for a given API and type.
-
#list_resolvers_by_function(params = {}) ⇒ Types::ListResolversByFunctionResponse
List the resolvers that are associated with a specific function.
-
#list_source_api_associations(params = {}) ⇒ Types::ListSourceApiAssociationsResponse
Lists the
SourceApiAssociationSummary
data. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a resource.
-
#list_types(params = {}) ⇒ Types::ListTypesResponse
Lists the types for a given API.
-
#list_types_by_association(params = {}) ⇒ Types::ListTypesByAssociationResponse
Lists
Type
objects by the source API association ID. -
#put_graphql_api_environment_variables(params = {}) ⇒ Types::PutGraphqlApiEnvironmentVariablesResponse
Creates a list of environmental variables in an API by its ID value.
-
#start_data_source_introspection(params = {}) ⇒ Types::StartDataSourceIntrospectionResponse
Creates a new introspection.
-
#start_schema_creation(params = {}) ⇒ Types::StartSchemaCreationResponse
Adds a new schema to your GraphQL API.
-
#start_schema_merge(params = {}) ⇒ Types::StartSchemaMergeResponse
Initiates a merge operation.
-
#tag_resource(params = {}) ⇒ Struct
Tags a resource with user-supplied tags.
-
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
-
#update_api_cache(params = {}) ⇒ Types::UpdateApiCacheResponse
Updates the cache for the GraphQL API.
-
#update_api_key(params = {}) ⇒ Types::UpdateApiKeyResponse
Updates an API key.
-
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a
DataSource
object. -
#update_domain_name(params = {}) ⇒ Types::UpdateDomainNameResponse
Updates a custom
DomainName
object. -
#update_function(params = {}) ⇒ Types::UpdateFunctionResponse
Updates a
Function
object. -
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a
GraphqlApi
object. -
#update_resolver(params = {}) ⇒ Types::UpdateResolverResponse
Updates a
Resolver
object. -
#update_source_api_association(params = {}) ⇒ Types::UpdateSourceApiAssociationResponse
Updates some of the configuration choices of a particular source API association.
-
#update_type(params = {}) ⇒ Types::UpdateTypeResponse
Updates a
Type
object.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#associate_api(params = {}) ⇒ Types::AssociateApiResponse
Maps an endpoint to your custom domain.
446 447 448 449 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 446 def associate_api(params = {}, = {}) req = build_request(:associate_api, params) req.send_request() end |
#associate_merged_graphql_api(params = {}) ⇒ Types::AssociateMergedGraphqlApiResponse
Creates an association between a Merged API and source API using the source API's identifier.
507 508 509 510 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 507 def associate_merged_graphql_api(params = {}, = {}) req = build_request(:associate_merged_graphql_api, params) req.send_request() end |
#associate_source_graphql_api(params = {}) ⇒ Types::AssociateSourceGraphqlApiResponse
Creates an association between a Merged API and source API using the Merged API's identifier.
568 569 570 571 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 568 def associate_source_graphql_api(params = {}, = {}) req = build_request(:associate_source_graphql_api, params) req.send_request() end |
#create_api_cache(params = {}) ⇒ Types::CreateApiCacheResponse
Creates a cache for the GraphQL API.
684 685 686 687 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 684 def create_api_cache(params = {}, = {}) req = build_request(:create_api_cache, params) req.send_request() end |
#create_api_key(params = {}) ⇒ Types::CreateApiKeyResponse
Creates a unique key that you can distribute to clients who invoke your API.
727 728 729 730 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 727 def create_api_key(params = {}, = {}) req = build_request(:create_api_key, params) req.send_request() end |
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a DataSource
object.
883 884 885 886 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 883 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_domain_name(params = {}) ⇒ Types::CreateDomainNameResponse
Creates a custom DomainName
object.
925 926 927 928 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 925 def create_domain_name(params = {}, = {}) req = build_request(:create_domain_name, params) req.send_request() end |
#create_function(params = {}) ⇒ Types::CreateFunctionResponse
Creates a Function
object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1030 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a GraphqlApi
object.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1251 def create_graphql_api(params = {}, = {}) req = build_request(:create_graphql_api, params) req.send_request() end |
#create_resolver(params = {}) ⇒ Types::CreateResolverResponse
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.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1397 def create_resolver(params = {}, = {}) req = build_request(:create_resolver, params) req.send_request() end |
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a Type
object.
1444 1445 1446 1447 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1444 def create_type(params = {}, = {}) req = build_request(:create_type, params) req.send_request() end |
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ApiCache
object.
1466 1467 1468 1469 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1466 def delete_api_cache(params = {}, = {}) req = build_request(:delete_api_cache, params) req.send_request() end |
#delete_api_key(params = {}) ⇒ Struct
Deletes an API key.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1492 def delete_api_key(params = {}, = {}) req = build_request(:delete_api_key, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Struct
Deletes a DataSource
object.
1518 1519 1520 1521 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1518 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_domain_name(params = {}) ⇒ Struct
Deletes a custom DomainName
object.
1540 1541 1542 1543 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1540 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a Function
.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1566 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a GraphqlApi
object.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1588 def delete_graphql_api(params = {}, = {}) req = build_request(:delete_graphql_api, params) req.send_request() end |
#delete_resolver(params = {}) ⇒ Struct
Deletes a Resolver
object.
1618 1619 1620 1621 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1618 def delete_resolver(params = {}, = {}) req = build_request(:delete_resolver, params) req.send_request() end |
#delete_type(params = {}) ⇒ Struct
Deletes a Type
object.
1644 1645 1646 1647 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1644 def delete_type(params = {}, = {}) req = build_request(:delete_type, params) req.send_request() end |
#disassociate_api(params = {}) ⇒ Struct
Removes an ApiAssociation
object from a custom domain.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1666 def disassociate_api(params = {}, = {}) req = build_request(:disassociate_api, params) req.send_request() end |
#disassociate_merged_graphql_api(params = {}) ⇒ Types::DisassociateMergedGraphqlApiResponse
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
1704 1705 1706 1707 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1704 def disassociate_merged_graphql_api(params = {}, = {}) req = build_request(:disassociate_merged_graphql_api, params) req.send_request() end |
#disassociate_source_graphql_api(params = {}) ⇒ Types::DisassociateSourceGraphqlApiResponse
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1742 def disassociate_source_graphql_api(params = {}, = {}) req = build_request(:disassociate_source_graphql_api, params) req.send_request() end |
#evaluate_code(params = {}) ⇒ Types::EvaluateCodeResponse
Evaluates the given code and returns the response. The code definition
requirements depend on the specified runtime. For APPSYNC_JS
runtimes, the code defines the request and response functions. The
request function takes the incoming request after a GraphQL operation
is parsed and converts it into a request configuration for the
selected data source operation. The response function interprets
responses from the data source and maps it to the shape of the GraphQL
field output type.
1808 1809 1810 1811 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1808 def evaluate_code(params = {}, = {}) req = build_request(:evaluate_code, params) req.send_request() end |
#evaluate_mapping_template(params = {}) ⇒ Types::EvaluateMappingTemplateResponse
Evaluates a given template and returns the response. The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
1856 1857 1858 1859 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1856 def evaluate_mapping_template(params = {}, = {}) req = build_request(:evaluate_mapping_template, params) req.send_request() end |
#flush_api_cache(params = {}) ⇒ Struct
Flushes an ApiCache
object.
1878 1879 1880 1881 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1878 def flush_api_cache(params = {}, = {}) req = build_request(:flush_api_cache, params) req.send_request() end |
#get_api_association(params = {}) ⇒ Types::GetApiAssociationResponse
Retrieves an ApiAssociation
object.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1909 def get_api_association(params = {}, = {}) req = build_request(:get_api_association, params) req.send_request() end |
#get_api_cache(params = {}) ⇒ Types::GetApiCacheResponse
Retrieves an ApiCache
object.
1943 1944 1945 1946 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1943 def get_api_cache(params = {}, = {}) req = build_request(:get_api_cache, params) req.send_request() end |
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Retrieves a DataSource
object.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2003 def get_data_source(params = {}, = {}) req = build_request(:get_data_source, params) req.send_request() end |
#get_data_source_introspection(params = {}) ⇒ Types::GetDataSourceIntrospectionResponse
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
2077 2078 2079 2080 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2077 def get_data_source_introspection(params = {}, = {}) req = build_request(:get_data_source_introspection, params) req.send_request() end |
#get_domain_name(params = {}) ⇒ Types::GetDomainNameResponse
Retrieves a custom DomainName
object.
2109 2110 2111 2112 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2109 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a Function
.
2155 2156 2157 2158 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2155 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a GraphqlApi
object.
2231 2232 2233 2234 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2231 def get_graphql_api(params = {}, = {}) req = build_request(:get_graphql_api, params) req.send_request() end |
#get_graphql_api_environment_variables(params = {}) ⇒ Types::GetGraphqlApiEnvironmentVariablesResponse
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2262 def get_graphql_api_environment_variables(params = {}, = {}) req = build_request(:get_graphql_api_environment_variables, params) req.send_request() end |
#get_introspection_schema(params = {}) ⇒ Types::GetIntrospectionSchemaResponse
Retrieves the introspection schema for a GraphQL API.
2299 2300 2301 2302 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2299 def get_introspection_schema(params = {}, = {}) req = build_request(:get_introspection_schema, params) req.send_request() end |
#get_resolver(params = {}) ⇒ Types::GetResolverResponse
Retrieves a Resolver
object.
2354 2355 2356 2357 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2354 def get_resolver(params = {}, = {}) req = build_request(:get_resolver, params) req.send_request() end |
#get_schema_creation_status(params = {}) ⇒ Types::GetSchemaCreationStatusResponse
Retrieves the current status of a schema creation operation.
2384 2385 2386 2387 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2384 def get_schema_creation_status(params = {}, = {}) req = build_request(:get_schema_creation_status, params) req.send_request() end |
#get_source_api_association(params = {}) ⇒ Types::GetSourceApiAssociationResponse
Retrieves a SourceApiAssociation
object.
2431 2432 2433 2434 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2431 def get_source_api_association(params = {}, = {}) req = build_request(:get_source_api_association, params) req.send_request() end |
#get_type(params = {}) ⇒ Types::GetTypeResponse
Retrieves a Type
object.
2471 2472 2473 2474 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2471 def get_type(params = {}, = {}) req = build_request(:get_type, params) req.send_request() end |
#list_api_keys(params = {}) ⇒ Types::ListApiKeysResponse
Lists the API keys for a given API.
DeleteApiKey
to manually delete a
key before it's automatically deleted.
2522 2523 2524 2525 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2522 def list_api_keys(params = {}, = {}) req = build_request(:list_api_keys, params) req.send_request() end |
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists the data sources for a given API.
2591 2592 2593 2594 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2591 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Lists multiple custom domain names.
2632 2633 2634 2635 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2632 def list_domain_names(params = {}, = {}) req = build_request(:list_domain_names, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
List multiple functions.
2687 2688 2689 2690 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2687 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_graphql_apis(params = {}) ⇒ Types::ListGraphqlApisResponse
Lists your GraphQL APIs.
2781 2782 2783 2784 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2781 def list_graphql_apis(params = {}, = {}) req = build_request(:list_graphql_apis, params) req.send_request() end |
#list_resolvers(params = {}) ⇒ Types::ListResolversResponse
Lists the resolvers for a given API and type.
2845 2846 2847 2848 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2845 def list_resolvers(params = {}, = {}) req = build_request(:list_resolvers, params) req.send_request() end |
#list_resolvers_by_function(params = {}) ⇒ Types::ListResolversByFunctionResponse
List the resolvers that are associated with a specific function.
2909 2910 2911 2912 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2909 def list_resolvers_by_function(params = {}, = {}) req = build_request(:list_resolvers_by_function, params) req.send_request() end |
#list_source_api_associations(params = {}) ⇒ Types::ListSourceApiAssociationsResponse
Lists the SourceApiAssociationSummary
data.
2956 2957 2958 2959 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2956 def list_source_api_associations(params = {}, = {}) req = build_request(:list_source_api_associations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a resource.
2985 2986 2987 2988 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2985 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_types(params = {}) ⇒ Types::ListTypesResponse
Lists the types for a given API.
3034 3035 3036 3037 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3034 def list_types(params = {}, = {}) req = build_request(:list_types, params) req.send_request() end |
#list_types_by_association(params = {}) ⇒ Types::ListTypesByAssociationResponse
Lists Type
objects by the source API association ID.
3092 3093 3094 3095 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3092 def list_types_by_association(params = {}, = {}) req = build_request(:list_types_by_association, params) req.send_request() end |
#put_graphql_api_environment_variables(params = {}) ⇒ Types::PutGraphqlApiEnvironmentVariablesResponse
Creates a list of environmental variables in an API by its ID value.
When creating an environmental variable, it must follow the constraints below:
Both JavaScript and VTL templates support environmental variables.
Environmental variables are not evaluated before function invocation.
Environmental variables only support string values.
Any defined value in an environmental variable is considered a string literal and not expanded.
Variable evaluations should ideally be performed in the function code.
When creating an environmental variable key-value pair, it must follow the additional constraints below:
Keys must begin with a letter.
Keys must be at least two characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the
environmentVariables
payload as a list in the format
\{"key1":"value1","key2":"value2", …\}
. Note that each call of the
PutGraphqlApiEnvironmentVariables
action will result in the
overwriting of the existing environmental variable list of that API.
This means the existing environmental variables will be lost. To avoid
this, you must include all existing and new environmental variables in
the list each time you call this action.
3190 3191 3192 3193 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3190 def put_graphql_api_environment_variables(params = {}, = {}) req = build_request(:put_graphql_api_environment_variables, params) req.send_request() end |
#start_data_source_introspection(params = {}) ⇒ Types::StartDataSourceIntrospectionResponse
Creates a new introspection. Returns the introspectionId
of the new
introspection after its creation.
3227 3228 3229 3230 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3227 def start_data_source_introspection(params = {}, = {}) req = build_request(:start_data_source_introspection, params) req.send_request() end |
#start_schema_creation(params = {}) ⇒ Types::StartSchemaCreationResponse
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
3262 3263 3264 3265 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3262 def start_schema_creation(params = {}, = {}) req = build_request(:start_schema_creation, params) req.send_request() end |
#start_schema_merge(params = {}) ⇒ Types::StartSchemaMergeResponse
Initiates a merge operation. Returns a status that shows the result of the merge operation.
3300 3301 3302 3303 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3300 def start_schema_merge(params = {}, = {}) req = build_request(:start_schema_merge, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a resource with user-supplied tags.
3328 3329 3330 3331 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3328 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
3354 3355 3356 3357 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3354 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_api_cache(params = {}) ⇒ Types::UpdateApiCacheResponse
Updates the cache for the GraphQL API.
3460 3461 3462 3463 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3460 def update_api_cache(params = {}, = {}) req = build_request(:update_api_cache, params) req.send_request() end |
#update_api_key(params = {}) ⇒ Types::UpdateApiKeyResponse
Updates an API key. You can update the key as long as it's not deleted.
3506 3507 3508 3509 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3506 def update_api_key(params = {}, = {}) req = build_request(:update_api_key, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a DataSource
object.
3660 3661 3662 3663 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3660 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_domain_name(params = {}) ⇒ Types::UpdateDomainNameResponse
Updates a custom DomainName
object.
3696 3697 3698 3699 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3696 def update_domain_name(params = {}, = {}) req = build_request(:update_domain_name, params) req.send_request() end |
#update_function(params = {}) ⇒ Types::UpdateFunctionResponse
Updates a Function
object.
3802 3803 3804 3805 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3802 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a GraphqlApi
object.
4009 4010 4011 4012 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4009 def update_graphql_api(params = {}, = {}) req = build_request(:update_graphql_api, params) req.send_request() end |
#update_resolver(params = {}) ⇒ Types::UpdateResolverResponse
Updates a Resolver
object.
4151 4152 4153 4154 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4151 def update_resolver(params = {}, = {}) req = build_request(:update_resolver, params) req.send_request() end |
#update_source_api_association(params = {}) ⇒ Types::UpdateSourceApiAssociationResponse
Updates some of the configuration choices of a particular source API association.
4209 4210 4211 4212 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4209 def update_source_api_association(params = {}, = {}) req = build_request(:update_source_api_association, params) req.send_request() end |
#update_type(params = {}) ⇒ Types::UpdateTypeResponse
Updates a Type
object.
4253 4254 4255 4256 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4253 def update_type(params = {}, = {}) req = build_request(:update_type, params) req.send_request() end |