Amazon MemoryDB Events API

openapi: 3.1.0
info:
  title: Amazon MemoryDB Events 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:
  /#DescribeEvents:
    post:
      operationId: DescribeEvents
      summary: Describe Events
      description: Returns events related to clusters, security groups, and parameter groups. You can obtain events specific
        to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only
        the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if
        necessary.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEventsResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DescribeEvents
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEventsRequest'
      tags:
      - Events
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:
    DescribeEventsRequest:
      type: object
      properties:
        SourceName:
          type: string
          description: The identifier of the event source for which events are returned. If not specified, all sources are
            included in the response.
        SourceType:
          type: string
          enum:
          - node
          - parameter-group
          - subnet-group
          - cluster
          - user
          - acl
          description: The event source to retrieve events for. If no value is specified, all events are returned.
        StartTime:
          type: string
          format: date-time
          description: 'The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example:
            2017-03-30T07:03:49.555Z'
        EndTime:
          type: string
          format: date-time
          description: 'The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example:
            2017-03-30T07:03:49.555Z'
        Duration:
          type: integer
          description: The number of minutes worth of events to retrieve.
        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.
    DescribeEventsResponse:
      type: object
      properties:
        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.
        Events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
          description: A list of events. Each element in the list contains detailed information about one event.
    Event:
      type: object
      properties:
        SourceName:
          type: string
          description: The name for the source of the event. For example, if the event occurred at the cluster level, the
            identifier would be the name of the cluster.
        SourceType:
          type: string
          enum:
          - node
          - parameter-group
          - subnet-group
          - cluster
          - user
          - acl
          description: Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
        Message:
          type: string
          description: The text of the event.
        Date:
          type: string
          format: date-time
          description: The date and time when the event occurred.
    InvalidParameterCombinationException:
      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)