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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-elasticache:amazon-elasticache-user-group-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.

GitHub Google LinkedIn

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 Group 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 Group
paths:
  /?Action=CreateUserGroup:
    post:
      operationId: CreateUserGroup
      summary: Create User Group
      description: 'For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more information, see Using Role Based Access Control (RBAC)'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UserGroup'
        '400':
          description: DefaultUserRequired; DuplicateUserNameFault; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault; TagQuotaPerResourceExceeded; UserGroupAlreadyExistsFault; UserGroupQuotaExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DefaultUserRequired'
        '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: CreateUserGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/CreateUserGroupMessage'
      tags:
      - User Group
  /?Action=DeleteUserGroup:
    post:
      operationId: DeleteUserGroup
      summary: Delete User Group
      description: 'For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UserGroup'
        '400':
          description: InvalidParameterValueException; InvalidUserGroupStateFault; ServiceLinkedRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: UserGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UserGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteUserGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DeleteUserGroupMessage'
      tags:
      - User Group
  /?Action=DescribeUserGroups:
    post:
      operationId: DescribeUserGroups
      summary: Describe User Groups
      description: Returns a list of user groups.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeUserGroupsResult'
        '400':
          description: InvalidParameterCombinationException; ServiceLinkedRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: UserGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UserGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeUserGroups
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/DescribeUserGroupsMessage'
      tags:
      - User Group
  /?Action=ModifyUserGroup:
    post:
      operationId: ModifyUserGroup
      summary: Modify User Group
      description: Changes the list of users that belong to the user group.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UserGroup'
        '400':
          description: DefaultUserRequired; DuplicateUserNameFault; InvalidParameterCombinationException; InvalidParameterValueException; InvalidUserGroupStateFault; ServiceLinkedRoleNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DefaultUserRequired'
        '404':
          description: UserGroupNotFoundFault; UserNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UserGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyUserGroup
                  Version:
                    type: string
                    const: '2015-02-02'
              - $ref: '#/components/schemas/ModifyUserGroupMessage'
      tags:
      - User Group
components:
  schemas:
    DescribeUserGroupsResult:
      type: object
      properties:
        UserGroups:
          type: array
          items:
            $ref: '#/components/schemas/UserGroup'
          description: Returns a list of user groups.
        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.>
    DescribeUserGroupsMessage:
      type: object
      properties:
        UserGroupId:
          type: string
          description: The ID of the user group.
        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. >
    DefaultUserRequired:
      type: object
      properties:
        message:
          type: string
    UserGroupPendingChanges:
      type: object
      properties:
        UserIdsToRemove:
          type: array
          items:
            type: string
          description: The list of user IDs to remove.
        UserIdsToAdd:
          type: array
          items:
            type: string
          description: The list of user IDs to add.
    ModifyUserGroupMessage:
      type: object
      properties:
        UserGroupId:
          type: string
          description: The ID of the user group.
        UserIdsToAdd:
          type: array
          items:
            type: string
          description: The list of user IDs to add to the user group.
        UserIdsToRemove:
          type: array
          items:
            type: string
          description: The list of user IDs to remove from the user group.
        Engine:
          type: string
          description: Modifies the engine listed in a user group. The options are valkey or redis.
      required:
      - UserGroupId
    InvalidParameterValueException:
      type: object
      properties:
        message:
          type: string
          description: A parameter value is invalid.
    CreateUserGroupMessage:
      type: object
      properties:
        UserGroupId:
          type: string
          description: The ID of the user group. This value is stored as a lowercase string.
        Engine:
          type: string
          description: Sets the engine listed in a user group. The options are valkey or redis.
        UserIds:
          type: array
          items:
            type: string
          description: The list of user IDs that belong to the user group.
        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. Available for Valkey and Redis OSS only.
      required:
      - UserGroupId
      - Engine
    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.
    DeleteUserGroupMessage:
      type: object
      properties:
        UserGroupId:
          type: string
          description: The ID of the user group.
      required:
      - UserGroupId
    UserGroup:
      type: object
      properties:
        UserGroupId:
          type: string
          description: The ID of the user group.
        Status:
          type: string
          description: Indicates user group status. Can be "creating", "active", "modifying", "deleting".
        Engine:
          type: string
          description: The options are valkey or redis.
        UserIds:
          type: array
          items:
            type: string
          description: The list of user IDs that belong to the user group.
        MinimumEngineVersion:
          type: string
          description: The minimum engine version required, which is Redis OSS 6.0
        PendingChanges:
          $ref: '#/components/schemas/UserGroupPendingChanges'
        ReplicationGroups:
          type: array
          items:
            type: string
          description: A list of replication groups that the user group can access.
        ServerlessCaches:
          type: array
          items:
            type: string
          description: Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of the user group.
    UserNotFoundFault:
      type: object
      properties:
        message:
          type: string
    UserGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
  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)