Struct 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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_appsync::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_appsync::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateApi operation has a Client::associate_api, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_api()
    .domain_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_api(&self) -> AssociateApiFluentBuilder

Constructs a fluent builder for the AssociateApi operation.

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

    The domain name.

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

    The API ID. Private APIs can not be associated with custom domains.

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

    The ApiAssociation object.

• On failure, responds with SdkError<AssociateApiError>

impl Client

pub fn associate_merged_graphql_api( &self, ) -> AssociateMergedGraphqlApiFluentBuilder

Constructs a fluent builder for the AssociateMergedGraphqlApi operation.

• The fluent builder is configurable:
  • source_api_identifier(impl Into<String>) / set_source_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

    
    
  • merged_api_identifier(impl Into<String>) / set_merged_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

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

    The description field.

    
    
  • source_api_association_config(SourceApiAssociationConfig) / set_source_api_association_config(Option<SourceApiAssociationConfig>):
    required: false
    

    The SourceApiAssociationConfig object data.

    
    
• On success, responds with AssociateMergedGraphqlApiOutput with field(s):
  • source_api_association(Option<SourceApiAssociation>):

    The SourceApiAssociation object data.

• On failure, responds with SdkError<AssociateMergedGraphqlApiError>

impl Client

pub fn associate_source_graphql_api( &self, ) -> AssociateSourceGraphqlApiFluentBuilder

Constructs a fluent builder for the AssociateSourceGraphqlApi operation.

• The fluent builder is configurable:
  • merged_api_identifier(impl Into<String>) / set_merged_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    
    
  • source_api_identifier(impl Into<String>) / set_source_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

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

    The description field.

    
    
  • source_api_association_config(SourceApiAssociationConfig) / set_source_api_association_config(Option<SourceApiAssociationConfig>):
    required: false
    

    The SourceApiAssociationConfig object data.

    
    
• On success, responds with AssociateSourceGraphqlApiOutput with field(s):
  • source_api_association(Option<SourceApiAssociation>):

    The SourceApiAssociation object data.

• On failure, responds with SdkError<AssociateSourceGraphqlApiError>

impl Client

pub fn create_api(&self) -> CreateApiFluentBuilder

Constructs a fluent builder for the CreateApi operation.

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

    The name for the Api.

    
    
  • owner_contact(impl Into<String>) / set_owner_contact(Option<String>):
    required: false
    

    The owner contact information for the Api.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map with keys of TagKey objects and values of TagValue objects.

    
    
  • event_config(EventConfig) / set_event_config(Option<EventConfig>):
    required: false
    

    The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

    
    
• On success, responds with CreateApiOutput with field(s):
  • api(Option<Api>):

    The Api object.

• On failure, responds with SdkError<CreateApiError>

impl Client

pub fn create_api_cache(&self) -> CreateApiCacheFluentBuilder

Constructs a fluent builder for the CreateApiCache operation.

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

    The GraphQL API ID.

    
    
  • ttl(i64) / set_ttl(Option<i64>):
    required: true
    

    TTL in seconds for cache entries.

    Valid values are 1–3,600 seconds.

    
    
  • transit_encryption_enabled(bool) / set_transit_encryption_enabled(Option<bool>):
    required: false
    

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

    
    
  • at_rest_encryption_enabled(bool) / set_at_rest_encryption_enabled(Option<bool>):
    required: false
    

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

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

    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>):
    required: true
    

    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.

    
    
  • health_metrics_config(CacheHealthMetricsConfig) / set_health_metrics_config(Option<CacheHealthMetricsConfig>):
    required: false
    

    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

    • NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.

    • EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

    Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.

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

    The ApiCache object.

• On failure, responds with SdkError<CreateApiCacheError>

impl Client

pub fn create_api_key(&self) -> CreateApiKeyFluentBuilder

Constructs a fluent builder for the CreateApiKey operation.

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

    The ID for your GraphQL API.

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

    A description of the purpose of the API key.

    
    
  • expires(i64) / set_expires(Option<i64>):
    required: false
    

    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>

impl Client

pub fn create_channel_namespace(&self) -> CreateChannelNamespaceFluentBuilder

