elasticsearchservice

package
v1.99.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package elasticsearchservice provides the client and types for making API requests to Amazon Elasticsearch 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).

See elasticsearchservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticsearchservice/

Using the Client

To contact Amazon Elasticsearch Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Elasticsearch Service client ElasticsearchService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticsearchservice/#New

Index

Constants

View Source
const (
	// DeploymentStatusPendingUpdate is a DeploymentStatus enum value
	DeploymentStatusPendingUpdate = "PENDING_UPDATE"

	// DeploymentStatusInProgress is a DeploymentStatus enum value
	DeploymentStatusInProgress = "IN_PROGRESS"

	// DeploymentStatusCompleted is a DeploymentStatus enum value
	DeploymentStatusCompleted = "COMPLETED"

	// DeploymentStatusNotEligible is a DeploymentStatus enum value
	DeploymentStatusNotEligible = "NOT_ELIGIBLE"

	// DeploymentStatusEligible is a DeploymentStatus enum value
	DeploymentStatusEligible = "ELIGIBLE"
)
View Source
const (
	// ESPartitionInstanceTypeM3MediumElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM3MediumElasticsearch = "m3.medium.elasticsearch"

	// ESPartitionInstanceTypeM3LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM3LargeElasticsearch = "m3.large.elasticsearch"

	// ESPartitionInstanceTypeM3XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM3XlargeElasticsearch = "m3.xlarge.elasticsearch"

	// ESPartitionInstanceTypeM32xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM32xlargeElasticsearch = "m3.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeM4LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM4LargeElasticsearch = "m4.large.elasticsearch"

	// ESPartitionInstanceTypeM4XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM4XlargeElasticsearch = "m4.xlarge.elasticsearch"

	// ESPartitionInstanceTypeM42xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM42xlargeElasticsearch = "m4.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeM44xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM44xlargeElasticsearch = "m4.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeM410xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM410xlargeElasticsearch = "m4.10xlarge.elasticsearch"

	// ESPartitionInstanceTypeM5LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM5LargeElasticsearch = "m5.large.elasticsearch"

	// ESPartitionInstanceTypeM5XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM5XlargeElasticsearch = "m5.xlarge.elasticsearch"

	// ESPartitionInstanceTypeM52xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM52xlargeElasticsearch = "m5.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeM54xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM54xlargeElasticsearch = "m5.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeM512xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeM512xlargeElasticsearch = "m5.12xlarge.elasticsearch"

	// ESPartitionInstanceTypeR5LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR5LargeElasticsearch = "r5.large.elasticsearch"

	// ESPartitionInstanceTypeR5XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR5XlargeElasticsearch = "r5.xlarge.elasticsearch"

	// ESPartitionInstanceTypeR52xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR52xlargeElasticsearch = "r5.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeR54xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR54xlargeElasticsearch = "r5.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeR512xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR512xlargeElasticsearch = "r5.12xlarge.elasticsearch"

	// ESPartitionInstanceTypeC5LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC5LargeElasticsearch = "c5.large.elasticsearch"

	// ESPartitionInstanceTypeC5XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC5XlargeElasticsearch = "c5.xlarge.elasticsearch"

	// ESPartitionInstanceTypeC52xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC52xlargeElasticsearch = "c5.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeC54xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC54xlargeElasticsearch = "c5.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeC59xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC59xlargeElasticsearch = "c5.9xlarge.elasticsearch"

	// ESPartitionInstanceTypeC518xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC518xlargeElasticsearch = "c5.18xlarge.elasticsearch"

	// ESPartitionInstanceTypeT2MicroElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeT2MicroElasticsearch = "t2.micro.elasticsearch"

	// ESPartitionInstanceTypeT2SmallElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeT2SmallElasticsearch = "t2.small.elasticsearch"

	// ESPartitionInstanceTypeT2MediumElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeT2MediumElasticsearch = "t2.medium.elasticsearch"

	// ESPartitionInstanceTypeR3LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR3LargeElasticsearch = "r3.large.elasticsearch"

	// ESPartitionInstanceTypeR3XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR3XlargeElasticsearch = "r3.xlarge.elasticsearch"

	// ESPartitionInstanceTypeR32xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR32xlargeElasticsearch = "r3.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeR34xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR34xlargeElasticsearch = "r3.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeR38xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR38xlargeElasticsearch = "r3.8xlarge.elasticsearch"

	// ESPartitionInstanceTypeI2XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI2XlargeElasticsearch = "i2.xlarge.elasticsearch"

	// ESPartitionInstanceTypeI22xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI22xlargeElasticsearch = "i2.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeD2XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeD2XlargeElasticsearch = "d2.xlarge.elasticsearch"

	// ESPartitionInstanceTypeD22xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeD22xlargeElasticsearch = "d2.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeD24xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeD24xlargeElasticsearch = "d2.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeD28xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeD28xlargeElasticsearch = "d2.8xlarge.elasticsearch"

	// ESPartitionInstanceTypeC4LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC4LargeElasticsearch = "c4.large.elasticsearch"

	// ESPartitionInstanceTypeC4XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC4XlargeElasticsearch = "c4.xlarge.elasticsearch"

	// ESPartitionInstanceTypeC42xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC42xlargeElasticsearch = "c4.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeC44xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC44xlargeElasticsearch = "c4.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeC48xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeC48xlargeElasticsearch = "c4.8xlarge.elasticsearch"

	// ESPartitionInstanceTypeR4LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR4LargeElasticsearch = "r4.large.elasticsearch"

	// ESPartitionInstanceTypeR4XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR4XlargeElasticsearch = "r4.xlarge.elasticsearch"

	// ESPartitionInstanceTypeR42xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR42xlargeElasticsearch = "r4.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeR44xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR44xlargeElasticsearch = "r4.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeR48xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR48xlargeElasticsearch = "r4.8xlarge.elasticsearch"

	// ESPartitionInstanceTypeR416xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeR416xlargeElasticsearch = "r4.16xlarge.elasticsearch"

	// ESPartitionInstanceTypeI3LargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI3LargeElasticsearch = "i3.large.elasticsearch"

	// ESPartitionInstanceTypeI3XlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI3XlargeElasticsearch = "i3.xlarge.elasticsearch"

	// ESPartitionInstanceTypeI32xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI32xlargeElasticsearch = "i3.2xlarge.elasticsearch"

	// ESPartitionInstanceTypeI34xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI34xlargeElasticsearch = "i3.4xlarge.elasticsearch"

	// ESPartitionInstanceTypeI38xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI38xlargeElasticsearch = "i3.8xlarge.elasticsearch"

	// ESPartitionInstanceTypeI316xlargeElasticsearch is a ESPartitionInstanceType enum value
	ESPartitionInstanceTypeI316xlargeElasticsearch = "i3.16xlarge.elasticsearch"
)
View Source
const (
	// LogTypeIndexSlowLogs is a LogType enum value
	LogTypeIndexSlowLogs = "INDEX_SLOW_LOGS"

	// LogTypeSearchSlowLogs is a LogType enum value
	LogTypeSearchSlowLogs = "SEARCH_SLOW_LOGS"

	// LogTypeEsApplicationLogs is a LogType enum value
	LogTypeEsApplicationLogs = "ES_APPLICATION_LOGS"
)

Type of Log File, it can be one of the following:

  • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.

  • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.

  • ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

View Source
const (
	// OptionStateRequiresIndexDocuments is a OptionState enum value
	OptionStateRequiresIndexDocuments = "RequiresIndexDocuments"

	// OptionStateProcessing is a OptionState enum value
	OptionStateProcessing = "Processing"

	// OptionStateActive is a OptionState enum value
	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 (
	// ReservedElasticsearchInstancePaymentOptionAllUpfront is a ReservedElasticsearchInstancePaymentOption enum value
	ReservedElasticsearchInstancePaymentOptionAllUpfront = "ALL_UPFRONT"

	// ReservedElasticsearchInstancePaymentOptionPartialUpfront is a ReservedElasticsearchInstancePaymentOption enum value
	ReservedElasticsearchInstancePaymentOptionPartialUpfront = "PARTIAL_UPFRONT"

	// ReservedElasticsearchInstancePaymentOptionNoUpfront is a ReservedElasticsearchInstancePaymentOption enum value
	ReservedElasticsearchInstancePaymentOptionNoUpfront = "NO_UPFRONT"
)
View Source
const (
	// UpgradeStatusInProgress is a UpgradeStatus enum value
	UpgradeStatusInProgress = "IN_PROGRESS"

	// UpgradeStatusSucceeded is a UpgradeStatus enum value
	UpgradeStatusSucceeded = "SUCCEEDED"

	// UpgradeStatusSucceededWithIssues is a UpgradeStatus enum value
	UpgradeStatusSucceededWithIssues = "SUCCEEDED_WITH_ISSUES"

	// UpgradeStatusFailed is a UpgradeStatus enum value
	UpgradeStatusFailed = "FAILED"
)
View Source
const (
	// UpgradeStepPreUpgradeCheck is a UpgradeStep enum value
	UpgradeStepPreUpgradeCheck = "PRE_UPGRADE_CHECK"

	// UpgradeStepSnapshot is a UpgradeStep enum value
	UpgradeStepSnapshot = "SNAPSHOT"

	// UpgradeStepUpgrade is a UpgradeStep enum value
	UpgradeStepUpgrade = "UPGRADE"
)
View Source
const (
	// VolumeTypeStandard is a VolumeType enum value
	VolumeTypeStandard = "standard"

	// VolumeTypeGp2 is a VolumeType enum value
	VolumeTypeGp2 = "gp2"

	// VolumeTypeIo1 is a VolumeType enum value
	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)for more information.

View Source
const (

	// ErrCodeBaseException for service response error code
	// "BaseException".
	//
	// An error occurred while processing the request.
	ErrCodeBaseException = "BaseException"

	// ErrCodeDisabledOperationException for service response error code
	// "DisabledOperationException".
	//
	// An error occured because the client wanted to access a not supported operation.
	// Gives http status code of 409.
	ErrCodeDisabledOperationException = "DisabledOperationException"

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// 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.
	ErrCodeInternalException = "InternalException"

	// ErrCodeInvalidTypeException for service response error code
	// "InvalidTypeException".
	//
	// An exception for trying to create or access sub-resource that is either invalid
	// or not supported. Gives http status code of 409.
	ErrCodeInvalidTypeException = "InvalidTypeException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// An exception for trying to create more than allowed resources or sub-resources.
	// Gives http status code of 409.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// An exception for creating a resource that already exists. Gives http status
	// code of 400.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// An exception for accessing or deleting a resource that does not exist. Gives
	// http status code of 400.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// An exception for missing / invalid input fields. Gives http status code of
	// 400.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "es"                    // Name of service.
	EndpointsID = ServiceName             // ID to lookup a service endpoint with.
	ServiceID   = "Elasticsearch Service" // ServiceID is a unique identifer of a specific service.
)

Service information constants

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)for
	// more information.
	//
	// Options is a required field
	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 is a required field
	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) SetOptions added in v1.5.0

SetOptions sets the Options field's value.

func (*AccessPoliciesStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

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 is a required field
	ARN *string `type:"string" required:"true"`

	// List of Tag that need to be added for the Elasticsearch domain.
	//
	// TagList is a required field
	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) SetARN added in v1.5.0

func (s *AddTagsInput) SetARN(v string) *AddTagsInput

SetARN sets the ARN field's value.

func (*AddTagsInput) SetTagList added in v1.5.0

func (s *AddTagsInput) SetTagList(v []*Tag) *AddTagsInput

SetTagList sets the TagList field's value.

func (AddTagsInput) String

func (s AddTagsInput) String() string

String returns the string representation

func (*AddTagsInput) Validate added in v1.1.21

