AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

You don't have access to perform this operation on this resource.

Class AdditionalAuthenticationProvider

Describes an additional authentication provider.

Class ApiAssociation

Describes an ApiAssociation object.

Class ApiCache

The ApiCache object.

Class ApiKey

Describes an API key.

Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.

  • ListApiKeys returns the expiration time in milliseconds.

  • CreateApiKey returns the expiration time in milliseconds.

  • UpdateApiKey is not available for this key version.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.

da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.

  • ListApiKeys returns the expiration time and deletion time in seconds.

  • CreateApiKey returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.

  • UpdateApiKey returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. You can update the key expiration time as long as the key isn't deleted.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.

  • Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.

Class ApiKeyLimitExceededException

The API key exceeded a limit. Try your request again.

Class ApiKeyValidityOutOfBoundsException

The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

Class ApiLimitExceededException

The GraphQL API exceeded a limit. Try your request again.

Class AppSyncRuntime

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

Class AssociateApiRequest

Container for the parameters to the AssociateApi operation. Maps an endpoint to your custom domain.

Class AssociateApiResponse

This is the response object from the AssociateApi operation.

Class AssociateMergedGraphqlApiRequest

Container for the parameters to the AssociateMergedGraphqlApi operation. Creates an association between a Merged API and source API using the source API's identifier.

Class AssociateMergedGraphqlApiResponse

This is the response object from the AssociateMergedGraphqlApi operation.

Class AssociateSourceGraphqlApiRequest

Container for the parameters to the AssociateSourceGraphqlApi operation. Creates an association between a Merged API and source API using the Merged API's identifier.

Class AssociateSourceGraphqlApiResponse

This is the response object from the AssociateSourceGraphqlApi operation.

Class AuthorizationConfig

The authorization configuration in case the HTTP endpoint requires authorization.

Class AwsIamConfig

The Identity and Access Management (IAM) configuration.

Class BadRequestDetail

Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the detail will contain a list of code errors.

Class BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

Class CachingConfig

The caching configuration for a resolver that has caching activated.

Class CodeError

Describes an AppSync error.

Class CodeErrorLocation

Describes the location of the error in a code sample.

Class CognitoUserPoolConfig

Describes an Amazon Cognito user pool configuration.

Class ConcurrentModificationException

Another modification is in progress at this time and it must complete before you can make your change.

Class CreateApiCacheRequest

Container for the parameters to the CreateApiCache operation. Creates a cache for the GraphQL API.

Class CreateApiCacheResponse

Represents the output of a CreateApiCache operation.

Class CreateApiKeyRequest

Container for the parameters to the CreateApiKey operation. Creates a unique key that you can distribute to clients who invoke your API.

Class CreateApiKeyResponse

This is the response object from the CreateApiKey operation.

Class CreateDataSourceRequest

Container for the parameters to the CreateDataSource operation. Creates a DataSource object.

Class CreateDataSourceResponse

This is the response object from the CreateDataSource operation.

Class CreateDomainNameRequest

Container for the parameters to the CreateDomainName operation. Creates a custom DomainName object.

Class CreateDomainNameResponse

This is the response object from the CreateDomainName operation.

Class CreateFunctionRequest

Container for the parameters to the CreateFunction operation. Creates a Function object.

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

Class CreateFunctionResponse

This is the response object from the CreateFunction operation.

Class CreateGraphqlApiRequest

Container for the parameters to the CreateGraphqlApi operation. Creates a GraphqlApi object.

Class CreateGraphqlApiResponse

This is the response object from the CreateGraphqlApi operation.

Class CreateResolverRequest

Container for the parameters to the CreateResolver operation. Creates a Resolver object.

A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.

Class CreateResolverResponse

This is the response object from the CreateResolver operation.

Class CreateTypeRequest

Container for the parameters to the CreateType operation. Creates a Type object.

Class CreateTypeResponse

This is the response object from the CreateType operation.

Class DataSource

Describes a data source.

Class DataSourceIntrospectionModel

Contains the introspected data that was retrieved from the data source.

Class DataSourceIntrospectionModelField

Represents the fields that were retrieved from the introspected data.

Class DataSourceIntrospectionModelFieldType

Represents the type data for each field retrieved from the introspection.

Class DataSourceIntrospectionModelIndex

The index that was retrieved from the introspected data.

Class DataSourceIntrospectionResult

Represents the output of a DataSourceIntrospectionResult. This is the populated result of a GetDataSourceIntrospection operation.

Class DeleteApiCacheRequest

Container for the parameters to the DeleteApiCache operation. Deletes an ApiCache object.

Class DeleteApiCacheResponse

Represents the output of a DeleteApiCache operation.

Class DeleteApiKeyRequest

Container for the parameters to the DeleteApiKey operation. Deletes an API key.

Class DeleteApiKeyResponse

