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(params = {}) ⇒ Types::CreateApiResponse
Creates an
Apiobject. -
#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_channel_namespace(params = {}) ⇒ Types::CreateChannelNamespaceResponse
Creates a
ChannelNamespacefor anApi. -
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a
DataSourceobject. -
#create_domain_name(params = {}) ⇒ Types::CreateDomainNameResponse
Creates a custom
DomainNameobject. -
#create_function(params = {}) ⇒ Types::CreateFunctionResponse
Creates a
Functionobject. -
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a
GraphqlApiobject. -
#create_resolver(params = {}) ⇒ Types::CreateResolverResponse
Creates a
Resolverobject. -
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a
Typeobject. -
#delete_api(params = {}) ⇒ Struct
Deletes an
Apiobject. -
#delete_api_cache(params = {}) ⇒ Struct
Deletes an
ApiCacheobject. -
#delete_api_key(params = {}) ⇒ Struct
Deletes an API key.
-
#delete_channel_namespace(params = {}) ⇒ Struct
Deletes a
ChannelNamespace. -
#delete_data_source(params = {}) ⇒ Struct
Deletes a
DataSourceobject. -
#delete_domain_name(params = {}) ⇒ Struct
Deletes a custom
DomainNameobject. -
#delete_function(params = {}) ⇒ Struct
Deletes a
Function. -
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a
GraphqlApiobject. -
#delete_resolver(params = {}) ⇒ Struct
Deletes a
Resolverobject. -
#delete_type(params = {}) ⇒ Struct
Deletes a
Typeobject. -
#disassociate_api(params = {}) ⇒ Struct
Removes an
ApiAssociationobject 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
ApiCacheobject. -
#get_api(params = {}) ⇒ Types::GetApiResponse
Retrieves an
Apiobject. -
#get_api_association(params = {}) ⇒ Types::GetApiAssociationResponse
Retrieves an
ApiAssociationobject. -
#get_api_cache(params = {}) ⇒ Types::GetApiCacheResponse
Retrieves an
ApiCacheobject. -
#get_channel_namespace(params = {}) ⇒ Types::GetChannelNamespaceResponse
Retrieves the channel namespace for a specified
Api. -
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Retrieves a
DataSourceobject. -
#get_data_source_introspection(params = {}) ⇒ Types::GetDataSourceIntrospectionResponse
Retrieves the record of an existing introspection.
-
#get_domain_name(params = {}) ⇒ Types::GetDomainNameResponse
Retrieves a custom
DomainNameobject. -
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a
Function. -
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a
GraphqlApiobject. -
#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
Resolverobject. -
#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
SourceApiAssociationobject. -
#get_type(params = {}) ⇒ Types::GetTypeResponse
Retrieves a
Typeobject. -
#list_api_keys(params = {}) ⇒ Types::ListApiKeysResponse
Lists the API keys for a given API.
-
#list_apis(params = {}) ⇒ Types::ListApisResponse
Lists the APIs in your AppSync account.
-
#list_channel_namespaces(params = {}) ⇒ Types::ListChannelNamespacesResponse
Lists the channel namespaces for a specified
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
SourceApiAssociationSummarydata. -
#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
Typeobjects 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(params = {}) ⇒ Types::UpdateApiResponse
Updates an
Api. -
#update_api_cache(params = {}) ⇒ Types::UpdateApiCacheResponse
Updates the cache for the GraphQL API.
-
#update_api_key(params = {}) ⇒ Types::UpdateApiKeyResponse
Updates an API key.
-
#update_channel_namespace(params = {}) ⇒ Types::UpdateChannelNamespaceResponse
Updates a
ChannelNamespaceassociated with anApi. -
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a
DataSourceobject. -
#update_domain_name(params = {}) ⇒ Types::UpdateDomainNameResponse
Updates a custom
DomainNameobject. -
#update_function(params = {}) ⇒ Types::UpdateFunctionResponse
Updates a
Functionobject. -
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a
GraphqlApiobject. -
#update_resolver(params = {}) ⇒ Types::UpdateResolverResponse
Updates a
Resolverobject. -
#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
Typeobject.
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.
479 480 481 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#associate_api(params = {}) ⇒ Types::AssociateApiResponse
Maps an endpoint to your custom domain.
515 516 517 518 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 515 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.
576 577 578 579 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 576 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.
637 638 639 640 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 637 def associate_source_graphql_api(params = {}, = {}) req = build_request(:associate_source_graphql_api, params) req.send_request() end |
#create_api(params = {}) ⇒ Types::CreateApiResponse
Creates an Api object. Use this operation to create an AppSync API
with your preferred configuration, such as an Event API that provides
real-time message publishing and message subscriptions over
WebSockets.
755 756 757 758 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 755 def create_api(params = {}, = {}) req = build_request(:create_api, params) req.send_request() end |
#create_api_cache(params = {}) ⇒ Types::CreateApiCacheResponse
Creates a cache for the GraphQL API.
876 877 878 879 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 876 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.
919 920 921 922 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 919 def create_api_key(params = {}, = {}) req = build_request(:create_api_key, params) req.send_request() end |
#create_channel_namespace(params = {}) ⇒ Types::CreateChannelNamespaceResponse
Creates a ChannelNamespace for an Api.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1023 def create_channel_namespace(params = {}, = {}) req = build_request(:create_channel_namespace, params) req.send_request() end |
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a DataSource object.
1179 1180 1181 1182 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1179 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.
1230 1231 1232 1233 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1230 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.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1335 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a GraphqlApi object.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1556 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.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1702 def create_resolver(params = {}, = {}) req = build_request(:create_resolver, params) req.send_request() end |
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a Type object.
1749 1750 1751 1752 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1749 def create_type(params = {}, = {}) req = build_request(:create_type, params) req.send_request() end |
#delete_api(params = {}) ⇒ Struct
Deletes an Api object
1771 1772 1773 1774 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1771 def delete_api(params = {}, = {}) req = build_request(:delete_api, params) req.send_request() end |
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ApiCache object.
1793 1794 1795 1796 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1793 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.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1819 def delete_api_key(params = {}, = {}) req = build_request(:delete_api_key, params) req.send_request() end |
#delete_channel_namespace(params = {}) ⇒ Struct
Deletes a ChannelNamespace.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1845 def delete_channel_namespace(params = {}, = {}) req = build_request(:delete_channel_namespace, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Struct
Deletes a DataSource object.
1871 1872 1873 1874 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1871 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.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1893 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a Function.
1919 1920 1921 1922 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1919 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a GraphqlApi object.
1941 1942 1943 1944 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1941 def delete_graphql_api(params = {}, = {}) req = build_request(:delete_graphql_api, params) req.send_request() end |
#delete_resolver(params = {}) ⇒ Struct
Deletes a Resolver object.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1971 def delete_resolver(params = {}, = {}) req = build_request(:delete_resolver, params) req.send_request() end |
#delete_type(params = {}) ⇒ Struct
Deletes a Type object.
1997 1998 1999 2000 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1997 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.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2019 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.
2057 2058 2059 2060 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2057 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.
2095 2096 2097 2098 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2095 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.
2165 2166 2167 2168 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2165 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).
2217 2218 2219 2220 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2217 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.
2239 2240 2241 2242 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2239 def flush_api_cache(params = {}, = {}) req = build_request(:flush_api_cache, params) req.send_request() end |
#get_api(params = {}) ⇒ Types::GetApiResponse
Retrieves an Api object.
2297 2298 2299 2300 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2297 def get_api(params = {}, = {}) req = build_request(:get_api, params) req.send_request() end |
#get_api_association(params = {}) ⇒ Types::GetApiAssociationResponse
Retrieves an ApiAssociation object.
2328 2329 2330 2331 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2328 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.
2362 2363 2364 2365 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2362 def get_api_cache(params = {}, = {}) req = build_request(:get_api_cache, params) req.send_request() end |
#get_channel_namespace(params = {}) ⇒ Types::GetChannelNamespaceResponse
Retrieves the channel namespace for a specified Api.
2411 2412 2413 2414 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2411 def get_channel_namespace(params = {}, = {}) req = build_request(:get_channel_namespace, params) req.send_request() end |
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Retrieves a DataSource object.
2471 2472 2473 2474 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2471 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.
2545 2546 2547 2548 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2545 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.
2580 2581 2582 2583 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2580 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a Function.
2626 2627 2628 2629 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2626 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a GraphqlApi object.
2702 2703 2704 2705 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2702 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.
2733 2734 2735 2736 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2733 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.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2770 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.
2825 2826 2827 2828 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2825 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.
2855 2856 2857 2858 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2855 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.
2902 2903 2904 2905 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2902 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.
2942 2943 2944 2945 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2942 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.
2995 2996 2997 2998 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2995 def list_api_keys(params = {}, = {}) req = build_request(:list_api_keys, params) req.send_request() end |
#list_apis(params = {}) ⇒ Types::ListApisResponse
Lists the APIs in your AppSync account.
ListApis returns only the high level API details. For more detailed
information about an API, use GetApi.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3067 3068 3069 3070 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3067 def list_apis(params = {}, = {}) req = build_request(:list_apis, params) req.send_request() end |
#list_channel_namespaces(params = {}) ⇒ Types::ListChannelNamespacesResponse
Lists the channel namespaces for a specified Api.
ListChannelNamespaces returns only high level details for the
channel namespace. To retrieve code handlers, use
GetChannelNamespace.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3131 3132 3133 3134 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3131 def list_channel_namespaces(params = {}, = {}) req = build_request(:list_channel_namespaces, 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.
3202 3203 3204 3205 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3202 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.
3248 3249 3250 3251 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3248 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.
3305 3306 3307 3308 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3305 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.
3401 3402 3403 3404 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3401 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.
3467 3468 3469 3470 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3467 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.
3533 3534 3535 3536 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3533 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.
3582 3583 3584 3585 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3582 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.
3611 3612 3613 3614 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3611 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.
3662 3663 3664 3665 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3662 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.
3722 3723 3724 3725 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3722 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.
3820 3821 3822 3823 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3820 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.
3857 3858 3859 3860 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3857 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.
3892 3893 3894 3895 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3892 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.
3930 3931 3932 3933 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3930 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.
3958 3959 3960 3961 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3958 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
3984 3985 3986 3987 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 3984 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_api(params = {}) ⇒ Types::UpdateApiResponse
Updates an Api.
4097 4098 4099 4100 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4097 def update_api(params = {}, = {}) req = build_request(:update_api, params) req.send_request() end |
#update_api_cache(params = {}) ⇒ Types::UpdateApiCacheResponse
Updates the cache for the GraphQL API.
4208 4209 4210 4211 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4208 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.
4254 4255 4256 4257 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4254 def update_api_key(params = {}, = {}) req = build_request(:update_api_key, params) req.send_request() end |
#update_channel_namespace(params = {}) ⇒ Types::UpdateChannelNamespaceResponse
Updates a ChannelNamespace associated with an Api.
4351 4352 4353 4354 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4351 def update_channel_namespace(params = {}, = {}) req = build_request(:update_channel_namespace, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a DataSource object.
4505 4506 4507 4508 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4505 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.
4544 4545 4546 4547 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4544 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.
4650 4651 4652 4653 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4650 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a GraphqlApi object.
4857 4858 4859 4860 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4857 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.
4999 5000 5001 5002 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 4999 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.
5057 5058 5059 5060 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 5057 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.
5101 5102 5103 5104 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 5101 def update_type(params = {}, = {}) req = build_request(:update_type, params) req.send_request() end |