Amazon RDS Rds Db Capacity Reservation API
The Rds Db Capacity Reservation API from Amazon RDS — 4 operation(s) for rds db capacity reservation.
The Rds Db Capacity Reservation API from Amazon RDS — 4 operation(s) for rds db capacity reservation.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-rds:amazon-rds-db-capacity-reservation-api"
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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon Relational Database Service Db Capacity Reservation…
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 Capacity Reservation
paths:
/?Action=CancelDBCapacityReservation:
post:
operationId: CancelDBCapacityReservation
summary: Cancel DBCapacity Reservation
description: 'Cancels a DB capacity reservation. Amazon RDS changes the state of the reservation to cancelled and stops reporting available capacity for it. Amazon RDS then releases the reserved capacity. A DB instance that uses the reservation keeps running. It continues on unreserved capacity, and Amazon RDS doesn''t stop it or modify it. However, Amazon RDS no longer reserves capacity for the DB instance. If Amazon RDS later moves the DB instance to different hardware, for example during hardware maintenance, that move can fail when the Amazon Web Services Region has insufficient capacity for the DB instance class. You can''t cancel a reservation in the active state during a capacity commitment. The response of DescribeDBCapacityReservations reports the end of the commitment in CommitmentInfo. Constraints: The reservation must be in the active, assessing, or delayed state. The reservation must not be past its end date.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelDBCapacityReservationResponse'
example:
DBCapacityReservation:
DBCapacityReservationName: my-mysql-reservation
DBCapacityReservationIdentifier: dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
DBCapacityReservationArn: arn:aws:rds:us-east-1:123456789012:db-capacity-reservation:dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
DBInstanceClass: db.m5.large
Engine: mysql
ReservedCapacityPerAvailabilityZone: 2
AvailableCapacityPerAvailabilityZoneList:
- AvailabilityZone: us-east-1a
AvailableCapacity: 0
- AvailabilityZone: us-east-1b
AvailableCapacity: 0
State: cancelled
CreateDate: '2026-09-10T18:22:41.612Z'
TagList: []
'404':
description: DBCapacityReservationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DBCapacityReservationNotFoundFault'
'400':
description: InvalidDBCapacityReservationStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidDBCapacityReservationStateFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CancelDBCapacityReservation
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/CancelDBCapacityReservationRequest'
example:
DBCapacityReservationIdentifier: dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
tags:
- Db Capacity Reservation
/?Action=CreateDBCapacityReservation:
post:
operationId: CreateDBCapacityReservation
summary: Create DBCapacity Reservation
description: 'Creates a DB capacity reservation. A DB capacity reservation reserves compute and memory capacity for DB instances of one DB instance class and one database engine. Amazon RDS reserves that capacity in each Availability Zone that you specify. Amazon RDS reserves the same amount of capacity in every Availability Zone in the request. You set that amount with CapacityPerAvailabilityZone, and you set the Availability Zones with AvailabilityZones. The total reserved capacity is CapacityPerAvailabilityZone multiplied by the number of Availability Zones. Specify StartDate and CommitmentDuration together to create a future-dated reservation. A future-dated reservation reserves capacity for a period that starts later. Amazon RDS holds that capacity for the length of the commitment. A future-dated reservation has the following additional constraints: DBInstanceClass must be a db.c, db.m, db.r, db.t, or db.x DB instance class. The letter after db. gives the DB instance class family. For example, db.x2g.xlarge qualifies, and db.z1d.xlarge doesn''t. If DBInstanceClass is a db.m or db.r DB instance class, it must be from generation 7 or later. The digit after the family letter gives the generatio'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateDBCapacityReservationResponse'
example:
DBCapacityReservation:
DBCapacityReservationName: my-mysql-reservation
DBCapacityReservationIdentifier: dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
DBCapacityReservationArn: arn:aws:rds:us-east-1:123456789012:db-capacity-reservation:dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
DBInstanceClass: db.m5.large
Engine: mysql
ReservedCapacityPerAvailabilityZone: 2
AvailableCapacityPerAvailabilityZoneList:
- AvailabilityZone: us-east-1a
AvailableCapacity: 2
- AvailabilityZone: us-east-1b
AvailableCapacity: 2
State: active
CreateDate: '2026-09-10T18:22:41.612Z'
TagList: []
'400':
description: DBCapacityReservationAlreadyExistsFault; DBCapacityReservationUnsupportedFault; InstanceQuotaExceededFault; InsufficientDBInstanceCapacityFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DBCapacityReservationAlreadyExistsFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateDBCapacityReservation
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/CreateDBCapacityReservationRequest'
example:
DBCapacityReservationName: my-mysql-reservation
DBInstanceClass: db.m5.large
Engine: mysql
CapacityPerAvailabilityZone: 2
AvailabilityZones:
- us-east-1a
- us-east-1b
tags:
- Db Capacity Reservation
/?Action=DescribeDBCapacityReservations:
post:
operationId: DescribeDBCapacityReservations
summary: Describe DBCapacity Reservations
description: Describes one or more DB capacity reservations. A DB capacity reservation reserves capacity for Amazon RDS DB instances in one or more Availability Zones. If you don't specify a DBCapacityReservationIdentifier, this operation returns information about all DB capacity reservations for your Amazon Web Services account. This operation supports pagination.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeDBCapacityReservationsResponse'
example:
DBCapacityReservations:
- DBCapacityReservationName: my-mysql-reservation
DBCapacityReservationIdentifier: dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
DBCapacityReservationArn: arn:aws:rds:us-east-1:123456789012:db-capacity-reservation:dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
DBInstanceClass: db.m5.large
Engine: mysql
ReservedCapacityPerAvailabilityZone: 2
AvailableCapacityPerAvailabilityZoneList:
- AvailabilityZone: us-east-1a
AvailableCapacity: 1
- AvailabilityZone: us-east-1b
AvailableCapacity: 2
State: active
CreateDate: '2026-09-10T18:22:41.612Z'
TagList: []
'404':
description: DBCapacityReservationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DBCapacityReservationNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeDBCapacityReservations
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/DescribeDBCapacityReservationsRequest'
example:
DBCapacityReservationIdentifier: dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
tags:
- Db Capacity Reservation
/?Action=ModifyDBCapacityReservation:
post:
operationId: ModifyDBCapacityReservation
summary: Modify DBCapacity Reservation
description: Modifies a DB capacity reservation. You can change the reserved capacity in each Availability Zone of the reservation, and you can change the end date of the reservation. You can't change the Availability Zones of an existing reservation. The reservation must be in the active state. A future-dated reservation that hasn't started isn't modifiable, and neither is a reservation that Amazon RDS is already modifying. You must specify CapacityPerAvailabilityZone, EndDateType, or EndDate. A request that specifies none of the three changes nothing, and Amazon RDS rejects it.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyDBCapacityReservationResponse'
'404':
description: DBCapacityReservationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DBCapacityReservationNotFoundFault'
'400':
description: InstanceQuotaExceededFault; InsufficientDBInstanceCapacityFault; InvalidDBCapacityReservationStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InstanceQuotaExceededFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ModifyDBCapacityReservation
Version:
type: string
const: '2014-10-31'
- $ref: '#/components/schemas/ModifyDBCapacityReservationRequest'
example:
DBCapacityReservationIdentifier: dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a
CapacityPerAvailabilityZone: 3
EndDateType: limited
EndDate: '2026-12-31T23:59:59Z'
tags:
- Db Capacity Reservation
components:
schemas:
AvailableCapacityPerAvailabilityZone:
type: object
properties:
AvailabilityZone:
type: string
description: The name of the Availability Zone.
AvailableCapacity:
type: integer
description: The number of DB instances that remain available in this Availability Zone. Amazon RDS decreases this value when a DB instance takes a unit of reserved capacity in this Availability Zone, and it increases this value when a DB instance releases that unit. A DB instance with a pending modification also holds a unit of reserved capacity. A DB instance has a pending modification when Amazon RDS accepts a change to the DB instance and applies that change later, during the maintenance window. Amazon RDS holds the unit from the time that it accepts the request. To find a DB instance with a pending mo
ModifyDBCapacityReservationRequest:
type: object
properties:
DBCapacityReservationIdentifier:
type: string
description: The identifier or the name of the DB capacity reservation to modify. You can specify the identifier, which has the prefix dbcr-, or the reservation name.
CapacityPerAvailabilityZone:
type: integer
description: 'The new number of DB instances to reserve in each Availability Zone of the reservation. Amazon RDS applies this number to every Availability Zone of the reservation. An increase reserves more capacity at the time of the request, so it can fail when the Amazon Web Services Region has insufficient capacity. This value multiplied by the number of Availability Zones counts against the DB instances quota for your Amazon Web Services account in the Amazon Web Services Region. Amazon RDS checks the quota only when you increase the value. Constraints: Minimum 1. Can''t be less than the highest number o'
EndDateType:
type: string
enum:
- unlimited
- limited
description: 'The end date type for the reservation. Valid Values: limited - The reservation has a specific end date. You must also specify EndDate. unlimited - The reservation doesn''t expire. Don''t specify EndDate.'
EndDate:
type: string
format: date-time
description: 'The new end date for the reservation, in Universal Coordinated Time (UTC). Required when EndDateType is limited. Don''t specify a value when EndDateType is unlimited. When you specify EndDate, you must also specify EndDateType. Constraints: Must be a date and time in the future. During a capacity commitment, must be at or after CommitmentEndDate.'
required:
- DBCapacityReservationIdentifier
DescribeDBCapacityReservationsResponse:
type: object
properties:
DBCapacityReservations:
type: array
items:
$ref: '#/components/schemas/DBCapacityReservation'
description: A list of DB capacity reservations.
Marker:
type: string
description: A pagination token that you can use in a later DescribeDBCapacityReservations request. If this value is returned, more records are available beyond this response.
ModifyDBCapacityReservationResponse:
type: object
properties:
DBCapacityReservation:
$ref: '#/components/schemas/DBCapacityReservation'
CancelDBCapacityReservationRequest:
type: object
properties:
DBCapacityReservationIdentifier:
type: string
description: The identifier or the name of the DB capacity reservation to cancel. You can specify the identifier, which has the prefix dbcr-, or the reservation name.
required:
- DBCapacityReservationIdentifier
CreateDBCapacityReservationRequest:
type: object
properties:
DBCapacityReservationName:
type: string
description: 'The name of the DB capacity reservation. This name must be unique for your Amazon Web Services account in the Amazon Web Services Region. Constraints: Must contain from 1 to 63 lowercase letters, digits, or hyphens. First character must be a lowercase letter. Can''t end with a hyphen or contain two consecutive hyphens. Can''t contain more than 16 groups of characters separated by hyphens. Can''t begin with dbcr-.'
DBInstanceClass:
type: string
description: 'The compute and memory capacity to reserve, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide. Constraints: Must be a DB instance class that the specified Engine supports. For RDS for Oracle with LicenseModel set to license-included, some DB instance classes aren''t supported. Either choose a supported DB instance class, or set LicenseModel to bring-your-own-license.'
Engine:
type: string
description: 'The database engine to reserve capacity for. Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres | mariadb | oracle-ee | oracle-ee-cdb | oracle-se2 | oracle-se2-cdb | sqlserver-ee | sqlserver-se | sqlserver-web | sqlserver-ex | sqlserver-dev-ee | sqlserver-dev-se | db2-ae | db2-ce | db2-se The Developer Edition engines sqlserver-dev-ee and sqlserver-dev-se support no Multi-AZ DB instance and no read replica. Therefore, a reservation for either engine serves Single-AZ DB instances only.'
CapacityPerAvailabilityZone:
type: integer
description: The number of DB instances to reserve in each Availability Zone that you list in AvailabilityZones. Amazon RDS reserves this number of DB instances in every listed Availability Zone. A Single-AZ DB instance uses one unit of reserved capacity, in one Availability Zone. A Multi-AZ DB instance is one DB instance, and it uses one unit of reserved capacity in each of two Availability Zones. Therefore, a Multi-AZ DB instance uses two units in total. A read replica uses one unit of reserved capacity, in the same way as any other DB instance. Amazon RDS reserves capacity in each Availability Zone sepa
AvailabilityZones:
type: array
items:
type: string
description: 'A list of Availability Zones for the reservation. You can''t change the Availability Zones of a reservation after you create it. Reserved capacity in an Availability Zone that no DB instance uses stays unused. Constraints: Must specify one or more Availability Zones. Each Availability Zone can appear only once. Each Availability Zone must be in the Amazon Web Services Region of the request. Each Availability Zone must have capacity for the requested DB instance class. Must include two or more Availability Zones to use the reservation for a Multi-AZ DB instance. A DB instance can use reserved ca'
EndDate:
type: string
format: date-time
description: 'The date and time when the reservation expires, in Universal Coordinated Time (UTC). If you don''t specify a value, the reservation doesn''t expire. To change the expiration of an existing reservation, use ModifyDBCapacityReservation. That operation takes EndDateType along with EndDate. Constraints: Must be a date and time in the future. For a future-dated reservation, must be at or after StartDate plus CommitmentDuration. For example, a reservation that starts on 2026-12-01 with a 30-day commitment can''t expire before 2026-12-31. To reserve capacity for one calendar month, set CommitmentDuratio'
StartDate:
type: string
format: date-time
description: 'The date and time when the reservation starts, in Universal Coordinated Time (UTC). Specify this parameter to create a future-dated reservation. If you don''t specify a value, the reservation starts immediately. A reservation that starts later always carries a capacity commitment. Therefore, a request that specifies StartDate must also meet every constraint of a future-dated reservation, including the minimum reserved capacity in each Availability Zone. Constraints: Must be from 5 to 120 days in the future. You must also specify CommitmentDuration. Example: 2026-12-01T00:00:00Z'
CommitmentDuration:
type: integer
description: 'The length of the capacity commitment that you request for a future-dated reservation, in seconds. Amazon RDS measures this length from StartDate. Amazon RDS can grant a shorter capacity commitment than you request. Therefore, read CommitmentEndDate in CommitmentInfo for the commitment that Amazon RDS granted. The commitment doesn''t end the reservation. Specify EndDate to set an expiration date. You can''t cancel a reservation in the active state during the commitment. Constraints: Minimum 1209600, which is 14 days. For a db.x DB instance class, such as db.x2g.xlarge, the minimum is 7257600, wh'
LicenseModel:
type: string
description: 'The license model to reserve capacity for. Specify this parameter only for RDS for Microsoft SQL Server Enterprise Edition, Standard Edition, and Developer Edition, for RDS for Oracle, or for RDS for Db2 Standard Edition and Advanced Edition. Amazon RDS rejects the request for any other engine. This includes Amazon Aurora, the Web and Express editions of RDS for Microsoft SQL Server, and RDS for Db2 Community Edition. Valid Values: RDS for Microsoft SQL Server Enterprise Edition and Standard Edition - license-included | bring-your-own-media RDS for Microsoft SQL Server Developer Edition - brin'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Tags to assign to the DB capacity reservation.
required:
- DBCapacityReservationName
- DBInstanceClass
- Engine
- CapacityPerAvailabilityZone
- AvailabilityZones
InstanceQuotaExceededFault:
type: object
properties:
message:
type: string
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}_.:/=+\\-@]*)$").'
DBCapacityReservationAlreadyExistsFault:
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
DBCapacityReservation:
type: object
properties:
DBCapacityReservationName:
type: string
description: The name that you specified for the DB capacity reservation.
DBInstanceClass:
type: string
description: The DB instance class for the reserved capacity. You specify this value when you create the reservation, and you can't change it afterward.
Engine:
type: string
description: The database engine for the reserved capacity. You specify this value when you create the reservation, and you can't change it afterward.
LicenseModel:
type: string
description: 'The license model for the reserved capacity. Amazon RDS returns this value only for a reservation that reserves capacity for a specific license model. Amazon RDS doesn''t return this value for a reservation whose database engine doesn''t support a license model. A DB instance launches into the reservation only when the license model of the DB instance matches this value. For a reservation that holds no license model, Amazon RDS applies no license model check at launch. Valid Values: RDS for Microsoft SQL Server Enterprise Edition and Standard Edition - license-included | bring-your-own-media RDS'
ReservedCapacityPerAvailabilityZone:
type: integer
description: The number of DB instances that Amazon RDS reserves in each Availability Zone of the reservation. This value matches the CapacityPerAvailabilityZone parameter of the request. The total reserved capacity is this value multiplied by the number of Availability Zones of the reservation.
AvailableCapacityPerAvailabilityZoneList:
type: array
items:
$ref: '#/components/schemas/AvailableCapacityPerAvailabilityZone'
description: 'The unused capacity of the reservation, reported for each Availability Zone of the reservation. Each entry names one Availability Zone, and it reports the number of DB instances that remain available in that Availability Zone. Amazon RDS reports available capacity only for a reservation that is in the active state and not past its end date. Otherwise, each entry reports an available capacity of 0. A future-dated reservation that hasn''t started reports 0, and a reservation that Amazon RDS is modifying reports 0. A reservation reports the pending state while Amazon RDS modifies it. Therefore, a '
EndDate:
type: string
format: date-time
description: The date and time when the reservation expires, in Universal Coordinated Time (UTC). Amazon RDS doesn't return this value if the reservation doesn't expire. A DB instance that uses the reservation keeps running after the reservation expires. It continues on unreserved capacity, and Amazon RDS doesn't stop it or modify it. However, Amazon RDS no longer reserves capacity for the DB instance. Amazon RDS might later move the DB instance to different hardware, for example during hardware maintenance. That move can fail when the Amazon Web Services Region has insufficient capacity for the DB instanc
CreateDate:
type: string
format: date-time
description: The date and time when the reservation was created, in Universal Coordinated Time (UTC).
StartDate:
type: string
format: date-time
description: The date and time when a future-dated reservation starts, in Universal Coordinated Time (UTC). Amazon RDS doesn't return this value for a reservation that started immediately.
CommitmentInfo:
$ref: '#/components/schemas/DBCapacityReservationCommitmentInfo'
State:
type: string
enum:
- active
- expired
- cancelled
- pending
- failed
- assessing
- scheduled
- delayed
- unsupported
description: 'The current state of the DB capacity reservation. A DB instance can use the reservation in the active state only. Valid Values: active - Amazon RDS holds the reserved capacity, and a DB instance can use it. pending - The reservation isn''t ready to use yet. Amazon RDS is creating the reserved capacity, or it is applying a requested modification. assessing - Amazon RDS is evaluating the request for a future-dated reservation. scheduled - Amazon RDS accepted a future-dated reservation, and the reservation is waiting for its start date. delayed - Amazon RDS couldn''t provide the reserved capacity o'
DBCapacityReservationArn:
type: string
description: The Amazon Resource Name (ARN) of the DB capacity reservation.
DBCapacityReservationIdentifier:
type: string
description: The unique identifier of the DB capacity reservation. The identifier has the prefix dbcr-. Every other DB capacity reservation operation takes this identifier.
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags associated with the DB capacity reservation.
CreateDBCapacityReservationResponse:
type: object
properties:
DBCapacityReservation:
$ref: '#/components/schemas/DBCapacityReservation'
DBCapacityReservationNotFoundFault:
type: object
properties:
message:
type: string
CancelDBCapacityReservationResponse:
type: object
properties:
DBCapacityReservation:
$ref: '#/components/schemas/DBCapacityReservation'
DescribeDBCapacityReservationsRequest:
type: object
properties:
DBCapacityReservationIdentifier:
type: string
description: The identifier or the name of the DB capacity reservation to describe. You can specify the identifier, which has the prefix dbcr-, or the reservation name.
Marker:
type: string
description: An optional pagination token provided by a previous DescribeDBCapacityReservations 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. Default: 100 Constraints: Must be a minimum of 20. Can''t exceed 100.'
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: 'A filter that specifies which DB capacity reservations to describe. Supported filters: db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request. state - Accepts reservation states. The response includes only the reservations in these states. engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines. db-instance-class - Accepts DB instance classes. The response includes only t'
DBCapacityReservationCommitmentInfo:
type: object
properties:
CommittedCapacityPerAvailabilityZone:
type: integer
description: The number of DB instances that Amazon RDS holds in each Availability Zone of the reservation for the length of the commitment.
CommitmentEndDate:
type: string
format: date-time
description: The date and time when the commitment ends, in Universal Coordinated Time (UTC). This date reports the capacity commitment that Amazon RDS granted. Amazon RDS can grant a shorter capacity commitment than you request in CommitmentDuration. Therefore, this date can fall earlier than StartDate plus CommitmentDuration.
InvalidDBCapacityReservationStateFault:
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: 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)