The Shards API from Amazon MemoryDB — 1 operation(s) for shards.
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-memorydb:amazon-memorydb-shards-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.1.0
info:
title: Amazon MemoryDB Shards API
version: '2021-01-01'
description: Generated from AWS's published Smithy model for Amazon MemoryDB. 1 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://memory-db.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/#FailoverShard:
post:
operationId: FailoverShard
summary: Failover Shard
description: Used to failover a shard. This API is designed for testing the behavior of your application in case of
MemoryDB failover. It is not designed to be used as a production-level tool for initiating a failover to overcome
a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon
may block this API.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/FailoverShardResponse'
'400':
description: APICallRateForCustomerExceededFault; InvalidClusterStateFault; InvalidKMSKeyFault; InvalidParameterCombinationException;
InvalidParameterValueException; TestFailoverNotAvailableFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/APICallRateForCustomerExceededFault'
'404':
description: ClusterNotFoundFault; ShardNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonMemoryDB.FailoverShard
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/FailoverShardRequest'
tags:
- Shards
components:
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: memorydb
schemas:
ACLsUpdateStatus:
type: object
properties:
ACLToApply:
type: string
description: A list of ACLs pending to be applied.
APICallRateForCustomerExceededFault:
type: object
properties:
message:
type: string
Cluster:
type: object
properties:
Name:
type: string
description: The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description:
type: string
description: A description of the cluster
Status:
type: string
description: The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates:
$ref: '#/components/schemas/ClusterPendingUpdates'
MultiRegionClusterName:
type: string
description: The name of the multi-Region cluster that this cluster belongs to.
NumberOfShards:
type: integer
description: The number of shards in the cluster
Shards:
type: array
items:
$ref: '#/components/schemas/Shard'
description: A list of shards that are members of the cluster.
AvailabilityMode:
type: string
enum:
- singleaz
- multiaz
description: Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint:
$ref: '#/components/schemas/Endpoint'
NodeType:
type: string
description: The cluster's node type
Engine:
type: string
description: The name of the engine used by the cluster.
EngineVersion:
type: string
description: The Redis OSS engine version used by the cluster
EnginePatchVersion:
type: string
description: The Redis OSS engine patch version used by the cluster
ParameterGroupName:
type: string
description: The name of the parameter group used by the cluster
ParameterGroupStatus:
type: string
description: The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups:
type: array
items:
$ref: '#/components/schemas/SecurityGroupMembership'
description: A list of security groups used by the cluster
SubnetGroupName:
type: string
description: The name of the subnet group used by the cluster
TLSEnabled:
type: boolean
description: A flag to indicate if In-transit encryption is enabled
KmsKeyId:
type: string
description: The ID of the KMS key used to encrypt the cluster
ARN:
type: string
description: The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn:
type: string
description: The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus:
type: string
description: The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit:
type: integer
description: The number of days for which MemoryDB retains automatic snapshots before deleting them. For example,
if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow:
type: string
description: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified
as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
period.
SnapshotWindow:
type: string
description: 'The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time
range.'
ACLName:
type: string
description: The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade:
type: boolean
description: When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering:
type: string
enum:
- 'true'
- 'false'
description: Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter
must be set when using r6gd nodes. For more information, see Data tiering.
NetworkType:
type: string
enum:
- ipv4
- ipv6
- dual_stack
description: The IP address type for the cluster. Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack'
if the cluster supports both IPv4 and IPv6 addressing.
IpDiscovery:
type: string
enum:
- ipv4
- ipv6
description: The mechanism that the cluster uses to discover IP addresses. Returns 'ipv4' when DNS endpoints resolve
to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.
ClusterNotFoundFault:
type: object
properties:
message:
type: string
ClusterPendingUpdates:
type: object
properties:
Resharding:
$ref: '#/components/schemas/ReshardingStatus'
ACLs:
$ref: '#/components/schemas/ACLsUpdateStatus'
ServiceUpdates:
type: array
items:
$ref: '#/components/schemas/PendingModifiedServiceUpdate'
description: A list of service updates being applied to the cluster
Endpoint:
type: object
properties:
Address:
type: string
description: The DNS hostname of the node.
Port:
type: integer
description: The port number that the engine is listening on.
FailoverShardRequest:
type: object
properties:
ClusterName:
type: string
description: The cluster being failed over.
ShardName:
type: string
description: The name of the shard.
required:
- ClusterName
- ShardName
FailoverShardResponse:
type: object
properties:
Cluster:
$ref: '#/components/schemas/Cluster'
Node:
type: object
properties:
Name:
type: string
description: The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster
name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status:
type: string
description: The status of the service update on the node
AvailabilityZone:
type: string
description: The Availability Zone in which the node resides
CreateTime:
type: string
format: date-time
description: The date and time when the node was created.
Endpoint:
$ref: '#/components/schemas/Endpoint'
PendingModifiedServiceUpdate:
type: object
properties:
ServiceUpdateName:
type: string
description: The unique ID of the service update
Status:
type: string
enum:
- available
- in-progress
- complete
- scheduled
description: The status of the service update
ReshardingStatus:
type: object
properties:
SlotMigration:
$ref: '#/components/schemas/SlotMigration'
SecurityGroupMembership:
type: object
properties:
SecurityGroupId:
type: string
description: The identifier of the security group.
Status:
type: string
description: The status of the security group membership. The status changes whenever a security group is modified,
or when the security groups assigned to a cluster are modified.
Shard:
type: object
properties:
Name:
type: string
description: The name of the shard
Status:
type: string
description: The current state of this replication group - creating, available, modifying, deleting.
Slots:
type: string
description: The keyspace for this shard.
Nodes:
type: array
items:
$ref: '#/components/schemas/Node'
description: A list containing information about individual nodes within the shard
NumberOfNodes:
type: integer
description: The number of nodes in the shard
SlotMigration:
type: object
properties:
ProgressPercentage:
type: number
description: The percentage of the slot migration that is complete.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/memorydb/service/2021-01-01/memorydb-2021-01-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)