elasticsearchservice

package
v1.1.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 21, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package elasticsearchservice provides a client for Amazon Elasticsearch Service.

Index

Examples

Constants

View Source 
const (
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeM3MediumElasticsearch = "m3.medium.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeM3LargeElasticsearch = "m3.large.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeM3XlargeElasticsearch = "m3.xlarge.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeM32xlargeElasticsearch = "m3.2xlarge.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeT2MicroElasticsearch = "t2.micro.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeT2SmallElasticsearch = "t2.small.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeT2MediumElasticsearch = "t2.medium.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeR3LargeElasticsearch = "r3.large.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeR3XlargeElasticsearch = "r3.xlarge.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeR32xlargeElasticsearch = "r3.2xlarge.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeR34xlargeElasticsearch = "r3.4xlarge.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeR38xlargeElasticsearch = "r3.8xlarge.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeI2XlargeElasticsearch = "i2.xlarge.elasticsearch"
	// @enum ESPartitionInstanceType
	ESPartitionInstanceTypeI22xlargeElasticsearch = "i2.2xlarge.elasticsearch"
)
View Source 
const (
	// @enum OptionState
	OptionStateRequiresIndexDocuments = "RequiresIndexDocuments"
	// @enum OptionState
	OptionStateProcessing = "Processing"
	// @enum OptionState
	OptionStateActive = "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.

View Source 
const (
	// @enum VolumeType
	VolumeTypeStandard = "standard"
	// @enum VolumeType
	VolumeTypeGp2 = "gp2"
	// @enum VolumeType
	VolumeTypeIo1 = "io1"
)

The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs" target="_blank)for more information.

View Source 
const ServiceName = "es"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPoliciesStatus 

