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-rds:amazon-rds-activity-stream-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 Relational Database Service Activity Stream API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 3 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Activity Stream
paths:
  /?Action=ModifyActivityStream:
    post:
      operationId: ModifyActivityStream
      summary: Modify Activity Stream
      description: Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide. This operation is supported for RDS for Oracle and Microsoft SQL Server.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyActivityStreamResponse'
        '404':
          description: DBInstanceNotFoundFault; ResourceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBInstanceNotFoundFault'
        '400':
          description: InvalidDBInstanceStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBInstanceStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyActivityStream
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyActivityStreamRequest'
      tags:
      - Activity Stream
  /?Action=StartActivityStream:
    post:
      operationId: StartActivityStream
      summary: Start Activity Stream
      description: Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StartActivityStreamResponse'
              example:
                KmsKeyId: arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1
                KinesisStreamName: aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S
                Status: starting
                Mode: async
                ApplyImmediately: true
        '404':
          description: DBClusterNotFoundFault; DBInstanceNotFoundFault; ResourceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '400':
          description: InvalidDBClusterStateFault; InvalidDBInstanceStateFault; KMSKeyNotAccessibleFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBClusterStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: StartActivityStream
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/StartActivityStreamRequest'
            example:
              ResourceArn: arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster
              Mode: async
              KmsKeyId: arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1
              ApplyImmediately: true
      tags:
      - Activity Stream
  /?Action=StopActivityStream:
    post:
      operationId: StopActivityStream
      summary: Stop Activity Stream
      description: Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StopActivityStreamResponse'
              example:
                KmsKeyId: arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1
                KinesisStreamName: aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S
                Status: stopping
        '404':
          description: DBClusterNotFoundFault; DBInstanceNotFoundFault; ResourceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '400':
          description: InvalidDBClusterStateFault; InvalidDBInstanceStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBClusterStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: StopActivityStream
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/StopActivityStreamRequest'
            example:
              ResourceArn: arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster
              ApplyImmediately: true
      tags:
      - Activity Stream
components:
  schemas:
    InvalidDBInstanceStateFault:
      type: object
      properties:
        message:
          type: string
    StartActivityStreamRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
        Mode:
          type: string
          enum:
          - sync
          - async
          description: Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
        KmsKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
        ApplyImmediately:
          type: boolean
          description: Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
        EngineNativeAuditFieldsIncluded:
          type: boolean
          description: Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
      required:
      - ResourceArn
      - Mode
      - KmsKeyId
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    InvalidDBClusterStateFault:
      type: object
      properties:
        message:
          type: string
    StartActivityStreamResponse:
      type: object
      properties:
        KmsKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
        KinesisStreamName:
          type: string
          description: The name of the Amazon Kinesis data stream to be used for the database activity stream.
        Status:
          type: string
          enum:
          - stopped
          - starting
          - started
          - stopping
          description: The status of the database activity stream.
        Mode:
          type: string
          enum:
          - sync
          - async
          description: The mode of the database activity stream.
        EngineNativeAuditFieldsIncluded:
          type: boolean
          description: Indicates whether engine-native audit fields are included in the database activity stream.
        ApplyImmediately:
          type: boolean
          description: Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
    DBInstanceNotFoundFault:
      type: object
      properties:
        message:
          type: string
    StopActivityStreamResponse:
      type: object
      properties:
        KmsKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
        KinesisStreamName:
          type: string
          description: The name of the Amazon Kinesis data stream used for the database activity stream.
        Status:
          type: string
          enum:
          - stopped
          - starting
          - started
          - stopping
          description: The status of the database activity stream.
    ModifyActivityStreamRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.
        AuditPolicyState:
          type: string
          enum:
          - locked
          - unlocked
          description: The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
    StopActivityStreamRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
        ApplyImmediately:
          type: boolean
          description: Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
      required:
      - ResourceArn
    ModifyActivityStreamResponse:
      type: object
      properties:
        KmsKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
        KinesisStreamName:
          type: string
          description: The name of the Amazon Kinesis data stream to be used for the database activity stream.
        Status:
          type: string
          enum:
          - stopped
          - starting
          - started
          - stopping
          description: The status of the modification to the database activity stream.
        Mode:
          type: string
          enum:
          - sync
          - async
          description: The mode of the database activity stream.
        EngineNativeAuditFieldsIncluded:
          type: boolean
          description: Indicates whether engine-native audit fields are included in the database activity stream.
        PolicyStatus:
          type: string
          enum:
          - locked
          - unlocked
          - locking-policy
          - unlocking-policy
          description: The status of the modification to the policy state of the database activity stream.
  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: rds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/rds/service/2014-10-31/rds-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)