Class: Aws::AppSync::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppSync::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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 ‘Api` object.
-
#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 ‘ChannelNamespace` for an `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(params = {}) ⇒ Struct
Deletes an ‘Api` object.
-
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ‘ApiCache` object.
-
#delete_api_key(params = {}) ⇒ Struct
Deletes an API key.
-
#delete_channel_namespace(params = {}) ⇒ Struct
Deletes a ‘ChannelNamespace`.
-
#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(params = {}) ⇒ Types::GetApiResponse
Retrieves an ‘Api` object.
-
#get_api_association(params = {}) ⇒ Types::GetApiAssociationResponse
Retrieves an ‘ApiAssociation` object.
-
#get_api_cache(params = {}) ⇒ Types::GetApiCacheResponse
Retrieves an ‘ApiCache` object.
-
#get_channel_namespace(params = {}) ⇒ Types::GetChannelNamespaceResponse
Retrieves the channel namespace for a specified ‘Api`.
-
#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_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 ‘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(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 ‘ChannelNamespace` associated with an `Api`.
-
#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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
467 468 469 |
# File 'lib/aws-sdk-appsync/client.rb', line 467 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5055 5056 5057 |
# File 'lib/aws-sdk-appsync/client.rb', line 5055 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5058 5059 5060 |
# File 'lib/aws-sdk-appsync/client.rb', line 5058 def errors_module Errors end |
Instance Method Details
#associate_api(params = {}) ⇒ Types::AssociateApiResponse
Maps an endpoint to your custom domain.
503 504 505 506 |
# File 'lib/aws-sdk-appsync/client.rb', line 503 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.
564 565 566 567 |
# File 'lib/aws-sdk-appsync/client.rb', line 564 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.
625 626 627 628 |
# File 'lib/aws-sdk-appsync/client.rb', line 625 def associate_source_graphql_api(params = {}, = {}) req = build_request(:associate_source_graphql_api, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 |
# File 'lib/aws-sdk-appsync/client.rb', line 5028 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::AppSync') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-appsync' context[:gem_version] = '1.102.0' Seahorse::Client::Request.new(handlers, context) 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.
743 744 745 746 |
# File 'lib/aws-sdk-appsync/client.rb', line 743 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.
864 865 866 867 |
# File 'lib/aws-sdk-appsync/client.rb', line 864 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.
907 908 909 910 |
# File 'lib/aws-sdk-appsync/client.rb', line 907 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`.
982 983 984 985 |
# File 'lib/aws-sdk-appsync/client.rb', line 982 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.
1138 1139 1140 1141 |
# File 'lib/aws-sdk-appsync/client.rb', line 1138 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.
1189 1190 1191 1192 |
# File 'lib/aws-sdk-appsync/client.rb', line 1189 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.
1294 1295 1296 1297 |
# File 'lib/aws-sdk-appsync/client.rb', line 1294 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_graphql_api(params = {}) ⇒ Types::CreateGraphqlApiResponse
Creates a ‘GraphqlApi` object.
1515 1516 1517 1518 |
# File 'lib/aws-sdk-appsync/client.rb', line 1515 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.
1661 1662 1663 1664 |
# File 'lib/aws-sdk-appsync/client.rb', line 1661 def create_resolver(params = {}, = {}) req = build_request(:create_resolver, params) req.send_request() end |
#create_type(params = {}) ⇒ Types::CreateTypeResponse
Creates a ‘Type` object.
1708 1709 1710 1711 |
# File 'lib/aws-sdk-appsync/client.rb', line 1708 def create_type(params = {}, = {}) req = build_request(:create_type, params) req.send_request() end |
#delete_api(params = {}) ⇒ Struct
Deletes an ‘Api` object
1730 1731 1732 1733 |
# File 'lib/aws-sdk-appsync/client.rb', line 1730 def delete_api(params = {}, = {}) req = build_request(:delete_api, params) req.send_request() end |
#delete_api_cache(params = {}) ⇒ Struct
Deletes an ‘ApiCache` object.
1752 1753 1754 1755 |
# File 'lib/aws-sdk-appsync/client.rb', line 1752 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.
1778 1779 1780 1781 |
# File 'lib/aws-sdk-appsync/client.rb', line 1778 def delete_api_key(params = {}, = {}) req = build_request(:delete_api_key, params) req.send_request() end |
#delete_channel_namespace(params = {}) ⇒ Struct
Deletes a ‘ChannelNamespace`.
1804 1805 1806 1807 |
# File 'lib/aws-sdk-appsync/client.rb', line 1804 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.
1830 1831 1832 1833 |
# File 'lib/aws-sdk-appsync/client.rb', line 1830 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.
1852 1853 1854 1855 |
# File 'lib/aws-sdk-appsync/client.rb', line 1852 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a ‘Function`.
1878 1879 1880 1881 |
# File 'lib/aws-sdk-appsync/client.rb', line 1878 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_graphql_api(params = {}) ⇒ Struct
Deletes a ‘GraphqlApi` object.
1900 1901 1902 1903 |
# File 'lib/aws-sdk-appsync/client.rb', line 1900 def delete_graphql_api(params = {}, = {}) req = build_request(:delete_graphql_api, params) req.send_request() end |
#delete_resolver(params = {}) ⇒ Struct
Deletes a ‘Resolver` object.
1930 1931 1932 1933 |
# File 'lib/aws-sdk-appsync/client.rb', line 1930 def delete_resolver(params = {}, = {}) req = build_request(:delete_resolver, params) req.send_request() end |
#delete_type(params = {}) ⇒ Struct
Deletes a ‘Type` object.
1956 1957 1958 1959 |
# File 'lib/aws-sdk-appsync/client.rb', line 1956 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.
1978 1979 1980 1981 |
# File 'lib/aws-sdk-appsync/client.rb', line 1978 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.
2016 2017 2018 2019 |
# File 'lib/aws-sdk-appsync/client.rb', line 2016 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.
2054 2055 2056 2057 |
# File 'lib/aws-sdk-appsync/client.rb', line 2054 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.
2124 2125 2126 2127 |
# File 'lib/aws-sdk-appsync/client.rb', line 2124 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).
2176 2177 2178 2179 |
# File 'lib/aws-sdk-appsync/client.rb', line 2176 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.
2198 2199 2200 2201 |
# File 'lib/aws-sdk-appsync/client.rb', line 2198 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.
2256 2257 2258 2259 |
# File 'lib/aws-sdk-appsync/client.rb', line 2256 def get_api(params = {}, = {}) req = build_request(:get_api, params) req.send_request() end |
#get_api_association(params = {}) ⇒ Types::GetApiAssociationResponse
Retrieves an ‘ApiAssociation` object.
2287 2288 2289 2290 |
# File 'lib/aws-sdk-appsync/client.rb', line 2287 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.
2321 2322 2323 2324 |
# File 'lib/aws-sdk-appsync/client.rb', line 2321 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`.
2364 2365 2366 2367 |
# File 'lib/aws-sdk-appsync/client.rb', line 2364 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.
2424 2425 2426 2427 |
# File 'lib/aws-sdk-appsync/client.rb', line 2424 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.
2498 2499 2500 2501 |
# File 'lib/aws-sdk-appsync/client.rb', line 2498 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.
2533 2534 2535 2536 |
# File 'lib/aws-sdk-appsync/client.rb', line 2533 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Get a ‘Function`.
2579 2580 2581 2582 |
# File 'lib/aws-sdk-appsync/client.rb', line 2579 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_graphql_api(params = {}) ⇒ Types::GetGraphqlApiResponse
Retrieves a ‘GraphqlApi` object.
2655 2656 2657 2658 |
# File 'lib/aws-sdk-appsync/client.rb', line 2655 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.
2686 2687 2688 2689 |
# File 'lib/aws-sdk-appsync/client.rb', line 2686 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.
2723 2724 2725 2726 |
# File 'lib/aws-sdk-appsync/client.rb', line 2723 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.
2778 2779 2780 2781 |
# File 'lib/aws-sdk-appsync/client.rb', line 2778 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.
2808 2809 2810 2811 |
# File 'lib/aws-sdk-appsync/client.rb', line 2808 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.
2855 2856 2857 2858 |
# File 'lib/aws-sdk-appsync/client.rb', line 2855 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.
2895 2896 2897 2898 |
# File 'lib/aws-sdk-appsync/client.rb', line 2895 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.
<note markdown=“1”> API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call ‘DeleteApiKey` to manually delete a key before it’s automatically deleted.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2948 2949 2950 2951 |
# File 'lib/aws-sdk-appsync/client.rb', line 2948 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.
3020 3021 3022 3023 |
# File 'lib/aws-sdk-appsync/client.rb', line 3020 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.
3078 3079 3080 3081 |
# File 'lib/aws-sdk-appsync/client.rb', line 3078 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.
3149 3150 3151 3152 |
# File 'lib/aws-sdk-appsync/client.rb', line 3149 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.
3195 3196 3197 3198 |
# File 'lib/aws-sdk-appsync/client.rb', line 3195 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.
3252 3253 3254 3255 |
# File 'lib/aws-sdk-appsync/client.rb', line 3252 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.
3348 3349 3350 3351 |
# File 'lib/aws-sdk-appsync/client.rb', line 3348 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.
3414 3415 3416 3417 |
# File 'lib/aws-sdk-appsync/client.rb', line 3414 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.
3480 3481 3482 3483 |
# File 'lib/aws-sdk-appsync/client.rb', line 3480 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.
3529 3530 3531 3532 |
# File 'lib/aws-sdk-appsync/client.rb', line 3529 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.
3558 3559 3560 3561 |
# File 'lib/aws-sdk-appsync/client.rb', line 3558 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.
3609 3610 3611 3612 |
# File 'lib/aws-sdk-appsync/client.rb', line 3609 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.
3669 3670 3671 3672 |
# File 'lib/aws-sdk-appsync/client.rb', line 3669 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 `…`. 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.
3767 3768 3769 3770 |
# File 'lib/aws-sdk-appsync/client.rb', line 3767 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.
3804 3805 3806 3807 |
# File 'lib/aws-sdk-appsync/client.rb', line 3804 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.
3839 3840 3841 3842 |
# File 'lib/aws-sdk-appsync/client.rb', line 3839 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.
3877 3878 3879 3880 |
# File 'lib/aws-sdk-appsync/client.rb', line 3877 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.
3905 3906 3907 3908 |
# File 'lib/aws-sdk-appsync/client.rb', line 3905 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource.
3931 3932 3933 3934 |
# File 'lib/aws-sdk-appsync/client.rb', line 3931 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_api(params = {}) ⇒ Types::UpdateApiResponse
Updates an ‘Api`.
4044 4045 4046 4047 |
# File 'lib/aws-sdk-appsync/client.rb', line 4044 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.
4155 4156 4157 4158 |
# File 'lib/aws-sdk-appsync/client.rb', line 4155 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.
4201 4202 4203 4204 |
# File 'lib/aws-sdk-appsync/client.rb', line 4201 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`.
4269 4270 4271 4272 |
# File 'lib/aws-sdk-appsync/client.rb', line 4269 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.
4423 4424 4425 4426 |
# File 'lib/aws-sdk-appsync/client.rb', line 4423 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.
4462 4463 4464 4465 |
# File 'lib/aws-sdk-appsync/client.rb', line 4462 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.
4568 4569 4570 4571 |
# File 'lib/aws-sdk-appsync/client.rb', line 4568 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_graphql_api(params = {}) ⇒ Types::UpdateGraphqlApiResponse
Updates a ‘GraphqlApi` object.
4775 4776 4777 4778 |
# File 'lib/aws-sdk-appsync/client.rb', line 4775 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.
4917 4918 4919 4920 |
# File 'lib/aws-sdk-appsync/client.rb', line 4917 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.
4975 4976 4977 4978 |
# File 'lib/aws-sdk-appsync/client.rb', line 4975 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.
5019 5020 5021 5022 |
# File 'lib/aws-sdk-appsync/client.rb', line 5019 def update_type(params = {}, = {}) req = build_request(:update_type, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5048 5049 5050 |
# File 'lib/aws-sdk-appsync/client.rb', line 5048 def waiter_names [] end |