EC2 / Paginator / DescribeHostReservationOfferings

DescribeHostReservationOfferings

class EC2.Paginator.DescribeHostReservationOfferings

paginator = client.get_paginator('describe_host_reservation_offerings')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_host_reservation_offerings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxDuration=123,
    MinDuration=123,
    OfferingId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  The filters.

  • instance-family - The instance family of the offering (for example, m4).

  • payment-option - The payment option ( NoUpfront | PartialUpfront | AllUpfront).

  • (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.

    • 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) –

• MaxDuration (integer) – This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

• MinDuration (integer) – This is the minimum duration of the reservation you’d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

• OfferingId (string) – The ID of the reservation offering.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'OfferingSet': [
        {
            'CurrencyCode': 'USD',
            'Duration': 123,
            'HourlyPrice': 'string',
            'InstanceFamily': 'string',
            'OfferingId': 'string',
            'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
            'UpfrontPrice': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • OfferingSet (list) –

    Information about the offerings.

    • (dict) –

      Details about the Dedicated Host Reservation offering.

      • CurrencyCode (string) –

        The currency of the offering.

      • Duration (integer) –

        The duration of the offering (in seconds).

      • HourlyPrice (string) –

        The hourly price of the offering.

      • InstanceFamily (string) –

        The instance family of the offering.

      • OfferingId (string) –

        The ID of the offering.

      • PaymentOption (string) –

        The available payment option.

      • UpfrontPrice (string) –

        The upfront price of the offering. Does not apply to No Upfront offerings.