Constructs a fluent builder for the CreateChannelNamespace operation.

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

    The Api ID.

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

    The name of the ChannelNamespace. This name must be unique within the Api

    
    
  • subscribe_auth_modes(AuthMode) / set_subscribe_auth_modes(Option<Vec::<AuthMode>>):
    required: false
    

    The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.

    
    
  • publish_auth_modes(AuthMode) / set_publish_auth_modes(Option<Vec::<AuthMode>>):
    required: false
    

    The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.

    
    
  • code_handlers(impl Into<String>) / set_code_handlers(Option<String>):
    required: false
    

    The event handler functions that run custom business logic to process published events and subscribe requests.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map with keys of TagKey objects and values of TagValue objects.

    
    
• On success, responds with CreateChannelNamespaceOutput with field(s):
  • channel_namespace(Option<ChannelNamespace>):

    The ChannelNamespace object.

• On failure, responds with SdkError<CreateChannelNamespaceError>

impl Client

pub fn create_data_source(&self) -> CreateDataSourceFluentBuilder

Constructs a fluent builder for the CreateDataSource operation.

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

    The API ID for the GraphQL API for the DataSource.

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

    A user-supplied name for the DataSource.

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

    A description of the DataSource.

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

    The type of the DataSource.

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

    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>):
    required: false
    

    Amazon DynamoDB settings.

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

    Lambda settings.

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

    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>):
    required: false
    

    Amazon OpenSearch Service settings.

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

    HTTP endpoint settings.

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

    Relational database settings.

    
    
  • event_bridge_config(EventBridgeDataSourceConfig) / set_event_bridge_config(Option<EventBridgeDataSourceConfig>):
    required: false
    

    Amazon EventBridge settings.

    
    
  • metrics_config(DataSourceLevelMetricsConfig) / set_metrics_config(Option<DataSourceLevelMetricsConfig>):
    required: false
    

    Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won’t be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

    metricsConfig can be ENABLED or DISABLED.

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

    The DataSource object.

• On failure, responds with SdkError<CreateDataSourceError>

impl Client

pub fn create_domain_name(&self) -> CreateDomainNameFluentBuilder

Constructs a fluent builder for the CreateDomainName operation.

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

    The domain name.

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

    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>):
    required: false
    

    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>

impl Client

pub fn create_function(&self) -> CreateFunctionFluentBuilder

Constructs a fluent builder for the CreateFunction operation.

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

    The GraphQL API ID.

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

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

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

    The Function description.

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

    The Function DataSource name.

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

    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>):
    required: false
    

    The Function response mapping template.

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

    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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    The maximum batching size for a resolver.

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

    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>):
    required: false
    

    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>

impl Client

pub fn create_graphql_api(&self) -> CreateGraphqlApiFluentBuilder

Constructs a fluent builder for the CreateGraphqlApi operation.

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

    A user-supplied name for the GraphqlApi.

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

    The Amazon CloudWatch Logs configuration.

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

    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>):
    required: false
    

    The Amazon Cognito user pool configuration.

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

    The OIDC configuration.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A TagMap object.

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

    A list of additional authentication providers for the GraphqlApi API.

    
    
  • xray_enabled(bool) / set_xray_enabled(Option<bool>):
    required: false
    

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

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

    Configuration for Lambda function authorization.

    
    
  • api_type(GraphQlApiType) / set_api_type(Option<GraphQlApiType>):
    required: false
    

    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

    
    
  • merged_api_execution_role_arn(impl Into<String>) / set_merged_api_execution_role_arn(Option<String>):
    required: false
    

    The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

    
    
  • visibility(GraphQlApiVisibility) / set_visibility(Option<GraphQlApiVisibility>):
    required: false
    

    Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

    
    
  • owner_contact(impl Into<String>) / set_owner_contact(Option<String>):
    required: false
    

    The owner contact information for an API resource.

    This field accepts any string input with a length of 0 - 256 characters.

    
    
  • introspection_config(GraphQlApiIntrospectionConfig) / set_introspection_config(Option<GraphQlApiIntrospectionConfig>):
    required: false
    

    Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

    For more information about introspection, see GraphQL introspection.

    
    
  • query_depth_limit(i32) / set_query_depth_limit(Option<i32>):
    required: false
    

    The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there’s no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

    
    
  • resolver_count_limit(i32) / set_resolver_count_limit(Option<i32>):
    required: false
    

    The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

    
    
  • enhanced_metrics_config(EnhancedMetricsConfig) / set_enhanced_metrics_config(Option<EnhancedMetricsConfig>):
    required: false
    

    The enhancedMetricsConfig object.

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

    The GraphqlApi.