type AccessPoliciesStatus struct {

	// The access policy configured for the Elasticsearch domain. Access policies
	// may be resource-based, IP-based, or IAM-based. See  Configuring Access Policies
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies"
	// target="_blank)for more information.
	Options *string `type:"string" required:"true"`

	// The status of the access policy for the Elasticsearch domain. See OptionStatus
	// for the status information that's included.
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (AccessPoliciesStatus) GoString 

func (s AccessPoliciesStatus) GoString() string

GoString returns the string representation

func (AccessPoliciesStatus) String 

func (s AccessPoliciesStatus) String() string

String returns the string representation

type AddTagsInput 

type AddTagsInput struct {

	// Specify the ARN for which you want to add the tags.
	ARN *string `type:"string" required:"true"`

	// List of Tag that need to be added for the Elasticsearch domain.
	TagList []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (AddTagsInput) GoString 

func (s AddTagsInput) GoString() string

GoString returns the string representation

func (AddTagsInput) String 

func (s AddTagsInput) String() string

String returns the string representation

type AddTagsOutput 

type AddTagsOutput struct {
	// contains filtered or unexported fields
}

func (AddTagsOutput) GoString 

func (s AddTagsOutput) GoString() string

GoString returns the string representation

func (AddTagsOutput) String 

func (s AddTagsOutput) String() string

String returns the string representation

type AdvancedOptionsStatus 

type AdvancedOptionsStatus struct {

	// Specifies the status of advanced options for the specified Elasticsearch
	// domain.
	Options map[string]*string `type:"map" required:"true"`

	// Specifies the status of OptionStatus for advanced options for the specified
	// Elasticsearch domain.
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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 (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank) 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 (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options).

func (AdvancedOptionsStatus) GoString 

func (s AdvancedOptionsStatus) GoString() string

GoString returns the string representation

func (AdvancedOptionsStatus) String 

func (s AdvancedOptionsStatus) String() string

String returns the string representation

type CreateElasticsearchDomainInput 

type CreateElasticsearchDomainInput struct {

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string `type:"string"`

	// 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 (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options"
	// target="_blank) for more information.
	AdvancedOptions map[string]*string `type:"map"`

	// The name of the Elasticsearch domain that you are creating. Domain names
	// are unique across the domains owned by an account within an AWS region. Domain
	// names must start with a letter or number and can contain the following characters:
	// a-z (lowercase), 0-9, and - (hyphen).
	DomainName *string `min:"3" type:"string" required:"true"`

	// Options to enable, disable and specify the type and size of EBS storage volumes.
	EBSOptions *EBSOptions `type:"structure"`

	// Configuration options for an Elasticsearch domain. Specifies the instance
	// type and number of instances in the domain cluster.
	ElasticsearchClusterConfig *ElasticsearchClusterConfig `type:"structure"`

	// Option to set time, in UTC format, of the daily automated snapshot. Default
	// value is 0 hours.
	SnapshotOptions *SnapshotOptions `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateElasticsearchDomainInput) GoString 

func (s CreateElasticsearchDomainInput) GoString() string

GoString returns the string representation

func (CreateElasticsearchDomainInput) String 

func (s CreateElasticsearchDomainInput) String() string

String returns the string representation

type CreateElasticsearchDomainOutput 

type CreateElasticsearchDomainOutput struct {

	// The status of the newly created Elasticsearch domain.
	DomainStatus *ElasticsearchDomainStatus `type:"structure"`
	// contains filtered or unexported fields
}

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

func (CreateElasticsearchDomainOutput) GoString 

func (s CreateElasticsearchDomainOutput) GoString() string

GoString returns the string representation

func (CreateElasticsearchDomainOutput) String 

func (s CreateElasticsearchDomainOutput) String() string

String returns the string representation

type DeleteElasticsearchDomainInput 

type DeleteElasticsearchDomainInput struct {

	// The name of the Elasticsearch domain that you want to permanently delete.
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DeleteElasticsearchDomainInput) GoString 

func (s DeleteElasticsearchDomainInput) GoString() string

GoString returns the string representation

func (DeleteElasticsearchDomainInput) String 

func (s DeleteElasticsearchDomainInput) String() string

String returns the string representation

type DeleteElasticsearchDomainOutput 

type DeleteElasticsearchDomainOutput struct {

	// The status of the Elasticsearch domain being deleted.
	DomainStatus *ElasticsearchDomainStatus `type:"structure"`
	// contains filtered or unexported fields
}

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.

func (DeleteElasticsearchDomainOutput) GoString 

func (s DeleteElasticsearchDomainOutput) GoString() string

GoString returns the string representation

func (DeleteElasticsearchDomainOutput) String 

func (s DeleteElasticsearchDomainOutput) String() string

String returns the string representation

type DescribeElasticsearchDomainConfigInput 

type DescribeElasticsearchDomainConfigInput struct {

	// The Elasticsearch domain that you want to get information about.
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeElasticsearchDomainConfigInput) GoString 

func (s DescribeElasticsearchDomainConfigInput) GoString() string

GoString returns the string representation

func (DescribeElasticsearchDomainConfigInput) String 

func (s DescribeElasticsearchDomainConfigInput) String() string

String returns the string representation

type DescribeElasticsearchDomainConfigOutput 

type DescribeElasticsearchDomainConfigOutput struct {

	// The configuration information of the domain requested in the DescribeElasticsearchDomainConfig
	// request.
	DomainConfig *ElasticsearchDomainConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

func (DescribeElasticsearchDomainConfigOutput) GoString 

func (s DescribeElasticsearchDomainConfigOutput) GoString() string

GoString returns the string representation

func (DescribeElasticsearchDomainConfigOutput) String 

func (s DescribeElasticsearchDomainConfigOutput) String() string

String returns the string representation

type DescribeElasticsearchDomainInput 

type DescribeElasticsearchDomainInput struct {

	// The name of the Elasticsearch domain for which you want information.
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeElasticsearchDomain operation.

func (DescribeElasticsearchDomainInput) GoString 

func (s DescribeElasticsearchDomainInput) GoString() string

GoString returns the string representation

func (DescribeElasticsearchDomainInput) String 

func (s DescribeElasticsearchDomainInput) String() string

String returns the string representation

type DescribeElasticsearchDomainOutput 

type DescribeElasticsearchDomainOutput struct {

	// The current status of the Elasticsearch domain.
	DomainStatus *ElasticsearchDomainStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

func (DescribeElasticsearchDomainOutput) GoString 

func (s DescribeElasticsearchDomainOutput) GoString() string

GoString returns the string representation

func (DescribeElasticsearchDomainOutput) String 

func (s DescribeElasticsearchDomainOutput) String() string

String returns the string representation

type DescribeElasticsearchDomainsInput 

type DescribeElasticsearchDomainsInput struct {

	// The Elasticsearch domains for which you want information.
	DomainNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeElasticsearchDomainsInput) GoString 

func (s DescribeElasticsearchDomainsInput) GoString() string

GoString returns the string representation

func (DescribeElasticsearchDomainsInput) String 

func (s DescribeElasticsearchDomainsInput) String() string

String returns the string representation

type DescribeElasticsearchDomainsOutput 

type DescribeElasticsearchDomainsOutput struct {

	// The status of the domains requested in the DescribeElasticsearchDomains request.
	DomainStatusList []*ElasticsearchDomainStatus `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeElasticsearchDomainsOutput) GoString 

func (s DescribeElasticsearchDomainsOutput) GoString() string

GoString returns the string representation

func (DescribeElasticsearchDomainsOutput) String 

func (s DescribeElasticsearchDomainsOutput) String() string

String returns the string representation

type DomainInfo 

type DomainInfo struct {

	// Specifies the DomainName.
	DomainName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (DomainInfo) GoString 

func (s DomainInfo) GoString() string

GoString returns the string representation

func (DomainInfo) String 

func (s DomainInfo) String() string

String returns the string representation

type EBSOptions 

type EBSOptions struct {

	// Specifies whether EBS-based storage is enabled.
	EBSEnabled *bool `type:"boolean"`

	// Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
	Iops *int64 `type:"integer"`

	// Integer to specify the size of an EBS volume.
	VolumeSize *int64 `type:"integer"`

	// Specifies the volume type for EBS-based storage.
	VolumeType *string `type:"string" enum:"VolumeType"`
	// contains filtered or unexported fields
}

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs" target="_blank).

func (EBSOptions) GoString 

func (s EBSOptions) GoString() string

GoString returns the string representation

func (EBSOptions) String 

func (s EBSOptions) String() string

String returns the string representation

type EBSOptionsStatus 

type EBSOptionsStatus struct {

	// Specifies the EBS options for the specified Elasticsearch domain.
	Options *EBSOptions `type:"structure" required:"true"`

	// Specifies the status of the EBS options for the specified Elasticsearch domain.
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Status of the EBS options for the specified Elasticsearch domain.

func (EBSOptionsStatus) GoString 

func (s EBSOptionsStatus) GoString() string

GoString returns the string representation

func (EBSOptionsStatus) String 

func (s EBSOptionsStatus) String() string

String returns the string representation

type ElasticsearchClusterConfig 

type ElasticsearchClusterConfig struct {

	// Total number of dedicated master nodes, active and on standby, for the cluster.
	DedicatedMasterCount *int64 `type:"integer"`

	// A boolean value to indicate whether a dedicated master node is enabled. See
	// About Dedicated Master Nodes (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes"
	// target="_blank) for more information.
	DedicatedMasterEnabled *bool `type:"boolean"`

	// The instance type for a dedicated master node.
	DedicatedMasterType *string `type:"string" enum:"ESPartitionInstanceType"`

	// The number of instances in the specified domain cluster.
	InstanceCount *int64 `type:"integer"`

	// The instance type for an Elasticsearch cluster.
	InstanceType *string `type:"string" enum:"ESPartitionInstanceType"`

	// A boolean value to indicate whether zone awareness is enabled. See About
	// Zone Awareness (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness"
	// target="_blank) for more information.
	ZoneAwarenessEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the configuration for the domain cluster, such as the type and number of instances.

func (ElasticsearchClusterConfig) GoString 

func (s ElasticsearchClusterConfig) GoString() string

GoString returns the string representation

func (ElasticsearchClusterConfig) String 

func (s ElasticsearchClusterConfig) String() string

String returns the string representation

type ElasticsearchClusterConfigStatus 

type ElasticsearchClusterConfigStatus struct {

	// Specifies the cluster configuration for the specified Elasticsearch domain.
	Options *ElasticsearchClusterConfig `type:"structure" required:"true"`

	// Specifies the status of the configuration for the specified Elasticsearch
	// domain.
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration status for the specified Elasticsearch domain.

func (ElasticsearchClusterConfigStatus) GoString 

func (s ElasticsearchClusterConfigStatus) GoString() string

GoString returns the string representation

func (ElasticsearchClusterConfigStatus) String 

func (s ElasticsearchClusterConfigStatus) String() string

String returns the string representation

type ElasticsearchDomainConfig 

type ElasticsearchDomainConfig struct {

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *AccessPoliciesStatus `type:"structure"`

	// Specifies the AdvancedOptions for the domain. See Configuring Advanced Options
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options"
	// target="_blank) for more information.
	AdvancedOptions *AdvancedOptionsStatus `type:"structure"`

	// Specifies the EBSOptions for the Elasticsearch domain.
	EBSOptions *EBSOptionsStatus `type:"structure"`

	// Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
	ElasticsearchClusterConfig *ElasticsearchClusterConfigStatus `type:"structure"`

	// Specifies the SnapshotOptions for the Elasticsearch domain.
	SnapshotOptions *SnapshotOptionsStatus `type:"structure"`
	// contains filtered or unexported fields
}

The configuration of an Elasticsearch domain.

func (ElasticsearchDomainConfig) GoString 

func (s ElasticsearchDomainConfig) GoString() string

GoString returns the string representation

func (ElasticsearchDomainConfig) String 

func (s ElasticsearchDomainConfig) String() string

String returns the string representation

type ElasticsearchDomainStatus 

type ElasticsearchDomainStatus struct {

	// The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers
	// for IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html"
	// target="_blank) in Using AWS Identity and Access Management for more information.
	ARN *string `type:"string" required:"true"`

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string `type:"string"`

	// Specifies the status of the AdvancedOptions
	AdvancedOptions map[string]*string `type:"map"`

	// The domain creation status. True if the creation of an Elasticsearch domain
	// is complete. False if domain creation is still in progress.
	Created *bool `type:"boolean"`

	// The domain deletion status. True if a delete request has been received for
	// the domain but resource cleanup is still in progress. False if the domain
	// has not been deleted. Once domain deletion is complete, the status of the
	// domain is no longer returned.
	Deleted *bool `type:"boolean"`

	// The unique identifier for the specified Elasticsearch domain.
	DomainId *string `min:"1" type:"string" required:"true"`

	// 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).
	DomainName *string `min:"3" type:"string" required:"true"`

	// The EBSOptions for the specified domain. See Configuring EBS-based Storage
	// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs"
	// target="_blank) for more information.
	EBSOptions *EBSOptions `type:"structure"`

	// The type and number of instances in the domain cluster.
	ElasticsearchClusterConfig *ElasticsearchClusterConfig `type:"structure" required:"true"`

	// The Elasticsearch domain endpoint that you use to submit index and search
	// requests.
	Endpoint *string `type:"string"`

	// The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch
	// Service is processing configuration changes. False if the configuration is
	// active.
	Processing *bool `type:"boolean"`

	// Specifies the status of the SnapshotOptions
	SnapshotOptions *SnapshotOptions `type:"structure"`
	// contains filtered or unexported fields
}

The current status of an Elasticsearch domain.

func (ElasticsearchDomainStatus) GoString 

func (s ElasticsearchDomainStatus) GoString() string

GoString returns the string representation

func (ElasticsearchDomainStatus) String 

func (s ElasticsearchDomainStatus) String() string

String returns the string representation

type ElasticsearchService 

type ElasticsearchService struct {
	*client.Client
}

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#cloudsearch_region" target="_blank). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ElasticsearchService

New creates a new instance of the ElasticsearchService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a ElasticsearchService client from just a session.
svc := elasticsearchservice.New(mySession)

// Create a ElasticsearchService client with additional configuration
svc := elasticsearchservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ElasticsearchService) AddTags 

func (c *ElasticsearchService) AddTags(input *AddTagsInput) (*AddTagsOutput, error)

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" target="_blank)

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.AddTagsInput{
		ARN: aws.String("ARN"), // Required
		TagList: []*elasticsearchservice.Tag{ // Required
			{ // Required
				Key:   aws.String("TagKey"),   // Required
				Value: aws.String("TagValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.AddTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) AddTagsRequest 

func (c *ElasticsearchService) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput)

AddTagsRequest generates a request for the AddTags operation.

func (*ElasticsearchService) CreateElasticsearchDomain 

func (c *ElasticsearchService) CreateElasticsearchDomain(input *CreateElasticsearchDomainInput) (*CreateElasticsearchDomainOutput, error)

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" target="_blank) in the Amazon Elasticsearch Service Developer Guide.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.CreateElasticsearchDomainInput{
		DomainName:     aws.String("DomainName"), // Required
		AccessPolicies: aws.String("PolicyDocument"),
		AdvancedOptions: map[string]*string{
			"Key": aws.String("String"), // Required
			// More values...
		},
		EBSOptions: &elasticsearchservice.EBSOptions{
			EBSEnabled: aws.Bool(true),
			Iops:       aws.Int64(1),
			VolumeSize: aws.Int64(1),
			VolumeType: aws.String("VolumeType"),
		},
		ElasticsearchClusterConfig: &elasticsearchservice.ElasticsearchClusterConfig{
			DedicatedMasterCount:   aws.Int64(1),
			DedicatedMasterEnabled: aws.Bool(true),
			DedicatedMasterType:    aws.String("ESPartitionInstanceType"),
			InstanceCount:          aws.Int64(1),
			InstanceType:           aws.String("ESPartitionInstanceType"),
			ZoneAwarenessEnabled:   aws.Bool(true),
		},
		SnapshotOptions: &elasticsearchservice.SnapshotOptions{
			AutomatedSnapshotStartHour: aws.Int64(1),
		},
	}
	resp, err := svc.CreateElasticsearchDomain(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) CreateElasticsearchDomainRequest 

func (c *ElasticsearchService) CreateElasticsearchDomainRequest(input *CreateElasticsearchDomainInput) (req *request.Request, output *CreateElasticsearchDomainOutput)

CreateElasticsearchDomainRequest generates a request for the CreateElasticsearchDomain operation.

func (*ElasticsearchService) DeleteElasticsearchDomain 

func (c *ElasticsearchService) DeleteElasticsearchDomain(input *DeleteElasticsearchDomainInput) (*DeleteElasticsearchDomainOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.DeleteElasticsearchDomainInput{
		DomainName: aws.String("DomainName"), // Required
	}
	resp, err := svc.DeleteElasticsearchDomain(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) DeleteElasticsearchDomainRequest 

func (c *ElasticsearchService) DeleteElasticsearchDomainRequest(input *DeleteElasticsearchDomainInput) (req *request.Request, output *DeleteElasticsearchDomainOutput)

DeleteElasticsearchDomainRequest generates a request for the DeleteElasticsearchDomain operation.

func (*ElasticsearchService) DescribeElasticsearchDomain 

func (c *ElasticsearchService) DescribeElasticsearchDomain(input *DescribeElasticsearchDomainInput) (*DescribeElasticsearchDomainOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.DescribeElasticsearchDomainInput{
		DomainName: aws.String("DomainName"), // Required
	}
	resp, err := svc.DescribeElasticsearchDomain(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) DescribeElasticsearchDomainConfig 

func (c *ElasticsearchService) DescribeElasticsearchDomainConfig(input *DescribeElasticsearchDomainConfigInput) (*DescribeElasticsearchDomainConfigOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.DescribeElasticsearchDomainConfigInput{
		DomainName: aws.String("DomainName"), // Required
	}
	resp, err := svc.DescribeElasticsearchDomainConfig(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) DescribeElasticsearchDomainConfigRequest 

func (c *ElasticsearchService) DescribeElasticsearchDomainConfigRequest(input *DescribeElasticsearchDomainConfigInput) (req *request.Request, output *DescribeElasticsearchDomainConfigOutput)

DescribeElasticsearchDomainConfigRequest generates a request for the DescribeElasticsearchDomainConfig operation.

func (*ElasticsearchService) DescribeElasticsearchDomainRequest 

func (c *ElasticsearchService) DescribeElasticsearchDomainRequest(input *DescribeElasticsearchDomainInput) (req *request.Request, output *DescribeElasticsearchDomainOutput)

DescribeElasticsearchDomainRequest generates a request for the DescribeElasticsearchDomain operation.

func (*ElasticsearchService) DescribeElasticsearchDomains 

func (c *ElasticsearchService) DescribeElasticsearchDomains(input *DescribeElasticsearchDomainsInput) (*DescribeElasticsearchDomainsOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.DescribeElasticsearchDomainsInput{
		DomainNames: []*string{ // Required
			aws.String("DomainName"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeElasticsearchDomains(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) DescribeElasticsearchDomainsRequest 

func (c *ElasticsearchService) DescribeElasticsearchDomainsRequest(input *DescribeElasticsearchDomainsInput) (req *request.Request, output *DescribeElasticsearchDomainsOutput)

DescribeElasticsearchDomainsRequest generates a request for the DescribeElasticsearchDomains operation.

func (*ElasticsearchService) ListDomainNames 

func (c *ElasticsearchService) ListDomainNames(input *ListDomainNamesInput) (*ListDomainNamesOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	var params *elasticsearchservice.ListDomainNamesInput
	resp, err := svc.ListDomainNames(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) ListDomainNamesRequest 

func (c *ElasticsearchService) ListDomainNamesRequest(input *ListDomainNamesInput) (req *request.Request, output *ListDomainNamesOutput)

ListDomainNamesRequest generates a request for the ListDomainNames operation.

func (*ElasticsearchService) ListTags 

func (c *ElasticsearchService) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

Returns all tags for the given Elasticsearch domain.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.ListTagsInput{
		ARN: aws.String("ARN"), // Required
	}
	resp, err := svc.ListTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) ListTagsRequest 

func (c *ElasticsearchService) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

ListTagsRequest generates a request for the ListTags operation.

func (*ElasticsearchService) RemoveTags 

func (c *ElasticsearchService) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.RemoveTagsInput{
		ARN: aws.String("ARN"), // Required
		TagKeys: []*string{ // Required
			aws.String("String"), // Required
			// More values...
		},
	}
	resp, err := svc.RemoveTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) RemoveTagsRequest 

func (c *ElasticsearchService) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput)

RemoveTagsRequest generates a request for the RemoveTags operation.

func (*ElasticsearchService) UpdateElasticsearchDomainConfig 

func (c *ElasticsearchService) UpdateElasticsearchDomainConfig(input *UpdateElasticsearchDomainConfigInput) (*UpdateElasticsearchDomainConfigOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/elasticsearchservice"
)

func main() {
	svc := elasticsearchservice.New(session.New())

	params := &elasticsearchservice.UpdateElasticsearchDomainConfigInput{
		DomainName:     aws.String("DomainName"), // Required
		AccessPolicies: aws.String("PolicyDocument"),
		AdvancedOptions: map[string]*string{
			"Key": aws.String("String"), // Required
			// More values...
		},
		EBSOptions: &elasticsearchservice.EBSOptions{
			EBSEnabled: aws.Bool(true),
			Iops:       aws.Int64(1),
			VolumeSize: aws.Int64(1),
			VolumeType: aws.String("VolumeType"),
		},
		ElasticsearchClusterConfig: &elasticsearchservice.ElasticsearchClusterConfig{
			DedicatedMasterCount:   aws.Int64(1),
			DedicatedMasterEnabled: aws.Bool(true),
			DedicatedMasterType:    aws.String("ESPartitionInstanceType"),
			InstanceCount:          aws.Int64(1),
			InstanceType:           aws.String("ESPartitionInstanceType"),
			ZoneAwarenessEnabled:   aws.Bool(true),
		},
		SnapshotOptions: &elasticsearchservice.SnapshotOptions{
			AutomatedSnapshotStartHour: aws.Int64(1),
		},
	}
	resp, err := svc.UpdateElasticsearchDomainConfig(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ElasticsearchService) UpdateElasticsearchDomainConfigRequest 

func (c *ElasticsearchService) UpdateElasticsearchDomainConfigRequest(input *UpdateElasticsearchDomainConfigInput) (req *request.Request, output *UpdateElasticsearchDomainConfigOutput)

UpdateElasticsearchDomainConfigRequest generates a request for the UpdateElasticsearchDomainConfig operation.

type ListDomainNamesInput 

type ListDomainNamesInput struct {
	// contains filtered or unexported fields
}

func (ListDomainNamesInput) GoString 

func (s ListDomainNamesInput) GoString() string

GoString returns the string representation

func (ListDomainNamesInput) String 

func (s ListDomainNamesInput) String() string

String returns the string representation

type ListDomainNamesOutput 

type ListDomainNamesOutput struct {

	// List of Elasticsearch domain names.
	DomainNames []*DomainInfo `type:"list"`
	// contains filtered or unexported fields
}

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

func (ListDomainNamesOutput) GoString 

func (s ListDomainNamesOutput) GoString() string

GoString returns the string representation

func (ListDomainNamesOutput) String 

func (s ListDomainNamesOutput) String() string

String returns the string representation

type ListTagsInput 

type ListTagsInput struct {

	// Specify the ARN for the Elasticsearch domain to which the tags are attached
	// that you want to view.
	ARN *string `location:"querystring" locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (ListTagsInput) GoString 

func (s ListTagsInput) GoString() string

GoString returns the string representation

func (ListTagsInput) String 

func (s ListTagsInput) String() string

String returns the string representation

type ListTagsOutput 

type ListTagsOutput struct {

	// List of Tag for the requested Elasticsearch domain.
	TagList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

func (ListTagsOutput) GoString 

func (s ListTagsOutput) GoString() string

GoString returns the string representation

func (ListTagsOutput) String 

func (s ListTagsOutput) String() string

String returns the string representation

type OptionStatus 

type OptionStatus struct {

	// Timestamp which tells the creation date for the entity.
	CreationDate *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

	// Indicates whether the Elasticsearch domain is being deleted.
	PendingDeletion *bool `type:"boolean"`

	// Provides the OptionState for the Elasticsearch domain.
	State *string `type:"string" required:"true" enum:"OptionState"`

	// Timestamp which tells the last updated time for the entity.
	UpdateDate *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

	// Specifies the latest version for the entity.
	UpdateVersion *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides the current status of the entity.

func (OptionStatus) GoString 

func (s OptionStatus) GoString() string

GoString returns the string representation

func (OptionStatus) String 

func (s OptionStatus) String() string

String returns the string representation

type RemoveTagsInput 

type RemoveTagsInput struct {

	// Specifies the ARN for the Elasticsearch domain from which you want to delete
	// the specified tags.
	ARN *string `type:"string" required:"true"`

	// Specifies the TagKey list which you want to remove from the Elasticsearch
	// domain.
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (RemoveTagsInput) GoString 

func (s RemoveTagsInput) GoString() string

GoString returns the string representation

func (RemoveTagsInput) String 

func (s RemoveTagsInput) String() string

String returns the string representation

type RemoveTagsOutput 

type RemoveTagsOutput struct {
	// contains filtered or unexported fields
}

func (RemoveTagsOutput) GoString 

func (s RemoveTagsOutput) GoString() string

GoString returns the string representation

func (RemoveTagsOutput) String 

func (s RemoveTagsOutput) String() string

String returns the string representation

type SnapshotOptions 

type SnapshotOptions struct {

	// Specifies the time, in UTC format, when the service takes a daily automated
	// snapshot of the specified Elasticsearch domain. Default value is 0 hours.
	AutomatedSnapshotStartHour *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (SnapshotOptions) GoString 

func (s SnapshotOptions) GoString() string

GoString returns the string representation

func (SnapshotOptions) String 

func (s SnapshotOptions) String() string

String returns the string representation

type SnapshotOptionsStatus 

type SnapshotOptionsStatus struct {

	// Specifies the daily snapshot options specified for the Elasticsearch domain.
	Options *SnapshotOptions `type:"structure" required:"true"`

	// Specifies the status of a daily automated snapshot.
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Status of a daily automated snapshot.

func (SnapshotOptionsStatus) GoString 

func (s SnapshotOptionsStatus) GoString() string

GoString returns the string representation

func (SnapshotOptionsStatus) String 

func (s SnapshotOptionsStatus) String() string

String returns the string representation

type Tag 

type Tag struct {

	// Specifies the TagKey, the name of the tag. Tag keys must be unique for the
	// Elasticsearch domain to which they are attached.
	Key *string `min:"1" type:"string" required:"true"`

	// Specifies the TagValue, the value assigned to the corresponding tag key.
	// Tag values can be null and do not have to be unique in a tag set. For example,
	// you can have a key value pair in a tag set of project : Trinity and cost-center
	// : Trinity
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies a key value pair for a resource tag.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String 

func (s Tag) String() string

String returns the string representation

type UpdateElasticsearchDomainConfigInput 

type UpdateElasticsearchDomainConfigInput struct {

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string `type:"string"`

	// Modifies the advanced 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 (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options"
	// target="_blank) for more information.
	AdvancedOptions map[string]*string `type:"map"`

	// The name of the Elasticsearch domain that you are updating.
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

	// Specify the type and size of the EBS volume that you want to use.
	EBSOptions *EBSOptions `type:"structure"`

	// The type and number of instances to instantiate for the domain cluster.
	ElasticsearchClusterConfig *ElasticsearchClusterConfig `type:"structure"`

	// Option to set the time, in UTC format, for the daily automated snapshot.
	// Default value is 0 hours.
	SnapshotOptions *SnapshotOptions `type:"structure"`
	// contains filtered or unexported fields
}

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

func (UpdateElasticsearchDomainConfigInput) GoString 

func (s UpdateElasticsearchDomainConfigInput) GoString() string

GoString returns the string representation

func (UpdateElasticsearchDomainConfigInput) String 

func (s UpdateElasticsearchDomainConfigInput) String() string

String returns the string representation

type UpdateElasticsearchDomainConfigOutput 

type UpdateElasticsearchDomainConfigOutput struct {

	// The status of the updated Elasticsearch domain.
	DomainConfig *ElasticsearchDomainConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

func (UpdateElasticsearchDomainConfigOutput) GoString 

func (s UpdateElasticsearchDomainConfigOutput) GoString() string

GoString returns the string representation

func (UpdateElasticsearchDomainConfigOutput) String 

func (s UpdateElasticsearchDomainConfigOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package elasticsearchserviceiface provides an interface for the Amazon Elasticsearch Service.
 Package elasticsearchserviceiface provides an interface for the Amazon Elasticsearch Service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.