NAME

Paws::ES - Perl Interface to AWS Amazon Elasticsearch Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ES');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions).

For the AWS API documentation, see https://docs.aws.amazon.com/elasticsearch-service/

METHODS

AddTags

ARN => Str
TagList => ArrayRef[Paws::ES::Tag]

Each argument is described in detail in: Paws::ES::AddTags

Returns: nothing

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information. (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging)

CancelElasticsearchServiceSoftwareUpdate

DomainName => Str

Each argument is described in detail in: Paws::ES::CancelElasticsearchServiceSoftwareUpdate

Returns: a Paws::ES::CancelElasticsearchServiceSoftwareUpdateResponse instance

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

CreateElasticsearchDomain

DomainName => Str
[AccessPolicies => Str]
[AdvancedOptions => Paws::ES::AdvancedOptions]
[CognitoOptions => Paws::ES::CognitoOptions]
[EBSOptions => Paws::ES::EBSOptions]
[ElasticsearchClusterConfig => Paws::ES::ElasticsearchClusterConfig]
[ElasticsearchVersion => Str]
[EncryptionAtRestOptions => Paws::ES::EncryptionAtRestOptions]
[LogPublishingOptions => Paws::ES::LogPublishingOptions]
[NodeToNodeEncryptionOptions => Paws::ES::NodeToNodeEncryptionOptions]
[SnapshotOptions => Paws::ES::SnapshotOptions]
[VPCOptions => Paws::ES::VPCOptions]

Each argument is described in detail in: Paws::ES::CreateElasticsearchDomain

Returns: a Paws::ES::CreateElasticsearchDomainResponse instance

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains) in the Amazon Elasticsearch Service Developer Guide.

DeleteElasticsearchDomain

DomainName => Str

Each argument is described in detail in: Paws::ES::DeleteElasticsearchDomain

Returns: a Paws::ES::DeleteElasticsearchDomainResponse instance

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

DeleteElasticsearchServiceRole

=>

Each argument is described in detail in: Paws::ES::DeleteElasticsearchServiceRole

Returns: nothing

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr) in VPC Endpoints for Amazon Elasticsearch Service Domains.

DescribeElasticsearchDomain

DomainName => Str

Each argument is described in detail in: Paws::ES::DescribeElasticsearchDomain

Returns: a Paws::ES::DescribeElasticsearchDomainResponse instance

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

DescribeElasticsearchDomainConfig

DomainName => Str

Each argument is described in detail in: Paws::ES::DescribeElasticsearchDomainConfig

Returns: a Paws::ES::DescribeElasticsearchDomainConfigResponse instance

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

DescribeElasticsearchDomains

DomainNames => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ES::DescribeElasticsearchDomains

Returns: a Paws::ES::DescribeElasticsearchDomainsResponse instance

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

DescribeElasticsearchInstanceTypeLimits

ElasticsearchVersion => Str
InstanceType => Str
[DomainName => Str]

Each argument is described in detail in: Paws::ES::DescribeElasticsearchInstanceTypeLimits

Returns: a Paws::ES::DescribeElasticsearchInstanceTypeLimitsResponse instance

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

DescribeReservedElasticsearchInstanceOfferings

[MaxResults => Int]
[NextToken => Str]
[ReservedElasticsearchInstanceOfferingId => Str]

Each argument is described in detail in: Paws::ES::DescribeReservedElasticsearchInstanceOfferings

Returns: a Paws::ES::DescribeReservedElasticsearchInstanceOfferingsResponse instance

Lists available reserved Elasticsearch instance offerings.

DescribeReservedElasticsearchInstances

[MaxResults => Int]
[NextToken => Str]
[ReservedElasticsearchInstanceId => Str]

Each argument is described in detail in: Paws::ES::DescribeReservedElasticsearchInstances

Returns: a Paws::ES::DescribeReservedElasticsearchInstancesResponse instance

Returns information about reserved Elasticsearch instances for this account.

GetCompatibleElasticsearchVersions

[DomainName => Str]

Each argument is described in detail in: Paws::ES::GetCompatibleElasticsearchVersions

Returns: a Paws::ES::GetCompatibleElasticsearchVersionsResponse instance

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

GetUpgradeHistory

DomainName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ES::GetUpgradeHistory

Returns: a Paws::ES::GetUpgradeHistoryResponse instance

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

GetUpgradeStatus

DomainName => Str

Each argument is described in detail in: Paws::ES::GetUpgradeStatus

Returns: a Paws::ES::GetUpgradeStatusResponse instance

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

ListDomainNames

=>

Each argument is described in detail in: Paws::ES::ListDomainNames

Returns: a Paws::ES::ListDomainNamesResponse instance

Returns the name of all Elasticsearch domains owned by the current user's account.

