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.
446 447 448 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#associate_api(params = {}) ⇒ Types::AssociateApiResponse
Maps an endpoint to your custom domain.
482 483 484 485 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 482 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.
543 544 545 546 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 543 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.
604 605 606 607 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 604 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.
720 721 722 723 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 720 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.
763 764 765 766 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 763 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.
919 920 921 922 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 919 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.
961 962 963 964 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 961 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.
1066 1067 1068 1069 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1066 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a GraphqlApi
object.
1287 1288 1289 1290 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1287 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.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1433 def create_resolver(params = {}, = {}) req = build_request(:create_resolver, params) req.send_request() end |
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a Type
object.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1480 def create_type(params = {}, = {}) req = build_request(:create_type, params) req.send_request() end |
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ApiCache
object.
1502 1503 1504 1505 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1502 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.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1528 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.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1554 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.
1576 1577 1578 1579 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1576 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a Function
.
1602 1603 1604 1605 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1602 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a GraphqlApi
object.
1624 1625 1626 1627 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1624 def delete_graphql_api(params = {}, = {}) req = build_request(:delete_graphql_api, params) req.send_request() end |
#delete_resolver(params = {}) ⇒ Struct
Deletes a Resolver
object.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1654 def delete_resolver(params = {}, = {}) req = build_request(:delete_resolver, params) req.send_request() end |
#delete_type(params = {}) ⇒ Struct
Deletes a Type
object.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1680 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.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1702 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.
1740 1741 1742 1743 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1740 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.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1778 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.
1844 1845 1846 1847 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1844 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).
1892 1893 1894 1895 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1892 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.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1914 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.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1945 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.
1979 1980 1981 1982 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1979 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.
2039 2040 2041 2042 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2039 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.
2113 2114 2115 2116 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2113 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.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2145 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a Function
.
2191 2192 2193 2194 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2191 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a GraphqlApi
object.
2267 2268 2269 2270 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2267 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.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2298 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.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2335 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.
2390 2391 2392 2393 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2390 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.
2420 2421 2422 2423 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2420 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.
2467 2468 2469 2470 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2467 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.
2507 2508 2509 2510 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2507 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2560 2561 2562 2563 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2560 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2631 2632 2633 2634 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2631 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2674 2675 2676 2677 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2674 def list_domain_names(params = {}, = {}) req = build_request(:list_domain_names, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
List multiple functions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2731 2732 2733 2734 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2731 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_graphql_apis(params = {}) ⇒ Types::ListGraphqlApisResponse
Lists your GraphQL APIs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2827 2828 2829 2830 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2827 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2893 2894 2895 2896 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2893 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2959 2960 2961 2962 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2959 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3008 3009 3010 3011 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3008 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.
3037 3038 3039 3040 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3037 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3088 3089 3090 3091 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3088 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3148 3149 3150 3151 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3148 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.
3246 3247 3248 3249 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3246 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.
3283 3284 3285 3286 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3283 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.
3318 3319 3320 3321 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3318 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.
3356 3357 3358 3359 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3356 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.
3384 3385 3386 3387 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3384 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
3410 3411 3412 3413 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3410 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.
3516 3517 3518 3519 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3516 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.
3562 3563 3564 3565 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3562 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.
3716 3717 3718 3719 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3716 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.
3752 3753 3754 3755 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3752 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.
3858 3859 3860 3861 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3858 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a GraphqlApi
object.
4065 4066 4067 4068 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4065 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.
4207 4208 4209 4210 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4207 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.
4265 4266 4267 4268 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4265 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.
4309 4310 4311 4312 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4309 def update_type(params = {}, = {}) req = build_request(:update_type, params) req.send_request() end |