This is the response object from the DeleteApiKey operation.

Class DeleteDataSourceRequest

Container for the parameters to the DeleteDataSource operation. Deletes a DataSource object.

Class DeleteDataSourceResponse

This is the response object from the DeleteDataSource operation.

Class DeleteDomainNameRequest

Container for the parameters to the DeleteDomainName operation. Deletes a custom DomainName object.

Class DeleteDomainNameResponse

This is the response object from the DeleteDomainName operation.

Class DeleteFunctionRequest

Container for the parameters to the DeleteFunction operation. Deletes a Function.

Class DeleteFunctionResponse

This is the response object from the DeleteFunction operation.

Class DeleteGraphqlApiRequest

Container for the parameters to the DeleteGraphqlApi operation. Deletes a GraphqlApi object.

Class DeleteGraphqlApiResponse

This is the response object from the DeleteGraphqlApi operation.

Class DeleteResolverRequest

Container for the parameters to the DeleteResolver operation. Deletes a Resolver object.

Class DeleteResolverResponse

This is the response object from the DeleteResolver operation.

Class DeleteTypeRequest

Container for the parameters to the DeleteType operation. Deletes a Type object.

Class DeleteTypeResponse

This is the response object from the DeleteType operation.

Class DeltaSyncConfig

Describes a Delta Sync configuration.

Class DisassociateApiRequest

Container for the parameters to the DisassociateApi operation. Removes an ApiAssociation object from a custom domain.

Class DisassociateApiResponse

This is the response object from the DisassociateApi operation.

Class DisassociateMergedGraphqlApiRequest

Container for the parameters to the DisassociateMergedGraphqlApi operation. Deletes an association between a Merged API and source API using the source API's identifier and the association ID.

Class DisassociateMergedGraphqlApiResponse

This is the response object from the DisassociateMergedGraphqlApi operation.

Class DisassociateSourceGraphqlApiRequest

Container for the parameters to the DisassociateSourceGraphqlApi operation. Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.

Class DisassociateSourceGraphqlApiResponse

This is the response object from the DisassociateSourceGraphqlApi operation.

Class DomainNameConfig

Describes a configuration for a custom domain.

Class DynamodbDataSourceConfig

Describes an Amazon DynamoDB data source configuration.

Class ElasticsearchDataSourceConfig

Describes an OpenSearch data source configuration.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.

Class EnhancedMetricsConfig

Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.

Enhanced metrics can be configured at the resolver, data source, and operation levels. EnhancedMetricsConfig contains three required parameters, each controlling one of these categories:

  1. resolverLevelMetricsBehavior: Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

    • GraphQL errors: The number of GraphQL errors that occurred.

    • Requests: The number of invocations that occurred during a request.

    • Latency: The time to complete a resolver invocation.

    • Cache hits: The number of cache hits during a request.

    • Cache misses: The number of cache misses during a request.

    These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:

    • FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the request.

    • PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED.

  2. dataSourceLevelMetricsBehavior: Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

    • Requests: The number of invocations that occured during a request.

    • Latency: The time to complete a data source invocation.

    • Errors: The number of errors that occurred during a data source invocation.

    These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:

    • FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources in the request.

    • PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the metricsConfig value set to ENABLED.

  3. operationLevelMetricsConfig: Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

    • Requests: The number of times a specified GraphQL operation was called.

    • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.

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

Class ErrorDetail

Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.

Class EvaluateCodeErrorDetail

Contains the list of errors from a code evaluation response.

Class EvaluateCodeRequest

Container for the parameters to the EvaluateCode operation. Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.

Class EvaluateCodeResponse

This is the response object from the EvaluateCode operation.

Class EvaluateMappingTemplateRequest

Container for the parameters to the EvaluateMappingTemplate operation. Evaluates a given template and returns the response. The mapping template can be a request or response template.

Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.

Mapping templates are written in the Apache Velocity Template Language (VTL).

Class EvaluateMappingTemplateResponse

This is the response object from the EvaluateMappingTemplate operation.

Class EventBridgeDataSourceConfig

Describes an Amazon EventBridge bus data source configuration.

Class FlushApiCacheRequest

Container for the parameters to the FlushApiCache operation. Flushes an ApiCache object.

Class FlushApiCacheResponse

Represents the output of a FlushApiCache operation.

Class FunctionConfiguration

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

Class GetApiAssociationRequest

Container for the parameters to the GetApiAssociation operation. Retrieves an ApiAssociation object.

Class GetApiAssociationResponse

This is the response object from the GetApiAssociation operation.

Class GetApiCacheRequest

Container for the parameters to the GetApiCache operation. Retrieves an ApiCache object.

Class GetApiCacheResponse

Represents the output of a GetApiCache operation.

Class GetDataSourceIntrospectionRequest

Container for the parameters to the GetDataSourceIntrospection operation. Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.

