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
-
#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 are executing your API.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a
DataSource
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_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. -
#flush_api_cache(params = {}) ⇒ Struct
Flushes an
ApiCache
object. -
#get_api_cache(params = {}) ⇒ Types::GetApiCacheResponse
Retrieves an
ApiCache
object. -
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Retrieves a
DataSource
object. -
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a
Function
. -
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a
GraphqlApi
object. -
#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_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_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_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a resource.
-
#list_types(params = {}) ⇒ Types::ListTypesResponse
Lists the types for a given API.
-
#start_schema_creation(params = {}) ⇒ Types::StartSchemaCreationResponse
Adds a new schema to your GraphQL API.
-
#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_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_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.
324 325 326 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#create_api_cache(params = {}) ⇒ Types::CreateApiCacheResponse
Creates a cache for the GraphQL API.
424 425 426 427 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 424 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 are executing your API.
467 468 469 470 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 467 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.
589 590 591 592 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 589 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_function(params = {}) ⇒ Types::CreateFunctionResponse
Creates a Function
object.
A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
653 654 655 656 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 653 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a GraphqlApi
object.
772 773 774 775 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 772 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.
881 882 883 884 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 881 def create_resolver(params = {}, = {}) req = build_request(:create_resolver, params) req.send_request() end |
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a Type
object.
928 929 930 931 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 928 def create_type(params = {}, = {}) req = build_request(:create_type, params) req.send_request() end |
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ApiCache
object.
950 951 952 953 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 950 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.
976 977 978 979 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 976 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.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1002 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a Function
.
1028 1029 1030 1031 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1028 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a GraphqlApi
object.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1050 def delete_graphql_api(params = {}, = {}) req = build_request(:delete_graphql_api, params) req.send_request() end |
#delete_resolver(params = {}) ⇒ Struct
Deletes a Resolver
object.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1080 def delete_resolver(params = {}, = {}) req = build_request(:delete_resolver, params) req.send_request() end |
#delete_type(params = {}) ⇒ Struct
Deletes a Type
object.
1106 1107 1108 1109 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1106 def delete_type(params = {}, = {}) req = build_request(:delete_type, params) req.send_request() end |
#flush_api_cache(params = {}) ⇒ Struct
Flushes an ApiCache
object.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1128 def flush_api_cache(params = {}, = {}) req = build_request(:flush_api_cache, params) req.send_request() end |
#get_api_cache(params = {}) ⇒ Types::GetApiCacheResponse
Retrieves an ApiCache
object.
1161 1162 1163 1164 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1161 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.
1217 1218 1219 1220 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1217 def get_data_source(params = {}, = {}) req = build_request(:get_data_source, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a Function
.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1256 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a GraphqlApi
object.
1313 1314 1315 1316 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1313 def get_graphql_api(params = {}, = {}) req = build_request(:get_graphql_api, params) req.send_request() end |
#get_introspection_schema(params = {}) ⇒ Types::GetIntrospectionSchemaResponse
Retrieves the introspection schema for a GraphQL API.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1350 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.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1400 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.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1430 def get_schema_creation_status(params = {}, = {}) req = build_request(:get_schema_creation_status, params) req.send_request() end |
#get_type(params = {}) ⇒ Types::GetTypeResponse
Retrieves a Type
object.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1470 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.
1521 1522 1523 1524 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1521 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.
1586 1587 1588 1589 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1586 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
List multiple functions.
1634 1635 1636 1637 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1634 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_graphql_apis(params = {}) ⇒ Types::ListGraphqlApisResponse
Lists your GraphQL APIs.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1700 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.
1759 1760 1761 1762 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1759 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.
1818 1819 1820 1821 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1818 def list_resolvers_by_function(params = {}, = {}) req = build_request(:list_resolvers_by_function, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a resource.
1847 1848 1849 1850 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1847 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.
1896 1897 1898 1899 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1896 def list_types(params = {}, = {}) req = build_request(:list_types, 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.
1931 1932 1933 1934 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1931 def start_schema_creation(params = {}, = {}) req = build_request(:start_schema_creation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a resource with user-supplied tags.
1959 1960 1961 1962 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1959 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
1985 1986 1987 1988 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 1985 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.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2074 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. The key can be updated while it is not deleted.
2118 2119 2120 2121 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2118 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.
2239 2240 2241 2242 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2239 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_function(params = {}) ⇒ Types::UpdateFunctionResponse
Updates a Function
object.
2304 2305 2306 2307 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2304 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a GraphqlApi
object.
2421 2422 2423 2424 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2421 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.
2527 2528 2529 2530 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2527 def update_resolver(params = {}, = {}) req = build_request(:update_resolver, params) req.send_request() end |
#update_type(params = {}) ⇒ Types::UpdateTypeResponse
Updates a Type
object.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/client.rb', line 2571 def update_type(params = {}, = {}) req = build_request(:update_type, params) req.send_request() end |