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-db-shard-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 Relational Database Service Db Shard Group 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: Db Shard Group
paths:
  /?Action=CreateDBShardGroup:
    post:
      operationId: CreateDBShardGroup
      summary: Create DBShard Group
      description: 'Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB clusters only'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBShardGroup'
        '404':
          description: DBClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
        '400':
          description: DBShardGroupAlreadyExistsFault; InvalidDBClusterStateFault; InvalidVPCNetworkStateFault; MaxDBShardGroupLimitReached; NetworkTypeNotSupported; UnsupportedDBEngineVersionFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBShardGroupAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDBShardGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBShardGroupMessage'
      tags:
      - Db Shard Group
  /?Action=DeleteDBShardGroup:
    post:
      operationId: DeleteDBShardGroup
      summary: Delete DBShard Group
      description: Deletes an Aurora Limitless Database DB shard group.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBShardGroup'
        '404':
          description: DBShardGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBShardGroupNotFoundFault'
        '400':
          description: InvalidDBClusterStateFault; InvalidDBShardGroupStateFault
          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: DeleteDBShardGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBShardGroupMessage'
      tags:
      - Db Shard Group
  /?Action=DescribeDBShardGroups:
    post:
      operationId: DescribeDBShardGroups
      summary: Describe DBShard Groups
      description: Describes existing Aurora Limitless Database DB shard groups.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeDBShardGroupsResponse'
        '404':
          description: DBClusterNotFoundFault; DBShardGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDBShardGroups
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBShardGroupsMessage'
      tags:
      - Db Shard Group
  /?Action=ModifyDBShardGroup:
    post:
      operationId: ModifyDBShardGroup
      summary: Modify DBShard Group
      description: Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBShardGroup'
        '400':
          description: DBShardGroupAlreadyExistsFault; InvalidDBClusterStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBShardGroupAlreadyExistsFault'
        '404':
          description: DBShardGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBShardGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyDBShardGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyDBShardGroupMessage'
      tags:
      - Db Shard Group
components:
  schemas:
    DBShardGroup:
      type: object
      properties:
        DBShardGroupResourceId:
          type: string
          description: The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
        DBShardGroupIdentifier:
          type: string
          description: The name of the DB shard group.
        DBClusterIdentifier:
          type: string
          description: The name of the primary DB cluster for the DB shard group.
        MaxACU:
          type: number
          description: The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
        MinACU:
          type: number
          description: The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
        ComputeRedundancy:
          type: integer
          description: 'Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following: 0 - Creates a DB shard group without a standby DB shard group. This is the default value. 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.'
        Status:
          type: string
          description: The status of the DB shard group.
        PubliclyAccessible:
          type: boolean
          description: Indicates whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group w
        Endpoint:
          type: string
          description: The connection endpoint for the DB shard group.
        DBShardGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB shard group.
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    InvalidDBClusterStateFault:
      type: object
      properties:
        message:
          type: string
    DeleteDBShardGroupMessage:
      type: object
      properties:
        DBShardGroupIdentifier:
          type: string
          description: The name of the DB shard group to delete.
      required:
      - DBShardGroupIdentifier
    DescribeDBShardGroupsResponse:
      type: object
      properties:
        DBShardGroups:
          type: array
          items:
            $ref: '#/components/schemas/DBShardGroup'
          description: Contains a list of DB shard groups for the user.
        Marker:
          type: string
          description: A pagination token that can be used in a later DescribeDBClusters request.
    DescribeDBShardGroupsMessage:
      type: object
      properties:
        DBShardGroupIdentifier:
          type: string
          description: 'The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn''t case-sensitive. Constraints: If supplied, must match an existing DB shard group identifier.'
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: A filter that specifies one or more DB shard groups to describe.
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeDBShardGroups 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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100'
    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}_.:/=+\\-@]*)$").'
    CreateDBShardGroupMessage:
      type: object
      properties:
        DBShardGroupIdentifier:
          type: string
          description: The name of the DB shard group.
        DBClusterIdentifier:
          type: string
          description: The name of the primary DB cluster for the DB shard group.
        ComputeRedundancy:
          type: integer
          description: 'Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following: 0 - Creates a DB shard group without a standby DB data access shard. This is the default value. 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ). 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.'
        MaxACU:
          type: number
          description: The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
        MinACU:
          type: number
          description: The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
        PubliclyAccessible:
          type: boolean
          description: 'Specifies whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group''s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group''s VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn''t permit it. When the DB shard group isn''t publicly accessible, it is an internal DB shard group '
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
      required:
      - DBShardGroupIdentifier
      - DBClusterIdentifier
      - MaxACU
    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
    DBShardGroupAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    DBShardGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ModifyDBShardGroupMessage:
      type: object
      properties:
        DBShardGroupIdentifier:
          type: string
          description: The name of the DB shard group to modify.
        MaxACU:
          type: number
          description: The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
        MinACU:
          type: number
          description: The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
        ComputeRedundancy:
          type: integer
          description: 'Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following: 0 - Creates a DB shard group without a standby DB shard group. This is the default value. 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.'
      required:
      - DBShardGroupIdentifier
  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)