Struct aws_sdk_appsync::Client

pub struct Client { /* private fields */ }

Client for AWS AppSync

Client for invoking operations on AWS AppSync. Each operation on AWS AppSync is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_appsync::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_appsync::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_appsync::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn associate_api(&self) -> AssociateApi

Constructs a fluent builder for the AssociateApi operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name.

  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

• On success, responds with AssociateApiOutput with field(s):
  • api_association(Option<ApiAssociation>):

    The ApiAssociation object.

• On failure, responds with SdkError<AssociateApiError>

pub fn create_api_cache(&self) -> CreateApiCache

Constructs a fluent builder for the CreateApiCache operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The GraphQL API ID.

  • ttl(i64) / set_ttl(i64):

    TTL in seconds for cache entries.

    Valid values are 1–3,600 seconds.

  • transit_encryption_enabled(bool) / set_transit_encryption_enabled(bool):

    Transit encryption flag when connecting to cache. You cannot update this setting after creation.

  • at_rest_encryption_enabled(bool) / set_at_rest_encryption_enabled(bool):

    At-rest encryption flag for cache. You cannot update this setting after creation.

  • api_caching_behavior(ApiCachingBehavior) / set_api_caching_behavior(Option<ApiCachingBehavior>):

    Caching behavior.

    • FULL_REQUEST_CACHING: All requests are fully cached.

    • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

  • r#type(ApiCacheType) / set_type(Option<ApiCacheType>):

    The cache instance type. Valid values are

    • SMALL

    • MEDIUM

    • LARGE

    • XLARGE

    • LARGE_2X

    • LARGE_4X

    • LARGE_8X (not available in all regions)

    • LARGE_12X

    Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

    The following legacy instance types are available, but their use is discouraged:

    • T2_SMALL: A t2.small instance type.

    • T2_MEDIUM: A t2.medium instance type.

    • R4_LARGE: A r4.large instance type.

    • R4_XLARGE: A r4.xlarge instance type.

    • R4_2XLARGE: A r4.2xlarge instance type.

    • R4_4XLARGE: A r4.4xlarge instance type.

    • R4_8XLARGE: A r4.8xlarge instance type.

• On success, responds with CreateApiCacheOutput with field(s):
  • api_cache(Option<ApiCache>):

    The ApiCache object.

• On failure, responds with SdkError<CreateApiCacheError>

pub fn create_api_key(&self) -> CreateApiKey

Constructs a fluent builder for the CreateApiKey operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The ID for your GraphQL API.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the purpose of the API key.

  • expires(i64) / set_expires(i64):

    From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

• On success, responds with CreateApiKeyOutput with field(s):
  • api_key(Option<ApiKey>):

    The API key.

• On failure, responds with SdkError<CreateApiKeyError>

pub fn create_data_source(&self) -> CreateDataSource

Constructs a fluent builder for the CreateDataSource operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID for the GraphQL API for the DataSource.

  • name(impl Into<String>) / set_name(Option<String>):

    A user-supplied name for the DataSource.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the DataSource.

  • r#type(DataSourceType) / set_type(Option<DataSourceType>):

    The type of the DataSource.

  • service_role_arn(impl Into<String>) / set_service_role_arn(Option<String>):

    The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.

  • dynamodb_config(DynamodbDataSourceConfig) / set_dynamodb_config(Option<DynamodbDataSourceConfig>):

    Amazon DynamoDB settings.

  • lambda_config(LambdaDataSourceConfig) / set_lambda_config(Option<LambdaDataSourceConfig>):

    Lambda settings.

  • elasticsearch_config(ElasticsearchDataSourceConfig) / set_elasticsearch_config(Option<ElasticsearchDataSourceConfig>):

    Amazon OpenSearch Service settings.

    As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

  • open_search_service_config(OpenSearchServiceDataSourceConfig) / set_open_search_service_config(Option<OpenSearchServiceDataSourceConfig>):

    Amazon OpenSearch Service settings.

  • http_config(HttpDataSourceConfig) / set_http_config(Option<HttpDataSourceConfig>):

    HTTP endpoint settings.

  • relational_database_config(RelationalDatabaseDataSourceConfig) / set_relational_database_config(Option<RelationalDatabaseDataSourceConfig>):

    Relational database settings.

