Amazon AppSync Appsync Apicaches API
The Appsync Apicaches API from Amazon AppSync — 2 operation(s) for appsync apicaches.
The Appsync Apicaches API from Amazon AppSync — 2 operation(s) for appsync apicaches.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-appsync:amazon-appsync-apicaches-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: AWS AppSync Apicaches API
version: '2017-07-25'
description: Generated from AWS's published Smithy model for AWS AppSync. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://appsync.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Apicaches
paths:
/v1/apis/{apiId}/ApiCaches:
post:
operationId: CreateApiCache
summary: Create Api Cache
description: Creates a cache for the GraphQL API.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApiCacheResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApiCacheRequest'
tags:
- Apicaches
delete:
operationId: DeleteApiCache
summary: Delete Api Cache
description: Deletes an ApiCache object.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteApiCacheResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteApiCacheRequest'
tags:
- Apicaches
get:
operationId: GetApiCache
summary: Get Api Cache
description: Retrieves an ApiCache object.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetApiCacheResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetApiCacheRequest'
tags:
- Apicaches
/v1/apis/{apiId}/ApiCaches/update:
post:
operationId: UpdateApiCache
summary: Update Api Cache
description: Updates the cache for the GraphQL API.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateApiCacheResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateApiCacheRequest'
tags:
- Apicaches
components:
schemas:
InternalFailureException:
type: object
properties:
message:
type: string
GetApiCacheResponse:
type: object
properties:
apiCache:
$ref: '#/components/schemas/ApiCache'
UnauthorizedException:
type: object
properties:
message:
type: string
CreateApiCacheResponse:
type: object
properties:
apiCache:
$ref: '#/components/schemas/ApiCache'
BadRequestException:
type: object
properties:
message:
type: string
reason:
type: string
enum:
- CODE_ERROR
detail:
$ref: '#/components/schemas/BadRequestDetail'
NotFoundException:
type: object
properties:
message:
type: string
BadRequestDetail:
type: object
properties:
codeErrors:
type: array
items:
$ref: '#/components/schemas/CodeError'
description: Contains the list of errors in the request.
DeleteApiCacheRequest:
type: object
properties:
apiId:
type: string
description: The API ID.
required:
- apiId
CodeError:
type: object
properties:
errorType:
type: string
description: 'The type of code error. Examples include, but aren''t limited to: LINT_ERROR, PARSER_ERROR.'
value:
type: string
description: 'A user presentable error. Examples include, but aren''t limited to: Parsing error: Unterminated string literal.'
location:
$ref: '#/components/schemas/CodeErrorLocation'
ApiCache:
type: object
properties:
ttl:
type: integer
description: TTL in seconds for cache entries. Valid values are 1–3,600 seconds.
apiCachingBehavior:
type: string
enum:
- FULL_REQUEST_CACHING
- PER_RESOLVER_CACHING
- OPERATION_LEVEL_CACHING
description: 'Caching behavior. FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache. PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.'
transitEncryptionEnabled:
type: boolean
description: Transit encryption flag when connecting to cache. You cannot update this setting after creation.
atRestEncryptionEnabled:
type: boolean
description: At-rest encryption flag for cache. You cannot update this setting after creation.
type:
type: string
enum:
- T2_SMALL
- T2_MEDIUM
- R4_LARGE
- R4_XLARGE
- R4_2XLARGE
- R4_4XLARGE
- R4_8XLARGE
- SMALL
- MEDIUM
- LARGE
- XLARGE
- LARGE_2X
- LARGE_4X
- LARGE_8X
- LARGE_12X
description: '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. '
status:
type: string
enum:
- AVAILABLE
- CREATING
- DELETING
- MODIFYING
- FAILED
description: 'The cache instance status. AVAILABLE: The instance is available for use. CREATING: The instance is currently creating. DELETING: The instance is currently deleting. MODIFYING: The instance is currently modifying. FAILED: The instance has failed creation.'
healthMetricsConfig:
type: string
enum:
- ENABLED
- DISABLED
description: '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.'
UpdateApiCacheRequest:
type: object
properties:
apiId:
type: string
description: The GraphQL API ID.
ttl:
type: integer
description: TTL in seconds for cache entries. Valid values are 1–3,600 seconds.
apiCachingBehavior:
type: string
enum:
- FULL_REQUEST_CACHING
- PER_RESOLVER_CACHING
- OPERATION_LEVEL_CACHING
description: 'Caching behavior. FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache. PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.'
type:
type: string
enum:
- T2_SMALL
- T2_MEDIUM
- R4_LARGE
- R4_XLARGE
- R4_2XLARGE
- R4_4XLARGE
- R4_8XLARGE
- SMALL
- MEDIUM
- LARGE
- XLARGE
- LARGE_2X
- LARGE_4X
- LARGE_8X
- LARGE_12X
description: '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. '
healthMetricsConfig:
type: string
enum:
- ENABLED
- DISABLED
description: '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.'
required:
- apiId
- ttl
- apiCachingBehavior
- type
ConcurrentModificationException:
type: object
properties:
message:
type: string
DeleteApiCacheResponse:
type: object
properties: {}
GetApiCacheRequest:
type: object
properties:
apiId:
type: string
description: The API ID.
required:
- apiId
CreateApiCacheRequest:
type: object
properties:
apiId:
type: string
description: The GraphQL API ID.
ttl:
type: integer
description: TTL in seconds for cache entries. Valid values are 1–3,600 seconds.
transitEncryptionEnabled:
type: boolean
description: Transit encryption flag when connecting to cache. You cannot update this setting after creation.
atRestEncryptionEnabled:
type: boolean
description: At-rest encryption flag for cache. You cannot update this setting after creation.
apiCachingBehavior:
type: string
enum:
- FULL_REQUEST_CACHING
- PER_RESOLVER_CACHING
- OPERATION_LEVEL_CACHING
description: 'Caching behavior. FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache. PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.'
type:
type: string
enum:
- T2_SMALL
- T2_MEDIUM
- R4_LARGE
- R4_XLARGE
- R4_2XLARGE
- R4_4XLARGE
- R4_8XLARGE
- SMALL
- MEDIUM
- LARGE
- XLARGE
- LARGE_2X
- LARGE_4X
- LARGE_8X
- LARGE_12X
description: '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. '
healthMetricsConfig:
type: string
enum:
- ENABLED
- DISABLED
description: '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.'
required:
- apiId
- ttl
- apiCachingBehavior
- type
CodeErrorLocation:
type: object
properties:
line:
type: integer
description: The line number in the code. Defaults to 0 if unknown.
column:
type: integer
description: The column number in the code. Defaults to 0 if unknown.
span:
type: integer
description: The span/length of the error. Defaults to -1 if unknown.
UpdateApiCacheResponse:
type: object
properties:
apiCache:
$ref: '#/components/schemas/ApiCache'
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: appsync
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/appsync/service/2017-07-25/appsync-2017-07-25.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)