❤
npm
Sign UpSign In

@datafire/amazonaws_es

5.0.0 • Public • Published

@datafire/amazonaws_es

Client library for Amazon Elasticsearch Service

Installation and Usage

npm install --save @datafire/amazonaws_es
let amazonaws_es = require('@datafire/amazonaws_es').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_es.ListDomainNames({}).then(data => {
  console.log(data);
});

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.

Actions

ListDomainNames

amazonaws_es.ListDomainNames({}, context)

Input

  • input object

Output

CreateElasticsearchDomain

amazonaws_es.CreateElasticsearchDomain({
  "DomainName": ""
}, context)

Input

Output

DescribeElasticsearchDomains

amazonaws_es.DescribeElasticsearchDomains({
  "DomainNames": []
}, context)

Input

Output

DeleteElasticsearchDomain

amazonaws_es.DeleteElasticsearchDomain({
  "DomainName": ""
}, context)

Input

  • input object
    • DomainName required string

Output

DescribeElasticsearchDomain

amazonaws_es.DescribeElasticsearchDomain({
  "DomainName": ""
}, context)

Input

  • input object
    • DomainName required string

Output

DescribeElasticsearchDomainConfig

amazonaws_es.DescribeElasticsearchDomainConfig({
  "DomainName": ""
}, context)

Input

  • input object
    • DomainName required string

Output

UpdateElasticsearchDomainConfig

amazonaws_es.UpdateElasticsearchDomainConfig({
  "DomainName": ""
}, context)

Input

Output

DescribeElasticsearchInstanceTypeLimits

amazonaws_es.DescribeElasticsearchInstanceTypeLimits({
  "InstanceType": "",
  "ElasticsearchVersion": ""
}, context)

Input

  • input object
    • InstanceType required string
    • ElasticsearchVersion required string

Output

ListElasticsearchInstanceTypes