• On success, responds with CreateDataSourceOutput with field(s):
  • data_source(Option<DataSource>):

    The DataSource object.

• On failure, responds with SdkError<CreateDataSourceError>

pub fn create_domain_name(&self) -> CreateDomainName

Constructs a fluent builder for the CreateDomainName operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name.

  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):

    The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the DomainName.

• On success, responds with CreateDomainNameOutput with field(s):
  • domain_name_config(Option<DomainNameConfig>):

    The configuration for the DomainName.

• On failure, responds with SdkError<CreateDomainNameError>

pub fn create_function(&self) -> CreateFunction

Constructs a fluent builder for the CreateFunction operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The GraphQL API ID.

  • name(impl Into<String>) / set_name(Option<String>):

    The Function name. The function name does not have to be unique.

  • description(impl Into<String>) / set_description(Option<String>):

    The Function description.

  • data_source_name(impl Into<String>) / set_data_source_name(Option<String>):

    The Function DataSource name.

  • request_mapping_template(impl Into<String>) / set_request_mapping_template(Option<String>):

    The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

  • response_mapping_template(impl Into<String>) / set_response_mapping_template(Option<String>):

    The Function response mapping template.

  • function_version(impl Into<String>) / set_function_version(Option<String>):

    The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.

  • sync_config(SyncConfig) / set_sync_config(Option<SyncConfig>):

    Describes a Sync configuration for a resolver.

    Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

  • max_batch_size(i32) / set_max_batch_size(i32):

    The maximum batching size for a resolver.

  • runtime(AppSyncRuntime) / set_runtime(Option<AppSyncRuntime>):

    Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

  • code(impl Into<String>) / set_code(Option<String>):

    The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

• On success, responds with CreateFunctionOutput with field(s):
  • function_configuration(Option<FunctionConfiguration>):

    The Function object.

• On failure, responds with SdkError<CreateFunctionError>

pub fn create_graphql_api(&self) -> CreateGraphqlApi

Constructs a fluent builder for the CreateGraphqlApi operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    A user-supplied name for the GraphqlApi.

  • log_config(LogConfig) / set_log_config(Option<LogConfig>):

    The Amazon CloudWatch Logs configuration.

  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):

    The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

  • user_pool_config(UserPoolConfig) / set_user_pool_config(Option<UserPoolConfig>):

    The Amazon Cognito user pool configuration.

  • open_id_connect_config(OpenIdConnectConfig) / set_open_id_connect_config(Option<OpenIdConnectConfig>):

    The OIDC configuration.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A TagMap object.

  • additional_authentication_providers(Vec<AdditionalAuthenticationProvider>) / set_additional_authentication_providers(Option<Vec<AdditionalAuthenticationProvider>>):

    A list of additional authentication providers for the GraphqlApi API.

  • xray_enabled(bool) / set_xray_enabled(bool):

    A flag indicating whether to use X-Ray tracing for the GraphqlApi.

  • lambda_authorizer_config(LambdaAuthorizerConfig) / set_lambda_authorizer_config(Option<LambdaAuthorizerConfig>):

    Configuration for Lambda function authorization.

• On success, responds with CreateGraphqlApiOutput with field(s):
  • graphql_api(Option<GraphqlApi>):

    The GraphqlApi.

• On failure, responds with SdkError<CreateGraphqlApiError>

pub fn create_resolver(&self) -> CreateResolver

Constructs a fluent builder for the CreateResolver operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The ID for the GraphQL API for which the resolver is being created.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The name of the Type.

  • field_name(impl Into<String>) / set_field_name(Option<String>):

    The name of the field to attach the resolver to.

  • data_source_name(impl Into<String>) / set_data_source_name(Option<String>):

    The name of the data source for which the resolver is being created.

  • request_mapping_template(impl Into<String>) / set_request_mapping_template(Option<String>):

    The mapping template to use for requests.

    A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

    VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

  • response_mapping_template(impl Into<String>) / set_response_mapping_template(Option<String>):

    The mapping template to use for responses from the data source.

  • kind(ResolverKind) / set_kind(Option<ResolverKind>):

    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

  • pipeline_config(PipelineConfig) / set_pipeline_config(Option<PipelineConfig>):

    The PipelineConfig.

  • sync_config(SyncConfig) / set_sync_config(Option<SyncConfig>):

    The SyncConfig for a resolver attached to a versioned data source.

  • caching_config(CachingConfig) / set_caching_config(Option<CachingConfig>):

    The caching configuration for the resolver.

  • max_batch_size(i32) / set_max_batch_size(i32):

    The maximum batching size for a resolver.

  • runtime(AppSyncRuntime) / set_runtime(Option<AppSyncRuntime>):

    Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

  • code(impl Into<String>) / set_code(Option<String>):

    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

• On success, responds with CreateResolverOutput with field(s):
  • resolver(Option<Resolver>):

    The Resolver object.

• On failure, responds with SdkError<CreateResolverError>

pub fn create_type(&self) -> CreateType

Constructs a fluent builder for the CreateType operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • definition(impl Into<String>) / set_definition(Option<String>):

    The type definition, in GraphQL Schema Definition Language (SDL) format.

    For more information, see the GraphQL SDL documentation.

  • format(TypeDefinitionFormat) / set_format(Option<TypeDefinitionFormat>):

    The type format: SDL or JSON.

• On success, responds with CreateTypeOutput with field(s):
  • r#type(Option<Type>):

    The Type object.

• On failure, responds with SdkError<CreateTypeError>

pub fn delete_api_cache(&self) -> DeleteApiCache

Constructs a fluent builder for the DeleteApiCache operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

• On success, responds with DeleteApiCacheOutput
• On failure, responds with SdkError<DeleteApiCacheError>

pub fn delete_api_key(&self) -> DeleteApiKey

Constructs a fluent builder for the DeleteApiKey operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID for the API key.

• On success, responds with DeleteApiKeyOutput
• On failure, responds with SdkError<DeleteApiKeyError>

pub fn delete_data_source(&self) -> DeleteDataSource

Constructs a fluent builder for the DeleteDataSource operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the data source.

• On success, responds with DeleteDataSourceOutput
• On failure, responds with SdkError<DeleteDataSourceError>

pub fn delete_domain_name(&self) -> DeleteDomainName

Constructs a fluent builder for the DeleteDomainName operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name.

• On success, responds with DeleteDomainNameOutput
• On failure, responds with SdkError<DeleteDomainNameError>

pub fn delete_function(&self) -> DeleteFunction

Constructs a fluent builder for the DeleteFunction operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The GraphQL API ID.

  • function_id(impl Into<String>) / set_function_id(Option<String>):

    The Function ID.

• On success, responds with DeleteFunctionOutput
• On failure, responds with SdkError<DeleteFunctionError>

pub fn delete_graphql_api(&self) -> DeleteGraphqlApi

Constructs a fluent builder for the DeleteGraphqlApi operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

• On success, responds with DeleteGraphqlApiOutput
• On failure, responds with SdkError<DeleteGraphqlApiError>

pub fn delete_resolver(&self) -> DeleteResolver

Constructs a fluent builder for the DeleteResolver operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The name of the resolver type.

  • field_name(impl Into<String>) / set_field_name(Option<String>):

    The resolver field name.

• On success, responds with DeleteResolverOutput
• On failure, responds with SdkError<DeleteResolverError>

pub fn delete_type(&self) -> DeleteType

