The Users API from Amazon MemoryDB — 1 operation(s) for users.
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-users-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 Users API
version: '2021-01-01'
description: Generated from AWS's published Smithy model for Amazon MemoryDB. 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://memory-db.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/#CreateUser:
post:
operationId: CreateUser
summary: Create User
description: Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateUserResponse'
'400':
description: DuplicateUserNameFault; InvalidParameterCombinationException; InvalidParameterValueException; TagQuotaPerResourceExceeded;
UserAlreadyExistsFault; UserQuotaExceededFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DuplicateUserNameFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonMemoryDB.CreateUser
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateUserRequest'
tags:
- Users
/#DeleteUser:
post:
operationId: DeleteUser
summary: Delete User
description: Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteUserResponse'
'400':
description: InvalidParameterValueException; InvalidUserStateFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: UserNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UserNotFoundFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonMemoryDB.DeleteUser
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteUserRequest'
tags:
- Users
/#DescribeUsers:
post:
operationId: DescribeUsers
summary: Describe Users
description: Returns a list of users.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeUsersResponse'
'400':
description: InvalidParameterCombinationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidParameterCombinationException'
'404':
description: UserNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UserNotFoundFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonMemoryDB.DescribeUsers
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeUsersRequest'
tags:
- Users
/#UpdateUser:
post:
operationId: UpdateUser
summary: Update User
description: Changes user password(s) and/or access string.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateUserResponse'
'400':
description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidUserStateFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidParameterCombinationException'
'404':
description: UserNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UserNotFoundFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonMemoryDB.UpdateUser
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
tags:
- Users
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:
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.
AuthenticationMode:
type: object
properties:
Type:
type: string
enum:
- password
- iam
description: Indicates whether the user requires a password to authenticate. All newly-created users require a password.
Passwords:
type: array
items:
type: string
description: The password(s) used for authentication
CreateUserRequest:
type: object
properties:
UserName:
type: string
description: The name of the user. This value must be unique as it also serves as the user identifier.
AuthenticationMode:
$ref: '#/components/schemas/AuthenticationMode'
AccessString:
type: string
description: Access permissions string used 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.
required:
- UserName
- AuthenticationMode
- AccessString
CreateUserResponse:
type: object
properties:
User:
$ref: '#/components/schemas/User'
DeleteUserRequest:
type: object
properties:
UserName:
type: string
description: The name of the user to delete
required:
- UserName
DeleteUserResponse:
type: object
properties:
User:
$ref: '#/components/schemas/User'
DescribeUsersRequest:
type: object
properties:
UserName:
type: string
description: The name of the user.
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: Filter to determine the list of users to return.
MaxResults:
type: integer
description: The maximum number of records to include in the response. If more records exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be retrieved.
NextToken:
type: string
description: An optional argument to pass in case the total number of records exceeds the value of MaxResults. If
nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for
each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
DescribeUsersResponse:
type: object
properties:
Users:
type: array
items:
$ref: '#/components/schemas/User'
description: A list of users.
NextToken:
type: string
description: An optional argument to pass in case the total number of records exceeds the value of MaxResults. If
nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for
each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
DuplicateUserNameFault:
type: object
properties:
message:
type: string
Filter:
type: object
properties:
Name:
type: string
description: The property being filtered. For example, UserName.
Values:
type: array
items:
type: string
description: The property values to filter on. For example, "user-123".
required:
- Name
- Values
InvalidParameterCombinationException:
type: object
properties:
message:
type: string
InvalidParameterValueException:
type: object
properties:
message:
type: string
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.
UpdateUserRequest:
type: object
properties:
UserName:
type: string
description: The name of the user
AuthenticationMode:
$ref: '#/components/schemas/AuthenticationMode'
AccessString:
type: string
description: Access permissions string used for this user.
required:
- UserName
UpdateUserResponse:
type: object
properties:
User:
$ref: '#/components/schemas/User'
User:
type: object
properties:
Name:
type: string
description: The name of the user
Status:
type: string
description: Indicates the user status. Can be "active", "modifying" or "deleting".
AccessString:
type: string
description: Access permissions string used for this user.
ACLNames:
type: array
items:
type: string
description: The names of the Access Control Lists to which the user belongs
MinimumEngineVersion:
type: string
description: The minimum engine version supported for the user
Authentication:
$ref: '#/components/schemas/Authentication'
ARN:
type: string
description: The Amazon Resource Name (ARN) of the user.
UserNotFoundFault:
type: object
properties:
message:
type: string
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)