amazonaws_es.ListElasticsearchInstanceTypes({
  "ElasticsearchVersion": ""
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • ElasticsearchVersion required string

Output

DeleteElasticsearchServiceRole

amazonaws_es.DeleteElasticsearchServiceRole({}, context)

Input

  • input object

Output

Output schema unknown

ListElasticsearchVersions

amazonaws_es.ListElasticsearchVersions({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string

Output

AddTags

amazonaws_es.AddTags({
  "ARN": "",
  "TagList": []
}, context)

Input

  • input object

Output

Output schema unknown

RemoveTags

amazonaws_es.RemoveTags({
  "ARN": "",
  "TagKeys": []
}, context)

Input

Output

Output schema unknown

ListTags

amazonaws_es.ListTags({}, context)

Input

  • input object

Output

Definitions

ARN

  • ARN string: The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

AccessPoliciesStatus

  • AccessPoliciesStatus object: The configured access rules for the domain's document and search endpoints, and the current status of those rules.

AddTagsRequest

  • AddTagsRequest object: Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

AdditionalLimit

  • AdditionalLimit object: List of limits that are specific to a given InstanceType and for each of it's InstanceRole .

AdditionalLimitList

AdvancedOptions

  • AdvancedOptions array:

    Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

    • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
    • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

    For more information, see Configuring Advanced Options.

AdvancedOptionsStatus

  • AdvancedOptionsStatus object:

    Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

    • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
    • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

    For more information, see Configuring Advanced Options.

BaseException

  • BaseException object: An error occurred while processing the request.

Boolean

  • Boolean boolean

CloudWatchLogsLogGroupArn

  • CloudWatchLogsLogGroupArn string: ARN of the Cloudwatch log group to which log needs to be published.

CreateElasticsearchDomainRequest

CreateElasticsearchDomainResponse

  • CreateElasticsearchDomainResponse object: The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

DeleteElasticsearchDomainRequest

  • DeleteElasticsearchDomainRequest object: Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

DeleteElasticsearchDomainResponse

  • DeleteElasticsearchDomainResponse object: The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

DescribeElasticsearchDomainConfigRequest

  • DescribeElasticsearchDomainConfigRequest object: Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

DescribeElasticsearchDomainConfigResponse

  • DescribeElasticsearchDomainConfigResponse object: The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

DescribeElasticsearchDomainRequest

  • DescribeElasticsearchDomainRequest object: Container for the parameters to the DescribeElasticsearchDomain operation.

DescribeElasticsearchDomainResponse

  • DescribeElasticsearchDomainResponse object: The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

DescribeElasticsearchDomainsRequest

  • DescribeElasticsearchDomainsRequest object: Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

DescribeElasticsearchDomainsResponse

  • DescribeElasticsearchDomainsResponse object: The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

DescribeElasticsearchInstanceTypeLimitsRequest

  • DescribeElasticsearchInstanceTypeLimitsRequest object: Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

DescribeElasticsearchInstanceTypeLimitsResponse

  • DescribeElasticsearchInstanceTypeLimitsResponse object: Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.

DisabledOperationException

  • DisabledOperationException object: An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DomainId

  • DomainId string: Unique identifier for an Elasticsearch domain.

DomainInfo

DomainInfoList

  • DomainInfoList array: Contains the list of Elasticsearch domain information.

DomainName

  • DomainName string: The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

DomainNameList

  • DomainNameList array: A list of Elasticsearch domain names.

EBSOptions

EBSOptionsStatus

  • EBSOptionsStatus object: Status of the EBS options for the specified Elasticsearch domain.

ESPartitionInstanceType

  • ESPartitionInstanceType string (values: 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)

ElasticsearchClusterConfig

ElasticsearchClusterConfigStatus

  • ElasticsearchClusterConfigStatus object: Specifies the configuration status for the specified Elasticsearch domain.

ElasticsearchDomainConfig

ElasticsearchDomainStatus

ElasticsearchDomainStatusList

  • ElasticsearchDomainStatusList array: A list that contains the status of each requested Elasticsearch domain.

ElasticsearchInstanceTypeList

  • ElasticsearchInstanceTypeList array: List of instance types supported by Amazon Elasticsearch service.

ElasticsearchVersionList

ElasticsearchVersionStatus

  • ElasticsearchVersionStatus object: Status of the Elasticsearch version options for the specified Elasticsearch domain.

ElasticsearchVersionString

  • ElasticsearchVersionString string

EncryptionAtRestOptions

  • EncryptionAtRestOptions object: Specifies the Encryption At Rest Options.

EncryptionAtRestOptionsStatus

  • EncryptionAtRestOptionsStatus object: Status of the Encryption At Rest options for the specified Elasticsearch domain.

EndpointsMap

ErrorMessage

  • ErrorMessage string

InstanceCountLimits

  • InstanceCountLimits object: InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

InstanceLimits

  • InstanceLimits object: InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

InstanceRole

  • InstanceRole string

IntegerClass

  • IntegerClass integer

InternalException

  • InternalException object: The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

InvalidTypeException

  • InvalidTypeException object: An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

KmsKeyId

  • KmsKeyId string

LimitExceededException

  • LimitExceededException object: An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

LimitName

  • LimitName string

LimitValue

  • LimitValue string

LimitValueList

Limits

  • Limits object: Limits for given InstanceType and for each of it's role.
    Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

LimitsByRole

  • LimitsByRole array: Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:
    • Data: If the given InstanceType is used as Data node
    • Master: If the given InstanceType is used as Master node

ListDomainNamesResponse

  • ListDomainNamesResponse object: The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.

ListElasticsearchInstanceTypesRequest

  • ListElasticsearchInstanceTypesRequest object: Container for the parameters to the ListElasticsearchInstanceTypes operation.

ListElasticsearchInstanceTypesResponse

  • ListElasticsearchInstanceTypesResponse object: Container for the parameters returned by ListElasticsearchInstanceTypes operation.

ListElasticsearchVersionsRequest

  • ListElasticsearchVersionsRequest object:

    Container for the parameters to the ListElasticsearchVersions operation.

    Use MaxResults to control the maximum number of results to retrieve in a single call.

    Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

ListElasticsearchVersionsResponse

  • ListElasticsearchVersionsResponse object: Container for the parameters for response received from ListElasticsearchVersions operation.

ListTagsRequest

  • ListTagsRequest object: Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

ListTagsResponse

  • ListTagsResponse object: The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

LogPublishingOption

  • LogPublishingOption object: Log Publishing option that is set for given domain.
    Attributes and their details:
    • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
    • Enabled: Whether the log publishing for given log type is enabled or not

LogPublishingOptions

LogPublishingOptionsStatus

  • LogPublishingOptionsStatus object: The configured log publishing options for the domain and their current status.

LogType

  • LogType string (values: INDEX_SLOW_LOGS, SEARCH_SLOW_LOGS): Type of Log File, it can be one of the following:
    • INDEX_SLOW_LOGS: Index slow logs contains insert requests that took more time than configured index query log threshold to execute.
    • SEARCH_SLOW_LOGS: Search slow logs contains search queries that took more time than configured search query log threshold to execute.

MaxResults

  • MaxResults integer: Set this value to limit the number of results returned.

MaximumInstanceCount

  • MaximumInstanceCount integer: Maximum number of Instances that can be instantiated for given InstanceType.

MinimumInstanceCount

  • MinimumInstanceCount integer: Minimum number of Instances that can be instantiated for given InstanceType.

NextToken

  • NextToken string: Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

OptionState

  • OptionState string (values: RequiresIndexDocuments, Processing, Active):

    The state of a requested change. One of the following:

    • Processing: The request change is still in-process.
    • Active: The request change is processed and deployed to the Elasticsearch domain.

OptionStatus

PolicyDocument

  • PolicyDocument string: Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

RemoveTagsRequest

  • RemoveTagsRequest object: Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

ResourceAlreadyExistsException

  • ResourceAlreadyExistsException object: An exception for creating a resource that already exists. Gives http status code of 400.

ResourceNotFoundException

  • ResourceNotFoundException object: An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

ServiceUrl

  • ServiceUrl string: The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.

SnapshotOptions

  • SnapshotOptions object: Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

SnapshotOptionsStatus

StorageSubTypeName

  • StorageSubTypeName string: SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes
    1. standard
    2. gp2
    3. io1
    Refer VolumeType for more information regarding above EBS storage options.

StorageType

StorageTypeLimit

  • StorageTypeLimit object: Limits that are applicable for given storage type.

StorageTypeLimitList

StorageTypeList

StorageTypeName

  • StorageTypeName string: Type of the storage. List of available storage options:
    1. instance
      2. Inbuilt storage available for the given Instance
    2. ebs
      3. Elastic block storage that would be attached to the given Instance

String

  • String string

StringList

  • StringList array

Tag

  • Tag object: Specifies a key value pair for a resource tag.

TagKey

  • TagKey string: A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

TagList

  • TagList array: A list of Tag

TagValue

  • TagValue string: A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.

UIntValue

  • UIntValue integer

UpdateElasticsearchDomainConfigRequest

UpdateElasticsearchDomainConfigResponse

  • UpdateElasticsearchDomainConfigResponse object: The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

UpdateTimestamp

  • UpdateTimestamp string

VPCDerivedInfo

VPCDerivedInfoStatus

  • VPCDerivedInfoStatus object: Status of the VPC options for the specified Elasticsearch domain.

VPCOptions

ValidationException

  • ValidationException object: An exception for missing / invalid input fields. Gives http status code of 400.

VolumeType

  • VolumeType string (values: standard, gp2, io1): The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_es

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

2

Version

5.0.0

License

MIT

Unpacked Size

126 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware