Amazon Elasticsearch Service

2018/05/07 - Amazon Elasticsearch Service - 3 new api methods

Changes  Update es client to latest version

DescribeReservedElasticsearchInstanceOfferings (new) Link ¶

Lists available reserved Elasticsearch instance offerings.

See also: AWS API Documentation

Request Syntax

client.describe_reserved_elasticsearch_instance_offerings(
    ReservedElasticsearchInstanceOfferingId='string',
    MaxResults=123,
    NextToken='string'
)
type ReservedElasticsearchInstanceOfferingId:

string

param ReservedElasticsearchInstanceOfferingId:

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

type MaxResults:

integer

param MaxResults:

Set this value to limit the number of results returned. If not specified, defaults to 100.

type NextToken:

string

param NextToken:

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    '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'|'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

    • NextToken (string) --

      Provides an identifier to allow retrieval of paginated results.

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

PurchaseReservedElasticsearchInstanceOffering (new) Link ¶

Allows you to purchase reserved Elasticsearch instances.

See also: AWS API Documentation

Request Syntax

client.purchase_reserved_elasticsearch_instance_offering(
    ReservedElasticsearchInstanceOfferingId='string',
    ReservationName='string',
    InstanceCount=123
)
type ReservedElasticsearchInstanceOfferingId:

string

param ReservedElasticsearchInstanceOfferingId:

[REQUIRED]

The ID of the reserved Elasticsearch instance offering to purchase.

type ReservationName:

string

param ReservationName:

[REQUIRED]

A customer-specified identifier to track this reservation.

type InstanceCount:

integer

param InstanceCount:

The number of Elasticsearch instances to reserve.

rtype:

dict

returns:

Response Syntax

{
    'ReservedElasticsearchInstanceId': 'string',
    'ReservationName': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

    • ReservedElasticsearchInstanceId (string) --

      Details of the reserved Elasticsearch instance which was purchased.

    • ReservationName (string) --

      The customer-specified identifier used to track this reservation.

DescribeReservedElasticsearchInstances (new) Link ¶

Returns information about reserved Elasticsearch instances for this account.

See also: AWS API Documentation

Request Syntax

client.describe_reserved_elasticsearch_instances(
    ReservedElasticsearchInstanceId='string',
    MaxResults=123,
    NextToken='string'
)
type ReservedElasticsearchInstanceId:

string

param ReservedElasticsearchInstanceId:

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

type MaxResults:

integer

param MaxResults:

Set this value to limit the number of results returned. If not specified, defaults to 100.

type NextToken:

string

param NextToken:

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'ReservedElasticsearchInstances': [
        {
            'ReservationName': 'string',
            'ReservedElasticsearchInstanceId': 'string',
            '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'|'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',
            'StartTime': datetime(2015, 1, 1),
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'ElasticsearchInstanceCount': 123,
            'State': 'string',
            'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Container for results from DescribeReservedElasticsearchInstances

    • NextToken (string) --

      Provides an identifier to allow retrieval of paginated results.

    • ReservedElasticsearchInstances (list) --

      List of reserved Elasticsearch instances.

      • (dict) --

        Details of a reserved Elasticsearch instance.

        • ReservationName (string) --

          The customer-specified identifier to track this reservation.

        • ReservedElasticsearchInstanceId (string) --

          The unique identifier for the reservation.

        • ReservedElasticsearchInstanceOfferingId (string) --

          The offering identifier.

        • ElasticsearchInstanceType (string) --

          The Elasticsearch instance type offered by the reserved instance offering.

        • StartTime (datetime) --

          The time the reservation started.

        • Duration (integer) --

          The duration, in seconds, for which the Elasticsearch instance is reserved.

        • FixedPrice (float) --

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

        • UsagePrice (float) --

          The rate you are charged for each hour for the domain that is using this reserved instance.

        • CurrencyCode (string) --

          The currency code for the reserved Elasticsearch instance offering.

        • ElasticsearchInstanceCount (integer) --

          The number of Elasticsearch instances that have been reserved.

        • State (string) --

          The state of the reserved Elasticsearch instance.

        • PaymentOption (string) --

          The payment option as defined in 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.