EC2 / Client / describe_reserved_instances_listings

describe_reserved_instances_listings#

EC2.Client.describe_reserved_instances_listings(**kwargs)#

Describes your account’s Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you’re searching for with what’s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.

Note

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_instances_listings(
    ReservedInstancesId='string',
    ReservedInstancesListingId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters:
  • ReservedInstancesId (string) – One or more Reserved Instance IDs.

  • ReservedInstancesListingId (string) – One or more Reserved Instance listing IDs.

  • Filters (list) –

    One or more filters.

    • reserved-instances-id - The ID of the Reserved Instances.

    • reserved-instances-listing-id - The ID of the Reserved Instances listing.

    • status - The status of the Reserved Instance listing ( pending | active | cancelled | closed).

    • status-message - The reason for the status.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

      For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

      • Name (string) –

        The name of the filter. Filter names are case-sensitive.

      • Values (list) –

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ReservedInstancesListings': [
        {
            'ClientToken': 'string',
            'CreateDate': datetime(2015, 1, 1),
            'InstanceCounts': [
                {
                    'InstanceCount': 123,
                    'State': 'available'|'sold'|'cancelled'|'pending'
                },
            ],
            'PriceSchedules': [
                {
                    'Active': True|False,
                    'CurrencyCode': 'USD',
                    'Price': 123.0,
                    'Term': 123
                },
            ],
            'ReservedInstancesId': 'string',
            'ReservedInstancesListingId': 'string',
            'Status': 'active'|'pending'|'cancelled'|'closed',
            'StatusMessage': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'UpdateDate': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    Contains the output of DescribeReservedInstancesListings.

    • ReservedInstancesListings (list) –

      Information about the Reserved Instance listing.

      • (dict) –

        Describes a Reserved Instance listing.

        • ClientToken (string) –

          A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

        • CreateDate (datetime) –

          The time the listing was created.

        • InstanceCounts (list) –

          The number of instances in this state.

          • (dict) –

            Describes a Reserved Instance listing state.

            • InstanceCount (integer) –

              The number of listed Reserved Instances in the state specified by the state.

            • State (string) –

              The states of the listed Reserved Instances.

        • PriceSchedules (list) –

          The price of the Reserved Instance listing.

          • (dict) –

            Describes the price for a Reserved Instance.

            • Active (boolean) –

              The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

              A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

            • CurrencyCode (string) –

              The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

            • Price (float) –

              The fixed price for the term.

            • Term (integer) –

              The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

        • ReservedInstancesId (string) –

          The ID of the Reserved Instance.

        • ReservedInstancesListingId (string) –

          The ID of the Reserved Instance listing.

        • Status (string) –

          The status of the Reserved Instance listing.

        • StatusMessage (string) –

          The reason for the current status of the Reserved Instance listing. The response can be blank.

        • Tags (list) –

          Any tags assigned to the resource.

          • (dict) –

            Describes a tag.

            • Key (string) –

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) –

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

        • UpdateDate (datetime) –

          The last modified timestamp of the listing.