Constructs a fluent builder for the DeleteType operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The type name.

• On success, responds with DeleteTypeOutput
• On failure, responds with SdkError<DeleteTypeError>

pub fn disassociate_api(&self) -> DisassociateApi

Constructs a fluent builder for the DisassociateApi operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name.

• On success, responds with DisassociateApiOutput
• On failure, responds with SdkError<DisassociateApiError>

pub fn evaluate_code(&self) -> EvaluateCode

Constructs a fluent builder for the EvaluateCode operation.

• The fluent builder is configurable:
  • runtime(AppSyncRuntime) / set_runtime(Option<AppSyncRuntime>):

    The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is supported.

  • code(impl Into<String>) / set_code(Option<String>):

    The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_JS.

  • context(impl Into<String>) / set_context(Option<String>):

    The map that holds all of the contextual information for your resolver invocation. A context is required for this action.

  • function(impl Into<String>) / set_function(Option<String>):

    The function within the code to be evaluated. If provided, the valid values are request and response.

• On success, responds with EvaluateCodeOutput with field(s):
  • evaluation_result(Option<String>):

    The result of the evaluation operation.

  • error(Option<EvaluateCodeErrorDetail>):

    Contains the payload of the response error.

  • logs(Option<Vec<String>>):

    A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

• On failure, responds with SdkError<EvaluateCodeError>

pub fn evaluate_mapping_template(&self) -> EvaluateMappingTemplate

Constructs a fluent builder for the EvaluateMappingTemplate operation.

• The fluent builder is configurable:
  • template(impl Into<String>) / set_template(Option<String>):

    The mapping template; this can be a request or response template. A template is required for this action.

  • context(impl Into<String>) / set_context(Option<String>):

    The map that holds all of the contextual information for your resolver invocation. A context is required for this action.

• On success, responds with EvaluateMappingTemplateOutput with field(s):
  • evaluation_result(Option<String>):

    The mapping template; this can be a request or response template.

  • error(Option<ErrorDetail>):

    The ErrorDetail object.

  • logs(Option<Vec<String>>):

    A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

• On failure, responds with SdkError<EvaluateMappingTemplateError>

pub fn flush_api_cache(&self) -> FlushApiCache

Constructs a fluent builder for the FlushApiCache operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

• On success, responds with FlushApiCacheOutput
• On failure, responds with SdkError<FlushApiCacheError>

pub fn get_api_association(&self) -> GetApiAssociation

Constructs a fluent builder for the GetApiAssociation operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name.

• On success, responds with GetApiAssociationOutput with field(s):
  • api_association(Option<ApiAssociation>):

    The ApiAssociation object.

• On failure, responds with SdkError<GetApiAssociationError>

pub fn get_api_cache(&self) -> GetApiCache

Constructs a fluent builder for the GetApiCache operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

• On success, responds with GetApiCacheOutput with field(s):
  • api_cache(Option<ApiCache>):

    The ApiCache object.

• On failure, responds with SdkError<GetApiCacheError>

pub fn get_data_source(&self) -> GetDataSource

Constructs a fluent builder for the GetDataSource operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the data source.

• On success, responds with GetDataSourceOutput with field(s):
  • data_source(Option<DataSource>):

    The DataSource object.

• On failure, responds with SdkError<GetDataSourceError>

pub fn get_domain_name(&self) -> GetDomainName

Constructs a fluent builder for the GetDomainName operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name.

• On success, responds with GetDomainNameOutput with field(s):
  • domain_name_config(Option<DomainNameConfig>):

    The configuration for the DomainName.

• On failure, responds with SdkError<GetDomainNameError>

pub fn get_function(&self) -> GetFunction

Constructs a fluent builder for the GetFunction operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The GraphQL API ID.

  • function_id(impl Into<String>) / set_function_id(Option<String>):

    The Function ID.

• On success, responds with GetFunctionOutput with field(s):
  • function_configuration(Option<FunctionConfiguration>):

    The Function object.

• On failure, responds with SdkError<GetFunctionError>

pub fn get_graphql_api(&self) -> GetGraphqlApi

Constructs a fluent builder for the GetGraphqlApi operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID for the GraphQL API.

• On success, responds with GetGraphqlApiOutput with field(s):
  • graphql_api(Option<GraphqlApi>):

    The GraphqlApi object.

• On failure, responds with SdkError<GetGraphqlApiError>

pub fn get_introspection_schema(&self) -> GetIntrospectionSchema

Constructs a fluent builder for the GetIntrospectionSchema operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • format(OutputType) / set_format(Option<OutputType>):

    The schema format: SDL or JSON.

  • include_directives(bool) / set_include_directives(Option<bool>):

    A flag that specifies whether the schema introspection should contain directives.

• On success, responds with GetIntrospectionSchemaOutput with field(s):
  • schema(Option<Blob>):

    The schema, in GraphQL Schema Definition Language (SDL) format.

    For more information, see the GraphQL SDL documentation.

• On failure, responds with SdkError<GetIntrospectionSchemaError>

pub fn get_resolver(&self) -> GetResolver

Constructs a fluent builder for the GetResolver operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The resolver type name.

  • field_name(impl Into<String>) / set_field_name(Option<String>):

    The resolver field name.

• On success, responds with GetResolverOutput with field(s):
  • resolver(Option<Resolver>):

    The Resolver object.

• On failure, responds with SdkError<GetResolverError>

pub fn get_schema_creation_status(&self) -> GetSchemaCreationStatus

Constructs a fluent builder for the GetSchemaCreationStatus operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

• On success, responds with GetSchemaCreationStatusOutput with field(s):
  • status(Option<SchemaStatus>):

    The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

  • details(Option<String>):

    Detailed information about the status of the schema creation operation.

• On failure, responds with SdkError<GetSchemaCreationStatusError>

pub fn get_type(&self) -> GetType

Constructs a fluent builder for the GetType operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The type name.

  • format(TypeDefinitionFormat) / set_format(Option<TypeDefinitionFormat>):

    The type format: SDL or JSON.

• On success, responds with GetTypeOutput with field(s):
  • r#type(Option<Type>):

    The Type object.

• On failure, responds with SdkError<GetTypeError>

pub fn list_api_keys(&self) -> ListApiKeys

Constructs a fluent builder for the ListApiKeys operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListApiKeysOutput with field(s):
  • api_keys(Option<Vec<ApiKey>>):

    The ApiKey objects.

  • next_token(Option<String>):

    An identifier to pass in the next request to this operation to return the next set of items in the list.

• On failure, responds with SdkError<ListApiKeysError>

pub fn list_data_sources(&self) -> ListDataSources

Constructs a fluent builder for the ListDataSources operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListDataSourcesOutput with field(s):
  • data_sources(Option<Vec<DataSource>>):

    The DataSource objects.

  • next_token(Option<String>):

    An identifier to pass in the next request to this operation to return the next set of items in the list.

• On failure, responds with SdkError<ListDataSourcesError>

pub fn list_domain_names(&self) -> ListDomainNames

Constructs a fluent builder for the ListDomainNames operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The API token.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListDomainNamesOutput with field(s):
  • domain_name_configs(Option<Vec<DomainNameConfig>>):

    Lists configurations for multiple domain names.

  • next_token(Option<String>):

    The API token.

• On failure, responds with SdkError<ListDomainNamesError>

pub fn list_functions(&self) -> ListFunctions

Constructs a fluent builder for the ListFunctions operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The GraphQL API ID.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListFunctionsOutput with field(s):
  • functions(Option<Vec<FunctionConfiguration>>):

    A list of Function objects.

  • next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

• On failure, responds with SdkError<ListFunctionsError>

pub fn list_graphql_apis(&self) -> ListGraphqlApis

Constructs a fluent builder for the ListGraphqlApis operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListGraphqlApisOutput with field(s):
  • graphql_apis(Option<Vec<GraphqlApi>>):

    The GraphqlApi objects.

  • next_token(Option<String>):

    An identifier to pass in the next request to this operation to return the next set of items in the list.

• On failure, responds with SdkError<ListGraphqlApisError>

pub fn list_resolvers(&self) -> ListResolvers

Constructs a fluent builder for the ListResolvers operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The type name.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListResolversOutput with field(s):
  • resolvers(Option<Vec<Resolver>>):

    The Resolver objects.

  • next_token(Option<String>):

    An identifier to pass in the next request to this operation to return the next set of items in the list.

• On failure, responds with SdkError<ListResolversError>

pub fn list_resolvers_by_function(&self) -> ListResolversByFunction

Constructs a fluent builder for the ListResolversByFunction operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • function_id(impl Into<String>) / set_function_id(Option<String>):

    The function ID.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListResolversByFunctionOutput with field(s):
  • resolvers(Option<Vec<Resolver>>):

    The list of resolvers.

  • next_token(Option<String>):

    An identifier that you can use to return the next set of items in the list.

• On failure, responds with SdkError<ListResolversByFunctionError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The GraphqlApi Amazon Resource Name (ARN).

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    A TagMap object.

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn list_types(&self) -> ListTypes

Constructs a fluent builder for the ListTypes operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • format(TypeDefinitionFormat) / set_format(Option<TypeDefinitionFormat>):

    The type format: SDL or JSON.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results that you want the request to return.

• On success, responds with ListTypesOutput with field(s):
  • types(Option<Vec<Type>>):

    The Type objects.

  • next_token(Option<String>):

    An identifier to pass in the next request to this operation to return the next set of items in the list.

• On failure, responds with SdkError<ListTypesError>

pub fn start_schema_creation(&self) -> StartSchemaCreation

Constructs a fluent builder for the StartSchemaCreation operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • definition(Blob) / set_definition(Option<Blob>):

    The schema definition, in GraphQL schema language format.

• On success, responds with StartSchemaCreationOutput with field(s):
  • status(Option<SchemaStatus>):

    The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

• On failure, responds with SdkError<StartSchemaCreationError>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The GraphqlApi Amazon Resource Name (ARN).

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A TagMap object.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The GraphqlApi Amazon Resource Name (ARN).

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    A list of TagKey objects.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

pub fn update_api_cache(&self) -> UpdateApiCache

Constructs a fluent builder for the UpdateApiCache operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The GraphQL API ID.

  • ttl(i64) / set_ttl(i64):

    TTL in seconds for cache entries.

    Valid values are 1–3,600 seconds.

  • api_caching_behavior(ApiCachingBehavior) / set_api_caching_behavior(Option<ApiCachingBehavior>):

    Caching behavior.

    • FULL_REQUEST_CACHING: All requests are fully cached.

    • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

  • r#type(ApiCacheType) / set_type(Option<ApiCacheType>):

    The cache instance type. Valid values are

    • SMALL

    • MEDIUM

    • LARGE

    • XLARGE

    • LARGE_2X

    • LARGE_4X

    • LARGE_8X (not available in all regions)

    • LARGE_12X

    Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

    The following legacy instance types are available, but their use is discouraged:

    • T2_SMALL: A t2.small instance type.

    • T2_MEDIUM: A t2.medium instance type.

    • R4_LARGE: A r4.large instance type.

    • R4_XLARGE: A r4.xlarge instance type.

    • R4_2XLARGE: A r4.2xlarge instance type.

    • R4_4XLARGE: A r4.4xlarge instance type.

    • R4_8XLARGE: A r4.8xlarge instance type.

• On success, responds with UpdateApiCacheOutput with field(s):
  • api_cache(Option<ApiCache>):

    The ApiCache object.

• On failure, responds with SdkError<UpdateApiCacheError>

pub fn update_api_key(&self) -> UpdateApiKey

Constructs a fluent builder for the UpdateApiKey operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The ID for the GraphQL API.

  • id(impl Into<String>) / set_id(Option<String>):

    The API key ID.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the purpose of the API key.

  • expires(i64) / set_expires(i64):

    From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

• On success, responds with UpdateApiKeyOutput with field(s):
  • api_key(Option<ApiKey>):

    The API key.

• On failure, responds with SdkError<UpdateApiKeyError>

pub fn update_data_source(&self) -> UpdateDataSource

Constructs a fluent builder for the UpdateDataSource operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • name(impl Into<String>) / set_name(Option<String>):

    The new name for the data source.

  • description(impl Into<String>) / set_description(Option<String>):

    The new description for the data source.

  • r#type(DataSourceType) / set_type(Option<DataSourceType>):

    The new data source type.

  • service_role_arn(impl Into<String>) / set_service_role_arn(Option<String>):

    The new service role Amazon Resource Name (ARN) for the data source.

  • dynamodb_config(DynamodbDataSourceConfig) / set_dynamodb_config(Option<DynamodbDataSourceConfig>):

    The new Amazon DynamoDB configuration.

  • lambda_config(LambdaDataSourceConfig) / set_lambda_config(Option<LambdaDataSourceConfig>):

    The new Lambda configuration.

  • elasticsearch_config(ElasticsearchDataSourceConfig) / set_elasticsearch_config(Option<ElasticsearchDataSourceConfig>):

    The new OpenSearch configuration.

    As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.

  • open_search_service_config(OpenSearchServiceDataSourceConfig) / set_open_search_service_config(Option<OpenSearchServiceDataSourceConfig>):

    The new OpenSearch configuration.

  • http_config(HttpDataSourceConfig) / set_http_config(Option<HttpDataSourceConfig>):

    The new HTTP endpoint configuration.

  • relational_database_config(RelationalDatabaseDataSourceConfig) / set_relational_database_config(Option<RelationalDatabaseDataSourceConfig>):

    The new relational database configuration.

• On success, responds with UpdateDataSourceOutput with field(s):
  • data_source(Option<DataSource>):

    The updated DataSource object.

• On failure, responds with SdkError<UpdateDataSourceError>

pub fn update_domain_name(&self) -> UpdateDomainName

Constructs a fluent builder for the UpdateDomainName operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the DomainName.

• On success, responds with UpdateDomainNameOutput with field(s):
  • domain_name_config(Option<DomainNameConfig>):

    The configuration for the DomainName.

• On failure, responds with SdkError<UpdateDomainNameError>

pub fn update_function(&self) -> UpdateFunction

Constructs a fluent builder for the UpdateFunction operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The GraphQL API ID.

  • name(impl Into<String>) / set_name(Option<String>):

    The Function name.

  • description(impl Into<String>) / set_description(Option<String>):

    The Function description.

  • function_id(impl Into<String>) / set_function_id(Option<String>):

    The function ID.

  • data_source_name(impl Into<String>) / set_data_source_name(Option<String>):

    The Function DataSource name.

  • request_mapping_template(impl Into<String>) / set_request_mapping_template(Option<String>):

    The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

  • response_mapping_template(impl Into<String>) / set_response_mapping_template(Option<String>):

    The Function request mapping template.

  • function_version(impl Into<String>) / set_function_version(Option<String>):

    The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.

  • sync_config(SyncConfig) / set_sync_config(Option<SyncConfig>):

    Describes a Sync configuration for a resolver.

    Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

  • max_batch_size(i32) / set_max_batch_size(i32):

    The maximum batching size for a resolver.

  • runtime(AppSyncRuntime) / set_runtime(Option<AppSyncRuntime>):

    Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

  • code(impl Into<String>) / set_code(Option<String>):

    The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

• On success, responds with UpdateFunctionOutput with field(s):
  • function_configuration(Option<FunctionConfiguration>):

    The Function object.

• On failure, responds with SdkError<UpdateFunctionError>

pub fn update_graphql_api(&self) -> UpdateGraphqlApi

Constructs a fluent builder for the UpdateGraphqlApi operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • name(impl Into<String>) / set_name(Option<String>):

    The new name for the GraphqlApi object.

  • log_config(LogConfig) / set_log_config(Option<LogConfig>):

    The Amazon CloudWatch Logs configuration for the GraphqlApi object.

  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):

    The new authentication type for the GraphqlApi object.

  • user_pool_config(UserPoolConfig) / set_user_pool_config(Option<UserPoolConfig>):

    The new Amazon Cognito user pool configuration for the ~GraphqlApi object.

  • open_id_connect_config(OpenIdConnectConfig) / set_open_id_connect_config(Option<OpenIdConnectConfig>):

    The OpenID Connect configuration for the GraphqlApi object.

  • additional_authentication_providers(Vec<AdditionalAuthenticationProvider>) / set_additional_authentication_providers(Option<Vec<AdditionalAuthenticationProvider>>):

    A list of additional authentication providers for the GraphqlApi API.

  • xray_enabled(bool) / set_xray_enabled(bool):

    A flag indicating whether to use X-Ray tracing for the GraphqlApi.

  • lambda_authorizer_config(LambdaAuthorizerConfig) / set_lambda_authorizer_config(Option<LambdaAuthorizerConfig>):

    Configuration for Lambda function authorization.

• On success, responds with UpdateGraphqlApiOutput with field(s):
  • graphql_api(Option<GraphqlApi>):

    The updated GraphqlApi object.

• On failure, responds with SdkError<UpdateGraphqlApiError>

pub fn update_resolver(&self) -> UpdateResolver

Constructs a fluent builder for the UpdateResolver operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The new type name.

  • field_name(impl Into<String>) / set_field_name(Option<String>):

    The new field name.

  • data_source_name(impl Into<String>) / set_data_source_name(Option<String>):

    The new data source name.

  • request_mapping_template(impl Into<String>) / set_request_mapping_template(Option<String>):

    The new request mapping template.

    A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

    VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

  • response_mapping_template(impl Into<String>) / set_response_mapping_template(Option<String>):

    The new response mapping template.

  • kind(ResolverKind) / set_kind(Option<ResolverKind>):

    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

  • pipeline_config(PipelineConfig) / set_pipeline_config(Option<PipelineConfig>):

    The PipelineConfig.

  • sync_config(SyncConfig) / set_sync_config(Option<SyncConfig>):

    The SyncConfig for a resolver attached to a versioned data source.

  • caching_config(CachingConfig) / set_caching_config(Option<CachingConfig>):

    The caching configuration for the resolver.

  • max_batch_size(i32) / set_max_batch_size(i32):

    The maximum batching size for a resolver.

  • runtime(AppSyncRuntime) / set_runtime(Option<AppSyncRuntime>):

    Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

  • code(impl Into<String>) / set_code(Option<String>):

    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

• On success, responds with UpdateResolverOutput with field(s):
  • resolver(Option<Resolver>):

    The updated Resolver object.

• On failure, responds with SdkError<UpdateResolverError>

pub fn update_type(&self) -> UpdateType

Constructs a fluent builder for the UpdateType operation.

• The fluent builder is configurable:
  • api_id(impl Into<String>) / set_api_id(Option<String>):

    The API ID.

  • type_name(impl Into<String>) / set_type_name(Option<String>):

    The new type name.

  • definition(impl Into<String>) / set_definition(Option<String>):

    The new definition.

  • format(TypeDefinitionFormat) / set_format(Option<TypeDefinitionFormat>):

    The new type format: SDL or JSON.

• On success, responds with UpdateTypeOutput with field(s):
  • r#type(Option<Type>):

    The updated Type object.

• On failure, responds with SdkError<UpdateTypeError>

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.