ElasticsearchService / Paginator / DescribeReservedElasticsearchInstanceOfferings

DescribeReservedElasticsearchInstanceOfferings

class ElasticsearchService.Paginator.DescribeReservedElasticsearchInstanceOfferings

paginator = client.get_paginator('describe_reserved_elasticsearch_instance_offerings')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ElasticsearchService.Client.describe_reserved_elasticsearch_instance_offerings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReservedElasticsearchInstanceOfferingId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ReservedElasticsearchInstanceOfferingId (string) – The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

• 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

{
    'ReservedElasticsearchInstanceOfferings': [
        {
            'ReservedElasticsearchInstanceOfferingId': 'string',
            'ElasticsearchInstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  Container for results from DescribeReservedElasticsearchInstanceOfferings

  • ReservedElasticsearchInstanceOfferings (list) –

    List of reserved Elasticsearch instance offerings

    • (dict) –

      Details of a reserved Elasticsearch instance offering.

      • ReservedElasticsearchInstanceOfferingId (string) –

        The Elasticsearch reserved instance offering identifier.

      • ElasticsearchInstanceType (string) –

        The Elasticsearch instance type offered by the reserved instance offering.

      • Duration (integer) –

        The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

      • FixedPrice (float) –

        The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

      • UsagePrice (float) –

        The rate you are charged for each hour the domain that is using the offering is running.

      • CurrencyCode (string) –

        The currency code for the reserved Elasticsearch instance offering.

      • PaymentOption (string) –

        Payment option for the reserved Elasticsearch instance offering

      • RecurringCharges (list) –

        The charge to your account regardless of whether you are creating any domains using the instance offering.

        • (dict) –

          Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

          • RecurringChargeAmount (float) –

            The monetary amount of the recurring charge.

          • RecurringChargeFrequency (string) –

            The frequency of the recurring charge.