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.
409 410 411 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#associate_api(params = {}) ⇒ Types::AssociateApiResponse
Maps an endpoint to your custom domain.
445 446 447 448 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 445 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.
506 507 508 509 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 506 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.
567 568 569 570 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 567 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.
683 684 685 686 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 683 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.
726 727 728 729 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 726 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.
882 883 884 885 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 882 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.
924 925 926 927 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 924 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.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1029 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a GraphqlApi
object.
1250 1251 1252 1253 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1250 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.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1396 def create_resolver(params = {}, = {}) req = build_request(:create_resolver, params) req.send_request() end |
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a Type
object.
1443 1444 1445 1446 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1443 def create_type(params = {}, = {}) req = build_request(:create_type, params) req.send_request() end |
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ApiCache
object.
1465 1466 1467 1468 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1465 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.
1491 1492 1493 1494 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1491 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.
1517 1518 1519 1520 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1517 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.
1539 1540 1541 1542 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1539 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a Function
.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1565 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a GraphqlApi
object.
1587 1588 1589 1590 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1587 def delete_graphql_api(params = {}, = {}) req = build_request(:delete_graphql_api, params) req.send_request() end |
#delete_resolver(params = {}) ⇒ Struct
Deletes a Resolver
object.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1617 def delete_resolver(params = {}, = {}) req = build_request(:delete_resolver, params) req.send_request() end |
#delete_type(params = {}) ⇒ Struct
Deletes a Type
object.
1643 1644 1645 1646 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1643 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.
1665 1666 1667 1668 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1665 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.
1703 1704 1705 1706 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1703 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.
1741 1742 1743 1744 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1741 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.
1807 1808 1809 1810 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1807 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).
1855 1856 1857 1858 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1855 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.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1877 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.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1908 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.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1942 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.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2002 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.
2076 2077 2078 2079 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2076 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2108 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a Function
.
2154 2155 2156 2157 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2154 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a GraphqlApi
object.
2230 2231 2232 2233 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2230 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.
2261 2262 2263 2264 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2261 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.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2298 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.
2353 2354 2355 2356 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2353 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.
2383 2384 2385 2386 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2383 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.
2430 2431 2432 2433 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2430 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.
2470 2471 2472 2473 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2470 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.
2521 2522 2523 2524 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2521 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.
2590 2591 2592 2593 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2590 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.
2631 2632 2633 2634 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2631 def list_domain_names(params = {}, = {}) req = build_request(:list_domain_names, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
List multiple functions.
2686 2687 2688 2689 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2686 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_graphql_apis(params = {}) ⇒ Types::ListGraphqlApisResponse
Lists your GraphQL APIs.
2780 2781 2782 2783 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2780 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.
2844 2845 2846 2847 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2844 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.
2908 2909 2910 2911 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2908 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.
2955 2956 2957 2958 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2955 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.
2984 2985 2986 2987 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2984 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.
3033 3034 3035 3036 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3033 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.
3091 3092 3093 3094 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3091 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.
3189 3190 3191 3192 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3189 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.
3226 3227 3228 3229 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3226 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.
3261 3262 3263 3264 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3261 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.
3299 3300 3301 3302 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3299 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.
3327 3328 3329 3330 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3327 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
3353 3354 3355 3356 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3353 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.
3459 3460 3461 3462 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3459 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.
3505 3506 3507 3508 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3505 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.
3659 3660 3661 3662 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3659 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.
3695 3696 3697 3698 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3695 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.
3801 3802 3803 3804 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3801 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a GraphqlApi
object.
4008 4009 4010 4011 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4008 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.
4150 4151 4152 4153 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4150 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.
4208 4209 4210 4211 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4208 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.
4252 4253 4254 4255 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4252 def update_type(params = {}, = {}) req = build_request(:update_type, params) req.send_request() end |