Amazon ElastiCache Elasticache User API
The Elasticache User API from Amazon ElastiCache — 4 operation(s) for elasticache user.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-elasticache:amazon-elasticache-user-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: Amazon ElastiCache User API
version: '2015-02-02'
description: Generated from AWS's published Smithy model for Amazon ElastiCache. 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://elasticache.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: User
paths:
/?Action=CreateUser:
post:
operationId: CreateUser
summary: Create User
description: 'For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see Using Role Based Access Control (RBAC).'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/User'
'400':
description: DuplicateUserNameFault; InvalidParameterCombinationException; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault; TagQuotaPerResourceExceeded; UserAlreadyExistsFault; UserQuotaExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DuplicateUserNameFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateUser
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/CreateUserMessage'
tags:
- User
/?Action=DeleteUser:
post:
operationId: DeleteUser
summary: Delete User
description: 'For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/User'
'400':
description: DefaultUserAssociatedToUserGroupFault; InvalidParameterValueException; InvalidUserStateFault; ServiceLinkedRoleNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DefaultUserAssociatedToUserGroupFault'
'404':
description: UserNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/UserNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DeleteUser
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/DeleteUserMessage'
tags:
- User
/?Action=DescribeUsers:
post:
operationId: DescribeUsers
summary: Describe Users
description: Returns a list of users.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeUsersResult'
'400':
description: InvalidParameterCombinationException; ServiceLinkedRoleNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidParameterCombinationException'
'404':
description: UserNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/UserNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeUsers
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/DescribeUsersMessage'
tags:
- User
/?Action=ModifyUser:
post:
operationId: ModifyUser
summary: Modify User
description: Changes user password(s) and/or access string.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/User'
'400':
description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidUserStateFault; ServiceLinkedRoleNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidParameterCombinationException'
'404':
description: UserNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/UserNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ModifyUser
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/ModifyUserMessage'
tags:
- User
components:
schemas:
CreateUserMessage:
type: object
properties:
UserId:
type: string
description: The ID of the user. This value is stored as a lowercase string.
UserName:
type: string
description: The username of the user.
Engine:
type: string
description: The options are valkey or redis.
Passwords:
type: array
items:
type: string
description: Passwords used for this user. You can create up to two passwords for each user.
AccessString:
type: string
description: Access permissions string used for this user.
NoPasswordRequired:
type: boolean
description: Indicates a password is not required for this user.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
AuthenticationMode:
$ref: '#/components/schemas/AuthenticationMode'
required:
- UserId
- UserName
- Engine
- AccessString
DuplicateUserNameFault:
type: object
properties:
message:
type: string
Authentication:
type: object
properties:
Type:
type: string
enum:
- password
- no-password
- iam
description: Indicates whether the user requires a password to authenticate.
PasswordCount:
type: integer
description: The number of passwords belonging to the user. The maximum is two.
ModifyUserMessage:
type: object
properties:
UserId:
type: string
description: The ID of the user.
AccessString:
type: string
description: Access permissions string used for this user.
AppendAccessString:
type: string
description: Adds additional user permissions to the access string.
Passwords:
type: array
items:
type: string
description: The passwords belonging to the user. You are allowed up to two.
NoPasswordRequired:
type: boolean
description: Indicates no password is required for the user.
AuthenticationMode:
$ref: '#/components/schemas/AuthenticationMode'
Engine:
type: string
description: Modifies the engine listed for a user. The options are valkey or redis.
required:
- UserId
DefaultUserAssociatedToUserGroupFault:
type: object
properties:
message:
type: string
DescribeUsersResult:
type: object
properties:
Users:
type: array
items:
$ref: '#/components/schemas/User'
description: A list of users.
Marker:
type: string
description: An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
Filter:
type: object
properties:
Name:
type: string
description: The property being filtered. For example, UserId.
Values:
type: array
items:
type: string
description: The property values to filter on. For example, "user-123".
required:
- Name
- Values
User:
type: object
properties:
UserId:
type: string
description: The ID of the user.
UserName:
type: string
description: The username of the user.
Status:
type: string
description: Indicates the user status. Can be "active", "modifying" or "deleting".
Engine:
type: string
description: The options are valkey or redis.
MinimumEngineVersion:
type: string
description: The minimum engine version required, which is Redis OSS 6.0
AccessString:
type: string
description: Access permissions string used for this user.
UserGroupIds:
type: array
items:
type: string
description: Returns a list of the user group IDs the user belongs to.
Authentication:
$ref: '#/components/schemas/Authentication'
ARN:
type: string
description: The Amazon Resource Name (ARN) of the user.
InvalidParameterCombinationException:
type: object
properties:
message:
type: string
description: Two or more parameters that must not be used together were used together.
Tag:
type: object
properties:
Key:
type: string
description: The key for the tag. May not be null.
Value:
type: string
description: The tag's value. May be null.
AuthenticationMode:
type: object
properties:
Type:
type: string
enum:
- password
- no-password-required
- iam
description: Specifies the authentication type. Possible options are IAM authentication, password and no password.
Passwords:
type: array
items:
type: string
description: Specifies the passwords to use for authentication if Type is set to password.
DeleteUserMessage:
type: object
properties:
UserId:
type: string
description: The ID of the user.
required:
- UserId
UserNotFoundFault:
type: object
properties:
message:
type: string
DescribeUsersMessage:
type: object
properties:
Engine:
type: string
description: The engine.
UserId:
type: string
description: The ID of the user.
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: Filter to determine the list of User IDs to return.
MaxRecords:
type: integer
description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Marker:
type: string
description: An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
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: elasticache
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/elasticache/service/2015-02-02/elasticache-2015-02-02.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)