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.
385 386 387 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#associate_api(params = {}) ⇒ Types::AssociateApiResponse
Maps an endpoint to your custom domain.
421 422 423 424 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 421 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.
482 483 484 485 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 482 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.
543 544 545 546 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 543 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.
659 660 661 662 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 659 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.
702 703 704 705 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 702 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.
858 859 860 861 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 858 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.
900 901 902 903 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 900 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.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1005 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a GraphqlApi
object.
1226 1227 1228 1229 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1226 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.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1372 def create_resolver(params = {}, = {}) req = build_request(:create_resolver, params) req.send_request() end |
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a Type
object.
1419 1420 1421 1422 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1419 def create_type(params = {}, = {}) req = build_request(:create_type, params) req.send_request() end |
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ApiCache
object.
1441 1442 1443 1444 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1441 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.
1467 1468 1469 1470 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1467 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.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1493 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.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1515 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a Function
.
1541 1542 1543 1544 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1541 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a GraphqlApi
object.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1563 def delete_graphql_api(params = {}, = {}) req = build_request(:delete_graphql_api, params) req.send_request() end |
#delete_resolver(params = {}) ⇒ Struct
Deletes a Resolver
object.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1593 def delete_resolver(params = {}, = {}) req = build_request(:delete_resolver, params) req.send_request() end |
#delete_type(params = {}) ⇒ Struct
Deletes a Type
object.
1619 1620 1621 1622 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1619 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.
1641 1642 1643 1644 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1641 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.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1679 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.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1717 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.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1783 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).
1831 1832 1833 1834 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1831 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.
1853 1854 1855 1856 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1853 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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1884 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.
1918 1919 1920 1921 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1918 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.
1978 1979 1980 1981 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1978 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.
2052 2053 2054 2055 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2052 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.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2084 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a Function
.
2130 2131 2132 2133 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2130 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a GraphqlApi
object.
2206 2207 2208 2209 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2206 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.
2237 2238 2239 2240 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2237 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.
2274 2275 2276 2277 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2274 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.
2329 2330 2331 2332 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2329 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.
2359 2360 2361 2362 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2359 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.
2406 2407 2408 2409 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2406 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.
2446 2447 2448 2449 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2446 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.
2497 2498 2499 2500 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2497 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.
2566 2567 2568 2569 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2566 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.
2607 2608 2609 2610 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2607 def list_domain_names(params = {}, = {}) req = build_request(:list_domain_names, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
List multiple functions.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2662 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_graphql_apis(params = {}) ⇒ Types::ListGraphqlApisResponse
Lists your GraphQL APIs.
2756 2757 2758 2759 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2756 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.
2820 2821 2822 2823 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2820 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.
2884 2885 2886 2887 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2884 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.
2931 2932 2933 2934 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2931 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.
2960 2961 2962 2963 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2960 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.
3009 3010 3011 3012 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3009 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.
3067 3068 3069 3070 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3067 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.
3165 3166 3167 3168 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3165 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.
3202 3203 3204 3205 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3202 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.
3237 3238 3239 3240 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3237 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.
3275 3276 3277 3278 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3275 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.
3303 3304 3305 3306 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3303 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
3329 3330 3331 3332 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3329 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.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3435 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.
3481 3482 3483 3484 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3481 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.
3635 3636 3637 3638 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3635 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.
3671 3672 3673 3674 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3671 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.
3777 3778 3779 3780 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3777 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a GraphqlApi
object.
3984 3985 3986 3987 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3984 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.
4126 4127 4128 4129 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4126 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.
4184 4185 4186 4187 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4184 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.
4228 4229 4230 4231 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4228 def update_type(params = {}, = {}) req = build_request(:update_type, params) req.send_request() end |