Class GetDataSourceIntrospectionResponse

This is the response object from the GetDataSourceIntrospection operation.

Class GetDataSourceRequest

Container for the parameters to the GetDataSource operation. Retrieves a DataSource object.

Class GetDataSourceResponse

This is the response object from the GetDataSource operation.

Class GetDomainNameRequest

Container for the parameters to the GetDomainName operation. Retrieves a custom DomainName object.

Class GetDomainNameResponse

This is the response object from the GetDomainName operation.

Class GetFunctionRequest

Container for the parameters to the GetFunction operation. Get a Function.

Class GetFunctionResponse

This is the response object from the GetFunction operation.

Class GetGraphqlApiEnvironmentVariablesRequest

Container for the parameters to the GetGraphqlApiEnvironmentVariables operation. Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

Class GetGraphqlApiEnvironmentVariablesResponse

This is the response object from the GetGraphqlApiEnvironmentVariables operation.

Class GetGraphqlApiRequest

Container for the parameters to the GetGraphqlApi operation. Retrieves a GraphqlApi object.

Class GetGraphqlApiResponse

This is the response object from the GetGraphqlApi operation.

Class GetIntrospectionSchemaRequest

Container for the parameters to the GetIntrospectionSchema operation. Retrieves the introspection schema for a GraphQL API.

Class GetIntrospectionSchemaResponse

This is the response object from the GetIntrospectionSchema operation.

Class GetResolverRequest

Container for the parameters to the GetResolver operation. Retrieves a Resolver object.

Class GetResolverResponse

This is the response object from the GetResolver operation.

Class GetSchemaCreationStatusRequest

Container for the parameters to the GetSchemaCreationStatus operation. Retrieves the current status of a schema creation operation.

Class GetSchemaCreationStatusResponse

This is the response object from the GetSchemaCreationStatus operation.

Class GetSourceApiAssociationRequest

Container for the parameters to the GetSourceApiAssociation operation. Retrieves a SourceApiAssociation object.

Class GetSourceApiAssociationResponse

This is the response object from the GetSourceApiAssociation operation.

Class GetTypeRequest

Container for the parameters to the GetType operation. Retrieves a Type object.

Class GetTypeResponse

This is the response object from the GetType operation.

Class GraphqlApi

Describes a GraphQL API.

Class GraphQLSchemaException

The GraphQL schema is not valid.

Class HttpDataSourceConfig

Describes an HTTP data source configuration.

Class InternalFailureException

An internal AppSync error occurred. Try your request again.

Class LambdaAuthorizerConfig

A LambdaAuthorizerConfig specifies how to authorize AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.

Class LambdaConflictHandlerConfig

The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict Handler.

Class LambdaDataSourceConfig

Describes an Lambda data source configuration.

Class LimitExceededException

The request exceeded a limit. Try your request again.

Class ListApiKeysRequest

Container for the parameters to the ListApiKeys operation. Lists the API keys for a given API.

API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.

Class ListApiKeysResponse

This is the response object from the ListApiKeys operation.

Class ListDataSourcesRequest

Container for the parameters to the ListDataSources operation. Lists the data sources for a given API.

Class ListDataSourcesResponse

This is the response object from the ListDataSources operation.

Class ListDomainNamesRequest

Container for the parameters to the ListDomainNames operation. Lists multiple custom domain names.

Class ListDomainNamesResponse

This is the response object from the ListDomainNames operation.

Class ListFunctionsRequest

Container for the parameters to the ListFunctions operation. List multiple functions.

Class ListFunctionsResponse

This is the response object from the ListFunctions operation.

Class ListGraphqlApisRequest

Container for the parameters to the ListGraphqlApis operation. Lists your GraphQL APIs.

Class ListGraphqlApisResponse

This is the response object from the ListGraphqlApis operation.

Class ListResolversByFunctionRequest

Container for the parameters to the ListResolversByFunction operation. List the resolvers that are associated with a specific function.

Class ListResolversByFunctionResponse

This is the response object from the ListResolversByFunction operation.

Class ListResolversRequest

Container for the parameters to the ListResolvers operation. Lists the resolvers for a given API and type.

Class ListResolversResponse

This is the response object from the ListResolvers operation.

Class ListSourceApiAssociationsRequest

Container for the parameters to the ListSourceApiAssociations operation. Lists the SourceApiAssociationSummary data.

Class ListSourceApiAssociationsResponse

This is the response object from the ListSourceApiAssociations operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags for a resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListTypesByAssociationRequest

Container for the parameters to the ListTypesByAssociation operation. Lists Type objects by the source API association ID.

Class ListTypesByAssociationResponse

This is the response object from the ListTypesByAssociation operation.

Class ListTypesRequest

Container for the parameters to the ListTypes operation. Lists the types for a given API.

Class ListTypesResponse

This is the response object from the ListTypes operation.

Class LogConfig

The Amazon CloudWatch Logs configuration.

Class NotFoundException

The resource specified in the request was not found. Check the resource, and then try again.

Class OpenIDConnectConfig

Describes an OpenID Connect (OIDC) configuration.

Class OpenSearchServiceDataSourceConfig

Describes an OpenSearch data source configuration.

Class PipelineConfig

The pipeline configuration for a resolver of kind PIPELINE.

Class PutGraphqlApiEnvironmentVariablesRequest

Container for the parameters to the PutGraphqlApiEnvironmentVariables operation. Creates a list of environmental variables in an API by its ID value.

When creating an environmental variable, it must follow the constraints below:

  • Both JavaScript and VTL templates support environmental variables.

  • Environmental variables are not evaluated before function invocation.

  • Environmental variables only support string values.

  • Any defined value in an environmental variable is considered a string literal and not expanded.

  • Variable evaluations should ideally be performed in the function code.

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

  • Keys must begin with a letter.

  • Keys must be at least two characters long.

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

  • Values can be up to 512 characters long.

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

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

Class PutGraphqlApiEnvironmentVariablesResponse

This is the response object from the PutGraphqlApiEnvironmentVariables operation.

Class RdsDataApiConfig

Contains the metadata required to introspect the RDS cluster.

Class RdsHttpEndpointConfig

The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.

Class RelationalDatabaseDataSourceConfig

Describes a relational database data source configuration.

Class Resolver

Describes a resolver.

Class SourceApiAssociation

Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API.

Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource Access Manager? in the Amazon Web Services Resource Access Manager guide.

Class SourceApiAssociationConfig

Describes properties used to specify configurations related to a source API.

Class SourceApiAssociationSummary

Describes the ARNs and IDs of associations, Merged APIs, and source APIs.

Class StartDataSourceIntrospectionRequest

Container for the parameters to the StartDataSourceIntrospection operation. Creates a new introspection. Returns the introspectionId of the new introspection after its creation.

Class StartDataSourceIntrospectionResponse

This is the response object from the StartDataSourceIntrospection operation.

Class StartSchemaCreationRequest

Container for the parameters to the StartSchemaCreation operation. Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

Class StartSchemaCreationResponse

This is the response object from the StartSchemaCreation operation.

Class StartSchemaMergeRequest

Container for the parameters to the StartSchemaMerge operation. Initiates a merge operation. Returns a status that shows the result of the merge operation.

Class StartSchemaMergeResponse

This is the response object from the StartSchemaMerge operation.

Class SyncConfig

Describes a Sync configuration for a resolver.

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

Class TagResourceRequest

Container for the parameters to the TagResource operation. Tags a resource with user-supplied tags.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class Type

Describes a type.

Class UnauthorizedException

You aren't authorized to perform this operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Untags a resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateApiCacheRequest

Container for the parameters to the UpdateApiCache operation. Updates the cache for the GraphQL API.

Class UpdateApiCacheResponse

Represents the output of a UpdateApiCache operation.

Class UpdateApiKeyRequest

Container for the parameters to the UpdateApiKey operation. Updates an API key. You can update the key as long as it's not deleted.

Class UpdateApiKeyResponse

This is the response object from the UpdateApiKey operation.

Class UpdateDataSourceRequest

Container for the parameters to the UpdateDataSource operation. Updates a DataSource object.

Class UpdateDataSourceResponse

This is the response object from the UpdateDataSource operation.

Class UpdateDomainNameRequest

Container for the parameters to the UpdateDomainName operation. Updates a custom DomainName object.

Class UpdateDomainNameResponse

This is the response object from the UpdateDomainName operation.

Class UpdateFunctionRequest

Container for the parameters to the UpdateFunction operation. Updates a Function object.

Class UpdateFunctionResponse

This is the response object from the UpdateFunction operation.

Class UpdateGraphqlApiRequest

Container for the parameters to the UpdateGraphqlApi operation. Updates a GraphqlApi object.

Class UpdateGraphqlApiResponse

This is the response object from the UpdateGraphqlApi operation.

Class UpdateResolverRequest

Container for the parameters to the UpdateResolver operation. Updates a Resolver object.

Class UpdateResolverResponse

This is the response object from the UpdateResolver operation.

Class UpdateSourceApiAssociationRequest

Container for the parameters to the UpdateSourceApiAssociation operation. Updates some of the configuration choices of a particular source API association.

Class UpdateSourceApiAssociationResponse

This is the response object from the UpdateSourceApiAssociation operation.

Class UpdateTypeRequest

Container for the parameters to the UpdateType operation. Updates a Type object.

Class UpdateTypeResponse

This is the response object from the UpdateType operation.

Class UserPoolConfig

Describes an Amazon Cognito user pool configuration.