func (s *AddTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 AdditionalLimit added in v1.7.1

type AdditionalLimit struct {

	// Name of Additional Limit is specific to a given InstanceType and for each
	// of it's InstanceRole etc. Attributes and their details:
	//    * MaximumNumberOfDataNodesSupported
	//
	//    * MaximumNumberOfDataNodesWithoutMasterNode
	LimitName *string `type:"string"`

	// Value for given AdditionalLimit$LimitName .
	LimitValues []*string `type:"list"`
	// contains filtered or unexported fields
}

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

func (AdditionalLimit) GoString added in v1.7.1

func (s AdditionalLimit) GoString() string

GoString returns the string representation

func (*AdditionalLimit) SetLimitName added in v1.7.1

func (s *AdditionalLimit) SetLimitName(v string) *AdditionalLimit

SetLimitName sets the LimitName field's value.

func (*AdditionalLimit) SetLimitValues added in v1.7.1

func (s *AdditionalLimit) SetLimitValues(v []*string) *AdditionalLimit

SetLimitValues sets the LimitValues field's value.

func (AdditionalLimit) String added in v1.7.1

func (s AdditionalLimit) String() string

String returns the string representation

type AdvancedOptionsStatus

type AdvancedOptionsStatus struct {

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

	// Specifies the status of OptionStatus for advanced options for the specified
	// Elasticsearch domain.
	//
	// Status is a required field
	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 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) SetOptions added in v1.5.0

SetOptions sets the Options field's value.

func (*AdvancedOptionsStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (AdvancedOptionsStatus) String

func (s AdvancedOptionsStatus) String() string

String returns the string representation

type CancelElasticsearchServiceSoftwareUpdateInput added in v1.99.0

type CancelElasticsearchServiceSoftwareUpdateInput struct {

	// The name of the domain that you want to stop the latest service software
	// update on.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.

func (CancelElasticsearchServiceSoftwareUpdateInput) GoString added in v1.99.0

GoString returns the string representation

func (*CancelElasticsearchServiceSoftwareUpdateInput) SetDomainName added in v1.99.0

SetDomainName sets the DomainName field's value.

func (CancelElasticsearchServiceSoftwareUpdateInput) String added in v1.99.0

String returns the string representation

func (*CancelElasticsearchServiceSoftwareUpdateInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type CancelElasticsearchServiceSoftwareUpdateOutput added in v1.99.0

type CancelElasticsearchServiceSoftwareUpdateOutput struct {

	// The current status of the Elasticsearch service software update.
	ServiceSoftwareOptions *ServiceSoftwareOptions `type:"structure"`
	// contains filtered or unexported fields
}

The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

func (CancelElasticsearchServiceSoftwareUpdateOutput) GoString added in v1.99.0

GoString returns the string representation

func (*CancelElasticsearchServiceSoftwareUpdateOutput) SetServiceSoftwareOptions added in v1.99.0

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (CancelElasticsearchServiceSoftwareUpdateOutput) String added in v1.99.0

String returns the string representation

type CognitoOptions added in v1.13.26

type CognitoOptions struct {

	// Specifies the option to enable Cognito for Kibana authentication.
	Enabled *bool `type:"boolean"`

	// Specifies the Cognito identity pool ID for Kibana authentication.
	IdentityPoolId *string `min:"1" type:"string"`

	// Specifies the role ARN that provides Elasticsearch permissions for accessing
	// Cognito resources.
	RoleArn *string `min:"20" type:"string"`

	// Specifies the Cognito user pool ID for Kibana authentication.
	UserPoolId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html).

func (CognitoOptions) GoString added in v1.13.26

func (s CognitoOptions) GoString() string

GoString returns the string representation

func (*CognitoOptions) SetEnabled added in v1.13.26

func (s *CognitoOptions) SetEnabled(v bool) *CognitoOptions

SetEnabled sets the Enabled field's value.

func (*CognitoOptions) SetIdentityPoolId added in v1.13.26

func (s *CognitoOptions) SetIdentityPoolId(v string) *CognitoOptions

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*CognitoOptions) SetRoleArn added in v1.13.26

func (s *CognitoOptions) SetRoleArn(v string) *CognitoOptions

SetRoleArn sets the RoleArn field's value.

func (*CognitoOptions) SetUserPoolId added in v1.13.26

func (s *CognitoOptions) SetUserPoolId(v string) *CognitoOptions

SetUserPoolId sets the UserPoolId field's value.

func (CognitoOptions) String added in v1.13.26

func (s CognitoOptions) String() string

String returns the string representation

func (*CognitoOptions) Validate added in v1.13.26

func (s *CognitoOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CognitoOptionsStatus added in v1.13.26

type CognitoOptionsStatus struct {

	// Specifies the Cognito options for the specified Elasticsearch domain.
	//
	// Options is a required field
	Options *CognitoOptions `type:"structure" required:"true"`

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

Status of the Cognito options for the specified Elasticsearch domain.

func (CognitoOptionsStatus) GoString added in v1.13.26

func (s CognitoOptionsStatus) GoString() string

GoString returns the string representation

func (*CognitoOptionsStatus) SetOptions added in v1.13.26

SetOptions sets the Options field's value.

func (*CognitoOptionsStatus) SetStatus added in v1.13.26

SetStatus sets the Status field's value.

func (CognitoOptionsStatus) String added in v1.13.26

func (s CognitoOptionsStatus) String() string

String returns the string representation

type CompatibleVersionsMap added in v1.99.0

type CompatibleVersionsMap struct {

	// The current version of Elasticsearch on which a domain is.
	SourceVersion *string `type:"string"`

	// List of supported elastic search versions.
	TargetVersions []*string `type:"list"`
	// contains filtered or unexported fields
}

A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.

func (CompatibleVersionsMap) GoString added in v1.99.0

func (s CompatibleVersionsMap) GoString() string

GoString returns the string representation

func (*CompatibleVersionsMap) SetSourceVersion added in v1.99.0

func (s *CompatibleVersionsMap) SetSourceVersion(v string) *CompatibleVersionsMap

SetSourceVersion sets the SourceVersion field's value.

func (*CompatibleVersionsMap) SetTargetVersions added in v1.99.0

func (s *CompatibleVersionsMap) SetTargetVersions(v []*string) *CompatibleVersionsMap

SetTargetVersions sets the TargetVersions field's value.

func (CompatibleVersionsMap) String added in v1.99.0

func (s CompatibleVersionsMap) 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)
	// for more information.
	AdvancedOptions map[string]*string `type:"map"`

	// Options to specify the Cognito user and identity pools for Kibana authentication.
	// For more information, see Amazon Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html).
	CognitoOptions *CognitoOptions `type:"structure"`

	// 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 is a required field
	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"`

	// String of format X.Y to specify version for the Elasticsearch domain eg.
	// "1.5" or "2.3". 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.
	ElasticsearchVersion *string `type:"string"`

	// Specifies the Encryption At Rest Options.
	EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

	// Map of LogType and LogPublishingOption, each containing options to publish
	// a given type of Elasticsearch log.
	LogPublishingOptions map[string]*LogPublishingOption `type:"map"`

	// Specifies the NodeToNodeEncryptionOptions.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions `type:"structure"`

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

	// Options to specify the subnets and security groups for VPC endpoint. For
	// more information, see Creating a VPC (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc)
	// in VPC Endpoints for Amazon Elasticsearch Service Domains
	VPCOptions *VPCOptions `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateElasticsearchDomainInput) GoString

GoString returns the string representation

func (*CreateElasticsearchDomainInput) SetAccessPolicies added in v1.5.0

SetAccessPolicies sets the AccessPolicies field's value.

func (*CreateElasticsearchDomainInput) SetAdvancedOptions added in v1.5.0

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*CreateElasticsearchDomainInput) SetCognitoOptions added in v1.13.26

SetCognitoOptions sets the CognitoOptions field's value.

func (*CreateElasticsearchDomainInput) SetDomainName added in v1.5.0

SetDomainName sets the DomainName field's value.

func (*CreateElasticsearchDomainInput) SetEBSOptions added in v1.5.0

SetEBSOptions sets the EBSOptions field's value.

func (*CreateElasticsearchDomainInput) SetElasticsearchClusterConfig added in v1.5.0

SetElasticsearchClusterConfig sets the ElasticsearchClusterConfig field's value.

func (*CreateElasticsearchDomainInput) SetElasticsearchVersion added in v1.5.0

SetElasticsearchVersion sets the ElasticsearchVersion field's value.

func (*CreateElasticsearchDomainInput) SetEncryptionAtRestOptions added in v1.12.43

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*CreateElasticsearchDomainInput) SetLogPublishingOptions added in v1.12.11

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*CreateElasticsearchDomainInput) SetNodeToNodeEncryptionOptions added in v1.99.0

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*CreateElasticsearchDomainInput) SetSnapshotOptions added in v1.5.0

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*CreateElasticsearchDomainInput) SetVPCOptions added in v1.12.12

SetVPCOptions sets the VPCOptions field's value.

func (CreateElasticsearchDomainInput) String

String returns the string representation

func (*CreateElasticsearchDomainInput) Validate added in v1.1.21

func (s *CreateElasticsearchDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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

GoString returns the string representation

func (*CreateElasticsearchDomainOutput) SetDomainStatus added in v1.5.0

SetDomainStatus sets the DomainStatus field's value.

func (CreateElasticsearchDomainOutput) String

String returns the string representation

type DeleteElasticsearchDomainInput

type DeleteElasticsearchDomainInput struct {

	// The name of the Elasticsearch domain that you want to permanently delete.
	//
	// DomainName is a required field
	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

GoString returns the string representation

func (*DeleteElasticsearchDomainInput) SetDomainName added in v1.5.0

SetDomainName sets the DomainName field's value.

func (DeleteElasticsearchDomainInput) String

String returns the string representation

func (*DeleteElasticsearchDomainInput) Validate added in v1.1.21

func (s *DeleteElasticsearchDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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

GoString returns the string representation

func (*DeleteElasticsearchDomainOutput) SetDomainStatus added in v1.5.0

SetDomainStatus sets the DomainStatus field's value.

func (DeleteElasticsearchDomainOutput) String

String returns the string representation

type DeleteElasticsearchServiceRoleInput added in v1.12.12

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

func (DeleteElasticsearchServiceRoleInput) GoString added in v1.12.12

GoString returns the string representation

func (DeleteElasticsearchServiceRoleInput) String added in v1.12.12

String returns the string representation

type DeleteElasticsearchServiceRoleOutput added in v1.12.12

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

func (DeleteElasticsearchServiceRoleOutput) GoString added in v1.12.12

GoString returns the string representation

func (DeleteElasticsearchServiceRoleOutput) String added in v1.12.12

String returns the string representation

type DescribeElasticsearchDomainConfigInput

type DescribeElasticsearchDomainConfigInput struct {

	// The Elasticsearch domain that you want to get information about.
	//
	// DomainName is a required field
	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

GoString returns the string representation

func (*DescribeElasticsearchDomainConfigInput) SetDomainName added in v1.5.0

SetDomainName sets the DomainName field's value.

func (DescribeElasticsearchDomainConfigInput) String

String returns the string representation

func (*DescribeElasticsearchDomainConfigInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeElasticsearchDomainConfigOutput

type DescribeElasticsearchDomainConfigOutput struct {

	// The configuration information of the domain requested in the DescribeElasticsearchDomainConfig
	// request.
	//
	// DomainConfig is a required field
	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

GoString returns the string representation

func (*DescribeElasticsearchDomainConfigOutput) SetDomainConfig added in v1.5.0

SetDomainConfig sets the DomainConfig field's value.

func (DescribeElasticsearchDomainConfigOutput) String

String returns the string representation

type DescribeElasticsearchDomainInput

type DescribeElasticsearchDomainInput struct {

	// The name of the Elasticsearch domain for which you want information.
	//
	// DomainName is a required field
	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

GoString returns the string representation

func (*DescribeElasticsearchDomainInput) SetDomainName added in v1.5.0

SetDomainName sets the DomainName field's value.

func (DescribeElasticsearchDomainInput) String

String returns the string representation

func (*DescribeElasticsearchDomainInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeElasticsearchDomainOutput

type DescribeElasticsearchDomainOutput struct {

	// The current status of the Elasticsearch domain.
	//
	// DomainStatus is a required field
	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

GoString returns the string representation

func (*DescribeElasticsearchDomainOutput) SetDomainStatus added in v1.5.0

SetDomainStatus sets the DomainStatus field's value.

func (DescribeElasticsearchDomainOutput) String

String returns the string representation

type DescribeElasticsearchDomainsInput

type DescribeElasticsearchDomainsInput struct {

	// The Elasticsearch domains for which you want information.
	//
	// DomainNames is a required field
	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

GoString returns the string representation

func (*DescribeElasticsearchDomainsInput) SetDomainNames added in v1.5.0

SetDomainNames sets the DomainNames field's value.

func (DescribeElasticsearchDomainsInput) String

String returns the string representation

func (*DescribeElasticsearchDomainsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeElasticsearchDomainsOutput

type DescribeElasticsearchDomainsOutput struct {

	// The status of the domains requested in the DescribeElasticsearchDomains request.
	//
	// DomainStatusList is a required field
	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

GoString returns the string representation

func (*DescribeElasticsearchDomainsOutput) SetDomainStatusList added in v1.5.0

SetDomainStatusList sets the DomainStatusList field's value.

func (DescribeElasticsearchDomainsOutput) String

String returns the string representation

type DescribeElasticsearchInstanceTypeLimitsInput added in v1.7.1

type DescribeElasticsearchInstanceTypeLimitsInput struct {

	// DomainName represents the name of the Domain that we are trying to modify.
	// This should be present only if we are querying for Elasticsearch Limits for
	// existing domain.
	DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"`

	// Version of Elasticsearch for which Limits are needed.
	//
	// ElasticsearchVersion is a required field
	ElasticsearchVersion *string `location:"uri" locationName:"ElasticsearchVersion" type:"string" required:"true"`

	// The instance type for an Elasticsearch cluster for which Elasticsearch Limits
	// are needed.
	//
	// InstanceType is a required field
	InstanceType *string `location:"uri" locationName:"InstanceType" type:"string" required:"true" enum:"ESPartitionInstanceType"`
	// contains filtered or unexported fields
}

Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

func (DescribeElasticsearchInstanceTypeLimitsInput) GoString added in v1.7.1

GoString returns the string representation

func (*DescribeElasticsearchInstanceTypeLimitsInput) SetDomainName added in v1.7.1

SetDomainName sets the DomainName field's value.

func (*DescribeElasticsearchInstanceTypeLimitsInput) SetElasticsearchVersion added in v1.7.1

SetElasticsearchVersion sets the ElasticsearchVersion field's value.

func (*DescribeElasticsearchInstanceTypeLimitsInput) SetInstanceType added in v1.7.1

SetInstanceType sets the InstanceType field's value.

func (DescribeElasticsearchInstanceTypeLimitsInput) String added in v1.7.1

String returns the string representation

func (*DescribeElasticsearchInstanceTypeLimitsInput) Validate added in v1.7.1

Validate inspects the fields of the type to determine if they are valid.

type DescribeElasticsearchInstanceTypeLimitsOutput added in v1.7.1

type DescribeElasticsearchInstanceTypeLimitsOutput struct {

	// 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
	LimitsByRole map[string]*Limits `type:"map"`
	// contains filtered or unexported fields
}

Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.

func (DescribeElasticsearchInstanceTypeLimitsOutput) GoString added in v1.7.1

GoString returns the string representation

func (*DescribeElasticsearchInstanceTypeLimitsOutput) SetLimitsByRole added in v1.7.1

SetLimitsByRole sets the LimitsByRole field's value.

func (DescribeElasticsearchInstanceTypeLimitsOutput) String added in v1.7.1

String returns the string representation

type DescribeReservedElasticsearchInstanceOfferingsInput added in v1.13.43

type DescribeReservedElasticsearchInstanceOfferingsInput struct {

	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The offering identifier filter value. Use this parameter to show only the
	// available offering that matches the specified reservation identifier.
	ReservedElasticsearchInstanceOfferingId *string `location:"querystring" locationName:"offeringId" type:"string"`
	// contains filtered or unexported fields
}

Container for parameters to DescribeReservedElasticsearchInstanceOfferings

func (DescribeReservedElasticsearchInstanceOfferingsInput) GoString added in v1.13.43

GoString returns the string representation

func (*DescribeReservedElasticsearchInstanceOfferingsInput) SetMaxResults added in v1.13.43

SetMaxResults sets the MaxResults field's value.

func (*DescribeReservedElasticsearchInstanceOfferingsInput) SetNextToken added in v1.13.43

SetNextToken sets the NextToken field's value.

func (*DescribeReservedElasticsearchInstanceOfferingsInput) SetReservedElasticsearchInstanceOfferingId added in v1.13.43

SetReservedElasticsearchInstanceOfferingId sets the ReservedElasticsearchInstanceOfferingId field's value.

func (DescribeReservedElasticsearchInstanceOfferingsInput) String added in v1.13.43

String returns the string representation

type DescribeReservedElasticsearchInstanceOfferingsOutput added in v1.13.43

type DescribeReservedElasticsearchInstanceOfferingsOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`

	// List of reserved Elasticsearch instance offerings
	ReservedElasticsearchInstanceOfferings []*ReservedElasticsearchInstanceOffering `type:"list"`
	// contains filtered or unexported fields
}

Container for results from DescribeReservedElasticsearchInstanceOfferings

func (DescribeReservedElasticsearchInstanceOfferingsOutput) GoString added in v1.13.43

GoString returns the string representation

func (*DescribeReservedElasticsearchInstanceOfferingsOutput) SetNextToken added in v1.13.43

SetNextToken sets the NextToken field's value.

func (*DescribeReservedElasticsearchInstanceOfferingsOutput) SetReservedElasticsearchInstanceOfferings added in v1.13.43

SetReservedElasticsearchInstanceOfferings sets the ReservedElasticsearchInstanceOfferings field's value.

func (DescribeReservedElasticsearchInstanceOfferingsOutput) String added in v1.13.43

String returns the string representation

type DescribeReservedElasticsearchInstancesInput added in v1.13.43

type DescribeReservedElasticsearchInstancesInput struct {

	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The reserved instance identifier filter value. Use this parameter to show
	// only the reservation that matches the specified reserved Elasticsearch instance
	// ID.
	ReservedElasticsearchInstanceId *string `location:"querystring" locationName:"reservationId" type:"string"`
	// contains filtered or unexported fields
}

Container for parameters to DescribeReservedElasticsearchInstances

func (DescribeReservedElasticsearchInstancesInput) GoString added in v1.13.43

GoString returns the string representation

func (*DescribeReservedElasticsearchInstancesInput) SetMaxResults added in v1.13.43

SetMaxResults sets the MaxResults field's value.

func (*DescribeReservedElasticsearchInstancesInput) SetNextToken added in v1.13.43

SetNextToken sets the NextToken field's value.

func (*DescribeReservedElasticsearchInstancesInput) SetReservedElasticsearchInstanceId added in v1.13.43

SetReservedElasticsearchInstanceId sets the ReservedElasticsearchInstanceId field's value.

func (DescribeReservedElasticsearchInstancesInput) String added in v1.13.43

String returns the string representation

type DescribeReservedElasticsearchInstancesOutput added in v1.13.43

type DescribeReservedElasticsearchInstancesOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`

	// List of reserved Elasticsearch instances.
	ReservedElasticsearchInstances []*ReservedElasticsearchInstance `type:"list"`
	// contains filtered or unexported fields
}

Container for results from DescribeReservedElasticsearchInstances

func (DescribeReservedElasticsearchInstancesOutput) GoString added in v1.13.43

GoString returns the string representation

func (*DescribeReservedElasticsearchInstancesOutput) SetNextToken added in v1.13.43

SetNextToken sets the NextToken field's value.

func (*DescribeReservedElasticsearchInstancesOutput) SetReservedElasticsearchInstances added in v1.13.43

SetReservedElasticsearchInstances sets the ReservedElasticsearchInstances field's value.

func (DescribeReservedElasticsearchInstancesOutput) String added in v1.13.43

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) SetDomainName added in v1.5.0

func (s *DomainInfo) SetDomainName(v string) *DomainInfo

SetDomainName sets the DomainName field's value.

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

func (EBSOptions) GoString

func (s EBSOptions) GoString() string

GoString returns the string representation

func (*EBSOptions) SetEBSEnabled added in v1.5.0

func (s *EBSOptions) SetEBSEnabled(v bool) *EBSOptions

SetEBSEnabled sets the EBSEnabled field's value.

func (*EBSOptions) SetIops added in v1.5.0

func (s *EBSOptions) SetIops(v int64) *EBSOptions

SetIops sets the Iops field's value.

func (*EBSOptions) SetVolumeSize added in v1.5.0

func (s *EBSOptions) SetVolumeSize(v int64) *EBSOptions

SetVolumeSize sets the VolumeSize field's value.

func (*EBSOptions) SetVolumeType added in v1.5.0

func (s *EBSOptions) SetVolumeType(v string) *EBSOptions

SetVolumeType sets the VolumeType field's value.

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 is a required field
	Options *EBSOptions `type:"structure" required:"true"`

	// Specifies the status of the EBS options for the specified Elasticsearch domain.
	//
	// Status is a required field
	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) SetOptions added in v1.5.0