• On failure, responds with SdkError<CreateGraphqlApiError>

impl Client

pub fn create_resolver(&self) -> CreateResolverFluentBuilder

Constructs a fluent builder for the CreateResolver operation.

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

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

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

    The name of the Type.

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

    The name of the field to attach the resolver to.

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

    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>):
    required: false
    

    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>):
    required: false
    

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

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

    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>):
    required: false
    

    The PipelineConfig.

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

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

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

    The caching configuration for the resolver.

    
    
  • max_batch_size(i32) / set_max_batch_size(Option<i32>):
    required: false
    

    The maximum batching size for a resolver.

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

    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>):
    required: false
    

    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.

    
    
  • metrics_config(ResolverLevelMetricsConfig) / set_metrics_config(Option<ResolverLevelMetricsConfig>):
    required: false
    

    Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won’t be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

    metricsConfig can be ENABLED or DISABLED.

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

    The Resolver object.

• On failure, responds with SdkError<CreateResolverError>

impl Client

pub fn create_type(&self) -> CreateTypeFluentBuilder

Constructs a fluent builder for the CreateType operation.

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

    The API ID.

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

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

    For more information, see the GraphQL SDL documentation.

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

    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>

impl Client

pub fn delete_api(&self) -> DeleteApiFluentBuilder

Constructs a fluent builder for the DeleteApi operation.

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

    The Api ID.

    
    
• On success, responds with DeleteApiOutput
• On failure, responds with SdkError<DeleteApiError>

impl Client

pub fn delete_api_cache(&self) -> DeleteApiCacheFluentBuilder

Constructs a fluent builder for the DeleteApiCache operation.

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

    The API ID.

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

impl Client

pub fn delete_api_key(&self) -> DeleteApiKeyFluentBuilder

Constructs a fluent builder for the DeleteApiKey operation.

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

    The API ID.

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

    The ID for the API key.

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

impl Client

pub fn delete_channel_namespace(&self) -> DeleteChannelNamespaceFluentBuilder

Constructs a fluent builder for the DeleteChannelNamespace operation.

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

    The ID of the Api associated with the ChannelNamespace.

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

    The name of the ChannelNamespace.

    
    
• On success, responds with DeleteChannelNamespaceOutput
• On failure, responds with SdkError<DeleteChannelNamespaceError>

impl Client

pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder

Constructs a fluent builder for the DeleteDataSource operation.

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

    The API ID.

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

    The name of the data source.

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

impl Client

pub fn delete_domain_name(&self) -> DeleteDomainNameFluentBuilder

Constructs a fluent builder for the DeleteDomainName operation.

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

    The domain name.

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

impl Client

pub fn delete_function(&self) -> DeleteFunctionFluentBuilder

Constructs a fluent builder for the DeleteFunction operation.

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

    The GraphQL API ID.

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

    The Function ID.

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

impl Client

pub fn delete_graphql_api(&self) -> DeleteGraphqlApiFluentBuilder

Constructs a fluent builder for the DeleteGraphqlApi operation.

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

    The API ID.

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

impl Client

pub fn delete_resolver(&self) -> DeleteResolverFluentBuilder

Constructs a fluent builder for the DeleteResolver operation.

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

    The API ID.

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

    The name of the resolver type.

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

    The resolver field name.

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

impl Client

pub fn delete_type(&self) -> DeleteTypeFluentBuilder

Constructs a fluent builder for the DeleteType operation.

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

    The API ID.

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

    The type name.

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

impl Client

pub fn disassociate_api(&self) -> DisassociateApiFluentBuilder

Constructs a fluent builder for the DisassociateApi operation.

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

    The domain name.

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

impl Client

pub fn disassociate_merged_graphql_api( &self, ) -> DisassociateMergedGraphqlApiFluentBuilder

Constructs a fluent builder for the DisassociateMergedGraphqlApi operation.

• The fluent builder is configurable:
  • source_api_identifier(impl Into<String>) / set_source_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID generated by the AppSync service for the source API association.

    
    
• On success, responds with DisassociateMergedGraphqlApiOutput with field(s):
  • source_api_association_status(Option<SourceApiAssociationStatus>):

    The state of the source API association.

• On failure, responds with SdkError<DisassociateMergedGraphqlApiError>

impl Client

pub fn disassociate_source_graphql_api( &self, ) -> DisassociateSourceGraphqlApiFluentBuilder

Constructs a fluent builder for the DisassociateSourceGraphqlApi operation.

• The fluent builder is configurable:
  • merged_api_identifier(impl Into<String>) / set_merged_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID generated by the AppSync service for the source API association.

    
    
• On success, responds with DisassociateSourceGraphqlApiOutput with field(s):
  • source_api_association_status(Option<SourceApiAssociationStatus>):

    The state of the source API association.

• On failure, responds with SdkError<DisassociateSourceGraphqlApiError>

impl Client

pub fn evaluate_code(&self) -> EvaluateCodeFluentBuilder

Constructs a fluent builder for the EvaluateCode operation.

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

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: false
    

    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>

impl Client

pub fn evaluate_mapping_template(&self) -> EvaluateMappingTemplateFluentBuilder

Constructs a fluent builder for the EvaluateMappingTemplate operation.

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

    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>):
    required: true
    

    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>

impl Client

pub fn flush_api_cache(&self) -> FlushApiCacheFluentBuilder

Constructs a fluent builder for the FlushApiCache operation.

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

    The API ID.

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

impl Client

pub fn get_api(&self) -> GetApiFluentBuilder

Constructs a fluent builder for the GetApi operation.

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

    The Api ID.

    
    
• On success, responds with GetApiOutput with field(s):
  • api(Option<Api>):

    The Api object.

• On failure, responds with SdkError<GetApiError>

impl Client

pub fn get_api_association(&self) -> GetApiAssociationFluentBuilder

Constructs a fluent builder for the GetApiAssociation operation.

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

    The domain name.

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

    The ApiAssociation object.

• On failure, responds with SdkError<GetApiAssociationError>

impl Client

pub fn get_api_cache(&self) -> GetApiCacheFluentBuilder

Constructs a fluent builder for the GetApiCache operation.

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

    The API ID.

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

    The ApiCache object.

• On failure, responds with SdkError<GetApiCacheError>

impl Client

pub fn get_channel_namespace(&self) -> GetChannelNamespaceFluentBuilder

Constructs a fluent builder for the GetChannelNamespace operation.

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

    The Api ID.

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

    The name of the ChannelNamespace.

    
    
• On success, responds with GetChannelNamespaceOutput with field(s):
  • channel_namespace(Option<ChannelNamespace>):

    The ChannelNamespace object.

• On failure, responds with SdkError<GetChannelNamespaceError>

impl Client

pub fn get_data_source(&self) -> GetDataSourceFluentBuilder

Constructs a fluent builder for the GetDataSource operation.

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

    The API ID.

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

    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>

impl Client

pub fn get_data_source_introspection( &self, ) -> GetDataSourceIntrospectionFluentBuilder

Constructs a fluent builder for the GetDataSourceIntrospection operation.

• The fluent builder is configurable:
  • introspection_id(impl Into<String>) / set_introspection_id(Option<String>):
    required: true
    

    The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

    
    
  • include_models_sdl(bool) / set_include_models_sdl(Option<bool>):
    required: false
    

    A boolean flag that determines whether SDL should be generated for introspected types. If set to true, each model will contain an sdl property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives.

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

    Determines the number of types to be returned in a single response before paginating. This value is typically taken from nextToken value from the previous response.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of introspected types that will be returned in a single response.

    
    
• On success, responds with GetDataSourceIntrospectionOutput with field(s):
  • introspection_id(Option<String>):

    The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

  • introspection_status(Option<DataSourceIntrospectionStatus>):

    The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.

  • introspection_status_detail(Option<String>):

    The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

  • introspection_result(Option<DataSourceIntrospectionResult>):

    The DataSourceIntrospectionResult object data.

• On failure, responds with SdkError<GetDataSourceIntrospectionError>

impl Client

pub fn get_domain_name(&self) -> GetDomainNameFluentBuilder

Constructs a fluent builder for the GetDomainName operation.

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

    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>

impl Client

pub fn get_function(&self) -> GetFunctionFluentBuilder

Constructs a fluent builder for the GetFunction operation.

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

    The GraphQL API ID.

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

    The Function ID.

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

    The Function object.

• On failure, responds with SdkError<GetFunctionError>

impl Client

pub fn get_graphql_api(&self) -> GetGraphqlApiFluentBuilder

Constructs a fluent builder for the GetGraphqlApi operation.

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

    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>

impl Client

pub fn get_graphql_api_environment_variables( &self, ) -> GetGraphqlApiEnvironmentVariablesFluentBuilder

Constructs a fluent builder for the GetGraphqlApiEnvironmentVariables operation.

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

    The ID of the API from which the environmental variable list will be retrieved.

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

    The payload containing each environmental variable in the “key” : “value” format.

• On failure, responds with SdkError<GetGraphqlApiEnvironmentVariablesError>

impl Client

pub fn get_introspection_schema(&self) -> GetIntrospectionSchemaFluentBuilder

Constructs a fluent builder for the GetIntrospectionSchema operation.

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

    The API ID.

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

    The schema format: SDL or JSON.

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

    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>

impl Client

pub fn get_resolver(&self) -> GetResolverFluentBuilder

Constructs a fluent builder for the GetResolver operation.

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

    The API ID.

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

    The resolver type name.

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

    The resolver field name.

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

    The Resolver object.

• On failure, responds with SdkError<GetResolverError>

impl Client

pub fn get_schema_creation_status(&self) -> GetSchemaCreationStatusFluentBuilder

Constructs a fluent builder for the GetSchemaCreationStatus operation.

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

    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>

impl Client

pub fn get_source_api_association(&self) -> GetSourceApiAssociationFluentBuilder

Constructs a fluent builder for the GetSourceApiAssociation operation.

• The fluent builder is configurable:
  • merged_api_identifier(impl Into<String>) / set_merged_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID generated by the AppSync service for the source API association.

    
    
• On success, responds with GetSourceApiAssociationOutput with field(s):
  • source_api_association(Option<SourceApiAssociation>):

    The SourceApiAssociation object data.

• On failure, responds with SdkError<GetSourceApiAssociationError>

impl Client

pub fn get_type(&self) -> GetTypeFluentBuilder

Constructs a fluent builder for the GetType operation.

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

    The API ID.

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

    The type name.

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

    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>

impl Client

pub fn list_api_keys(&self) -> ListApiKeysFluentBuilder

Constructs a fluent builder for the ListApiKeys operation. This operation supports pagination; See into_paginator().

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

    The API ID.

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

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_apis(&self) -> ListApisFluentBuilder

Constructs a fluent builder for the ListApis operation. This operation supports pagination; See into_paginator().

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

    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(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListApisOutput with field(s):
  • apis(Option<Vec::<Api>>):

    The Api 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<ListApisError>

impl Client

pub fn list_channel_namespaces(&self) -> ListChannelNamespacesFluentBuilder

Constructs a fluent builder for the ListChannelNamespaces operation. This operation supports pagination; See into_paginator().

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

    The Api ID.

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

    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(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListChannelNamespacesOutput with field(s):
  • channel_namespaces(Option<Vec::<ChannelNamespace>>):

    The ChannelNamespace 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<ListChannelNamespacesError>

impl Client

pub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder

Constructs a fluent builder for the ListDataSources operation. This operation supports pagination; See into_paginator().

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

    The API ID.

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

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_domain_names(&self) -> ListDomainNamesFluentBuilder

Constructs a fluent builder for the ListDomainNames operation. This operation supports pagination; See into_paginator().

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

    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(Option<i32>):
    required: false
    

    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>):

    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<ListDomainNamesError>

impl Client

pub fn list_functions(&self) -> ListFunctionsFluentBuilder

Constructs a fluent builder for the ListFunctions operation. This operation supports pagination; See into_paginator().

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

    The GraphQL API ID.

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

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_graphql_apis(&self) -> ListGraphqlApisFluentBuilder

Constructs a fluent builder for the ListGraphqlApis operation. This operation supports pagination; See into_paginator().

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

    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(Option<i32>):
    required: false
    

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

    
    
  • api_type(GraphQlApiType) / set_api_type(Option<GraphQlApiType>):
    required: false
    

    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

    
    
  • owner(Ownership) / set_owner(Option<Ownership>):
    required: false
    

    The account owner of the GraphQL API.

    
    
• 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>

impl Client

pub fn list_resolvers(&self) -> ListResolversFluentBuilder

Constructs a fluent builder for the ListResolvers operation. This operation supports pagination; See into_paginator().

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

    The API ID.

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

    The type name.

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

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_resolvers_by_function(&self) -> ListResolversByFunctionFluentBuilder

Constructs a fluent builder for the ListResolversByFunction operation. This operation supports pagination; See into_paginator().

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

    The API ID.

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

    The function ID.

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

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_source_api_associations( &self, ) -> ListSourceApiAssociationsFluentBuilder

Constructs a fluent builder for the ListSourceApiAssociations operation. This operation supports pagination; See into_paginator().

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

    The API ID.

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

    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(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListSourceApiAssociationsOutput with field(s):
  • source_api_association_summaries(Option<Vec::<SourceApiAssociationSummary>>):

    The SourceApiAssociationSummary object data.

  • 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<ListSourceApiAssociationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    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>

impl Client

pub fn list_types(&self) -> ListTypesFluentBuilder

Constructs a fluent builder for the ListTypes operation. This operation supports pagination; See into_paginator().

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

    The API ID.

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

    The type format: SDL or JSON.

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

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_types_by_association(&self) -> ListTypesByAssociationFluentBuilder

Constructs a fluent builder for the ListTypesByAssociation operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • merged_api_identifier(impl Into<String>) / set_merged_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID generated by the AppSync service for the source API association.

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

    The format type.

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

    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(Option<i32>):
    required: false
    

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

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

    The Type 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<ListTypesByAssociationError>

impl Client

pub fn put_graphql_api_environment_variables( &self, ) -> PutGraphqlApiEnvironmentVariablesFluentBuilder

Constructs a fluent builder for the PutGraphqlApiEnvironmentVariables operation.

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

    The ID of the API to which the environmental variable list will be written.

    
    
  • environment_variables(impl Into<String>, impl Into<String>) / set_environment_variables(Option<HashMap::<String, String>>):
    required: true
    

    The list of environmental variables to add to the API.

    When creating an environmental variable key-value pair, it must follow the additional constraints below:

    • Keys must begin with a letter.

    • Keys must be at least two characters long.

    • Keys can only contain letters, numbers, and the underscore character (_).

    • Values can be up to 512 characters long.

    • You can configure up to 50 key-value pairs in a GraphQL API.

    You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {“key1”:“value1”,“key2”:“value2”, …}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.

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

    The payload containing each environmental variable in the “key” : “value” format.

• On failure, responds with SdkError<PutGraphqlApiEnvironmentVariablesError>

impl Client

pub fn start_data_source_introspection( &self, ) -> StartDataSourceIntrospectionFluentBuilder

Constructs a fluent builder for the StartDataSourceIntrospection operation.

• The fluent builder is configurable:
  • rds_data_api_config(RdsDataApiConfig) / set_rds_data_api_config(Option<RdsDataApiConfig>):
    required: false
    

    The rdsDataApiConfig object data.

    
    
• On success, responds with StartDataSourceIntrospectionOutput with field(s):
  • introspection_id(Option<String>):

    The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

  • introspection_status(Option<DataSourceIntrospectionStatus>):

    The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.

  • introspection_status_detail(Option<String>):

    The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

• On failure, responds with SdkError<StartDataSourceIntrospectionError>

impl Client

pub fn start_schema_creation(&self) -> StartSchemaCreationFluentBuilder

Constructs a fluent builder for the StartSchemaCreation operation.

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

    The API ID.

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

    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>

impl Client

pub fn start_schema_merge(&self) -> StartSchemaMergeFluentBuilder

Constructs a fluent builder for the StartSchemaMerge operation.

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID generated by the AppSync service for the source API association.

    
    
  • merged_api_identifier(impl Into<String>) / set_merged_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    
    
• On success, responds with StartSchemaMergeOutput with field(s):
  • source_api_association_status(Option<SourceApiAssociationStatus>):

    The state of the source API association.

• On failure, responds with SdkError<StartSchemaMergeError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The GraphqlApi Amazon Resource Name (ARN).

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    A TagMap object.

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The GraphqlApi Amazon Resource Name (ARN).

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A list of TagKey objects.

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

impl Client

pub fn update_api(&self) -> UpdateApiFluentBuilder

Constructs a fluent builder for the UpdateApi operation.

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

    The Api ID.

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

    The name of the Api.

    
    
  • owner_contact(impl Into<String>) / set_owner_contact(Option<String>):
    required: false
    

    The owner contact information for the Api.

    
    
  • event_config(EventConfig) / set_event_config(Option<EventConfig>):
    required: false
    

    The new event configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

    
    
• On success, responds with UpdateApiOutput with field(s):
  • api(Option<Api>):

    The Api object.

• On failure, responds with SdkError<UpdateApiError>

impl Client

pub fn update_api_cache(&self) -> UpdateApiCacheFluentBuilder

Constructs a fluent builder for the UpdateApiCache operation.

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

    The GraphQL API ID.

    
    
  • ttl(i64) / set_ttl(Option<i64>):
    required: true
    

    TTL in seconds for cache entries.

    Valid values are 1–3,600 seconds.

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

    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>):
    required: true
    

    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.

    
    
  • health_metrics_config(CacheHealthMetricsConfig) / set_health_metrics_config(Option<CacheHealthMetricsConfig>):
    required: false
    

    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

    • NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.

    • EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

    Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.

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

    The ApiCache object.

• On failure, responds with SdkError<UpdateApiCacheError>

impl Client

pub fn update_api_key(&self) -> UpdateApiKeyFluentBuilder

Constructs a fluent builder for the UpdateApiKey operation.

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

    The ID for the GraphQL API.

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

    The API key ID.

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

    A description of the purpose of the API key.

    
    
  • expires(i64) / set_expires(Option<i64>):
    required: false
    

    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>

impl Client

pub fn update_channel_namespace(&self) -> UpdateChannelNamespaceFluentBuilder

Constructs a fluent builder for the UpdateChannelNamespace operation.

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

    The Api ID.

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

    The name of the ChannelNamespace.

    
    
  • subscribe_auth_modes(AuthMode) / set_subscribe_auth_modes(Option<Vec::<AuthMode>>):
    required: false
    

    The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.

    
    
  • publish_auth_modes(AuthMode) / set_publish_auth_modes(Option<Vec::<AuthMode>>):
    required: false
    

    The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.

    
    
  • code_handlers(impl Into<String>) / set_code_handlers(Option<String>):
    required: false
    

    The event handler functions that run custom business logic to process published events and subscribe requests.

    
    
• On success, responds with UpdateChannelNamespaceOutput with field(s):
  • channel_namespace(Option<ChannelNamespace>):

    The ChannelNamespace object.

• On failure, responds with SdkError<UpdateChannelNamespaceError>

impl Client

pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder

Constructs a fluent builder for the UpdateDataSource operation.

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

    The API ID.

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

    The new name for the data source.

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

    The new description for the data source.

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

    The new data source type.

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

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

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

    The new Amazon DynamoDB configuration.

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

    The new Lambda configuration.

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

    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>):
    required: false
    

    The new OpenSearch configuration.

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

    The new HTTP endpoint configuration.

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

    The new relational database configuration.

    
    
  • event_bridge_config(EventBridgeDataSourceConfig) / set_event_bridge_config(Option<EventBridgeDataSourceConfig>):
    required: false
    

    The new Amazon EventBridge settings.

    
    
  • metrics_config(DataSourceLevelMetricsConfig) / set_metrics_config(Option<DataSourceLevelMetricsConfig>):
    required: false
    

    Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won’t be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

    metricsConfig can be ENABLED or DISABLED.

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

    The updated DataSource object.

• On failure, responds with SdkError<UpdateDataSourceError>

impl Client

pub fn update_domain_name(&self) -> UpdateDomainNameFluentBuilder

Constructs a fluent builder for the UpdateDomainName operation.

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

    The domain name.

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

    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>

impl Client

pub fn update_function(&self) -> UpdateFunctionFluentBuilder

Constructs a fluent builder for the UpdateFunction operation.

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

    The GraphQL API ID.

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

    The Function name.

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

    The Function description.

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

    The function ID.

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

    The Function DataSource name.

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

    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>):
    required: false
    

    The Function request mapping template.

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

    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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    The maximum batching size for a resolver.

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

    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>):
    required: false
    

    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>

impl Client

pub fn update_graphql_api(&self) -> UpdateGraphqlApiFluentBuilder

Constructs a fluent builder for the UpdateGraphqlApi operation.

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

    The API ID.

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

    The new name for the GraphqlApi object.

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

    The Amazon CloudWatch Logs configuration for the GraphqlApi object.

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

    The new authentication type for the GraphqlApi object.

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

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

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

    The OpenID Connect configuration for the GraphqlApi object.

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

    A list of additional authentication providers for the GraphqlApi API.

    
    
  • xray_enabled(bool) / set_xray_enabled(Option<bool>):
    required: false
    

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

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

    Configuration for Lambda function authorization.

    
    
  • merged_api_execution_role_arn(impl Into<String>) / set_merged_api_execution_role_arn(Option<String>):
    required: false
    

    The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

    
    
  • owner_contact(impl Into<String>) / set_owner_contact(Option<String>):
    required: false
    

    The owner contact information for an API resource.

    This field accepts any string input with a length of 0 - 256 characters.

    
    
  • introspection_config(GraphQlApiIntrospectionConfig) / set_introspection_config(Option<GraphQlApiIntrospectionConfig>):
    required: false
    

    Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

    For more information about introspection, see GraphQL introspection.

    
    
  • query_depth_limit(i32) / set_query_depth_limit(Option<i32>):
    required: false
    

    The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there’s no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

    Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

    
    
  • resolver_count_limit(i32) / set_resolver_count_limit(Option<i32>):
    required: false
    

    The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

    
    
  • enhanced_metrics_config(EnhancedMetricsConfig) / set_enhanced_metrics_config(Option<EnhancedMetricsConfig>):
    required: false
    

    The enhancedMetricsConfig object.

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

    The updated GraphqlApi object.

• On failure, responds with SdkError<UpdateGraphqlApiError>

impl Client

pub fn update_resolver(&self) -> UpdateResolverFluentBuilder

Constructs a fluent builder for the UpdateResolver operation.

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

    The API ID.

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

    The new type name.

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

    The new field name.

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

    The new data source name.

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

    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>):
    required: false
    

    The new response mapping template.

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

    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>):
    required: false
    

    The PipelineConfig.

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

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

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

    The caching configuration for the resolver.

    
    
  • max_batch_size(i32) / set_max_batch_size(Option<i32>):
    required: false
    

    The maximum batching size for a resolver.

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

    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>):
    required: false
    

    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.

    
    
  • metrics_config(ResolverLevelMetricsConfig) / set_metrics_config(Option<ResolverLevelMetricsConfig>):
    required: false
    

    Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won’t be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

    metricsConfig can be ENABLED or DISABLED.

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

    The updated Resolver object.

• On failure, responds with SdkError<UpdateResolverError>

impl Client

pub fn update_source_api_association( &self, ) -> UpdateSourceApiAssociationFluentBuilder

Constructs a fluent builder for the UpdateSourceApiAssociation operation.

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID generated by the AppSync service for the source API association.

    
    
  • merged_api_identifier(impl Into<String>) / set_merged_api_identifier(Option<String>):
    required: true
    

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

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

    The description field.

    
    
  • source_api_association_config(SourceApiAssociationConfig) / set_source_api_association_config(Option<SourceApiAssociationConfig>):
    required: false
    

    The SourceApiAssociationConfig object data.

    
    
• On success, responds with UpdateSourceApiAssociationOutput with field(s):
  • source_api_association(Option<SourceApiAssociation>):

    The SourceApiAssociation object data.

• On failure, responds with SdkError<UpdateSourceApiAssociationError>

impl Client

pub fn update_type(&self) -> UpdateTypeFluentBuilder

Constructs a fluent builder for the UpdateType operation.

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

    The API ID.

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

    The new type name.

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

    The new definition.

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

    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 from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

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.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.