ListElasticsearchInstanceTypes

ElasticsearchVersion => Str
[DomainName => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ES::ListElasticsearchInstanceTypes

Returns: a Paws::ES::ListElasticsearchInstanceTypesResponse instance

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

ListElasticsearchVersions

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ES::ListElasticsearchVersions

Returns: a Paws::ES::ListElasticsearchVersionsResponse instance

List all supported Elasticsearch versions

ListTags

ARN => Str

Each argument is described in detail in: Paws::ES::ListTags

Returns: a Paws::ES::ListTagsResponse instance

Returns all tags for the given Elasticsearch domain.

PurchaseReservedElasticsearchInstanceOffering

ReservationName => Str
ReservedElasticsearchInstanceOfferingId => Str
[InstanceCount => Int]

Each argument is described in detail in: Paws::ES::PurchaseReservedElasticsearchInstanceOffering

Returns: a Paws::ES::PurchaseReservedElasticsearchInstanceOfferingResponse instance

Allows you to purchase reserved Elasticsearch instances.

RemoveTags

ARN => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ES::RemoveTags

Returns: nothing

Removes the specified set of tags from the specified Elasticsearch domain.

StartElasticsearchServiceSoftwareUpdate

DomainName => Str

Each argument is described in detail in: Paws::ES::StartElasticsearchServiceSoftwareUpdate

Returns: a Paws::ES::StartElasticsearchServiceSoftwareUpdateResponse instance

Schedules a service software update for an Amazon ES domain.

UpdateElasticsearchDomainConfig

DomainName => Str
[AccessPolicies => Str]
[AdvancedOptions => Paws::ES::AdvancedOptions]
[CognitoOptions => Paws::ES::CognitoOptions]
[EBSOptions => Paws::ES::EBSOptions]
[ElasticsearchClusterConfig => Paws::ES::ElasticsearchClusterConfig]
[LogPublishingOptions => Paws::ES::LogPublishingOptions]
[SnapshotOptions => Paws::ES::SnapshotOptions]
[VPCOptions => Paws::ES::VPCOptions]

Each argument is described in detail in: Paws::ES::UpdateElasticsearchDomainConfig

Returns: a Paws::ES::UpdateElasticsearchDomainConfigResponse instance

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

UpgradeElasticsearchDomain

DomainName => Str
TargetVersion => Str
[PerformCheckOnly => Bool]

Each argument is described in detail in: Paws::ES::UpgradeElasticsearchDomain

Returns: a Paws::ES::UpgradeElasticsearchDomainResponse instance

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllReservedElasticsearchInstanceOfferings(sub { },[MaxResults => Int, NextToken => Str, ReservedElasticsearchInstanceOfferingId => Str])

DescribeAllReservedElasticsearchInstanceOfferings([MaxResults => Int, NextToken => Str, ReservedElasticsearchInstanceOfferingId => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ReservedElasticsearchInstanceOfferings, passing the object as the first parameter, and the string 'ReservedElasticsearchInstanceOfferings' as the second parameter 

If not, it will return a a Paws::ES::DescribeReservedElasticsearchInstanceOfferingsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllReservedElasticsearchInstances(sub { },[MaxResults => Int, NextToken => Str, ReservedElasticsearchInstanceId => Str])

DescribeAllReservedElasticsearchInstances([MaxResults => Int, NextToken => Str, ReservedElasticsearchInstanceId => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ReservedElasticsearchInstances, passing the object as the first parameter, and the string 'ReservedElasticsearchInstances' as the second parameter 

If not, it will return a a Paws::ES::DescribeReservedElasticsearchInstancesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllUpgradeHistory(sub { },DomainName => Str, [MaxResults => Int, NextToken => Str])

GetAllUpgradeHistory(DomainName => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - UpgradeHistories, passing the object as the first parameter, and the string 'UpgradeHistories' as the second parameter 

If not, it will return a a Paws::ES::GetUpgradeHistoryResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllElasticsearchInstanceTypes(sub { },ElasticsearchVersion => Str, [DomainName => Str, MaxResults => Int, NextToken => Str])

ListAllElasticsearchInstanceTypes(ElasticsearchVersion => Str, [DomainName => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ElasticsearchInstanceTypes, passing the object as the first parameter, and the string 'ElasticsearchInstanceTypes' as the second parameter 

If not, it will return a a Paws::ES::ListElasticsearchInstanceTypesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllElasticsearchVersions(sub { },[MaxResults => Int, NextToken => Str])

ListAllElasticsearchVersions([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ElasticsearchVersions, passing the object as the first parameter, and the string 'ElasticsearchVersions' as the second parameter 

If not, it will return a a Paws::ES::ListElasticsearchVersionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues