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-tenant-database-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 Tenant Database API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Tenant Database
paths:
  /?Action=CreateTenantDatabase:
    post:
      operationId: CreateTenantDatabase
      summary: Create Tenant Database
      description: Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTenantDatabaseResult'
        '404':
          description: DBInstanceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBInstanceNotFoundFault'
        '400':
          description: InvalidDBInstanceStateFault; KMSKeyNotAccessibleFault; TenantDatabaseAlreadyExistsFault; TenantDatabaseQuotaExceededFault
          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: CreateTenantDatabase
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateTenantDatabaseMessage'
      tags:
      - Tenant Database
  /?Action=DeleteTenantDatabase:
    post:
      operationId: DeleteTenantDatabase
      summary: Delete Tenant Database
      description: Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances. You can't delete a tenant database when it is the only tenant in the DB instance.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTenantDatabaseResult'
        '404':
          description: DBInstanceNotFoundFault; TenantDatabaseNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBInstanceNotFoundFault'
        '400':
          description: DBSnapshotAlreadyExistsFault; InvalidDBInstanceStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBSnapshotAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTenantDatabase
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteTenantDatabaseMessage'
      tags:
      - Tenant Database
  /?Action=DescribeTenantDatabases:
    post:
      operationId: DescribeTenantDatabases
      summary: Describe Tenant Databases
      description: Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TenantDatabasesMessage'
        '404':
          description: DBInstanceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBInstanceNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTenantDatabases
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeTenantDatabasesMessage'
      tags:
      - Tenant Database
  /?Action=ModifyTenantDatabase:
    post:
      operationId: ModifyTenantDatabase
      summary: Modify Tenant Database
      description: Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyTenantDatabaseResult'
        '404':
          description: DBInstanceNotFoundFault; TenantDatabaseNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBInstanceNotFoundFault'
        '400':
          description: InvalidDBInstanceStateFault; KMSKeyNotAccessibleFault; TenantDatabaseAlreadyExistsFault
          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: ModifyTenantDatabase
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyTenantDatabaseMessage'
      tags:
      - Tenant Database
components:
  schemas:
    ModifyTenantDatabaseMessage:
      type: object
      properties:
        DBInstanceIdentifier:
          type: string
          description: 'The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn''t case-sensitive. Constraints: Must match the identifier of an existing DB instance.'
        TenantDBName:
          type: string
          description: 'The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive. Constraints: Must match the identifier of an existing tenant database.'
        MasterUserPassword:
          type: string
          description: 'The new password for the master user of the specified tenant database in your DB instance. Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked. Constraints: Can include any printable ASCII character except /, " (double quote), @, &amp; (ampersand), and '' (single quote). Length constraints: Must contain between 8 and 30 characters.'
        NewTenantDBName:
          type: string
          description: 'The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive. Constraints: Can''t be the string null or any other reserved word. Can''t be longer than 8 characters.'
        ManageMasterUserPassword:
          type: boolean
          description: Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the tenant database doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword. If the tenant database already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new pas
        RotateMasterUserPassword:
          type: boolean
          description: 'Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The secret value contains the updated password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: You must apply the change immediately when rotating the master user password.'
        MasterUserSecretKmsKeyId:
          type: string
          description: 'The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if both of the following conditions are met: The tenant database doesn''t manage the master user password in Amazon Web Services Secrets Manager. If the tenant database already manages the master user password in Amazon Web Services Secrets Manager, you can''t change the KMS key used to encrypt the secret. You''re turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If'
      required:
      - DBInstanceIdentifier
      - TenantDBName
    DescribeTenantDatabasesMessage:
      type: object
      properties:
        DBInstanceIdentifier:
          type: string
          description: The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.
        TenantDBName:
          type: string
          description: The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'A filter that specifies one or more database tenants to describe. Supported filters: tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. tenant-database-resource-id - Tenant database resource identifiers. dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.'
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        MaxRecords:
          type: integer
          description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
    InvalidDBInstanceStateFault:
      type: object
      properties:
        message:
          type: string
    TenantDatabase:
      type: object
      properties:
        TenantDatabaseCreateTime:
          type: string
          format: date-time
          description: The creation time of the tenant database.
        DBInstanceIdentifier:
          type: string
          description: The ID of the DB instance that contains the tenant database.
        TenantDBName:
          type: string
          description: The database name of the tenant database.
        Status:
          type: string
          description: The status of the tenant database.
        MasterUsername:
          type: string
          description: The master username of the tenant database.
        DbiResourceId:
          type: string
          description: The Amazon Web Services Region-unique, immutable identifier for the DB instance.
        TenantDatabaseResourceId:
          type: string
          description: The Amazon Web Services Region-unique, immutable identifier for the tenant database.
        TenantDatabaseARN:
          type: string
          description: The Amazon Resource Name (ARN) for the tenant database.
        CharacterSetName:
          type: string
          description: The character set of the tenant database.
        NcharCharacterSetName:
          type: string
          description: The NCHAR character set name of the tenant database.
        DeletionProtection:
          type: boolean
          description: Specifies whether deletion protection is enabled for the DB instance.
        PendingModifiedValues:
          $ref: '#/components/schemas/TenantDatabasePendingModifiedValues'
        MasterUserSecret:
          $ref: '#/components/schemas/MasterUserSecret'
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    TenantDatabasesMessage:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        TenantDatabases:
          type: array
          items:
            $ref: '#/components/schemas/TenantDatabase'
          description: An array of the tenant databases requested by the DescribeTenantDatabases operation.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can''t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
        Value:
          type: string
          description: 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can''t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
    CreateTenantDatabaseResult:
      type: object
      properties:
        TenantDatabase:
          $ref: '#/components/schemas/TenantDatabase'
    DBInstanceNotFoundFault:
      type: object
      properties:
        message:
          type: string
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: One or more filter values. Filter values are case-sensitive.
      required:
      - Name
      - Values
    CreateTenantDatabaseMessage:
      type: object
      properties:
        DBInstanceIdentifier:
          type: string
          description: The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.
        TenantDBName:
          type: string
          description: The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.
        MasterUsername:
          type: string
          description: 'The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive. Constraints: Must be 1 to 16 letters, numbers, or underscores. First character must be a letter. Can''t be a reserved word for the chosen database engine.'
        MasterUserPassword:
          type: string
          description: 'The password for the master user in your tenant database. Constraints: Must be 8 to 30 characters. Can include any printable ASCII character except forward slash (/), double quote ("), at symbol (@), ampersand (&amp;), or single quote (''). Can''t be specified when ManageMasterUserPassword is enabled.'
        CharacterSetName:
          type: string
          description: The character set for your tenant database. If you don't specify a value, the character set name defaults to AL32UTF8.
        NcharCharacterSetName:
          type: string
          description: The NCHAR value for the tenant database.
        ManageMasterUserPassword:
          type: boolean
          description: 'Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: Can''t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.'
        MasterUserSecretKmsKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
      required:
      - DBInstanceIdentifier
      - TenantDBName
      - MasterUsername
    TenantDatabasePendingModifiedValues:
      type: object
      properties:
        MasterUserPassword:
          type: string
          description: The master password for the tenant database.
        TenantDBName:
          type: string
          description: The name of the tenant database.
    DeleteTenantDatabaseMessage:
      type: object
      properties:
        DBInstanceIdentifier:
          type: string
          description: The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
        TenantDBName:
          type: string
          description: The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.
        SkipFinalSnapshot:
          type: boolean
          description: Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
        FinalDBSnapshotIdentifier:
          type: string
          description: The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
      required:
      - DBInstanceIdentifier
      - TenantDBName
    DBSnapshotAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    DeleteTenantDatabaseResult:
      type: object
      properties:
        TenantDatabase:
          $ref: '#/components/schemas/TenantDatabase'
    ModifyTenantDatabaseResult:
      type: object
      properties:
        TenantDatabase:
          $ref: '#/components/schemas/TenantDatabase'
    MasterUserSecret:
      type: object
      properties:
        SecretArn:
          type: string
          description: The Amazon Resource Name (ARN) of the secret.
        SecretStatus:
          type: string
          description: 'The status of the secret. The possible status values include the following: creating - The secret is being created. active - The secret is available for normal use and rotation. rotating - The secret is being rotated. impaired - The secret can be used to access database credentials, but it can''t be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off a'
        KmsKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier that is used to encrypt the secret.
  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)