func (s *EBSOptionsStatus) SetOptions(v *EBSOptions) *EBSOptionsStatus

SetOptions sets the Options field's value.

func (*EBSOptionsStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

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)
	// 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"`

	// Specifies the zone awareness configuration for a domain when zone awareness
	// is enabled.
	ZoneAwarenessConfig *ZoneAwarenessConfig `type:"structure"`

	// 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)
	// 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) SetDedicatedMasterCount added in v1.5.0

func (s *ElasticsearchClusterConfig) SetDedicatedMasterCount(v int64) *ElasticsearchClusterConfig

SetDedicatedMasterCount sets the DedicatedMasterCount field's value.

func (*ElasticsearchClusterConfig) SetDedicatedMasterEnabled added in v1.5.0

func (s *ElasticsearchClusterConfig) SetDedicatedMasterEnabled(v bool) *ElasticsearchClusterConfig

SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.

func (*ElasticsearchClusterConfig) SetDedicatedMasterType added in v1.5.0

func (s *ElasticsearchClusterConfig) SetDedicatedMasterType(v string) *ElasticsearchClusterConfig

SetDedicatedMasterType sets the DedicatedMasterType field's value.

func (*ElasticsearchClusterConfig) SetInstanceCount added in v1.5.0

SetInstanceCount sets the InstanceCount field's value.

func (*ElasticsearchClusterConfig) SetInstanceType added in v1.5.0

SetInstanceType sets the InstanceType field's value.

func (*ElasticsearchClusterConfig) SetZoneAwarenessConfig added in v1.99.0

SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.

func (*ElasticsearchClusterConfig) SetZoneAwarenessEnabled added in v1.5.0

func (s *ElasticsearchClusterConfig) SetZoneAwarenessEnabled(v bool) *ElasticsearchClusterConfig

SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.

func (ElasticsearchClusterConfig) String

String returns the string representation

type ElasticsearchClusterConfigStatus

type ElasticsearchClusterConfigStatus struct {

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

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

Specifies the configuration status for the specified Elasticsearch domain.

func (ElasticsearchClusterConfigStatus) GoString

GoString returns the string representation

func (*ElasticsearchClusterConfigStatus) SetOptions added in v1.5.0

SetOptions sets the Options field's value.

func (*ElasticsearchClusterConfigStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (ElasticsearchClusterConfigStatus) 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)
	// for more information.
	AdvancedOptions *AdvancedOptionsStatus `type:"structure"`

	// The CognitoOptions for the specified domain. For more information, see Amazon
	// Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html).
	CognitoOptions *CognitoOptionsStatus `type:"structure"`

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

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

	// String of format X.Y to specify version for the Elasticsearch domain.
	ElasticsearchVersion *ElasticsearchVersionStatus `type:"structure"`

	// Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
	EncryptionAtRestOptions *EncryptionAtRestOptionsStatus `type:"structure"`

	// Log publishing options for the given domain.
	LogPublishingOptions *LogPublishingOptionsStatus `type:"structure"`

	// Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus `type:"structure"`

	// Specifies the SnapshotOptions for the Elasticsearch domain.
	SnapshotOptions *SnapshotOptionsStatus `type:"structure"`

	// The VPCOptions for the specified domain. For more information, see VPC Endpoints
	// for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html).
	VPCOptions *VPCDerivedInfoStatus `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) SetAccessPolicies added in v1.5.0

SetAccessPolicies sets the AccessPolicies field's value.

func (*ElasticsearchDomainConfig) SetAdvancedOptions added in v1.5.0

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*ElasticsearchDomainConfig) SetCognitoOptions added in v1.13.26

SetCognitoOptions sets the CognitoOptions field's value.

func (*ElasticsearchDomainConfig) SetEBSOptions added in v1.5.0

SetEBSOptions sets the EBSOptions field's value.

func (*ElasticsearchDomainConfig) SetElasticsearchClusterConfig added in v1.5.0

SetElasticsearchClusterConfig sets the ElasticsearchClusterConfig field's value.

func (*ElasticsearchDomainConfig) SetElasticsearchVersion added in v1.5.0

SetElasticsearchVersion sets the ElasticsearchVersion field's value.

func (*ElasticsearchDomainConfig) SetEncryptionAtRestOptions added in v1.12.43

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*ElasticsearchDomainConfig) SetLogPublishingOptions added in v1.12.11

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*ElasticsearchDomainConfig) SetNodeToNodeEncryptionOptions added in v1.99.0

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*ElasticsearchDomainConfig) SetSnapshotOptions added in v1.5.0

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*ElasticsearchDomainConfig) SetVPCOptions added in v1.12.12

SetVPCOptions sets the VPCOptions field's value.

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)
	// in Using AWS Identity and Access Management for more information.
	//
	// ARN is a required field
	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 CognitoOptions for the specified domain. For more information, see Amazon
	// Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html).
	CognitoOptions *CognitoOptions `type:"structure"`

	// 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 is a required field
	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 is a required field
	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)
	// for more information.
	EBSOptions *EBSOptions `type:"structure"`

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

	ElasticsearchVersion *string `type:"string"`

	// Specifies the status of the EncryptionAtRestOptions.
	EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

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

	// Map containing the Elasticsearch domain endpoints used to submit index and
	// search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
	Endpoints map[string]*string `type:"map"`

	// Log publishing options for the given domain.
	LogPublishingOptions map[string]*LogPublishingOption `type:"map"`

	// Specifies the status of the NodeToNodeEncryptionOptions.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions `type:"structure"`

	// 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"`

	// The current status of the Elasticsearch domain's service software.
	ServiceSoftwareOptions *ServiceSoftwareOptions `type:"structure"`

	// Specifies the status of the SnapshotOptions
	SnapshotOptions *SnapshotOptions `type:"structure"`

	// The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch
	// Service is undergoing a version upgrade. False if the configuration is active.
	UpgradeProcessing *bool `type:"boolean"`

	// The VPCOptions for the specified domain. For more information, see VPC Endpoints
	// for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html).
	VPCOptions *VPCDerivedInfo `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) SetARN added in v1.5.0

SetARN sets the ARN field's value.

func (*ElasticsearchDomainStatus) SetAccessPolicies added in v1.5.0

SetAccessPolicies sets the AccessPolicies field's value.

func (*ElasticsearchDomainStatus) SetAdvancedOptions added in v1.5.0

func (s *ElasticsearchDomainStatus) SetAdvancedOptions(v map[string]*string) *ElasticsearchDomainStatus

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*ElasticsearchDomainStatus) SetCognitoOptions added in v1.13.26

SetCognitoOptions sets the CognitoOptions field's value.

func (*ElasticsearchDomainStatus) SetCreated added in v1.5.0

SetCreated sets the Created field's value.

func (*ElasticsearchDomainStatus) SetDeleted added in v1.5.0

SetDeleted sets the Deleted field's value.

func (*ElasticsearchDomainStatus) SetDomainId added in v1.5.0

SetDomainId sets the DomainId field's value.

func (*ElasticsearchDomainStatus) SetDomainName added in v1.5.0

SetDomainName sets the DomainName field's value.

func (*ElasticsearchDomainStatus) SetEBSOptions added in v1.5.0

SetEBSOptions sets the EBSOptions field's value.

func (*ElasticsearchDomainStatus) SetElasticsearchClusterConfig added in v1.5.0

SetElasticsearchClusterConfig sets the ElasticsearchClusterConfig field's value.

func (*ElasticsearchDomainStatus) SetElasticsearchVersion added in v1.5.0

func (s *ElasticsearchDomainStatus) SetElasticsearchVersion(v string) *ElasticsearchDomainStatus

SetElasticsearchVersion sets the ElasticsearchVersion field's value.

func (*ElasticsearchDomainStatus) SetEncryptionAtRestOptions added in v1.12.43

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*ElasticsearchDomainStatus) SetEndpoint added in v1.5.0

SetEndpoint sets the Endpoint field's value.

func (*ElasticsearchDomainStatus) SetEndpoints added in v1.12.12

SetEndpoints sets the Endpoints field's value.

func (*ElasticsearchDomainStatus) SetLogPublishingOptions added in v1.12.11

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*ElasticsearchDomainStatus) SetNodeToNodeEncryptionOptions added in v1.99.0

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*ElasticsearchDomainStatus) SetProcessing added in v1.5.0

SetProcessing sets the Processing field's value.

func (*ElasticsearchDomainStatus) SetServiceSoftwareOptions added in v1.99.0

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (*ElasticsearchDomainStatus) SetSnapshotOptions added in v1.5.0

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*ElasticsearchDomainStatus) SetUpgradeProcessing added in v1.99.0

func (s *ElasticsearchDomainStatus) SetUpgradeProcessing(v bool) *ElasticsearchDomainStatus

SetUpgradeProcessing sets the UpgradeProcessing field's value.

func (*ElasticsearchDomainStatus) SetVPCOptions added in v1.12.12

SetVPCOptions sets the VPCOptions field's value.

func (ElasticsearchDomainStatus) String

func (s ElasticsearchDomainStatus) String() string

String returns the string representation

type ElasticsearchService

type ElasticsearchService struct {
	*client.Client
}

ElasticsearchService provides the API operation methods for making requests to Amazon Elasticsearch Service. See this package's package overview docs for details on the service.

ElasticsearchService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

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)

AddTags API operation for Amazon Elasticsearch Service.

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)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation AddTags for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) AddTagsRequest

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

AddTagsRequest generates a "aws/request.Request" representing the client's request for the AddTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTags for more information on using the AddTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddTagsRequest method.
req, resp := client.AddTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) AddTagsWithContext added in v1.8.0

func (c *ElasticsearchService) AddTagsWithContext(ctx aws.Context, input *AddTagsInput, opts ...request.Option) (*AddTagsOutput, error)

AddTagsWithContext is the same as AddTags with the addition of the ability to pass a context and additional request options.

See AddTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) CancelElasticsearchServiceSoftwareUpdate added in v1.99.0

CancelElasticsearchServiceSoftwareUpdate API operation for Amazon Elasticsearch Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation CancelElasticsearchServiceSoftwareUpdate for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) CancelElasticsearchServiceSoftwareUpdateRequest added in v1.99.0

func (c *ElasticsearchService) CancelElasticsearchServiceSoftwareUpdateRequest(input *CancelElasticsearchServiceSoftwareUpdateInput) (req *request.Request, output *CancelElasticsearchServiceSoftwareUpdateOutput)

CancelElasticsearchServiceSoftwareUpdateRequest generates a "aws/request.Request" representing the client's request for the CancelElasticsearchServiceSoftwareUpdate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelElasticsearchServiceSoftwareUpdate for more information on using the CancelElasticsearchServiceSoftwareUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelElasticsearchServiceSoftwareUpdateRequest method.
req, resp := client.CancelElasticsearchServiceSoftwareUpdateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) CancelElasticsearchServiceSoftwareUpdateWithContext added in v1.99.0

func (c *ElasticsearchService) CancelElasticsearchServiceSoftwareUpdateWithContext(ctx aws.Context, input *CancelElasticsearchServiceSoftwareUpdateInput, opts ...request.Option) (*CancelElasticsearchServiceSoftwareUpdateOutput, error)

CancelElasticsearchServiceSoftwareUpdateWithContext is the same as CancelElasticsearchServiceSoftwareUpdate with the addition of the ability to pass a context and additional request options.

See CancelElasticsearchServiceSoftwareUpdate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) CreateElasticsearchDomain

CreateElasticsearchDomain API operation for Amazon Elasticsearch Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation CreateElasticsearchDomain for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

  • ErrCodeInternalException "InternalException" 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.

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

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

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

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

func (*ElasticsearchService) CreateElasticsearchDomainRequest

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

CreateElasticsearchDomainRequest generates a "aws/request.Request" representing the client's request for the CreateElasticsearchDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateElasticsearchDomain for more information on using the CreateElasticsearchDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateElasticsearchDomainRequest method.
req, resp := client.CreateElasticsearchDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) CreateElasticsearchDomainWithContext added in v1.8.0

func (c *ElasticsearchService) CreateElasticsearchDomainWithContext(ctx aws.Context, input *CreateElasticsearchDomainInput, opts ...request.Option) (*CreateElasticsearchDomainOutput, error)

CreateElasticsearchDomainWithContext is the same as CreateElasticsearchDomain with the addition of the ability to pass a context and additional request options.

See CreateElasticsearchDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DeleteElasticsearchDomain

DeleteElasticsearchDomain API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DeleteElasticsearchDomain for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) DeleteElasticsearchDomainRequest

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

DeleteElasticsearchDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteElasticsearchDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteElasticsearchDomain for more information on using the DeleteElasticsearchDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteElasticsearchDomainRequest method.
req, resp := client.DeleteElasticsearchDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DeleteElasticsearchDomainWithContext added in v1.8.0

func (c *ElasticsearchService) DeleteElasticsearchDomainWithContext(ctx aws.Context, input *DeleteElasticsearchDomainInput, opts ...request.Option) (*DeleteElasticsearchDomainOutput, error)

DeleteElasticsearchDomainWithContext is the same as DeleteElasticsearchDomain with the addition of the ability to pass a context and additional request options.

See DeleteElasticsearchDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DeleteElasticsearchServiceRole added in v1.12.12

DeleteElasticsearchServiceRole API operation for Amazon Elasticsearch Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DeleteElasticsearchServiceRole for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

func (*ElasticsearchService) DeleteElasticsearchServiceRoleRequest added in v1.12.12

func (c *ElasticsearchService) DeleteElasticsearchServiceRoleRequest(input *DeleteElasticsearchServiceRoleInput) (req *request.Request, output *DeleteElasticsearchServiceRoleOutput)

DeleteElasticsearchServiceRoleRequest generates a "aws/request.Request" representing the client's request for the DeleteElasticsearchServiceRole operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteElasticsearchServiceRole for more information on using the DeleteElasticsearchServiceRole API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteElasticsearchServiceRoleRequest method.
req, resp := client.DeleteElasticsearchServiceRoleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DeleteElasticsearchServiceRoleWithContext added in v1.12.12

func (c *ElasticsearchService) DeleteElasticsearchServiceRoleWithContext(ctx aws.Context, input *DeleteElasticsearchServiceRoleInput, opts ...request.Option) (*DeleteElasticsearchServiceRoleOutput, error)

DeleteElasticsearchServiceRoleWithContext is the same as DeleteElasticsearchServiceRole with the addition of the ability to pass a context and additional request options.

See DeleteElasticsearchServiceRole for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeElasticsearchDomain

DescribeElasticsearchDomain API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DescribeElasticsearchDomain for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) DescribeElasticsearchDomainConfig

DescribeElasticsearchDomainConfig API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DescribeElasticsearchDomainConfig for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) DescribeElasticsearchDomainConfigRequest

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

DescribeElasticsearchDomainConfigRequest generates a "aws/request.Request" representing the client's request for the DescribeElasticsearchDomainConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeElasticsearchDomainConfig for more information on using the DescribeElasticsearchDomainConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeElasticsearchDomainConfigRequest method.
req, resp := client.DescribeElasticsearchDomainConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DescribeElasticsearchDomainConfigWithContext added in v1.8.0

func (c *ElasticsearchService) DescribeElasticsearchDomainConfigWithContext(ctx aws.Context, input *DescribeElasticsearchDomainConfigInput, opts ...request.Option) (*DescribeElasticsearchDomainConfigOutput, error)

DescribeElasticsearchDomainConfigWithContext is the same as DescribeElasticsearchDomainConfig with the addition of the ability to pass a context and additional request options.

See DescribeElasticsearchDomainConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeElasticsearchDomainRequest

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

DescribeElasticsearchDomainRequest generates a "aws/request.Request" representing the client's request for the DescribeElasticsearchDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeElasticsearchDomain for more information on using the DescribeElasticsearchDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeElasticsearchDomainRequest method.
req, resp := client.DescribeElasticsearchDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DescribeElasticsearchDomainWithContext added in v1.8.0

func (c *ElasticsearchService) DescribeElasticsearchDomainWithContext(ctx aws.Context, input *DescribeElasticsearchDomainInput, opts ...request.Option) (*DescribeElasticsearchDomainOutput, error)

DescribeElasticsearchDomainWithContext is the same as DescribeElasticsearchDomain with the addition of the ability to pass a context and additional request options.

See DescribeElasticsearchDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeElasticsearchDomains

DescribeElasticsearchDomains API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DescribeElasticsearchDomains for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

func (*ElasticsearchService) DescribeElasticsearchDomainsRequest

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

DescribeElasticsearchDomainsRequest generates a "aws/request.Request" representing the client's request for the DescribeElasticsearchDomains operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeElasticsearchDomains for more information on using the DescribeElasticsearchDomains API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeElasticsearchDomainsRequest method.
req, resp := client.DescribeElasticsearchDomainsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DescribeElasticsearchDomainsWithContext added in v1.8.0

func (c *ElasticsearchService) DescribeElasticsearchDomainsWithContext(ctx aws.Context, input *DescribeElasticsearchDomainsInput, opts ...request.Option) (*DescribeElasticsearchDomainsOutput, error)

DescribeElasticsearchDomainsWithContext is the same as DescribeElasticsearchDomains with the addition of the ability to pass a context and additional request options.

See DescribeElasticsearchDomains for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeElasticsearchInstanceTypeLimits added in v1.7.1

DescribeElasticsearchInstanceTypeLimits API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DescribeElasticsearchInstanceTypeLimits for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

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

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

func (*ElasticsearchService) DescribeElasticsearchInstanceTypeLimitsRequest added in v1.7.1

func (c *ElasticsearchService) DescribeElasticsearchInstanceTypeLimitsRequest(input *DescribeElasticsearchInstanceTypeLimitsInput) (req *request.Request, output *DescribeElasticsearchInstanceTypeLimitsOutput)

DescribeElasticsearchInstanceTypeLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeElasticsearchInstanceTypeLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeElasticsearchInstanceTypeLimits for more information on using the DescribeElasticsearchInstanceTypeLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeElasticsearchInstanceTypeLimitsRequest method.
req, resp := client.DescribeElasticsearchInstanceTypeLimitsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DescribeElasticsearchInstanceTypeLimitsWithContext added in v1.8.0

func (c *ElasticsearchService) DescribeElasticsearchInstanceTypeLimitsWithContext(ctx aws.Context, input *DescribeElasticsearchInstanceTypeLimitsInput, opts ...request.Option) (*DescribeElasticsearchInstanceTypeLimitsOutput, error)

DescribeElasticsearchInstanceTypeLimitsWithContext is the same as DescribeElasticsearchInstanceTypeLimits with the addition of the ability to pass a context and additional request options.

See DescribeElasticsearchInstanceTypeLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeReservedElasticsearchInstanceOfferings added in v1.13.43

DescribeReservedElasticsearchInstanceOfferings API operation for Amazon Elasticsearch Service.

Lists available reserved Elasticsearch instance offerings.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DescribeReservedElasticsearchInstanceOfferings for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) DescribeReservedElasticsearchInstanceOfferingsPages added in v1.13.43

DescribeReservedElasticsearchInstanceOfferingsPages iterates over the pages of a DescribeReservedElasticsearchInstanceOfferings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReservedElasticsearchInstanceOfferings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeReservedElasticsearchInstanceOfferings operation.
pageNum := 0
err := client.DescribeReservedElasticsearchInstanceOfferingsPages(params,
    func(page *elasticsearchservice.DescribeReservedElasticsearchInstanceOfferingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElasticsearchService) DescribeReservedElasticsearchInstanceOfferingsPagesWithContext added in v1.13.43

func (c *ElasticsearchService) DescribeReservedElasticsearchInstanceOfferingsPagesWithContext(ctx aws.Context, input *DescribeReservedElasticsearchInstanceOfferingsInput, fn func(*DescribeReservedElasticsearchInstanceOfferingsOutput, bool) bool, opts ...request.Option) error

DescribeReservedElasticsearchInstanceOfferingsPagesWithContext same as DescribeReservedElasticsearchInstanceOfferingsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeReservedElasticsearchInstanceOfferingsRequest added in v1.13.43

func (c *ElasticsearchService) DescribeReservedElasticsearchInstanceOfferingsRequest(input *DescribeReservedElasticsearchInstanceOfferingsInput) (req *request.Request, output *DescribeReservedElasticsearchInstanceOfferingsOutput)

DescribeReservedElasticsearchInstanceOfferingsRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedElasticsearchInstanceOfferings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReservedElasticsearchInstanceOfferings for more information on using the DescribeReservedElasticsearchInstanceOfferings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeReservedElasticsearchInstanceOfferingsRequest method.
req, resp := client.DescribeReservedElasticsearchInstanceOfferingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DescribeReservedElasticsearchInstanceOfferingsWithContext added in v1.13.43

func (c *ElasticsearchService) DescribeReservedElasticsearchInstanceOfferingsWithContext(ctx aws.Context, input *DescribeReservedElasticsearchInstanceOfferingsInput, opts ...request.Option) (*DescribeReservedElasticsearchInstanceOfferingsOutput, error)

DescribeReservedElasticsearchInstanceOfferingsWithContext is the same as DescribeReservedElasticsearchInstanceOfferings with the addition of the ability to pass a context and additional request options.

See DescribeReservedElasticsearchInstanceOfferings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeReservedElasticsearchInstances added in v1.13.43

DescribeReservedElasticsearchInstances API operation for Amazon Elasticsearch Service.

Returns information about reserved Elasticsearch instances for this account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation DescribeReservedElasticsearchInstances for usage and error information.

Returned Error Codes:

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

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) DescribeReservedElasticsearchInstancesPages added in v1.13.43

func (c *ElasticsearchService) DescribeReservedElasticsearchInstancesPages(input *DescribeReservedElasticsearchInstancesInput, fn func(*DescribeReservedElasticsearchInstancesOutput, bool) bool) error

DescribeReservedElasticsearchInstancesPages iterates over the pages of a DescribeReservedElasticsearchInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReservedElasticsearchInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeReservedElasticsearchInstances operation.
pageNum := 0
err := client.DescribeReservedElasticsearchInstancesPages(params,
    func(page *elasticsearchservice.DescribeReservedElasticsearchInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElasticsearchService) DescribeReservedElasticsearchInstancesPagesWithContext added in v1.13.43

func (c *ElasticsearchService) DescribeReservedElasticsearchInstancesPagesWithContext(ctx aws.Context, input *DescribeReservedElasticsearchInstancesInput, fn func(*DescribeReservedElasticsearchInstancesOutput, bool) bool, opts ...request.Option) error

DescribeReservedElasticsearchInstancesPagesWithContext same as DescribeReservedElasticsearchInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) DescribeReservedElasticsearchInstancesRequest added in v1.13.43

func (c *ElasticsearchService) DescribeReservedElasticsearchInstancesRequest(input *DescribeReservedElasticsearchInstancesInput) (req *request.Request, output *DescribeReservedElasticsearchInstancesOutput)

DescribeReservedElasticsearchInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedElasticsearchInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReservedElasticsearchInstances for more information on using the DescribeReservedElasticsearchInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeReservedElasticsearchInstancesRequest method.
req, resp := client.DescribeReservedElasticsearchInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) DescribeReservedElasticsearchInstancesWithContext added in v1.13.43

func (c *ElasticsearchService) DescribeReservedElasticsearchInstancesWithContext(ctx aws.Context, input *DescribeReservedElasticsearchInstancesInput, opts ...request.Option) (*DescribeReservedElasticsearchInstancesOutput, error)

DescribeReservedElasticsearchInstancesWithContext is the same as DescribeReservedElasticsearchInstances with the addition of the ability to pass a context and additional request options.

See DescribeReservedElasticsearchInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) GetCompatibleElasticsearchVersions added in v1.99.0

GetCompatibleElasticsearchVersions API operation for Amazon Elasticsearch Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation GetCompatibleElasticsearchVersions for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) GetCompatibleElasticsearchVersionsRequest added in v1.99.0

func (c *ElasticsearchService) GetCompatibleElasticsearchVersionsRequest(input *GetCompatibleElasticsearchVersionsInput) (req *request.Request, output *GetCompatibleElasticsearchVersionsOutput)

GetCompatibleElasticsearchVersionsRequest generates a "aws/request.Request" representing the client's request for the GetCompatibleElasticsearchVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCompatibleElasticsearchVersions for more information on using the GetCompatibleElasticsearchVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCompatibleElasticsearchVersionsRequest method.
req, resp := client.GetCompatibleElasticsearchVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) GetCompatibleElasticsearchVersionsWithContext added in v1.99.0

func (c *ElasticsearchService) GetCompatibleElasticsearchVersionsWithContext(ctx aws.Context, input *GetCompatibleElasticsearchVersionsInput, opts ...request.Option) (*GetCompatibleElasticsearchVersionsOutput, error)

GetCompatibleElasticsearchVersionsWithContext is the same as GetCompatibleElasticsearchVersions with the addition of the ability to pass a context and additional request options.

See GetCompatibleElasticsearchVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) GetUpgradeHistory added in v1.99.0

GetUpgradeHistory API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation GetUpgradeHistory for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) GetUpgradeHistoryPages added in v1.99.0

func (c *ElasticsearchService) GetUpgradeHistoryPages(input *GetUpgradeHistoryInput, fn func(*GetUpgradeHistoryOutput, bool) bool) error

GetUpgradeHistoryPages iterates over the pages of a GetUpgradeHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetUpgradeHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetUpgradeHistory operation.
pageNum := 0
err := client.GetUpgradeHistoryPages(params,
    func(page *elasticsearchservice.GetUpgradeHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElasticsearchService) GetUpgradeHistoryPagesWithContext added in v1.99.0

func (c *ElasticsearchService) GetUpgradeHistoryPagesWithContext(ctx aws.Context, input *GetUpgradeHistoryInput, fn func(*GetUpgradeHistoryOutput, bool) bool, opts ...request.Option) error

GetUpgradeHistoryPagesWithContext same as GetUpgradeHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) GetUpgradeHistoryRequest added in v1.99.0

func (c *ElasticsearchService) GetUpgradeHistoryRequest(input *GetUpgradeHistoryInput) (req *request.Request, output *GetUpgradeHistoryOutput)

GetUpgradeHistoryRequest generates a "aws/request.Request" representing the client's request for the GetUpgradeHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetUpgradeHistory for more information on using the GetUpgradeHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetUpgradeHistoryRequest method.
req, resp := client.GetUpgradeHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) GetUpgradeHistoryWithContext added in v1.99.0

func (c *ElasticsearchService) GetUpgradeHistoryWithContext(ctx aws.Context, input *GetUpgradeHistoryInput, opts ...request.Option) (*GetUpgradeHistoryOutput, error)

GetUpgradeHistoryWithContext is the same as GetUpgradeHistory with the addition of the ability to pass a context and additional request options.

See GetUpgradeHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) GetUpgradeStatus added in v1.99.0

GetUpgradeStatus API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation GetUpgradeStatus for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) GetUpgradeStatusRequest added in v1.99.0

func (c *ElasticsearchService) GetUpgradeStatusRequest(input *GetUpgradeStatusInput) (req *request.Request, output *GetUpgradeStatusOutput)

GetUpgradeStatusRequest generates a "aws/request.Request" representing the client's request for the GetUpgradeStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetUpgradeStatus for more information on using the GetUpgradeStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetUpgradeStatusRequest method.
req, resp := client.GetUpgradeStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) GetUpgradeStatusWithContext added in v1.99.0

func (c *ElasticsearchService) GetUpgradeStatusWithContext(ctx aws.Context, input *GetUpgradeStatusInput, opts ...request.Option) (*GetUpgradeStatusOutput, error)

GetUpgradeStatusWithContext is the same as GetUpgradeStatus with the addition of the ability to pass a context and additional request options.

See GetUpgradeStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) ListDomainNames

ListDomainNames API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation ListDomainNames for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

func (*ElasticsearchService) ListDomainNamesRequest

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

ListDomainNamesRequest generates a "aws/request.Request" representing the client's request for the ListDomainNames operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDomainNames for more information on using the ListDomainNames API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDomainNamesRequest method.
req, resp := client.ListDomainNamesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) ListDomainNamesWithContext added in v1.8.0

func (c *ElasticsearchService) ListDomainNamesWithContext(ctx aws.Context, input *ListDomainNamesInput, opts ...request.Option) (*ListDomainNamesOutput, error)

ListDomainNamesWithContext is the same as ListDomainNames with the addition of the ability to pass a context and additional request options.

See ListDomainNames for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) ListElasticsearchInstanceTypes added in v1.7.1

ListElasticsearchInstanceTypes API operation for Amazon Elasticsearch Service.

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation ListElasticsearchInstanceTypes for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) ListElasticsearchInstanceTypesPages added in v1.7.1

func (c *ElasticsearchService) ListElasticsearchInstanceTypesPages(input *ListElasticsearchInstanceTypesInput, fn func(*ListElasticsearchInstanceTypesOutput, bool) bool) error

ListElasticsearchInstanceTypesPages iterates over the pages of a ListElasticsearchInstanceTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListElasticsearchInstanceTypes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListElasticsearchInstanceTypes operation.
pageNum := 0
err := client.ListElasticsearchInstanceTypesPages(params,
    func(page *elasticsearchservice.ListElasticsearchInstanceTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElasticsearchService) ListElasticsearchInstanceTypesPagesWithContext added in v1.8.0

func (c *ElasticsearchService) ListElasticsearchInstanceTypesPagesWithContext(ctx aws.Context, input *ListElasticsearchInstanceTypesInput, fn func(*ListElasticsearchInstanceTypesOutput, bool) bool, opts ...request.Option) error

ListElasticsearchInstanceTypesPagesWithContext same as ListElasticsearchInstanceTypesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) ListElasticsearchInstanceTypesRequest added in v1.7.1

func (c *ElasticsearchService) ListElasticsearchInstanceTypesRequest(input *ListElasticsearchInstanceTypesInput) (req *request.Request, output *ListElasticsearchInstanceTypesOutput)

ListElasticsearchInstanceTypesRequest generates a "aws/request.Request" representing the client's request for the ListElasticsearchInstanceTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListElasticsearchInstanceTypes for more information on using the ListElasticsearchInstanceTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListElasticsearchInstanceTypesRequest method.
req, resp := client.ListElasticsearchInstanceTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) ListElasticsearchInstanceTypesWithContext added in v1.8.0

func (c *ElasticsearchService) ListElasticsearchInstanceTypesWithContext(ctx aws.Context, input *ListElasticsearchInstanceTypesInput, opts ...request.Option) (*ListElasticsearchInstanceTypesOutput, error)

ListElasticsearchInstanceTypesWithContext is the same as ListElasticsearchInstanceTypes with the addition of the ability to pass a context and additional request options.

See ListElasticsearchInstanceTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) ListElasticsearchVersions added in v1.7.1

ListElasticsearchVersions API operation for Amazon Elasticsearch Service.

List all supported Elasticsearch versions

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation ListElasticsearchVersions for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) ListElasticsearchVersionsPages added in v1.7.1

func (c *ElasticsearchService) ListElasticsearchVersionsPages(input *ListElasticsearchVersionsInput, fn func(*ListElasticsearchVersionsOutput, bool) bool) error

ListElasticsearchVersionsPages iterates over the pages of a ListElasticsearchVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListElasticsearchVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListElasticsearchVersions operation.
pageNum := 0
err := client.ListElasticsearchVersionsPages(params,
    func(page *elasticsearchservice.ListElasticsearchVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElasticsearchService) ListElasticsearchVersionsPagesWithContext added in v1.8.0

func (c *ElasticsearchService) ListElasticsearchVersionsPagesWithContext(ctx aws.Context, input *ListElasticsearchVersionsInput, fn func(*ListElasticsearchVersionsOutput, bool) bool, opts ...request.Option) error

ListElasticsearchVersionsPagesWithContext same as ListElasticsearchVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) ListElasticsearchVersionsRequest added in v1.7.1

func (c *ElasticsearchService) ListElasticsearchVersionsRequest(input *ListElasticsearchVersionsInput) (req *request.Request, output *ListElasticsearchVersionsOutput)

ListElasticsearchVersionsRequest generates a "aws/request.Request" representing the client's request for the ListElasticsearchVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListElasticsearchVersions for more information on using the ListElasticsearchVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListElasticsearchVersionsRequest method.
req, resp := client.ListElasticsearchVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) ListElasticsearchVersionsWithContext added in v1.8.0

func (c *ElasticsearchService) ListElasticsearchVersionsWithContext(ctx aws.Context, input *ListElasticsearchVersionsInput, opts ...request.Option) (*ListElasticsearchVersionsOutput, error)

ListElasticsearchVersionsWithContext is the same as ListElasticsearchVersions with the addition of the ability to pass a context and additional request options.

See ListElasticsearchVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) ListTags

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

ListTags API operation for Amazon Elasticsearch Service.

Returns all tags for the given Elasticsearch domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation ListTags for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) ListTagsRequest

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

ListTagsRequest generates a "aws/request.Request" representing the client's request for the ListTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTags for more information on using the ListTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsRequest method.
req, resp := client.ListTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) ListTagsWithContext added in v1.8.0

func (c *ElasticsearchService) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

ListTagsWithContext is the same as ListTags with the addition of the ability to pass a context and additional request options.

See ListTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) PurchaseReservedElasticsearchInstanceOffering added in v1.13.43

PurchaseReservedElasticsearchInstanceOffering API operation for Amazon Elasticsearch Service.

Allows you to purchase reserved Elasticsearch instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation PurchaseReservedElasticsearchInstanceOffering for usage and error information.

Returned Error Codes:

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

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

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

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) PurchaseReservedElasticsearchInstanceOfferingRequest added in v1.13.43

func (c *ElasticsearchService) PurchaseReservedElasticsearchInstanceOfferingRequest(input *PurchaseReservedElasticsearchInstanceOfferingInput) (req *request.Request, output *PurchaseReservedElasticsearchInstanceOfferingOutput)

PurchaseReservedElasticsearchInstanceOfferingRequest generates a "aws/request.Request" representing the client's request for the PurchaseReservedElasticsearchInstanceOffering operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PurchaseReservedElasticsearchInstanceOffering for more information on using the PurchaseReservedElasticsearchInstanceOffering API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PurchaseReservedElasticsearchInstanceOfferingRequest method.
req, resp := client.PurchaseReservedElasticsearchInstanceOfferingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) PurchaseReservedElasticsearchInstanceOfferingWithContext added in v1.13.43

func (c *ElasticsearchService) PurchaseReservedElasticsearchInstanceOfferingWithContext(ctx aws.Context, input *PurchaseReservedElasticsearchInstanceOfferingInput, opts ...request.Option) (*PurchaseReservedElasticsearchInstanceOfferingOutput, error)

PurchaseReservedElasticsearchInstanceOfferingWithContext is the same as PurchaseReservedElasticsearchInstanceOffering with the addition of the ability to pass a context and additional request options.

See PurchaseReservedElasticsearchInstanceOffering for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) RemoveTags

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

RemoveTags API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation RemoveTags for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) RemoveTagsRequest

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

RemoveTagsRequest generates a "aws/request.Request" representing the client's request for the RemoveTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTags for more information on using the RemoveTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveTagsRequest method.
req, resp := client.RemoveTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) RemoveTagsWithContext added in v1.8.0

func (c *ElasticsearchService) RemoveTagsWithContext(ctx aws.Context, input *RemoveTagsInput, opts ...request.Option) (*RemoveTagsOutput, error)

RemoveTagsWithContext is the same as RemoveTags with the addition of the ability to pass a context and additional request options.

See RemoveTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) StartElasticsearchServiceSoftwareUpdate added in v1.99.0

StartElasticsearchServiceSoftwareUpdate API operation for Amazon Elasticsearch Service.

Schedules a service software update for an Amazon ES domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation StartElasticsearchServiceSoftwareUpdate for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

func (*ElasticsearchService) StartElasticsearchServiceSoftwareUpdateRequest added in v1.99.0

func (c *ElasticsearchService) StartElasticsearchServiceSoftwareUpdateRequest(input *StartElasticsearchServiceSoftwareUpdateInput) (req *request.Request, output *StartElasticsearchServiceSoftwareUpdateOutput)

StartElasticsearchServiceSoftwareUpdateRequest generates a "aws/request.Request" representing the client's request for the StartElasticsearchServiceSoftwareUpdate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartElasticsearchServiceSoftwareUpdate for more information on using the StartElasticsearchServiceSoftwareUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartElasticsearchServiceSoftwareUpdateRequest method.
req, resp := client.StartElasticsearchServiceSoftwareUpdateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) StartElasticsearchServiceSoftwareUpdateWithContext added in v1.99.0

func (c *ElasticsearchService) StartElasticsearchServiceSoftwareUpdateWithContext(ctx aws.Context, input *StartElasticsearchServiceSoftwareUpdateInput, opts ...request.Option) (*StartElasticsearchServiceSoftwareUpdateOutput, error)

StartElasticsearchServiceSoftwareUpdateWithContext is the same as StartElasticsearchServiceSoftwareUpdate with the addition of the ability to pass a context and additional request options.

See StartElasticsearchServiceSoftwareUpdate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) UpdateElasticsearchDomainConfig

UpdateElasticsearchDomainConfig API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation UpdateElasticsearchDomainConfig for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "InternalException" 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.

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

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

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

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

func (*ElasticsearchService) UpdateElasticsearchDomainConfigRequest

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

UpdateElasticsearchDomainConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateElasticsearchDomainConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateElasticsearchDomainConfig for more information on using the UpdateElasticsearchDomainConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateElasticsearchDomainConfigRequest method.
req, resp := client.UpdateElasticsearchDomainConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) UpdateElasticsearchDomainConfigWithContext added in v1.8.0

func (c *ElasticsearchService) UpdateElasticsearchDomainConfigWithContext(ctx aws.Context, input *UpdateElasticsearchDomainConfigInput, opts ...request.Option) (*UpdateElasticsearchDomainConfigOutput, error)

UpdateElasticsearchDomainConfigWithContext is the same as UpdateElasticsearchDomainConfig with the addition of the ability to pass a context and additional request options.

See UpdateElasticsearchDomainConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ElasticsearchService) UpgradeElasticsearchDomain added in v1.99.0

UpgradeElasticsearchDomain API operation for Amazon Elasticsearch Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elasticsearch Service's API operation UpgradeElasticsearchDomain for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

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

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

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

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

  • ErrCodeInternalException "InternalException" 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.

func (*ElasticsearchService) UpgradeElasticsearchDomainRequest added in v1.99.0

func (c *ElasticsearchService) UpgradeElasticsearchDomainRequest(input *UpgradeElasticsearchDomainInput) (req *request.Request, output *UpgradeElasticsearchDomainOutput)

UpgradeElasticsearchDomainRequest generates a "aws/request.Request" representing the client's request for the UpgradeElasticsearchDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpgradeElasticsearchDomain for more information on using the UpgradeElasticsearchDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpgradeElasticsearchDomainRequest method.
req, resp := client.UpgradeElasticsearchDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*ElasticsearchService) UpgradeElasticsearchDomainWithContext added in v1.99.0

func (c *ElasticsearchService) UpgradeElasticsearchDomainWithContext(ctx aws.Context, input *UpgradeElasticsearchDomainInput, opts ...request.Option) (*UpgradeElasticsearchDomainOutput, error)

UpgradeElasticsearchDomainWithContext is the same as UpgradeElasticsearchDomain with the addition of the ability to pass a context and additional request options.

See UpgradeElasticsearchDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ElasticsearchVersionStatus added in v1.2.10

type ElasticsearchVersionStatus struct {

	// Specifies the Elasticsearch version for the specified Elasticsearch domain.
	//
	// Options is a required field
	Options *string `type:"string" required:"true"`

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

Status of the Elasticsearch version options for the specified Elasticsearch domain.

func (ElasticsearchVersionStatus) GoString added in v1.2.10

func (s ElasticsearchVersionStatus) GoString() string

GoString returns the string representation

func (*ElasticsearchVersionStatus) SetOptions added in v1.5.0

SetOptions sets the Options field's value.

func (*ElasticsearchVersionStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (ElasticsearchVersionStatus) String added in v1.2.10

String returns the string representation

type EncryptionAtRestOptions added in v1.12.43

type EncryptionAtRestOptions struct {

	// Specifies the option to enable Encryption At Rest.
	Enabled *bool `type:"boolean"`

	// Specifies the KMS Key ID for Encryption At Rest options.
	KmsKeyId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the Encryption At Rest Options.

func (EncryptionAtRestOptions) GoString added in v1.12.43

func (s EncryptionAtRestOptions) GoString() string

GoString returns the string representation

func (*EncryptionAtRestOptions) SetEnabled added in v1.12.43

SetEnabled sets the Enabled field's value.

func (*EncryptionAtRestOptions) SetKmsKeyId added in v1.12.43

SetKmsKeyId sets the KmsKeyId field's value.

func (EncryptionAtRestOptions) String added in v1.12.43

func (s EncryptionAtRestOptions) String() string

String returns the string representation

func (*EncryptionAtRestOptions) Validate added in v1.12.43

func (s *EncryptionAtRestOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EncryptionAtRestOptionsStatus added in v1.12.43

type EncryptionAtRestOptionsStatus struct {

	// Specifies the Encryption At Rest options for the specified Elasticsearch
	// domain.
	//
	// Options is a required field
	Options *EncryptionAtRestOptions `type:"structure" required:"true"`

	// Specifies the status of the Encryption At Rest options for the specified
	// Elasticsearch domain.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Status of the Encryption At Rest options for the specified Elasticsearch domain.

func (EncryptionAtRestOptionsStatus) GoString added in v1.12.43

GoString returns the string representation

func (*EncryptionAtRestOptionsStatus) SetOptions added in v1.12.43

SetOptions sets the Options field's value.

func (*EncryptionAtRestOptionsStatus) SetStatus added in v1.12.43

SetStatus sets the Status field's value.

func (EncryptionAtRestOptionsStatus) String added in v1.12.43

String returns the string representation

type GetCompatibleElasticsearchVersionsInput added in v1.99.0

type GetCompatibleElasticsearchVersionsInput struct {

	// 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 `location:"querystring" locationName:"domainName" min:"3" type:"string"`
	// contains filtered or unexported fields
}

Container for request parameters to GetCompatibleElasticsearchVersions operation.

func (GetCompatibleElasticsearchVersionsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetCompatibleElasticsearchVersionsInput) SetDomainName added in v1.99.0

SetDomainName sets the DomainName field's value.

func (GetCompatibleElasticsearchVersionsInput) String added in v1.99.0

String returns the string representation

func (*GetCompatibleElasticsearchVersionsInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetCompatibleElasticsearchVersionsOutput added in v1.99.0

type GetCompatibleElasticsearchVersionsOutput struct {

	// A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions
	// operation.
	CompatibleElasticsearchVersions []*CompatibleVersionsMap `type:"list"`
	// contains filtered or unexported fields
}

Container for response returned by GetCompatibleElasticsearchVersions operation.

func (GetCompatibleElasticsearchVersionsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetCompatibleElasticsearchVersionsOutput) SetCompatibleElasticsearchVersions added in v1.99.0

SetCompatibleElasticsearchVersions sets the CompatibleElasticsearchVersions field's value.

func (GetCompatibleElasticsearchVersionsOutput) String added in v1.99.0

String returns the string representation

type GetUpgradeHistoryInput added in v1.99.0

type GetUpgradeHistoryInput struct {

	// 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 is a required field
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

	// Set this value to limit the number of results returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Container for request parameters to GetUpgradeHistory operation.

func (GetUpgradeHistoryInput) GoString added in v1.99.0

func (s GetUpgradeHistoryInput) GoString() string

GoString returns the string representation

func (*GetUpgradeHistoryInput) SetDomainName added in v1.99.0

SetDomainName sets the DomainName field's value.

func (*GetUpgradeHistoryInput) SetMaxResults added in v1.99.0

SetMaxResults sets the MaxResults field's value.

func (*GetUpgradeHistoryInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (GetUpgradeHistoryInput) String added in v1.99.0

func (s GetUpgradeHistoryInput) String() string

String returns the string representation

func (*GetUpgradeHistoryInput) Validate added in v1.99.0

func (s *GetUpgradeHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetUpgradeHistoryOutput added in v1.99.0

type GetUpgradeHistoryOutput struct {

	// Pagination token that needs to be supplied to the next call to get the next
	// page of results
	NextToken *string `type:"string"`

	// A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade
	// Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse
	// object.
	UpgradeHistories []*UpgradeHistory `type:"list"`
	// contains filtered or unexported fields
}

Container for response returned by GetUpgradeHistory operation.

func (GetUpgradeHistoryOutput) GoString added in v1.99.0

func (s GetUpgradeHistoryOutput) GoString() string

GoString returns the string representation

func (*GetUpgradeHistoryOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*GetUpgradeHistoryOutput) SetUpgradeHistories added in v1.99.0

func (s *GetUpgradeHistoryOutput) SetUpgradeHistories(v []*UpgradeHistory) *GetUpgradeHistoryOutput

SetUpgradeHistories sets the UpgradeHistories field's value.

func (GetUpgradeHistoryOutput) String added in v1.99.0

func (s GetUpgradeHistoryOutput) String() string

String returns the string representation

type GetUpgradeStatusInput added in v1.99.0

type GetUpgradeStatusInput struct {

	// 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 is a required field
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for request parameters to GetUpgradeStatus operation.

func (GetUpgradeStatusInput) GoString added in v1.99.0

func (s GetUpgradeStatusInput) GoString() string

GoString returns the string representation

func (*GetUpgradeStatusInput) SetDomainName added in v1.99.0

func (s *GetUpgradeStatusInput) SetDomainName(v string) *GetUpgradeStatusInput

SetDomainName sets the DomainName field's value.

func (GetUpgradeStatusInput) String added in v1.99.0

func (s GetUpgradeStatusInput) String() string

String returns the string representation

func (*GetUpgradeStatusInput) Validate added in v1.99.0

func (s *GetUpgradeStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetUpgradeStatusOutput added in v1.99.0

type GetUpgradeStatusOutput struct {

	// One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse
	// object. The status can take one of the following values:
	//    * In Progress
	//
	//    * Succeeded
	//
	//    * Succeeded with Issues
	//
	//    * Failed
	StepStatus *string `type:"string" enum:"UpgradeStatus"`

	// A string that describes the update briefly
	UpgradeName *string `type:"string"`

	// Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does
	// through:
	//    * PreUpgradeCheck
	//
	//    * Snapshot
	//
	//    * Upgrade
	UpgradeStep *string `type:"string" enum:"UpgradeStep"`
	// contains filtered or unexported fields
}

Container for response returned by GetUpgradeStatus operation.

func (GetUpgradeStatusOutput) GoString added in v1.99.0

func (s GetUpgradeStatusOutput) GoString() string

GoString returns the string representation

func (*GetUpgradeStatusOutput) SetStepStatus added in v1.99.0

SetStepStatus sets the StepStatus field's value.

func (*GetUpgradeStatusOutput) SetUpgradeName added in v1.99.0

SetUpgradeName sets the UpgradeName field's value.

func (*GetUpgradeStatusOutput) SetUpgradeStep added in v1.99.0

SetUpgradeStep sets the UpgradeStep field's value.

func (GetUpgradeStatusOutput) String added in v1.99.0

func (s GetUpgradeStatusOutput) String() string

String returns the string representation

type InstanceCountLimits added in v1.7.1

type InstanceCountLimits struct {

	// Maximum number of Instances that can be instantiated for given InstanceType.
	MaximumInstanceCount *int64 `type:"integer"`

	// Minimum number of Instances that can be instantiated for given InstanceType.
	MinimumInstanceCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (InstanceCountLimits) GoString added in v1.7.1

func (s InstanceCountLimits) GoString() string

GoString returns the string representation

func (*InstanceCountLimits) SetMaximumInstanceCount added in v1.7.1

func (s *InstanceCountLimits) SetMaximumInstanceCount(v int64) *InstanceCountLimits

SetMaximumInstanceCount sets the MaximumInstanceCount field's value.

func (*InstanceCountLimits) SetMinimumInstanceCount added in v1.7.1

func (s *InstanceCountLimits) SetMinimumInstanceCount(v int64) *InstanceCountLimits

SetMinimumInstanceCount sets the MinimumInstanceCount field's value.

func (InstanceCountLimits) String added in v1.7.1

func (s InstanceCountLimits) String() string

String returns the string representation

type InstanceLimits added in v1.7.1

type InstanceLimits struct {

	// InstanceCountLimits represents the limits on number of instances that be
	// created in Amazon Elasticsearch for given InstanceType.
	InstanceCountLimits *InstanceCountLimits `type:"structure"`
	// contains filtered or unexported fields
}

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

func (InstanceLimits) GoString added in v1.7.1

func (s InstanceLimits) GoString() string

GoString returns the string representation

func (*InstanceLimits) SetInstanceCountLimits added in v1.7.1

func (s *InstanceLimits) SetInstanceCountLimits(v *InstanceCountLimits) *InstanceLimits

SetInstanceCountLimits sets the InstanceCountLimits field's value.

func (InstanceLimits) String added in v1.7.1

func (s InstanceLimits) String() string

String returns the string representation

type Limits added in v1.7.1

type Limits struct {

	// List of additional limits that are specific to a given InstanceType and for
	// each of it's InstanceRole .
	AdditionalLimits []*AdditionalLimit `type:"list"`

	// InstanceLimits represents the list of instance related attributes that are
	// available for given InstanceType.
	InstanceLimits *InstanceLimits `type:"structure"`

	// StorageType represents the list of storage related types and attributes that
	// are available for given InstanceType.
	StorageTypes []*StorageType `type:"list"`
	// contains filtered or unexported fields
}

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

func (Limits) GoString added in v1.7.1

func (s Limits) GoString() string

GoString returns the string representation

func (*Limits) SetAdditionalLimits added in v1.7.1

func (s *Limits) SetAdditionalLimits(v []*AdditionalLimit) *Limits

SetAdditionalLimits sets the AdditionalLimits field's value.

func (*Limits) SetInstanceLimits added in v1.7.1

func (s *Limits) SetInstanceLimits(v *InstanceLimits) *Limits

SetInstanceLimits sets the InstanceLimits field's value.

func (*Limits) SetStorageTypes added in v1.7.1

func (s *Limits) SetStorageTypes(v []*StorageType) *Limits

SetStorageTypes sets the StorageTypes field's value.

func (Limits) String added in v1.7.1

func (s Limits) String() string

String returns the string representation

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) SetDomainNames added in v1.5.0

func (s *ListDomainNamesOutput) SetDomainNames(v []*DomainInfo) *ListDomainNamesOutput

SetDomainNames sets the DomainNames field's value.

func (ListDomainNamesOutput) String

func (s ListDomainNamesOutput) String() string

String returns the string representation

type ListElasticsearchInstanceTypesInput added in v1.7.1

type ListElasticsearchInstanceTypesInput struct {

	// DomainName represents the name of the Domain that we are trying to modify.
	// This should be present only if we are querying for list of available Elasticsearch
	// instance types when modifying existing domain.
	DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"`

	// Version of Elasticsearch for which list of supported elasticsearch instance
	// types are needed.
	//
	// ElasticsearchVersion is a required field
	ElasticsearchVersion *string `location:"uri" locationName:"ElasticsearchVersion" type:"string" required:"true"`

	// Set this value to limit the number of results returned. Value provided must
	// be greater than 30 else it wont be honored.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters to the ListElasticsearchInstanceTypes operation.

func (ListElasticsearchInstanceTypesInput) GoString added in v1.7.1

GoString returns the string representation

func (*ListElasticsearchInstanceTypesInput) SetDomainName added in v1.7.1

SetDomainName sets the DomainName field's value.

func (*ListElasticsearchInstanceTypesInput) SetElasticsearchVersion added in v1.7.1

SetElasticsearchVersion sets the ElasticsearchVersion field's value.

func (*ListElasticsearchInstanceTypesInput) SetMaxResults added in v1.7.1

SetMaxResults sets the MaxResults field's value.

func (*ListElasticsearchInstanceTypesInput) SetNextToken added in v1.7.1

SetNextToken sets the NextToken field's value.

func (ListElasticsearchInstanceTypesInput) String added in v1.7.1

String returns the string representation

func (*ListElasticsearchInstanceTypesInput) Validate added in v1.7.1

Validate inspects the fields of the type to determine if they are valid.

type ListElasticsearchInstanceTypesOutput added in v1.7.1

type ListElasticsearchInstanceTypesOutput struct {

	// List of instance types supported by Amazon Elasticsearch service for given
	// ElasticsearchVersion
	ElasticsearchInstanceTypes []*string `type:"list"`

	// In case if there are more results available NextToken would be present, make
	// further request to the same API with received NextToken to paginate remaining
	// results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters returned by ListElasticsearchInstanceTypes operation.

func (ListElasticsearchInstanceTypesOutput) GoString added in v1.7.1

GoString returns the string representation

func (*ListElasticsearchInstanceTypesOutput) SetElasticsearchInstanceTypes added in v1.7.1

SetElasticsearchInstanceTypes sets the ElasticsearchInstanceTypes field's value.

func (*ListElasticsearchInstanceTypesOutput) SetNextToken added in v1.7.1

SetNextToken sets the NextToken field's value.

func (ListElasticsearchInstanceTypesOutput) String added in v1.7.1

String returns the string representation

type ListElasticsearchVersionsInput added in v1.7.1

type ListElasticsearchVersionsInput struct {

	// Set this value to limit the number of results returned. Value provided must
	// be greater than 10 else it wont be honored.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

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.

func (ListElasticsearchVersionsInput) GoString added in v1.7.1

GoString returns the string representation

func (*ListElasticsearchVersionsInput) SetMaxResults added in v1.7.1

SetMaxResults sets the MaxResults field's value.

func (*ListElasticsearchVersionsInput) SetNextToken added in v1.7.1

SetNextToken sets the NextToken field's value.

func (ListElasticsearchVersionsInput) String added in v1.7.1

String returns the string representation

type ListElasticsearchVersionsOutput added in v1.7.1

type ListElasticsearchVersionsOutput struct {

	// List of supported elastic search versions.
	ElasticsearchVersions []*string `type:"list"`

	// 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.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters for response received from ListElasticsearchVersions operation.

func (ListElasticsearchVersionsOutput) GoString added in v1.7.1

GoString returns the string representation

func (*ListElasticsearchVersionsOutput) SetElasticsearchVersions added in v1.7.1

func (s *ListElasticsearchVersionsOutput) SetElasticsearchVersions(v []*string) *ListElasticsearchVersionsOutput

SetElasticsearchVersions sets the ElasticsearchVersions field's value.

func (*ListElasticsearchVersionsOutput) SetNextToken added in v1.7.1

SetNextToken sets the NextToken field's value.

func (ListElasticsearchVersionsOutput) String added in v1.7.1

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 is a required field
	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) SetARN added in v1.5.0

func (s *ListTagsInput) SetARN(v string) *ListTagsInput

SetARN sets the ARN field's value.

func (ListTagsInput) String

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate added in v1.1.21

func (s *ListTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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) SetTagList added in v1.5.0

func (s *ListTagsOutput) SetTagList(v []*Tag) *ListTagsOutput

SetTagList sets the TagList field's value.

func (ListTagsOutput) String

func (s ListTagsOutput) String() string

String returns the string representation

type LogPublishingOption added in v1.12.11

type LogPublishingOption struct {

	// ARN of the Cloudwatch log group to which log needs to be published.
	CloudWatchLogsLogGroupArn *string `type:"string"`

	// Specifies whether given log publishing option is enabled or not.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (LogPublishingOption) GoString added in v1.12.11

func (s LogPublishingOption) GoString() string

GoString returns the string representation

func (*LogPublishingOption) SetCloudWatchLogsLogGroupArn added in v1.12.11

func (s *LogPublishingOption) SetCloudWatchLogsLogGroupArn(v string) *LogPublishingOption

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*LogPublishingOption) SetEnabled added in v1.12.11

func (s *LogPublishingOption) SetEnabled(v bool) *LogPublishingOption

SetEnabled sets the Enabled field's value.

func (LogPublishingOption) String added in v1.12.11

func (s LogPublishingOption) String() string

String returns the string representation

type LogPublishingOptionsStatus added in v1.12.11

type LogPublishingOptionsStatus struct {

	// The log publishing options configured for the Elasticsearch domain.
	Options map[string]*LogPublishingOption `type:"map"`

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

The configured log publishing options for the domain and their current status.

func (LogPublishingOptionsStatus) GoString added in v1.12.11

func (s LogPublishingOptionsStatus) GoString() string

GoString returns the string representation

func (*LogPublishingOptionsStatus) SetOptions added in v1.12.11

SetOptions sets the Options field's value.

func (*LogPublishingOptionsStatus) SetStatus added in v1.12.11

SetStatus sets the Status field's value.

func (LogPublishingOptionsStatus) String added in v1.12.11

String returns the string representation

type NodeToNodeEncryptionOptions added in v1.99.0

type NodeToNodeEncryptionOptions struct {

	// Specify true to enable node-to-node encryption.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the node-to-node encryption options.

func (NodeToNodeEncryptionOptions) GoString added in v1.99.0

func (s NodeToNodeEncryptionOptions) GoString() string

GoString returns the string representation

func (*NodeToNodeEncryptionOptions) SetEnabled added in v1.99.0

SetEnabled sets the Enabled field's value.

func (NodeToNodeEncryptionOptions) String added in v1.99.0

String returns the string representation

type NodeToNodeEncryptionOptionsStatus added in v1.99.0

type NodeToNodeEncryptionOptionsStatus struct {

	// Specifies the node-to-node encryption options for the specified Elasticsearch
	// domain.
	//
	// Options is a required field
	Options *NodeToNodeEncryptionOptions `type:"structure" required:"true"`

	// Specifies the status of the node-to-node encryption options for the specified
	// Elasticsearch domain.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Status of the node-to-node encryption options for the specified Elasticsearch domain.

func (NodeToNodeEncryptionOptionsStatus) GoString added in v1.99.0

GoString returns the string representation

func (*NodeToNodeEncryptionOptionsStatus) SetOptions added in v1.99.0

SetOptions sets the Options field's value.

func (*NodeToNodeEncryptionOptionsStatus) SetStatus added in v1.99.0

SetStatus sets the Status field's value.

func (NodeToNodeEncryptionOptionsStatus) String added in v1.99.0

String returns the string representation

type OptionStatus

type OptionStatus struct {

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

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

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

	// Timestamp which tells the last updated time for the entity.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `type:"timestamp" 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) SetCreationDate added in v1.5.0

func (s *OptionStatus) SetCreationDate(v time.Time) *OptionStatus

SetCreationDate sets the CreationDate field's value.

func (*OptionStatus) SetPendingDeletion added in v1.5.0

func (s *OptionStatus) SetPendingDeletion(v bool) *OptionStatus

SetPendingDeletion sets the PendingDeletion field's value.

func (*OptionStatus) SetState added in v1.5.0

func (s *OptionStatus) SetState(v string) *OptionStatus

SetState sets the State field's value.

func (*OptionStatus) SetUpdateDate added in v1.5.0

func (s *OptionStatus) SetUpdateDate(v time.Time) *OptionStatus

SetUpdateDate sets the UpdateDate field's value.

func (*OptionStatus) SetUpdateVersion added in v1.5.0

func (s *OptionStatus) SetUpdateVersion(v int64) *OptionStatus

SetUpdateVersion sets the UpdateVersion field's value.

func (OptionStatus) String

func (s OptionStatus) String() string

String returns the string representation

type PurchaseReservedElasticsearchInstanceOfferingInput added in v1.13.43

type PurchaseReservedElasticsearchInstanceOfferingInput struct {

	// The number of Elasticsearch instances to reserve.
	InstanceCount *int64 `min:"1" type:"integer"`

	// A customer-specified identifier to track this reservation.
	//
	// ReservationName is a required field
	ReservationName *string `min:"5" type:"string" required:"true"`

	// The ID of the reserved Elasticsearch instance offering to purchase.
	//
	// ReservedElasticsearchInstanceOfferingId is a required field
	ReservedElasticsearchInstanceOfferingId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for parameters to PurchaseReservedElasticsearchInstanceOffering

func (PurchaseReservedElasticsearchInstanceOfferingInput) GoString added in v1.13.43

GoString returns the string representation

func (*PurchaseReservedElasticsearchInstanceOfferingInput) SetInstanceCount added in v1.13.43

SetInstanceCount sets the InstanceCount field's value.

func (*PurchaseReservedElasticsearchInstanceOfferingInput) SetReservationName added in v1.13.43

SetReservationName sets the ReservationName field's value.

func (*PurchaseReservedElasticsearchInstanceOfferingInput) SetReservedElasticsearchInstanceOfferingId added in v1.13.43

SetReservedElasticsearchInstanceOfferingId sets the ReservedElasticsearchInstanceOfferingId field's value.

func (PurchaseReservedElasticsearchInstanceOfferingInput) String added in v1.13.43

String returns the string representation

func (*PurchaseReservedElasticsearchInstanceOfferingInput) Validate added in v1.13.43

Validate inspects the fields of the type to determine if they are valid.

type PurchaseReservedElasticsearchInstanceOfferingOutput added in v1.13.43

type PurchaseReservedElasticsearchInstanceOfferingOutput struct {

	// The customer-specified identifier used to track this reservation.
	ReservationName *string `min:"5" type:"string"`

	// Details of the reserved Elasticsearch instance which was purchased.
	ReservedElasticsearchInstanceId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

func (PurchaseReservedElasticsearchInstanceOfferingOutput) GoString added in v1.13.43

GoString returns the string representation

func (*PurchaseReservedElasticsearchInstanceOfferingOutput) SetReservationName added in v1.13.43

SetReservationName sets the ReservationName field's value.

func (*PurchaseReservedElasticsearchInstanceOfferingOutput) SetReservedElasticsearchInstanceId added in v1.13.43

SetReservedElasticsearchInstanceId sets the ReservedElasticsearchInstanceId field's value.

func (PurchaseReservedElasticsearchInstanceOfferingOutput) String added in v1.13.43

String returns the string representation

type RecurringCharge added in v1.13.43

type RecurringCharge struct {

	// The monetary amount of the recurring charge.
	RecurringChargeAmount *float64 `type:"double"`

	// The frequency of the recurring charge.
	RecurringChargeFrequency *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (RecurringCharge) GoString added in v1.13.43

func (s RecurringCharge) GoString() string

GoString returns the string representation

func (*RecurringCharge) SetRecurringChargeAmount added in v1.13.43

func (s *RecurringCharge) SetRecurringChargeAmount(v float64) *RecurringCharge

SetRecurringChargeAmount sets the RecurringChargeAmount field's value.

func (*RecurringCharge) SetRecurringChargeFrequency added in v1.13.43

func (s *RecurringCharge) SetRecurringChargeFrequency(v string) *RecurringCharge

SetRecurringChargeFrequency sets the RecurringChargeFrequency field's value.

func (RecurringCharge) String added in v1.13.43

func (s RecurringCharge) 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 is a required field
	ARN *string `type:"string" required:"true"`

	// Specifies the TagKey list which you want to remove from the Elasticsearch
	// domain.
	//
	// TagKeys is a required field
	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) SetARN added in v1.5.0

func (s *RemoveTagsInput) SetARN(v string) *RemoveTagsInput

SetARN sets the ARN field's value.

func (*RemoveTagsInput) SetTagKeys added in v1.5.0

func (s *RemoveTagsInput) SetTagKeys(v []*string) *RemoveTagsInput

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsInput) String

func (s RemoveTagsInput) String() string

String returns the string representation

func (*RemoveTagsInput) Validate added in v1.1.21

func (s *RemoveTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 ReservedElasticsearchInstance added in v1.13.43

type ReservedElasticsearchInstance struct {

	// The currency code for the reserved Elasticsearch instance offering.
	CurrencyCode *string `type:"string"`

	// The duration, in seconds, for which the Elasticsearch instance is reserved.
	Duration *int64 `type:"integer"`

	// The number of Elasticsearch instances that have been reserved.
	ElasticsearchInstanceCount *int64 `type:"integer"`

	// The Elasticsearch instance type offered by the reserved instance offering.
	ElasticsearchInstanceType *string `type:"string" enum:"ESPartitionInstanceType"`

	// The upfront fixed charge you will paid to purchase the specific reserved
	// Elasticsearch instance offering.
	FixedPrice *float64 `type:"double"`

	// The payment option as defined in the reserved Elasticsearch instance offering.
	PaymentOption *string `type:"string" enum:"ReservedElasticsearchInstancePaymentOption"`

	// The charge to your account regardless of whether you are creating any domains
	// using the instance offering.
	RecurringCharges []*RecurringCharge `type:"list"`

	// The customer-specified identifier to track this reservation.
	ReservationName *string `min:"5" type:"string"`

	// The unique identifier for the reservation.
	ReservedElasticsearchInstanceId *string `type:"string"`

	// The offering identifier.
	ReservedElasticsearchInstanceOfferingId *string `type:"string"`

	// The time the reservation started.
	StartTime *time.Time `type:"timestamp"`

	// The state of the reserved Elasticsearch instance.
	State *string `type:"string"`

	// The rate you are charged for each hour for the domain that is using this
	// reserved instance.
	UsagePrice *float64 `type:"double"`
	// contains filtered or unexported fields
}

Details of a reserved Elasticsearch instance.

func (ReservedElasticsearchInstance) GoString added in v1.13.43

GoString returns the string representation

func (*ReservedElasticsearchInstance) SetCurrencyCode added in v1.13.43

SetCurrencyCode sets the CurrencyCode field's value.

func (*ReservedElasticsearchInstance) SetDuration added in v1.13.43

SetDuration sets the Duration field's value.

func (*ReservedElasticsearchInstance) SetElasticsearchInstanceCount added in v1.13.43

func (s *ReservedElasticsearchInstance) SetElasticsearchInstanceCount(v int64) *ReservedElasticsearchInstance

SetElasticsearchInstanceCount sets the ElasticsearchInstanceCount field's value.

func (*ReservedElasticsearchInstance) SetElasticsearchInstanceType added in v1.13.43

func (s *ReservedElasticsearchInstance) SetElasticsearchInstanceType(v string) *ReservedElasticsearchInstance

SetElasticsearchInstanceType sets the ElasticsearchInstanceType field's value.

func (*ReservedElasticsearchInstance) SetFixedPrice added in v1.13.43

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedElasticsearchInstance) SetPaymentOption added in v1.13.43

SetPaymentOption sets the PaymentOption field's value.

func (*ReservedElasticsearchInstance) SetRecurringCharges added in v1.13.43

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedElasticsearchInstance) SetReservationName added in v1.13.43

SetReservationName sets the ReservationName field's value.

func (*ReservedElasticsearchInstance) SetReservedElasticsearchInstanceId added in v1.13.43

func (s *ReservedElasticsearchInstance) SetReservedElasticsearchInstanceId(v string) *ReservedElasticsearchInstance

SetReservedElasticsearchInstanceId sets the ReservedElasticsearchInstanceId field's value.

func (*ReservedElasticsearchInstance) SetReservedElasticsearchInstanceOfferingId added in v1.13.43

func (s *ReservedElasticsearchInstance) SetReservedElasticsearchInstanceOfferingId(v string) *ReservedElasticsearchInstance

SetReservedElasticsearchInstanceOfferingId sets the ReservedElasticsearchInstanceOfferingId field's value.

func (*ReservedElasticsearchInstance) SetStartTime added in v1.13.43

SetStartTime sets the StartTime field's value.

func (*ReservedElasticsearchInstance) SetState added in v1.13.43

SetState sets the State field's value.

func (*ReservedElasticsearchInstance) SetUsagePrice added in v1.13.43

SetUsagePrice sets the UsagePrice field's value.

func (ReservedElasticsearchInstance) String added in v1.13.43

String returns the string representation

type ReservedElasticsearchInstanceOffering added in v1.13.43

type ReservedElasticsearchInstanceOffering struct {

	// The currency code for the reserved Elasticsearch instance offering.
	CurrencyCode *string `type:"string"`

	// The duration, in seconds, for which the offering will reserve the Elasticsearch
	// instance.
	Duration *int64 `type:"integer"`

	// The Elasticsearch instance type offered by the reserved instance offering.
	ElasticsearchInstanceType *string `type:"string" enum:"ESPartitionInstanceType"`

	// The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch
	// instance offering.
	FixedPrice *float64 `type:"double"`

	// Payment option for the reserved Elasticsearch instance offering
	PaymentOption *string `type:"string" enum:"ReservedElasticsearchInstancePaymentOption"`

	// The charge to your account regardless of whether you are creating any domains
	// using the instance offering.
	RecurringCharges []*RecurringCharge `type:"list"`

	// The Elasticsearch reserved instance offering identifier.
	ReservedElasticsearchInstanceOfferingId *string `type:"string"`

	// The rate you are charged for each hour the domain that is using the offering
	// is running.
	UsagePrice *float64 `type:"double"`
	// contains filtered or unexported fields
}

Details of a reserved Elasticsearch instance offering.

func (ReservedElasticsearchInstanceOffering) GoString added in v1.13.43

GoString returns the string representation

func (*ReservedElasticsearchInstanceOffering) SetCurrencyCode added in v1.13.43

SetCurrencyCode sets the CurrencyCode field's value.

func (*ReservedElasticsearchInstanceOffering) SetDuration added in v1.13.43

SetDuration sets the Duration field's value.

func (*ReservedElasticsearchInstanceOffering) SetElasticsearchInstanceType added in v1.13.43

SetElasticsearchInstanceType sets the ElasticsearchInstanceType field's value.

func (*ReservedElasticsearchInstanceOffering) SetFixedPrice added in v1.13.43

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedElasticsearchInstanceOffering) SetPaymentOption added in v1.13.43

SetPaymentOption sets the PaymentOption field's value.

func (*ReservedElasticsearchInstanceOffering) SetRecurringCharges added in v1.13.43

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedElasticsearchInstanceOffering) SetReservedElasticsearchInstanceOfferingId added in v1.13.43

func (s *ReservedElasticsearchInstanceOffering) SetReservedElasticsearchInstanceOfferingId(v string) *ReservedElasticsearchInstanceOffering

SetReservedElasticsearchInstanceOfferingId sets the ReservedElasticsearchInstanceOfferingId field's value.

func (*ReservedElasticsearchInstanceOffering) SetUsagePrice added in v1.13.43

SetUsagePrice sets the UsagePrice field's value.

func (ReservedElasticsearchInstanceOffering) String added in v1.13.43

String returns the string representation

type ServiceSoftwareOptions added in v1.99.0

type ServiceSoftwareOptions struct {

	// Timestamp, in Epoch time, until which you can manually request a service
	// software update. After this date, we automatically update your service software.
	AutomatedUpdateDate *time.Time `type:"timestamp"`

	// True if you are able to cancel your service software version update. False
	// if you are not able to cancel your service software version.
	Cancellable *bool `type:"boolean"`

	// The current service software version that is present on the domain.
	CurrentVersion *string `type:"string"`

	// The description of the UpdateStatus.
	Description *string `type:"string"`

	// The new service software version if one is available.
	NewVersion *string `type:"string"`

	// True if you are able to update you service software version. False if you
	// are not able to update your service software version.
	UpdateAvailable *bool `type:"boolean"`

	// The status of your service software update. This field can take the following
	// values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
	UpdateStatus *string `type:"string" enum:"DeploymentStatus"`
	// contains filtered or unexported fields
}

The current options of an Elasticsearch domain service software options.

func (ServiceSoftwareOptions) GoString added in v1.99.0

func (s ServiceSoftwareOptions) GoString() string

GoString returns the string representation

func (*ServiceSoftwareOptions) SetAutomatedUpdateDate added in v1.99.0

func (s *ServiceSoftwareOptions) SetAutomatedUpdateDate(v time.Time) *ServiceSoftwareOptions

SetAutomatedUpdateDate sets the AutomatedUpdateDate field's value.

func (*ServiceSoftwareOptions) SetCancellable added in v1.99.0

func (s *ServiceSoftwareOptions) SetCancellable(v bool) *ServiceSoftwareOptions

SetCancellable sets the Cancellable field's value.

func (*ServiceSoftwareOptions) SetCurrentVersion added in v1.99.0

func (s *ServiceSoftwareOptions) SetCurrentVersion(v string) *ServiceSoftwareOptions

SetCurrentVersion sets the CurrentVersion field's value.

func (*ServiceSoftwareOptions) SetDescription added in v1.99.0

SetDescription sets the Description field's value.

func (*ServiceSoftwareOptions) SetNewVersion added in v1.99.0

SetNewVersion sets the NewVersion field's value.

func (*ServiceSoftwareOptions) SetUpdateAvailable added in v1.99.0

func (s *ServiceSoftwareOptions) SetUpdateAvailable(v bool) *ServiceSoftwareOptions

SetUpdateAvailable sets the UpdateAvailable field's value.

func (*ServiceSoftwareOptions) SetUpdateStatus added in v1.99.0

func (s *ServiceSoftwareOptions) SetUpdateStatus(v string) *ServiceSoftwareOptions

SetUpdateStatus sets the UpdateStatus field's value.

func (ServiceSoftwareOptions) String added in v1.99.0

func (s ServiceSoftwareOptions) 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) SetAutomatedSnapshotStartHour added in v1.5.0

func (s *SnapshotOptions) SetAutomatedSnapshotStartHour(v int64) *SnapshotOptions

SetAutomatedSnapshotStartHour sets the AutomatedSnapshotStartHour field's value.

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 is a required field
	Options *SnapshotOptions `type:"structure" required:"true"`

	// Specifies the status of a daily automated snapshot.
	//
	// Status is a required field
	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) SetOptions added in v1.5.0

SetOptions sets the Options field's value.

func (*SnapshotOptionsStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (SnapshotOptionsStatus) String

func (s SnapshotOptionsStatus) String() string

String returns the string representation

type StartElasticsearchServiceSoftwareUpdateInput added in v1.99.0

type StartElasticsearchServiceSoftwareUpdateInput struct {

	// The name of the domain that you want to update to the latest service software.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.

func (StartElasticsearchServiceSoftwareUpdateInput) GoString added in v1.99.0

GoString returns the string representation

func (*StartElasticsearchServiceSoftwareUpdateInput) SetDomainName added in v1.99.0

SetDomainName sets the DomainName field's value.

func (StartElasticsearchServiceSoftwareUpdateInput) String added in v1.99.0

String returns the string representation

func (*StartElasticsearchServiceSoftwareUpdateInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type StartElasticsearchServiceSoftwareUpdateOutput added in v1.99.0

type StartElasticsearchServiceSoftwareUpdateOutput struct {

	// The current status of the Elasticsearch service software update.
	ServiceSoftwareOptions *ServiceSoftwareOptions `type:"structure"`
	// contains filtered or unexported fields
}

The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

func (StartElasticsearchServiceSoftwareUpdateOutput) GoString added in v1.99.0

GoString returns the string representation

func (*StartElasticsearchServiceSoftwareUpdateOutput) SetServiceSoftwareOptions added in v1.99.0

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (StartElasticsearchServiceSoftwareUpdateOutput) String added in v1.99.0

String returns the string representation

type StorageType added in v1.7.1

type StorageType struct {

	// 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 standard gp2 io1
	// Refer VolumeType for more information regarding above EBS storage options.
	StorageSubTypeName *string `type:"string"`

	// List of limits that are applicable for given storage type.
	StorageTypeLimits []*StorageTypeLimit `type:"list"`

	// Type of the storage. List of available storage options: instance Inbuilt
	// storage available for the given Instance ebs Elastic block storage that would
	// be attached to the given Instance
	StorageTypeName *string `type:"string"`
	// contains filtered or unexported fields
}

StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

func (StorageType) GoString added in v1.7.1

func (s StorageType) GoString() string

GoString returns the string representation

func (*StorageType) SetStorageSubTypeName added in v1.7.1

func (s *StorageType) SetStorageSubTypeName(v string) *StorageType

SetStorageSubTypeName sets the StorageSubTypeName field's value.

func (*StorageType) SetStorageTypeLimits added in v1.7.1

func (s *StorageType) SetStorageTypeLimits(v []*StorageTypeLimit) *StorageType

SetStorageTypeLimits sets the StorageTypeLimits field's value.

func (*StorageType) SetStorageTypeName added in v1.7.1

func (s *StorageType) SetStorageTypeName(v string) *StorageType

SetStorageTypeName sets the StorageTypeName field's value.

func (StorageType) String added in v1.7.1

func (s StorageType) String() string

String returns the string representation

type StorageTypeLimit added in v1.7.1

type StorageTypeLimit struct {

	// Name of storage limits that are applicable for given storage type. If StorageType
	// is ebs, following storage options are applicable MinimumVolumeSize Minimum
	// amount of volume size that is applicable for given storage type.It can be
	// empty if it is not applicable. MaximumVolumeSize Maximum amount of volume
	// size that is applicable for given storage type.It can be empty if it is not
	// applicable. MaximumIops Maximum amount of Iops that is applicable for given
	// storage type.It can be empty if it is not applicable. MinimumIops Minimum
	// amount of Iops that is applicable for given storage type.It can be empty
	// if it is not applicable.
	LimitName *string `type:"string"`

	// Values for the StorageTypeLimit$LimitName .
	LimitValues []*string `type:"list"`
	// contains filtered or unexported fields
}

Limits that are applicable for given storage type.

func (StorageTypeLimit) GoString added in v1.7.1

func (s StorageTypeLimit) GoString() string

GoString returns the string representation

func (*StorageTypeLimit) SetLimitName added in v1.7.1

func (s *StorageTypeLimit) SetLimitName(v string) *StorageTypeLimit

SetLimitName sets the LimitName field's value.

func (*StorageTypeLimit) SetLimitValues added in v1.7.1

func (s *StorageTypeLimit) SetLimitValues(v []*string) *StorageTypeLimit

SetLimitValues sets the LimitValues field's value.

func (StorageTypeLimit) String added in v1.7.1

func (s StorageTypeLimit) 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 is a required field
	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 is a required field
	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) SetKey added in v1.5.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.1.21

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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)
	// for more information.
	AdvancedOptions map[string]*string `type:"map"`

	// Options to specify the Cognito user and identity pools for Kibana authentication.
	// For more information, see Amazon Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html).
	CognitoOptions *CognitoOptions `type:"structure"`

	// The name of the Elasticsearch domain that you are updating.
	//
	// DomainName is a required field
	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"`

	// Map of LogType and LogPublishingOption, each containing options to publish
	// a given type of Elasticsearch log.
	LogPublishingOptions map[string]*LogPublishingOption `type:"map"`

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

	// Options to specify the subnets and security groups for VPC endpoint. For
	// more information, see Creating a VPC (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc)
	// in VPC Endpoints for Amazon Elasticsearch Service Domains
	VPCOptions *VPCOptions `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

GoString returns the string representation

func (*UpdateElasticsearchDomainConfigInput) SetAccessPolicies added in v1.5.0

SetAccessPolicies sets the AccessPolicies field's value.

func (*UpdateElasticsearchDomainConfigInput) SetAdvancedOptions added in v1.5.0

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*UpdateElasticsearchDomainConfigInput) SetCognitoOptions added in v1.13.26

SetCognitoOptions sets the CognitoOptions field's value.

func (*UpdateElasticsearchDomainConfigInput) SetDomainName added in v1.5.0

SetDomainName sets the DomainName field's value.

func (*UpdateElasticsearchDomainConfigInput) SetEBSOptions added in v1.5.0

SetEBSOptions sets the EBSOptions field's value.

func (*UpdateElasticsearchDomainConfigInput) SetElasticsearchClusterConfig added in v1.5.0

SetElasticsearchClusterConfig sets the ElasticsearchClusterConfig field's value.

func (*UpdateElasticsearchDomainConfigInput) SetLogPublishingOptions added in v1.12.11

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*UpdateElasticsearchDomainConfigInput) SetSnapshotOptions added in v1.5.0

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*UpdateElasticsearchDomainConfigInput) SetVPCOptions added in v1.12.12

SetVPCOptions sets the VPCOptions field's value.

func (UpdateElasticsearchDomainConfigInput) String

String returns the string representation

func (*UpdateElasticsearchDomainConfigInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type UpdateElasticsearchDomainConfigOutput

type UpdateElasticsearchDomainConfigOutput struct {

	// The status of the updated Elasticsearch domain.
	//
	// DomainConfig is a required field
	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

GoString returns the string representation

func (*UpdateElasticsearchDomainConfigOutput) SetDomainConfig added in v1.5.0

SetDomainConfig sets the DomainConfig field's value.

func (UpdateElasticsearchDomainConfigOutput) String

String returns the string representation

type UpgradeElasticsearchDomainInput added in v1.99.0

type UpgradeElasticsearchDomainInput struct {

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

	// This flag, when set to True, indicates that an Upgrade Eligibility Check
	// needs to be performed. This will not actually perform the Upgrade.
	PerformCheckOnly *bool `type:"boolean"`

	// The version of Elasticsearch that you intend to upgrade the domain to.
	//
	// TargetVersion is a required field
	TargetVersion *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for request parameters to UpgradeElasticsearchDomain operation.

func (UpgradeElasticsearchDomainInput) GoString added in v1.99.0

GoString returns the string representation

func (*UpgradeElasticsearchDomainInput) SetDomainName added in v1.99.0

SetDomainName sets the DomainName field's value.

func (*UpgradeElasticsearchDomainInput) SetPerformCheckOnly added in v1.99.0

SetPerformCheckOnly sets the PerformCheckOnly field's value.

func (*UpgradeElasticsearchDomainInput) SetTargetVersion added in v1.99.0

SetTargetVersion sets the TargetVersion field's value.

func (UpgradeElasticsearchDomainInput) String added in v1.99.0

String returns the string representation

func (*UpgradeElasticsearchDomainInput) Validate added in v1.99.0

func (s *UpgradeElasticsearchDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpgradeElasticsearchDomainOutput added in v1.99.0

type UpgradeElasticsearchDomainOutput struct {

	// 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"`

	// This flag, when set to True, indicates that an Upgrade Eligibility Check
	// needs to be performed. This will not actually perform the Upgrade.
	PerformCheckOnly *bool `type:"boolean"`

	// The version of Elasticsearch that you intend to upgrade the domain to.
	TargetVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Container for response returned by UpgradeElasticsearchDomain operation.

func (UpgradeElasticsearchDomainOutput) GoString added in v1.99.0

GoString returns the string representation

func (*UpgradeElasticsearchDomainOutput) SetDomainName added in v1.99.0

SetDomainName sets the DomainName field's value.

func (*UpgradeElasticsearchDomainOutput) SetPerformCheckOnly added in v1.99.0

SetPerformCheckOnly sets the PerformCheckOnly field's value.

func (*UpgradeElasticsearchDomainOutput) SetTargetVersion added in v1.99.0

SetTargetVersion sets the TargetVersion field's value.

func (UpgradeElasticsearchDomainOutput) String added in v1.99.0

String returns the string representation

type UpgradeHistory added in v1.99.0

type UpgradeHistory struct {

	// UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ"
	// format.
	StartTimestamp *time.Time `type:"timestamp"`

	// A list of UpgradeStepItem s representing information about each step performed
	// as pard of a specific Upgrade or Upgrade Eligibility Check.
	StepsList []*UpgradeStepItem `type:"list"`

	// A string that describes the update briefly
	UpgradeName *string `type:"string"`

	// The overall status of the update. The status can take one of the following
	// values:
	//    * In Progress
	//
	//    * Succeeded
	//
	//    * Succeeded with Issues
	//
	//    * Failed
	UpgradeStatus *string `type:"string" enum:"UpgradeStatus"`
	// contains filtered or unexported fields
}

History of the last 10 Upgrades and Upgrade Eligibility Checks.

func (UpgradeHistory) GoString added in v1.99.0

func (s UpgradeHistory) GoString() string

GoString returns the string representation

func (*UpgradeHistory) SetStartTimestamp added in v1.99.0

func (s *UpgradeHistory) SetStartTimestamp(v time.Time) *UpgradeHistory

SetStartTimestamp sets the StartTimestamp field's value.

func (*UpgradeHistory) SetStepsList added in v1.99.0

func (s *UpgradeHistory) SetStepsList(v []*UpgradeStepItem) *UpgradeHistory

SetStepsList sets the StepsList field's value.

func (*UpgradeHistory) SetUpgradeName added in v1.99.0

func (s *UpgradeHistory) SetUpgradeName(v string) *UpgradeHistory

SetUpgradeName sets the UpgradeName field's value.

func (*UpgradeHistory) SetUpgradeStatus added in v1.99.0

func (s *UpgradeHistory) SetUpgradeStatus(v string) *UpgradeHistory

SetUpgradeStatus sets the UpgradeStatus field's value.

func (UpgradeHistory) String added in v1.99.0

func (s UpgradeHistory) String() string

String returns the string representation

type UpgradeStepItem added in v1.99.0

type UpgradeStepItem struct {

	// A list of strings containing detailed information about the errors encountered
	// in a particular step.
	Issues []*string `type:"list"`

	// The Floating point value representing progress percentage of a particular
	// step.
	ProgressPercent *float64 `type:"double"`

	// Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does
	// through:
	//    * PreUpgradeCheck
	//
	//    * Snapshot
	//
	//    * Upgrade
	UpgradeStep *string `type:"string" enum:"UpgradeStep"`

	// The status of a particular step during an upgrade. The status can take one
	// of the following values:
	//    * In Progress
	//
	//    * Succeeded
	//
	//    * Succeeded with Issues
	//
	//    * Failed
	UpgradeStepStatus *string `type:"string" enum:"UpgradeStatus"`
	// contains filtered or unexported fields
}

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

func (UpgradeStepItem) GoString added in v1.99.0

func (s UpgradeStepItem) GoString() string

GoString returns the string representation

func (*UpgradeStepItem) SetIssues added in v1.99.0

func (s *UpgradeStepItem) SetIssues(v []*string) *UpgradeStepItem

SetIssues sets the Issues field's value.

func (*UpgradeStepItem) SetProgressPercent added in v1.99.0

func (s *UpgradeStepItem) SetProgressPercent(v float64) *UpgradeStepItem

SetProgressPercent sets the ProgressPercent field's value.

func (*UpgradeStepItem) SetUpgradeStep added in v1.99.0

func (s *UpgradeStepItem) SetUpgradeStep(v string) *UpgradeStepItem

SetUpgradeStep sets the UpgradeStep field's value.

func (*UpgradeStepItem) SetUpgradeStepStatus added in v1.99.0

func (s *UpgradeStepItem) SetUpgradeStepStatus(v string) *UpgradeStepItem

SetUpgradeStepStatus sets the UpgradeStepStatus field's value.

func (UpgradeStepItem) String added in v1.99.0

func (s UpgradeStepItem) String() string

String returns the string representation

type VPCDerivedInfo added in v1.12.12

type VPCDerivedInfo struct {

	// The availability zones for the Elasticsearch domain. Exists only if the domain
	// was created with VPCOptions.
	AvailabilityZones []*string `type:"list"`

	// Specifies the security groups for VPC endpoint.
	SecurityGroupIds []*string `type:"list"`

	// Specifies the subnets for VPC endpoint.
	SubnetIds []*string `type:"list"`

	// The VPC Id for the Elasticsearch domain. Exists only if the domain was created
	// with VPCOptions.
	VPCId *string `type:"string"`
	// contains filtered or unexported fields
}

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html).

func (VPCDerivedInfo) GoString added in v1.12.12

func (s VPCDerivedInfo) GoString() string

GoString returns the string representation

func (*VPCDerivedInfo) SetAvailabilityZones added in v1.12.12

func (s *VPCDerivedInfo) SetAvailabilityZones(v []*string) *VPCDerivedInfo

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*VPCDerivedInfo) SetSecurityGroupIds added in v1.12.12

func (s *VPCDerivedInfo) SetSecurityGroupIds(v []*string) *VPCDerivedInfo

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VPCDerivedInfo) SetSubnetIds added in v1.12.12

func (s *VPCDerivedInfo) SetSubnetIds(v []*string) *VPCDerivedInfo

SetSubnetIds sets the SubnetIds field's value.

func (*VPCDerivedInfo) SetVPCId added in v1.12.12

func (s *VPCDerivedInfo) SetVPCId(v string) *VPCDerivedInfo

SetVPCId sets the VPCId field's value.

func (VPCDerivedInfo) String added in v1.12.12

func (s VPCDerivedInfo) String() string

String returns the string representation

type VPCDerivedInfoStatus added in v1.12.12

type VPCDerivedInfoStatus struct {

	// Specifies the VPC options for the specified Elasticsearch domain.
	//
	// Options is a required field
	Options *VPCDerivedInfo `type:"structure" required:"true"`

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

Status of the VPC options for the specified Elasticsearch domain.

func (VPCDerivedInfoStatus) GoString added in v1.12.12

func (s VPCDerivedInfoStatus) GoString() string

GoString returns the string representation

func (*VPCDerivedInfoStatus) SetOptions added in v1.12.12

SetOptions sets the Options field's value.

func (*VPCDerivedInfoStatus) SetStatus added in v1.12.12

SetStatus sets the Status field's value.

func (VPCDerivedInfoStatus) String added in v1.12.12

func (s VPCDerivedInfoStatus) String() string

String returns the string representation

type VPCOptions added in v1.12.12

type VPCOptions struct {

	// Specifies the security groups for VPC endpoint.
	SecurityGroupIds []*string `type:"list"`

	// Specifies the subnets for VPC endpoint.
	SubnetIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html).

func (VPCOptions) GoString added in v1.12.12

func (s VPCOptions) GoString() string

GoString returns the string representation

func (*VPCOptions) SetSecurityGroupIds added in v1.12.12

func (s *VPCOptions) SetSecurityGroupIds(v []*string) *VPCOptions

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VPCOptions) SetSubnetIds added in v1.12.12

func (s *VPCOptions) SetSubnetIds(v []*string) *VPCOptions

SetSubnetIds sets the SubnetIds field's value.

func (VPCOptions) String added in v1.12.12

func (s VPCOptions) String() string

String returns the string representation

type ZoneAwarenessConfig added in v1.99.0

type ZoneAwarenessConfig struct {

	// An integer value to indicate the number of availability zones for a domain
	// when zone awareness is enabled. This should be equal to number of subnets
	// if VPC endpoints is enabled
	AvailabilityZoneCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

func (ZoneAwarenessConfig) GoString added in v1.99.0

func (s ZoneAwarenessConfig) GoString() string

GoString returns the string representation

func (*ZoneAwarenessConfig) SetAvailabilityZoneCount added in v1.99.0

func (s *ZoneAwarenessConfig) SetAvailabilityZoneCount(v int64) *ZoneAwarenessConfig

SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.

func (ZoneAwarenessConfig) String added in v1.99.0

func (s ZoneAwarenessConfig) String() string

String returns the string representation

Directories

Path Synopsis
Package elasticsearchserviceiface provides an interface to enable mocking the Amazon Elasticsearch Service service client for testing your code.
Package elasticsearchserviceiface provides an interface to enable mocking the Amazon Elasticsearch Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL