Commitments

List EC2 Reserved Instances#

GET /api/organizations/{organization_id}/commitments/ec2

Your EC2 Reserved Instances. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier for the reserved instance.
    • type (string): EC2 instance type.
    • region (string): AWS region where the instances are reserved. One of 33 values, like us-east-1.
    • count (number): Number of reserved instances.
    • platform (string): Operating system platform.
    • start_time (string): Start date of the reservation (ISO 8601).
    • end_time (string): Expiration date of the reservation (ISO 8601).
    • duration (number): Length of the reservation period in months.
    • state (string): Current state of the reservation. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.
    • payment_option (string): Payment structure.
    • offering_class (string): Offering class type. One of convertible, standard.
    • commitment_price (number): Monthly cost with the reservation, per reserved instance.
    • on_demand_price (number): What one reserved instance would cost a month at the on-demand list price, not based on usage.
    • savings (number): Expected monthly savings for the whole reservation: (on_demand_price - commitment_price) x count.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List RDS Reserved Instances#

GET /api/organizations/{organization_id}/commitments/rds

Your RDS Reserved Instances. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier for the reserved instance.
    • type (string): RDS instance type.
    • platform (string): Database engine type.
    • region (string): AWS region where the instances are reserved. One of 33 values, like us-east-1.
    • count (number): Number of reserved instances.
    • multi_az (boolean): Whether Multi-AZ deployment is enabled.
    • start_time (string): Start date of the reservation (ISO 8601).
    • end_time (string): Expiration date of the reservation (ISO 8601).
    • duration (number): Length of the reservation period in months.
    • state (string): Current state of the reservation. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.
    • payment_option (string): Payment structure.
    • commitment_price (number): Monthly cost with the reservation, per reserved instance.
    • on_demand_price (number): What one reserved instance would cost a month at the on-demand list price, not based on usage.
    • savings (number): Expected monthly savings for the whole reservation: (on_demand_price - commitment_price) x count.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List ElastiCache Reserved Instances#

GET /api/organizations/{organization_id}/commitments/elasticache

Your ElastiCache Reserved Instances. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier for the reserved instance.
    • type (string): Cache node instance type.
    • platform (string): Cache engine type (e.g., redis, memcached, valkey).
    • region (string): AWS region where the instances are reserved. One of 33 values, like us-east-1.
    • count (number): Number of reserved instances.
    • start_time (string): Start date of the reservation (ISO 8601).
    • end_time (string): Expiration date of the reservation (ISO 8601).
    • duration (number): Length of the reservation period in months.
    • state (string): Current state of the reservation. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.
    • payment_option (string): Payment structure.
    • commitment_price (number): Monthly cost with the reservation, per reserved instance.
    • on_demand_price (number): What one reserved instance would cost a month at the on-demand list price, not based on usage.
    • savings (number): Expected monthly savings for the whole reservation: (on_demand_price - commitment_price) x count.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List OpenSearch Reserved Instances#

GET /api/organizations/{organization_id}/commitments/opensearch

Your OpenSearch Reserved Instances. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions. One of 33 values, like us-east-1.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier for the reserved instance.
    • type (string): OpenSearch instance type.
    • region (string): AWS region where the instances are reserved. One of 33 values, like us-east-1.
    • count (number): Number of reserved instances.
    • start_time (string): Start date of the reservation (ISO 8601).
    • end_time (string): Expiration date of the reservation (ISO 8601).
    • duration (number): Length of the reservation period in months.
    • state (string): Current state of the reservation. One of active, payment-failed, payment-pending, queued, queued-deleted, retired.
    • payment_option (string): Payment structure.
    • commitment_price (number): Monthly cost with the reservation, per reserved instance.
    • on_demand_price (number): What one reserved instance would cost a month at the on-demand list price, not based on usage.
    • savings (number): Expected monthly savings for the whole reservation: (on_demand_price - commitment_price) x count.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List Compute Savings Plans#

GET /api/organizations/{organization_id}/commitments/savings_plans/compute

Your Compute Savings Plans. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier assigned by AWS for this Savings Plan.
    • service (string): Savings Plan type. One of compute, database, ec2_instance, sage_maker.
    • region (string): AWS region, or "N/A" for region-agnostic Savings Plans.
    • family (string): EC2 instance family for EC2 Instance Savings Plans, or "N/A" for family-agnostic Savings Plans.
    • commitment (number): Hourly commitment amount in USD.
    • cost (number): Monthly cost calculated from hourly commitment (commitment x ~730 hours/month).
    • payment_option (string): Payment structure.
    • up_front_amount (string): One-time upfront payment amount, or "N/A" if no upfront payment applies.
    • recurring_amount (string): Recurring hourly charge amount, or "N/A" if fully paid upfront.
    • term_seconds (number or null): Contract term reported by AWS, in seconds.
    • start_time (string): Start date of the Savings Plan (ISO 8601).
    • end_time (string): Expiration date of the Savings Plan (ISO 8601).
    • state (string): Current state of the Savings Plan. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.
    • savings (number): Expected monthly savings assuming full utilization.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List EC2 Instance Savings Plans#

GET /api/organizations/{organization_id}/commitments/savings_plans/ec2_instance

Your EC2 Instance Savings Plans. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier assigned by AWS for this Savings Plan.
    • service (string): Savings Plan type. One of compute, database, ec2_instance, sage_maker.
    • region (string): AWS region, or "N/A" for region-agnostic Savings Plans.
    • family (string): EC2 instance family for EC2 Instance Savings Plans, or "N/A" for family-agnostic Savings Plans.
    • commitment (number): Hourly commitment amount in USD.
    • cost (number): Monthly cost calculated from hourly commitment (commitment x ~730 hours/month).
    • payment_option (string): Payment structure.
    • up_front_amount (string): One-time upfront payment amount, or "N/A" if no upfront payment applies.
    • recurring_amount (string): Recurring hourly charge amount, or "N/A" if fully paid upfront.
    • term_seconds (number or null): Contract term reported by AWS, in seconds.
    • start_time (string): Start date of the Savings Plan (ISO 8601).
    • end_time (string): Expiration date of the Savings Plan (ISO 8601).
    • state (string): Current state of the Savings Plan. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.
    • savings (number): Expected monthly savings assuming full utilization.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List SageMaker Savings Plans#

GET /api/organizations/{organization_id}/commitments/savings_plans/sage_maker

Your SageMaker Savings Plans. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier assigned by AWS for this Savings Plan.
    • service (string): Savings Plan type. One of compute, database, ec2_instance, sage_maker.
    • region (string): AWS region, or "N/A" for region-agnostic Savings Plans.
    • family (string): EC2 instance family for EC2 Instance Savings Plans, or "N/A" for family-agnostic Savings Plans.
    • commitment (number): Hourly commitment amount in USD.
    • cost (number): Monthly cost calculated from hourly commitment (commitment x ~730 hours/month).
    • payment_option (string): Payment structure.
    • up_front_amount (string): One-time upfront payment amount, or "N/A" if no upfront payment applies.
    • recurring_amount (string): Recurring hourly charge amount, or "N/A" if fully paid upfront.
    • term_seconds (number or null): Contract term reported by AWS, in seconds.
    • start_time (string): Start date of the Savings Plan (ISO 8601).
    • end_time (string): Expiration date of the Savings Plan (ISO 8601).
    • state (string): Current state of the Savings Plan. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.
    • savings (number): Expected monthly savings assuming full utilization.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.

List Database Savings Plans#

GET /api/organizations/{organization_id}/commitments/savings_plans/database

Your Database Savings Plans. Without a state filter, it returns the active, retired, and returned ones.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.
accountquerystring, repeatableOnly the records in these AWS accounts, by 12-digit account ID.
regionquerystring, repeatableOnly the records in these regions.
statequerystring, repeatableOnly the records in these states. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.

Response

  • summary (object): Totals for the matching records.

    • total (integer): How many commitments match.
    • active (integer): How many of them are active.
    • accounts (integer): How many accounts they span.

  • commitments (array of objects): The matching commitments.

    • id (string): Unique identifier assigned by AWS for this Savings Plan.
    • service (string): Savings Plan type. One of compute, database, ec2_instance, sage_maker.
    • region (string): AWS region, or "N/A" for region-agnostic Savings Plans.
    • family (string): EC2 instance family for EC2 Instance Savings Plans, or "N/A" for family-agnostic Savings Plans.
    • commitment (number): Hourly commitment amount in USD.
    • cost (number): Monthly cost calculated from hourly commitment (commitment x ~730 hours/month).
    • payment_option (string): Payment structure.
    • up_front_amount (string): One-time upfront payment amount, or "N/A" if no upfront payment applies.
    • recurring_amount (string): Recurring hourly charge amount, or "N/A" if fully paid upfront.
    • term_seconds (number or null): Contract term reported by AWS, in seconds.
    • start_time (string): Start date of the Savings Plan (ISO 8601).
    • end_time (string): Expiration date of the Savings Plan (ISO 8601).
    • state (string): Current state of the Savings Plan. One of active, payment-failed, payment-pending, pending-return, queued, queued-deleted, retired, returned.
    • savings (number): Expected monthly savings assuming full utilization.
    • managed_by (string): Who manages it: aws for a commitment you bought, milkstraw for one MilkStraw AI provides. One of aws, milkstraw.
    • utilization_percentage (number or null): How much of the commitment was used so far this month, from 0 to 100; null until AWS reports it, about 2 days late.
    • account_id (string): The 12-digit ID of the AWS account it belongs to.

Errors: 401, 403, 404, 422, 429. See errors.