opensearchservice

package
v1.42.12 Latest Latest
Warning

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

 Go to latest Published: Nov 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 35

Documentation

Overview

Package opensearchservice provides the client and types for making API requests to Amazon OpenSearch Service.

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

For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-configuration-samples.html). The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html).

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#service-regions).

See https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01 for more information on this service.

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

Using the Client

To contact Amazon OpenSearch 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 OpenSearch Service client OpenSearchService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/opensearchservice/#New

Index

Constants

View Source 
const (
	// AutoTuneDesiredStateEnabled is a AutoTuneDesiredState enum value
	AutoTuneDesiredStateEnabled = "ENABLED"

	// AutoTuneDesiredStateDisabled is a AutoTuneDesiredState enum value
	AutoTuneDesiredStateDisabled = "DISABLED"
)

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

View Source 
const (
	// AutoTuneStateEnabled is a AutoTuneState enum value
	AutoTuneStateEnabled = "ENABLED"

	// AutoTuneStateDisabled is a AutoTuneState enum value
	AutoTuneStateDisabled = "DISABLED"

	// AutoTuneStateEnableInProgress is a AutoTuneState enum value
	AutoTuneStateEnableInProgress = "ENABLE_IN_PROGRESS"

	// AutoTuneStateDisableInProgress is a AutoTuneState enum value
	AutoTuneStateDisableInProgress = "DISABLE_IN_PROGRESS"

	// AutoTuneStateDisabledAndRollbackScheduled is a AutoTuneState enum value
	AutoTuneStateDisabledAndRollbackScheduled = "DISABLED_AND_ROLLBACK_SCHEDULED"

	// AutoTuneStateDisabledAndRollbackInProgress is a AutoTuneState enum value
	AutoTuneStateDisabledAndRollbackInProgress = "DISABLED_AND_ROLLBACK_IN_PROGRESS"

	// AutoTuneStateDisabledAndRollbackComplete is a AutoTuneState enum value
	AutoTuneStateDisabledAndRollbackComplete = "DISABLED_AND_ROLLBACK_COMPLETE"

	// AutoTuneStateDisabledAndRollbackError is a AutoTuneState enum value
	AutoTuneStateDisabledAndRollbackError = "DISABLED_AND_ROLLBACK_ERROR"

	// AutoTuneStateError is a AutoTuneState enum value
	AutoTuneStateError = "ERROR"
)

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

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 (
	// DescribePackagesFilterNamePackageId is a DescribePackagesFilterName enum value
	DescribePackagesFilterNamePackageId = "PackageID"

	// DescribePackagesFilterNamePackageName is a DescribePackagesFilterName enum value
	DescribePackagesFilterNamePackageName = "PackageName"

	// DescribePackagesFilterNamePackageStatus is a DescribePackagesFilterName enum value
	DescribePackagesFilterNamePackageStatus = "PackageStatus"
)
View Source 
const (
	// DomainPackageStatusAssociating is a DomainPackageStatus enum value
	DomainPackageStatusAssociating = "ASSOCIATING"

	// DomainPackageStatusAssociationFailed is a DomainPackageStatus enum value
	DomainPackageStatusAssociationFailed = "ASSOCIATION_FAILED"

	// DomainPackageStatusActive is a DomainPackageStatus enum value
	DomainPackageStatusActive = "ACTIVE"

	// DomainPackageStatusDissociating is a DomainPackageStatus enum value
	DomainPackageStatusDissociating = "DISSOCIATING"

	// DomainPackageStatusDissociationFailed is a DomainPackageStatus enum value
	DomainPackageStatusDissociationFailed = "DISSOCIATION_FAILED"
)
View Source 
const (
	// EngineTypeOpenSearch is a EngineType enum value
	EngineTypeOpenSearch = "OpenSearch"

	// EngineTypeElasticsearch is a EngineType enum value
	EngineTypeElasticsearch = "Elasticsearch"
)
View Source 
const (
	// InboundConnectionStatusCodePendingAcceptance is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodePendingAcceptance = "PENDING_ACCEPTANCE"

	// InboundConnectionStatusCodeApproved is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodeApproved = "APPROVED"

	// InboundConnectionStatusCodeProvisioning is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodeProvisioning = "PROVISIONING"

	// InboundConnectionStatusCodeActive is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodeActive = "ACTIVE"

	// InboundConnectionStatusCodeRejecting is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodeRejecting = "REJECTING"

	// InboundConnectionStatusCodeRejected is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodeRejected = "REJECTED"

	// InboundConnectionStatusCodeDeleting is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodeDeleting = "DELETING"

	// InboundConnectionStatusCodeDeleted is a InboundConnectionStatusCode enum value
	InboundConnectionStatusCodeDeleted = "DELETED"
)
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"

	// LogTypeAuditLogs is a LogType enum value
	LogTypeAuditLogs = "AUDIT_LOGS"
)

Type of log file. 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: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

  • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.

View Source 
const (
	// OpenSearchPartitionInstanceTypeM3MediumSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM3MediumSearch = "m3.medium.search"

	// OpenSearchPartitionInstanceTypeM3LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM3LargeSearch = "m3.large.search"

	// OpenSearchPartitionInstanceTypeM3XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM3XlargeSearch = "m3.xlarge.search"

	// OpenSearchPartitionInstanceTypeM32xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM32xlargeSearch = "m3.2xlarge.search"

	// OpenSearchPartitionInstanceTypeM4LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM4LargeSearch = "m4.large.search"

	// OpenSearchPartitionInstanceTypeM4XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM4XlargeSearch = "m4.xlarge.search"

	// OpenSearchPartitionInstanceTypeM42xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM42xlargeSearch = "m4.2xlarge.search"

	// OpenSearchPartitionInstanceTypeM44xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM44xlargeSearch = "m4.4xlarge.search"

	// OpenSearchPartitionInstanceTypeM410xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM410xlargeSearch = "m4.10xlarge.search"

	// OpenSearchPartitionInstanceTypeM5LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM5LargeSearch = "m5.large.search"

	// OpenSearchPartitionInstanceTypeM5XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM5XlargeSearch = "m5.xlarge.search"

	// OpenSearchPartitionInstanceTypeM52xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM52xlargeSearch = "m5.2xlarge.search"

	// OpenSearchPartitionInstanceTypeM54xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM54xlargeSearch = "m5.4xlarge.search"

	// OpenSearchPartitionInstanceTypeM512xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM512xlargeSearch = "m5.12xlarge.search"

	// OpenSearchPartitionInstanceTypeM524xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM524xlargeSearch = "m5.24xlarge.search"

	// OpenSearchPartitionInstanceTypeR5LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR5LargeSearch = "r5.large.search"

	// OpenSearchPartitionInstanceTypeR5XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR5XlargeSearch = "r5.xlarge.search"

	// OpenSearchPartitionInstanceTypeR52xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR52xlargeSearch = "r5.2xlarge.search"

	// OpenSearchPartitionInstanceTypeR54xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR54xlargeSearch = "r5.4xlarge.search"

	// OpenSearchPartitionInstanceTypeR512xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR512xlargeSearch = "r5.12xlarge.search"

	// OpenSearchPartitionInstanceTypeR524xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR524xlargeSearch = "r5.24xlarge.search"

	// OpenSearchPartitionInstanceTypeC5LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC5LargeSearch = "c5.large.search"

	// OpenSearchPartitionInstanceTypeC5XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC5XlargeSearch = "c5.xlarge.search"

	// OpenSearchPartitionInstanceTypeC52xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC52xlargeSearch = "c5.2xlarge.search"

	// OpenSearchPartitionInstanceTypeC54xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC54xlargeSearch = "c5.4xlarge.search"

	// OpenSearchPartitionInstanceTypeC59xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC59xlargeSearch = "c5.9xlarge.search"

	// OpenSearchPartitionInstanceTypeC518xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC518xlargeSearch = "c5.18xlarge.search"

	// OpenSearchPartitionInstanceTypeT3NanoSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT3NanoSearch = "t3.nano.search"

	// OpenSearchPartitionInstanceTypeT3MicroSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT3MicroSearch = "t3.micro.search"

	// OpenSearchPartitionInstanceTypeT3SmallSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT3SmallSearch = "t3.small.search"

	// OpenSearchPartitionInstanceTypeT3MediumSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT3MediumSearch = "t3.medium.search"

	// OpenSearchPartitionInstanceTypeT3LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT3LargeSearch = "t3.large.search"

	// OpenSearchPartitionInstanceTypeT3XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT3XlargeSearch = "t3.xlarge.search"

	// OpenSearchPartitionInstanceTypeT32xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT32xlargeSearch = "t3.2xlarge.search"

	// OpenSearchPartitionInstanceTypeUltrawarm1MediumSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeUltrawarm1MediumSearch = "ultrawarm1.medium.search"

	// OpenSearchPartitionInstanceTypeUltrawarm1LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeUltrawarm1LargeSearch = "ultrawarm1.large.search"

	// OpenSearchPartitionInstanceTypeUltrawarm1XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeUltrawarm1XlargeSearch = "ultrawarm1.xlarge.search"

	// OpenSearchPartitionInstanceTypeT2MicroSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT2MicroSearch = "t2.micro.search"

	// OpenSearchPartitionInstanceTypeT2SmallSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT2SmallSearch = "t2.small.search"

	// OpenSearchPartitionInstanceTypeT2MediumSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT2MediumSearch = "t2.medium.search"

	// OpenSearchPartitionInstanceTypeR3LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR3LargeSearch = "r3.large.search"

	// OpenSearchPartitionInstanceTypeR3XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR3XlargeSearch = "r3.xlarge.search"

	// OpenSearchPartitionInstanceTypeR32xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR32xlargeSearch = "r3.2xlarge.search"

	// OpenSearchPartitionInstanceTypeR34xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR34xlargeSearch = "r3.4xlarge.search"

	// OpenSearchPartitionInstanceTypeR38xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR38xlargeSearch = "r3.8xlarge.search"

	// OpenSearchPartitionInstanceTypeI2XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI2XlargeSearch = "i2.xlarge.search"

	// OpenSearchPartitionInstanceTypeI22xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI22xlargeSearch = "i2.2xlarge.search"

	// OpenSearchPartitionInstanceTypeD2XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeD2XlargeSearch = "d2.xlarge.search"

	// OpenSearchPartitionInstanceTypeD22xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeD22xlargeSearch = "d2.2xlarge.search"

	// OpenSearchPartitionInstanceTypeD24xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeD24xlargeSearch = "d2.4xlarge.search"

	// OpenSearchPartitionInstanceTypeD28xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeD28xlargeSearch = "d2.8xlarge.search"

	// OpenSearchPartitionInstanceTypeC4LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC4LargeSearch = "c4.large.search"

	// OpenSearchPartitionInstanceTypeC4XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC4XlargeSearch = "c4.xlarge.search"

	// OpenSearchPartitionInstanceTypeC42xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC42xlargeSearch = "c4.2xlarge.search"

	// OpenSearchPartitionInstanceTypeC44xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC44xlargeSearch = "c4.4xlarge.search"

	// OpenSearchPartitionInstanceTypeC48xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC48xlargeSearch = "c4.8xlarge.search"

	// OpenSearchPartitionInstanceTypeR4LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR4LargeSearch = "r4.large.search"

	// OpenSearchPartitionInstanceTypeR4XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR4XlargeSearch = "r4.xlarge.search"

	// OpenSearchPartitionInstanceTypeR42xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR42xlargeSearch = "r4.2xlarge.search"

	// OpenSearchPartitionInstanceTypeR44xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR44xlargeSearch = "r4.4xlarge.search"

	// OpenSearchPartitionInstanceTypeR48xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR48xlargeSearch = "r4.8xlarge.search"

	// OpenSearchPartitionInstanceTypeR416xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR416xlargeSearch = "r4.16xlarge.search"

	// OpenSearchPartitionInstanceTypeI3LargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI3LargeSearch = "i3.large.search"

	// OpenSearchPartitionInstanceTypeI3XlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI3XlargeSearch = "i3.xlarge.search"

	// OpenSearchPartitionInstanceTypeI32xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI32xlargeSearch = "i3.2xlarge.search"

	// OpenSearchPartitionInstanceTypeI34xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI34xlargeSearch = "i3.4xlarge.search"

	// OpenSearchPartitionInstanceTypeI38xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI38xlargeSearch = "i3.8xlarge.search"

	// OpenSearchPartitionInstanceTypeI316xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeI316xlargeSearch = "i3.16xlarge.search"

	// OpenSearchPartitionInstanceTypeR6gLargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gLargeSearch = "r6g.large.search"

	// OpenSearchPartitionInstanceTypeR6gXlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gXlargeSearch = "r6g.xlarge.search"

	// OpenSearchPartitionInstanceTypeR6g2xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6g2xlargeSearch = "r6g.2xlarge.search"

	// OpenSearchPartitionInstanceTypeR6g4xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6g4xlargeSearch = "r6g.4xlarge.search"

	// OpenSearchPartitionInstanceTypeR6g8xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6g8xlargeSearch = "r6g.8xlarge.search"

	// OpenSearchPartitionInstanceTypeR6g12xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6g12xlargeSearch = "r6g.12xlarge.search"

	// OpenSearchPartitionInstanceTypeM6gLargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM6gLargeSearch = "m6g.large.search"

	// OpenSearchPartitionInstanceTypeM6gXlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM6gXlargeSearch = "m6g.xlarge.search"

	// OpenSearchPartitionInstanceTypeM6g2xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM6g2xlargeSearch = "m6g.2xlarge.search"

	// OpenSearchPartitionInstanceTypeM6g4xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM6g4xlargeSearch = "m6g.4xlarge.search"

	// OpenSearchPartitionInstanceTypeM6g8xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM6g8xlargeSearch = "m6g.8xlarge.search"

	// OpenSearchPartitionInstanceTypeM6g12xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeM6g12xlargeSearch = "m6g.12xlarge.search"

	// OpenSearchPartitionInstanceTypeC6gLargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC6gLargeSearch = "c6g.large.search"

	// OpenSearchPartitionInstanceTypeC6gXlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC6gXlargeSearch = "c6g.xlarge.search"

	// OpenSearchPartitionInstanceTypeC6g2xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC6g2xlargeSearch = "c6g.2xlarge.search"

	// OpenSearchPartitionInstanceTypeC6g4xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC6g4xlargeSearch = "c6g.4xlarge.search"

	// OpenSearchPartitionInstanceTypeC6g8xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC6g8xlargeSearch = "c6g.8xlarge.search"

	// OpenSearchPartitionInstanceTypeC6g12xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeC6g12xlargeSearch = "c6g.12xlarge.search"

	// OpenSearchPartitionInstanceTypeR6gdLargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gdLargeSearch = "r6gd.large.search"

	// OpenSearchPartitionInstanceTypeR6gdXlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gdXlargeSearch = "r6gd.xlarge.search"

	// OpenSearchPartitionInstanceTypeR6gd2xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gd2xlargeSearch = "r6gd.2xlarge.search"

	// OpenSearchPartitionInstanceTypeR6gd4xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gd4xlargeSearch = "r6gd.4xlarge.search"

	// OpenSearchPartitionInstanceTypeR6gd8xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gd8xlargeSearch = "r6gd.8xlarge.search"

	// OpenSearchPartitionInstanceTypeR6gd12xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gd12xlargeSearch = "r6gd.12xlarge.search"

	// OpenSearchPartitionInstanceTypeR6gd16xlargeSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeR6gd16xlargeSearch = "r6gd.16xlarge.search"

	// OpenSearchPartitionInstanceTypeT4gSmallSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT4gSmallSearch = "t4g.small.search"

	// OpenSearchPartitionInstanceTypeT4gMediumSearch is a OpenSearchPartitionInstanceType enum value
	OpenSearchPartitionInstanceTypeT4gMediumSearch = "t4g.medium.search"
)
View Source 
const (
	// OpenSearchWarmPartitionInstanceTypeUltrawarm1MediumSearch is a OpenSearchWarmPartitionInstanceType enum value
	OpenSearchWarmPartitionInstanceTypeUltrawarm1MediumSearch = "ultrawarm1.medium.search"

	// OpenSearchWarmPartitionInstanceTypeUltrawarm1LargeSearch is a OpenSearchWarmPartitionInstanceType enum value
	OpenSearchWarmPartitionInstanceTypeUltrawarm1LargeSearch = "ultrawarm1.large.search"

	// OpenSearchWarmPartitionInstanceTypeUltrawarm1XlargeSearch is a OpenSearchWarmPartitionInstanceType enum value
	OpenSearchWarmPartitionInstanceTypeUltrawarm1XlargeSearch = "ultrawarm1.xlarge.search"
)
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 progress.

  • Active: The request change is processed and deployed to the domain.

View Source 
const (
	// OutboundConnectionStatusCodeValidating is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeValidating = "VALIDATING"

	// OutboundConnectionStatusCodeValidationFailed is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeValidationFailed = "VALIDATION_FAILED"

	// OutboundConnectionStatusCodePendingAcceptance is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodePendingAcceptance = "PENDING_ACCEPTANCE"

	// OutboundConnectionStatusCodeApproved is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeApproved = "APPROVED"

	// OutboundConnectionStatusCodeProvisioning is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeProvisioning = "PROVISIONING"

	// OutboundConnectionStatusCodeActive is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeActive = "ACTIVE"

	// OutboundConnectionStatusCodeRejecting is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeRejecting = "REJECTING"

	// OutboundConnectionStatusCodeRejected is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeRejected = "REJECTED"

	// OutboundConnectionStatusCodeDeleting is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeDeleting = "DELETING"

	// OutboundConnectionStatusCodeDeleted is a OutboundConnectionStatusCode enum value
	OutboundConnectionStatusCodeDeleted = "DELETED"
)
View Source 
const (
	// PackageStatusCopying is a PackageStatus enum value
	PackageStatusCopying = "COPYING"

	// PackageStatusCopyFailed is a PackageStatus enum value
	PackageStatusCopyFailed = "COPY_FAILED"

	// PackageStatusValidating is a PackageStatus enum value
	PackageStatusValidating = "VALIDATING"

	// PackageStatusValidationFailed is a PackageStatus enum value
	PackageStatusValidationFailed = "VALIDATION_FAILED"

	// PackageStatusAvailable is a PackageStatus enum value
	PackageStatusAvailable = "AVAILABLE"

	// PackageStatusDeleting is a PackageStatus enum value
	PackageStatusDeleting = "DELETING"

	// PackageStatusDeleted is a PackageStatus enum value
	PackageStatusDeleted = "DELETED"

	// PackageStatusDeleteFailed is a PackageStatus enum value
	PackageStatusDeleteFailed = "DELETE_FAILED"
)
View Source 
const (
	// ReservedInstancePaymentOptionAllUpfront is a ReservedInstancePaymentOption enum value
	ReservedInstancePaymentOptionAllUpfront = "ALL_UPFRONT"

	// ReservedInstancePaymentOptionPartialUpfront is a ReservedInstancePaymentOption enum value
	ReservedInstancePaymentOptionPartialUpfront = "PARTIAL_UPFRONT"

	// ReservedInstancePaymentOptionNoUpfront is a ReservedInstancePaymentOption enum value
	ReservedInstancePaymentOptionNoUpfront = "NO_UPFRONT"
)
View Source 
const (
	// RollbackOnDisableNoRollback is a RollbackOnDisable enum value
	RollbackOnDisableNoRollback = "NO_ROLLBACK"

	// RollbackOnDisableDefaultRollback is a RollbackOnDisable enum value
	RollbackOnDisableDefaultRollback = "DEFAULT_ROLLBACK"
)

The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

View Source 
const (
	// ScheduledAutoTuneActionTypeJvmHeapSizeTuning is a ScheduledAutoTuneActionType enum value
	ScheduledAutoTuneActionTypeJvmHeapSizeTuning = "JVM_HEAP_SIZE_TUNING"

	// ScheduledAutoTuneActionTypeJvmYoungGenTuning is a ScheduledAutoTuneActionType enum value
	ScheduledAutoTuneActionTypeJvmYoungGenTuning = "JVM_YOUNG_GEN_TUNING"
)

The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING, and JVM_YOUNG_GEN_TUNING.

View Source 
const (
	// ScheduledAutoTuneSeverityTypeLow is a ScheduledAutoTuneSeverityType enum value
	ScheduledAutoTuneSeverityTypeLow = "LOW"

	// ScheduledAutoTuneSeverityTypeMedium is a ScheduledAutoTuneSeverityType enum value
	ScheduledAutoTuneSeverityTypeMedium = "MEDIUM"

	// ScheduledAutoTuneSeverityTypeHigh is a ScheduledAutoTuneSeverityType enum value
	ScheduledAutoTuneSeverityTypeHigh = "HIGH"
)

The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.

View Source 
const (
	// TLSSecurityPolicyPolicyMinTls10201907 is a TLSSecurityPolicy enum value
	TLSSecurityPolicyPolicyMinTls10201907 = "Policy-Min-TLS-1-0-2019-07"

	// TLSSecurityPolicyPolicyMinTls12201907 is a TLSSecurityPolicy enum value
	TLSSecurityPolicyPolicyMinTls12201907 = "Policy-Min-TLS-1-2-2019-07"
)
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/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs) for more information.

View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// An error occurred because user does not have permissions to access the resource.
	// Returns HTTP status code 403.
	ErrCodeAccessDeniedException = "AccessDeniedException"

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

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// An error occurred because the client attempts to remove a resource that is
	// currently in use. Returns HTTP status code 409.
	ErrCodeConflictException = "ConflictException"

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

	// ErrCodeInvalidPaginationTokenException for service response error code
	// "InvalidPaginationTokenException".
	//
	// The request processing has failed because of invalid pagination token provided
	// by customer. Returns an HTTP status code of 400.
	ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException"

	// 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 = "OpenSearch" // Name of service.
	EndpointsID = "es"         // ID to lookup a service endpoint with.
	ServiceID   = "OpenSearch" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// AutoTuneTypeScheduledAction is a AutoTuneType enum value
	AutoTuneTypeScheduledAction = "SCHEDULED_ACTION"
)

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

View Source 
const (
	// PackageTypeTxtDictionary is a PackageType enum value
	PackageTypeTxtDictionary = "TXT-DICTIONARY"
)
View Source 
const (
	// TimeUnitHours is a TimeUnit enum value
	TimeUnitHours = "HOURS"
)

The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.

Variables

This section is empty.

Functions

func AutoTuneDesiredState_Values 

func AutoTuneDesiredState_Values() []string

AutoTuneDesiredState_Values returns all elements of the AutoTuneDesiredState enum

func AutoTuneState_Values 

func AutoTuneState_Values() []string

AutoTuneState_Values returns all elements of the AutoTuneState enum

func AutoTuneType_Values 

func AutoTuneType_Values() []string

AutoTuneType_Values returns all elements of the AutoTuneType enum

func DeploymentStatus_Values 

func DeploymentStatus_Values() []string

DeploymentStatus_Values returns all elements of the DeploymentStatus enum

func DescribePackagesFilterName_Values 

func DescribePackagesFilterName_Values() []string

DescribePackagesFilterName_Values returns all elements of the DescribePackagesFilterName enum

func DomainPackageStatus_Values 

func DomainPackageStatus_Values() []string

DomainPackageStatus_Values returns all elements of the DomainPackageStatus enum

func EngineType_Values added in v1.40.45 

func EngineType_Values() []string

EngineType_Values returns all elements of the EngineType enum

func InboundConnectionStatusCode_Values 

func InboundConnectionStatusCode_Values() []string

InboundConnectionStatusCode_Values returns all elements of the InboundConnectionStatusCode enum

func LogType_Values 

func LogType_Values() []string

LogType_Values returns all elements of the LogType enum

func OpenSearchPartitionInstanceType_Values 

func OpenSearchPartitionInstanceType_Values() []string

OpenSearchPartitionInstanceType_Values returns all elements of the OpenSearchPartitionInstanceType enum

func OpenSearchWarmPartitionInstanceType_Values 

func OpenSearchWarmPartitionInstanceType_Values() []string

OpenSearchWarmPartitionInstanceType_Values returns all elements of the OpenSearchWarmPartitionInstanceType enum

func OptionState_Values 

func OptionState_Values() []string

OptionState_Values returns all elements of the OptionState enum

func OutboundConnectionStatusCode_Values 

func OutboundConnectionStatusCode_Values() []string

OutboundConnectionStatusCode_Values returns all elements of the OutboundConnectionStatusCode enum

func PackageStatus_Values 

func PackageStatus_Values() []string

PackageStatus_Values returns all elements of the PackageStatus enum

func PackageType_Values 

func PackageType_Values() []string

PackageType_Values returns all elements of the PackageType enum

func ReservedInstancePaymentOption_Values 

func ReservedInstancePaymentOption_Values() []string

ReservedInstancePaymentOption_Values returns all elements of the ReservedInstancePaymentOption enum

func RollbackOnDisable_Values 

func RollbackOnDisable_Values() []string

RollbackOnDisable_Values returns all elements of the RollbackOnDisable enum

func ScheduledAutoTuneActionType_Values 

func ScheduledAutoTuneActionType_Values() []string

ScheduledAutoTuneActionType_Values returns all elements of the ScheduledAutoTuneActionType enum

func ScheduledAutoTuneSeverityType_Values 

func ScheduledAutoTuneSeverityType_Values() []string

ScheduledAutoTuneSeverityType_Values returns all elements of the ScheduledAutoTuneSeverityType enum

func TLSSecurityPolicy_Values 

func TLSSecurityPolicy_Values() []string

TLSSecurityPolicy_Values returns all elements of the TLSSecurityPolicy enum

func TimeUnit_Values 

func TimeUnit_Values() []string

TimeUnit_Values returns all elements of the TimeUnit enum

func UpgradeStatus_Values 

func UpgradeStatus_Values() []string

UpgradeStatus_Values returns all elements of the UpgradeStatus enum

func UpgradeStep_Values 

func UpgradeStep_Values() []string

UpgradeStep_Values returns all elements of the UpgradeStep enum

func VolumeType_Values 

func VolumeType_Values() []string

VolumeType_Values returns all elements of the VolumeType enum

Types

type AWSDomainInformation 

type AWSDomainInformation struct {

	// The name of an 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"`

	OwnerId *string `min:"12" type:"string"`

	Region *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (AWSDomainInformation) GoString 

func (s AWSDomainInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AWSDomainInformation) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*AWSDomainInformation) SetOwnerId 

func (s *AWSDomainInformation) SetOwnerId(v string) *AWSDomainInformation

SetOwnerId sets the OwnerId field's value.

func (*AWSDomainInformation) SetRegion 

func (s *AWSDomainInformation) SetRegion(v string) *AWSDomainInformation

SetRegion sets the Region field's value.

func (AWSDomainInformation) String 

func (s AWSDomainInformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AWSDomainInformation) Validate 

func (s *AWSDomainInformation) Validate() error

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

type AcceptInboundConnectionInput 

type AcceptInboundConnectionInput struct {

	// The ID of the inbound connection you want to accept.
	//
	// ConnectionId is a required field
	ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the AcceptInboundConnection operation.

func (AcceptInboundConnectionInput) GoString 

func (s AcceptInboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInboundConnectionInput) SetConnectionId 

func (s *AcceptInboundConnectionInput) SetConnectionId(v string) *AcceptInboundConnectionInput

SetConnectionId sets the ConnectionId field's value.

func (AcceptInboundConnectionInput) String 

func (s AcceptInboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInboundConnectionInput) Validate 

func (s *AcceptInboundConnectionInput) Validate() error

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

type AcceptInboundConnectionOutput 

type AcceptInboundConnectionOutput struct {

	// The InboundConnection of the accepted inbound connection.
	Connection *InboundConnection `type:"structure"`
	// contains filtered or unexported fields
}

The result of an AcceptInboundConnection operation. Contains details about the accepted inbound connection.

func (AcceptInboundConnectionOutput) GoString 

func (s AcceptInboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInboundConnectionOutput) SetConnection 

func (s *AcceptInboundConnectionOutput) SetConnection(v *InboundConnection) *AcceptInboundConnectionOutput

SetConnection sets the Connection field's value.

func (AcceptInboundConnectionOutput) String 

func (s AcceptInboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessPoliciesStatus 

type AccessPoliciesStatus struct {

	// The access policy configured for the domain. Access policies can be resource-based,
	// IP-based, or IAM-based. See Configuring access policies (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessPoliciesStatus) SetOptions 

func (s *AccessPoliciesStatus) SetOptions(v string) *AccessPoliciesStatus

SetOptions sets the Options field's value.

func (*AccessPoliciesStatus) SetStatus 

func (s *AccessPoliciesStatus) SetStatus(v *OptionStatus) *AccessPoliciesStatus

SetStatus sets the Status field's value.

func (AccessPoliciesStatus) String 

func (s AccessPoliciesStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddTagsInput 

type AddTagsInput struct {

	// Specify the ARN of the domain you want to add tags to.
	//
	// ARN is a required field
	ARN *string `min:"20" type:"string" required:"true"`

	// List of Tag to add to the 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. Specifies the tags to attach to the domain.

func (AddTagsInput) GoString 

func (s AddTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsInput) SetARN 

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

SetARN sets the ARN field's value.

func (*AddTagsInput) SetTagList 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsInput) Validate 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddTagsOutput) String 

func (s AddTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdditionalLimit 

type AdditionalLimit struct {

	// Additional limit is specific to a given InstanceType and for each of its
	// InstanceRole etc. Attributes and their details:
	//    * MaximumNumberOfDataNodesSupported
	//
	//    * MaximumNumberOfDataNodesWithoutMasterNode
	LimitName *string `type:"string"`

	// Value for a 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 its InstanceRole .

func (AdditionalLimit) GoString 

func (s AdditionalLimit) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdditionalLimit) SetLimitName 

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

SetLimitName sets the LimitName field's value.

func (*AdditionalLimit) SetLimitValues 

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

SetLimitValues sets the LimitValues field's value.

func (AdditionalLimit) String 

func (s AdditionalLimit) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdvancedOptionsStatus 

type AdvancedOptionsStatus struct {

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

	// The OptionStatus for advanced options for the specified 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 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 Advanced cluster parameters for more information.

  • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

For more information, see Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).

func (AdvancedOptionsStatus) GoString 

func (s AdvancedOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedOptionsStatus) SetOptions 

func (s *AdvancedOptionsStatus) SetOptions(v map[string]*string) *AdvancedOptionsStatus

SetOptions sets the Options field's value.

func (*AdvancedOptionsStatus) SetStatus 

func (s *AdvancedOptionsStatus) SetStatus(v *OptionStatus) *AdvancedOptionsStatus

SetStatus sets the Status field's value.

func (AdvancedOptionsStatus) String 

func (s AdvancedOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdvancedSecurityOptions 

type AdvancedSecurityOptions struct {

	// True if advanced security is enabled.
	Enabled *bool `type:"boolean"`

	// True if the internal user database is enabled.
	InternalUserDatabaseEnabled *bool `type:"boolean"`

	// Describes the SAML application configured for a domain.
	SAMLOptions *SAMLOptionsOutput_ `type:"structure"`
	// contains filtered or unexported fields
}

The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

func (AdvancedSecurityOptions) GoString 

func (s AdvancedSecurityOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptions) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*AdvancedSecurityOptions) SetInternalUserDatabaseEnabled 

func (s *AdvancedSecurityOptions) SetInternalUserDatabaseEnabled(v bool) *AdvancedSecurityOptions

SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.

func (*AdvancedSecurityOptions) SetSAMLOptions 

func (s *AdvancedSecurityOptions) SetSAMLOptions(v *SAMLOptionsOutput_) *AdvancedSecurityOptions

SetSAMLOptions sets the SAMLOptions field's value.

func (AdvancedSecurityOptions) String 

func (s AdvancedSecurityOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdvancedSecurityOptionsInput_ 

type AdvancedSecurityOptionsInput_ struct {

	// True if advanced security is enabled.
	Enabled *bool `type:"boolean"`

	// True if the internal user database is enabled.
	InternalUserDatabaseEnabled *bool `type:"boolean"`

	// Credentials for the master user: username and password, ARN, or both.
	MasterUserOptions *MasterUserOptions `type:"structure"`

	// The SAML application configuration for the domain.
	SAMLOptions *SAMLOptionsInput_ `type:"structure"`
	// contains filtered or unexported fields
}

The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

func (AdvancedSecurityOptionsInput_) GoString 

func (s AdvancedSecurityOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptionsInput_) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*AdvancedSecurityOptionsInput_) SetInternalUserDatabaseEnabled 

func (s *AdvancedSecurityOptionsInput_) SetInternalUserDatabaseEnabled(v bool) *AdvancedSecurityOptionsInput_

SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.

func (*AdvancedSecurityOptionsInput_) SetMasterUserOptions 

func (s *AdvancedSecurityOptionsInput_) SetMasterUserOptions(v *MasterUserOptions) *AdvancedSecurityOptionsInput_

SetMasterUserOptions sets the MasterUserOptions field's value.

func (*AdvancedSecurityOptionsInput_) SetSAMLOptions 

func (s *AdvancedSecurityOptionsInput_) SetSAMLOptions(v *SAMLOptionsInput_) *AdvancedSecurityOptionsInput_

SetSAMLOptions sets the SAMLOptions field's value.

func (AdvancedSecurityOptionsInput_) String 

func (s AdvancedSecurityOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptionsInput_) Validate 

func (s *AdvancedSecurityOptionsInput_) Validate() error

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

type AdvancedSecurityOptionsStatus 

type AdvancedSecurityOptionsStatus struct {

	// Advanced security options for the specified domain.
	//
	// Options is a required field
	Options *AdvancedSecurityOptions `type:"structure" required:"true"`

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

The status of advanced security options for the specified domain.

func (AdvancedSecurityOptionsStatus) GoString 

func (s AdvancedSecurityOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptionsStatus) SetOptions 

func (s *AdvancedSecurityOptionsStatus) SetOptions(v *AdvancedSecurityOptions) *AdvancedSecurityOptionsStatus

SetOptions sets the Options field's value.

func (*AdvancedSecurityOptionsStatus) SetStatus 

func (s *AdvancedSecurityOptionsStatus) SetStatus(v *OptionStatus) *AdvancedSecurityOptionsStatus

SetStatus sets the Status field's value.

func (AdvancedSecurityOptionsStatus) String 

func (s AdvancedSecurityOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociatePackageInput 

type AssociatePackageInput struct {

	// The name of the domain to associate the package with.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

	// Internal ID of the package to associate with a domain. Use DescribePackages
	// to find this value.
	//
	// PackageID is a required field
	PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the request parameters to the AssociatePackage operation.

func (AssociatePackageInput) GoString 

func (s AssociatePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePackageInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*AssociatePackageInput) SetPackageID 

func (s *AssociatePackageInput) SetPackageID(v string) *AssociatePackageInput

SetPackageID sets the PackageID field's value.

func (AssociatePackageInput) String 

func (s AssociatePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePackageInput) Validate 

func (s *AssociatePackageInput) Validate() error

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

type AssociatePackageOutput 

type AssociatePackageOutput struct {

	// DomainPackageDetails
	DomainPackageDetails *DomainPackageDetails `type:"structure"`
	// contains filtered or unexported fields
}

Container for the response returned by AssociatePackage operation.

func (AssociatePackageOutput) GoString 

func (s AssociatePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePackageOutput) SetDomainPackageDetails 

func (s *AssociatePackageOutput) SetDomainPackageDetails(v *DomainPackageDetails) *AssociatePackageOutput

SetDomainPackageDetails sets the DomainPackageDetails field's value.

func (AssociatePackageOutput) String 

func (s AssociatePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTune 

type AutoTune struct {

	// Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch
	// Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	AutoTuneDetails *AutoTuneDetails `type:"structure"`

	// Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
	AutoTuneType *string `type:"string" enum:"AutoTuneType"`
	// contains filtered or unexported fields
}

Specifies the Auto-Tune type and Auto-Tune action details.

func (AutoTune) GoString 

func (s AutoTune) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTune) SetAutoTuneDetails 

func (s *AutoTune) SetAutoTuneDetails(v *AutoTuneDetails) *AutoTune

SetAutoTuneDetails sets the AutoTuneDetails field's value.

func (*AutoTune) SetAutoTuneType 

func (s *AutoTune) SetAutoTuneType(v string) *AutoTune

SetAutoTuneType sets the AutoTuneType field's value.

func (AutoTune) String 

func (s AutoTune) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneDetails 

type AutoTuneDetails struct {

	// Specifies details about the scheduled Auto-Tune action. See Auto-Tune for
	// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	ScheduledAutoTuneDetails *ScheduledAutoTuneDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.

func (AutoTuneDetails) GoString 

func (s AutoTuneDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneDetails) SetScheduledAutoTuneDetails 

func (s *AutoTuneDetails) SetScheduledAutoTuneDetails(v *ScheduledAutoTuneDetails) *AutoTuneDetails

SetScheduledAutoTuneDetails sets the ScheduledAutoTuneDetails field's value.

func (AutoTuneDetails) String 

func (s AutoTuneDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneMaintenanceSchedule 

type AutoTuneMaintenanceSchedule struct {

	// A cron expression for a recurring maintenance schedule. See Auto-Tune for
	// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	CronExpressionForRecurrence *string `type:"string"`

	// Specifies maintenance schedule duration: duration value and duration unit.
	// See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	Duration *Duration `type:"structure"`

	// The timestamp at which the Auto-Tune maintenance schedule starts.
	StartAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.

func (AutoTuneMaintenanceSchedule) GoString 

func (s AutoTuneMaintenanceSchedule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneMaintenanceSchedule) SetCronExpressionForRecurrence 

func (s *AutoTuneMaintenanceSchedule) SetCronExpressionForRecurrence(v string) *AutoTuneMaintenanceSchedule

SetCronExpressionForRecurrence sets the CronExpressionForRecurrence field's value.

func (*AutoTuneMaintenanceSchedule) SetDuration 

func (s *AutoTuneMaintenanceSchedule) SetDuration(v *Duration) *AutoTuneMaintenanceSchedule

SetDuration sets the Duration field's value.

func (*AutoTuneMaintenanceSchedule) SetStartAt 

func (s *AutoTuneMaintenanceSchedule) SetStartAt(v time.Time) *AutoTuneMaintenanceSchedule

SetStartAt sets the StartAt field's value.

func (AutoTuneMaintenanceSchedule) String 

func (s AutoTuneMaintenanceSchedule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneMaintenanceSchedule) Validate 

func (s *AutoTuneMaintenanceSchedule) Validate() error

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

type AutoTuneOptions 

type AutoTuneOptions struct {

	// The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
	DesiredState *string `type:"string" enum:"AutoTuneDesiredState"`

	// A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service
	// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	MaintenanceSchedules []*AutoTuneMaintenanceSchedule `type:"list"`

	// The rollback state while disabling Auto-Tune for the domain. Valid values
	// are NO_ROLLBACK and DEFAULT_ROLLBACK.
	RollbackOnDisable *string `type:"string" enum:"RollbackOnDisable"`
	// contains filtered or unexported fields
}

The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

func (AutoTuneOptions) GoString 

func (s AutoTuneOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptions) SetDesiredState 

func (s *AutoTuneOptions) SetDesiredState(v string) *AutoTuneOptions

SetDesiredState sets the DesiredState field's value.

func (*AutoTuneOptions) SetMaintenanceSchedules 

func (s *AutoTuneOptions) SetMaintenanceSchedules(v []*AutoTuneMaintenanceSchedule) *AutoTuneOptions

SetMaintenanceSchedules sets the MaintenanceSchedules field's value.

func (*AutoTuneOptions) SetRollbackOnDisable 

func (s *AutoTuneOptions) SetRollbackOnDisable(v string) *AutoTuneOptions

SetRollbackOnDisable sets the RollbackOnDisable field's value.

func (AutoTuneOptions) String 

func (s AutoTuneOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptions) Validate 

func (s *AutoTuneOptions) Validate() error

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

type AutoTuneOptionsInput_ 

type AutoTuneOptionsInput_ struct {

	// The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
	DesiredState *string `type:"string" enum:"AutoTuneDesiredState"`

	// A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service
	// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	MaintenanceSchedules []*AutoTuneMaintenanceSchedule `type:"list"`
	// contains filtered or unexported fields
}

The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

func (AutoTuneOptionsInput_) GoString 

func (s AutoTuneOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsInput_) SetDesiredState 

func (s *AutoTuneOptionsInput_) SetDesiredState(v string) *AutoTuneOptionsInput_

SetDesiredState sets the DesiredState field's value.

func (*AutoTuneOptionsInput_) SetMaintenanceSchedules 

func (s *AutoTuneOptionsInput_) SetMaintenanceSchedules(v []*AutoTuneMaintenanceSchedule) *AutoTuneOptionsInput_

SetMaintenanceSchedules sets the MaintenanceSchedules field's value.

func (AutoTuneOptionsInput_) String 

func (s AutoTuneOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsInput_) Validate 

func (s *AutoTuneOptionsInput_) Validate() error

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

type AutoTuneOptionsOutput_ 

type AutoTuneOptionsOutput_ struct {

	// The error message while enabling or disabling Auto-Tune.
	ErrorMessage *string `type:"string"`

	// The AutoTuneState for the domain.
	State *string `type:"string" enum:"AutoTuneState"`
	// contains filtered or unexported fields
}

The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

func (AutoTuneOptionsOutput_) GoString 

func (s AutoTuneOptionsOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsOutput_) SetErrorMessage 

func (s *AutoTuneOptionsOutput_) SetErrorMessage(v string) *AutoTuneOptionsOutput_

SetErrorMessage sets the ErrorMessage field's value.

func (*AutoTuneOptionsOutput_) SetState 

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

SetState sets the State field's value.

func (AutoTuneOptionsOutput_) String 

func (s AutoTuneOptionsOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneOptionsStatus 

type AutoTuneOptionsStatus struct {

	// Specifies Auto-Tune options for the domain.
	Options *AutoTuneOptions `type:"structure"`

	// The status of the Auto-Tune options for the domain.
	Status *AutoTuneStatus `type:"structure"`
	// contains filtered or unexported fields
}

The Auto-Tune status for the domain.

func (AutoTuneOptionsStatus) GoString 

func (s AutoTuneOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsStatus) SetOptions 

func (s *AutoTuneOptionsStatus) SetOptions(v *AutoTuneOptions) *AutoTuneOptionsStatus

SetOptions sets the Options field's value.

func (*AutoTuneOptionsStatus) SetStatus 

func (s *AutoTuneOptionsStatus) SetStatus(v *AutoTuneStatus) *AutoTuneOptionsStatus

SetStatus sets the Status field's value.

func (AutoTuneOptionsStatus) String 

func (s AutoTuneOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneStatus 

type AutoTuneStatus struct {

	// The timestamp of the Auto-Tune options creation date.
	//
	// CreationDate is a required field
	CreationDate *time.Time `type:"timestamp" required:"true"`

	// The error message while enabling or disabling Auto-Tune.
	ErrorMessage *string `type:"string"`

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

	// The AutoTuneState for the domain.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"AutoTuneState"`

	// The timestamp of when the Auto-Tune options were last updated.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `type:"timestamp" required:"true"`

	// The latest version of the Auto-Tune options.
	UpdateVersion *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides the current Auto-Tune status for the domain.

func (AutoTuneStatus) GoString 

func (s AutoTuneStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneStatus) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*AutoTuneStatus) SetErrorMessage 

func (s *AutoTuneStatus) SetErrorMessage(v string) *AutoTuneStatus

SetErrorMessage sets the ErrorMessage field's value.

func (*AutoTuneStatus) SetPendingDeletion 

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

SetPendingDeletion sets the PendingDeletion field's value.

func (*AutoTuneStatus) SetState 

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

SetState sets the State field's value.

func (*AutoTuneStatus) SetUpdateDate 

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

SetUpdateDate sets the UpdateDate field's value.

func (*AutoTuneStatus) SetUpdateVersion 

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

SetUpdateVersion sets the UpdateVersion field's value.

func (AutoTuneStatus) String 

func (s AutoTuneStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BaseException 

type BaseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred while processing the request.

func (*BaseException) Code 

func (s *BaseException) Code() string

Code returns the exception type name.

func (*BaseException) Error 

func (s *BaseException) Error() string

func (BaseException) GoString 

func (s BaseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BaseException) Message 

func (s *BaseException) Message() string

Message returns the exception's message.

func (*BaseException) OrigErr 

func (s *BaseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BaseException) RequestID 

func (s *BaseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BaseException) StatusCode 

func (s *BaseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BaseException) String 

func (s BaseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelServiceSoftwareUpdateInput 

type CancelServiceSoftwareUpdateInput 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 CancelServiceSoftwareUpdate operation. Specifies the name of the domain that you wish to cancel a service software update on.

func (CancelServiceSoftwareUpdateInput) GoString 

func (s CancelServiceSoftwareUpdateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelServiceSoftwareUpdateInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (CancelServiceSoftwareUpdateInput) String 

func (s CancelServiceSoftwareUpdateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelServiceSoftwareUpdateInput) Validate 

func (s *CancelServiceSoftwareUpdateInput) Validate() error

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

type CancelServiceSoftwareUpdateOutput 

type CancelServiceSoftwareUpdateOutput struct {

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

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

func (CancelServiceSoftwareUpdateOutput) GoString 

func (s CancelServiceSoftwareUpdateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelServiceSoftwareUpdateOutput) SetServiceSoftwareOptions 

func (s *CancelServiceSoftwareUpdateOutput) SetServiceSoftwareOptions(v *ServiceSoftwareOptions) *CancelServiceSoftwareUpdateOutput

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (CancelServiceSoftwareUpdateOutput) String 

func (s CancelServiceSoftwareUpdateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterConfig 

type ClusterConfig struct {

	// Specifies the ColdStorageOptions config for a Domain
	ColdStorageOptions *ColdStorageOptions `type:"structure"`

	// 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
	// Dedicated master nodes in Amazon OpenSearch Service (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-dedicatedmasternodes)
	// for more information.
	DedicatedMasterEnabled *bool `type:"boolean"`

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

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

	// The instance type for an OpenSearch cluster. UltraWarm instance types are
	// not supported for data instances.
	InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

	// The number of UltraWarm nodes in the cluster.
	WarmCount *int64 `type:"integer"`

	// True to enable UltraWarm storage.
	WarmEnabled *bool `type:"boolean"`

	// The instance type for the OpenSearch cluster's warm nodes.
	WarmType *string `type:"string" enum:"OpenSearchWarmPartitionInstanceType"`

	// 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 Configuring
	// a multi-AZ domain in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html)
	// for more information.
	ZoneAwarenessEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (ClusterConfig) GoString 

func (s ClusterConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterConfig) SetColdStorageOptions 

func (s *ClusterConfig) SetColdStorageOptions(v *ColdStorageOptions) *ClusterConfig

SetColdStorageOptions sets the ColdStorageOptions field's value.

func (*ClusterConfig) SetDedicatedMasterCount 

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

SetDedicatedMasterCount sets the DedicatedMasterCount field's value.

func (*ClusterConfig) SetDedicatedMasterEnabled 

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

SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.

func (*ClusterConfig) SetDedicatedMasterType 

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

SetDedicatedMasterType sets the DedicatedMasterType field's value.

func (*ClusterConfig) SetInstanceCount 

func (s *ClusterConfig) SetInstanceCount(v int64) *ClusterConfig

SetInstanceCount sets the InstanceCount field's value.

func (*ClusterConfig) SetInstanceType 

func (s *ClusterConfig) SetInstanceType(v string) *ClusterConfig

SetInstanceType sets the InstanceType field's value.

func (*ClusterConfig) SetWarmCount 

func (s *ClusterConfig) SetWarmCount(v int64) *ClusterConfig

SetWarmCount sets the WarmCount field's value.

func (*ClusterConfig) SetWarmEnabled 

func (s *ClusterConfig) SetWarmEnabled(v bool) *ClusterConfig

SetWarmEnabled sets the WarmEnabled field's value.

func (*ClusterConfig) SetWarmType 

func (s *ClusterConfig) SetWarmType(v string) *ClusterConfig

SetWarmType sets the WarmType field's value.

func (*ClusterConfig) SetZoneAwarenessConfig 

func (s *ClusterConfig) SetZoneAwarenessConfig(v *ZoneAwarenessConfig) *ClusterConfig

SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.

func (*ClusterConfig) SetZoneAwarenessEnabled 

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

SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.

func (ClusterConfig) String 

func (s ClusterConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterConfig) Validate 

func (s *ClusterConfig) Validate() error

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

type ClusterConfigStatus 

type ClusterConfigStatus struct {

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

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

The configuration status for the specified domain.

func (ClusterConfigStatus) GoString 

func (s ClusterConfigStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterConfigStatus) SetOptions 

func (s *ClusterConfigStatus) SetOptions(v *ClusterConfig) *ClusterConfigStatus

SetOptions sets the Options field's value.

func (*ClusterConfigStatus) SetStatus 

func (s *ClusterConfigStatus) SetStatus(v *OptionStatus) *ClusterConfigStatus

SetStatus sets the Status field's value.

func (ClusterConfigStatus) String 

func (s ClusterConfigStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CognitoOptions 

type CognitoOptions struct {

	// The option to enable Cognito for OpenSearch Dashboards authentication.
	Enabled *bool `type:"boolean"`

	// The Cognito identity pool ID for OpenSearch Dashboards authentication.
	IdentityPoolId *string `min:"1" type:"string"`

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

	// The Cognito user pool ID for OpenSearch Dashboards authentication.
	UserPoolId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (CognitoOptions) GoString 

func (s CognitoOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CognitoOptions) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*CognitoOptions) SetIdentityPoolId 

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

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*CognitoOptions) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*CognitoOptions) SetUserPoolId 

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

SetUserPoolId sets the UserPoolId field's value.

func (CognitoOptions) String 

func (s CognitoOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CognitoOptions) Validate 

func (s *CognitoOptions) Validate() error

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

type CognitoOptionsStatus 

type CognitoOptionsStatus struct {

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

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

The status of the Cognito options for the specified domain.

func (CognitoOptionsStatus) GoString 

func (s CognitoOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CognitoOptionsStatus) SetOptions 

func (s *CognitoOptionsStatus) SetOptions(v *CognitoOptions) *CognitoOptionsStatus

SetOptions sets the Options field's value.

func (*CognitoOptionsStatus) SetStatus 

func (s *CognitoOptionsStatus) SetStatus(v *OptionStatus) *CognitoOptionsStatus

SetStatus sets the Status field's value.

func (CognitoOptionsStatus) String 

func (s CognitoOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ColdStorageOptions 

type ColdStorageOptions struct {

	// Enable cold storage option. Accepted values true or false
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration for cold storage options such as enabled

func (ColdStorageOptions) GoString 

func (s ColdStorageOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColdStorageOptions) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (ColdStorageOptions) String 

func (s ColdStorageOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColdStorageOptions) Validate 

func (s *ColdStorageOptions) Validate() error

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

type CompatibleVersionsMap 

type CompatibleVersionsMap struct {

	// The current version of OpenSearch a domain is on.
	SourceVersion *string `min:"14" type:"string"`

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

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

func (CompatibleVersionsMap) GoString 

func (s CompatibleVersionsMap) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompatibleVersionsMap) SetSourceVersion 

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

SetSourceVersion sets the SourceVersion field's value.

func (*CompatibleVersionsMap) SetTargetVersions 

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

SetTargetVersions sets the TargetVersions field's value.

func (CompatibleVersionsMap) String 

func (s CompatibleVersionsMap) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDomainInput 

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

	// Specifies advanced security options.
	AdvancedSecurityOptions *AdvancedSecurityOptionsInput_ `type:"structure"`

	// Specifies Auto-Tune options.
	AutoTuneOptions *AutoTuneOptionsInput_ `type:"structure"`

	// Configuration options for a domain. Specifies the instance type and number
	// of instances in the domain.
	ClusterConfig *ClusterConfig `type:"structure"`

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

	// Options to specify configurations that will be applied to the domain endpoint.
	DomainEndpointOptions *DomainEndpointOptions `type:"structure"`

	// The name of the Amazon OpenSearch Service domain you're creating. Domain
	// names are unique across the domains owned by an account within an AWS region.
	// Domain names must start with a lowercase letter 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"`

	// Options for encryption of data at rest.
	EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

	// String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine
	// version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0"
	// or "Elasticsearch_7.9". For more information, see Creating and managing Amazon
	// OpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains).
	EngineVersion *string `min:"14" type:"string"`

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

	// Node-to-node encryption options.
	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"`

	// A list of Tag added during domain creation.
	TagList []*Tag `type:"list"`

	// Options to specify the subnets and security groups for a VPC endpoint. For
	// more information, see Launching your Amazon OpenSearch Service domains using
	// a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
	VPCOptions *VPCOptions `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDomainInput) GoString 

func (s CreateDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainInput) SetAccessPolicies 

func (s *CreateDomainInput) SetAccessPolicies(v string) *CreateDomainInput

SetAccessPolicies sets the AccessPolicies field's value.

func (*CreateDomainInput) SetAdvancedOptions 

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

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*CreateDomainInput) SetAdvancedSecurityOptions 

func (s *CreateDomainInput) SetAdvancedSecurityOptions(v *AdvancedSecurityOptionsInput_) *CreateDomainInput

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*CreateDomainInput) SetAutoTuneOptions 

func (s *CreateDomainInput) SetAutoTuneOptions(v *AutoTuneOptionsInput_) *CreateDomainInput

SetAutoTuneOptions sets the AutoTuneOptions field's value.

func (*CreateDomainInput) SetClusterConfig 

func (s *CreateDomainInput) SetClusterConfig(v *ClusterConfig) *CreateDomainInput

SetClusterConfig sets the ClusterConfig field's value.

func (*CreateDomainInput) SetCognitoOptions 

func (s *CreateDomainInput) SetCognitoOptions(v *CognitoOptions) *CreateDomainInput

SetCognitoOptions sets the CognitoOptions field's value.

func (*CreateDomainInput) SetDomainEndpointOptions 

func (s *CreateDomainInput) SetDomainEndpointOptions(v *DomainEndpointOptions) *CreateDomainInput

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*CreateDomainInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*CreateDomainInput) SetEBSOptions 

func (s *CreateDomainInput) SetEBSOptions(v *EBSOptions) *CreateDomainInput

SetEBSOptions sets the EBSOptions field's value.

func (*CreateDomainInput) SetEncryptionAtRestOptions 

func (s *CreateDomainInput) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *CreateDomainInput

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*CreateDomainInput) SetEngineVersion 

func (s *CreateDomainInput) SetEngineVersion(v string) *CreateDomainInput

SetEngineVersion sets the EngineVersion field's value.

func (*CreateDomainInput) SetLogPublishingOptions 

func (s *CreateDomainInput) SetLogPublishingOptions(v map[string]*LogPublishingOption) *CreateDomainInput

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*CreateDomainInput) SetNodeToNodeEncryptionOptions 

func (s *CreateDomainInput) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptions) *CreateDomainInput

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*CreateDomainInput) SetSnapshotOptions 

func (s *CreateDomainInput) SetSnapshotOptions(v *SnapshotOptions) *CreateDomainInput

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*CreateDomainInput) SetTagList 

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

SetTagList sets the TagList field's value.

func (*CreateDomainInput) SetVPCOptions 

func (s *CreateDomainInput) SetVPCOptions(v *VPCOptions) *CreateDomainInput

SetVPCOptions sets the VPCOptions field's value.

func (CreateDomainInput) String 

func (s CreateDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainInput) Validate 

func (s *CreateDomainInput) Validate() error

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

type CreateDomainOutput 

type CreateDomainOutput struct {

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

The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.

func (CreateDomainOutput) GoString 

func (s CreateDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainOutput) SetDomainStatus 

func (s *CreateDomainOutput) SetDomainStatus(v *DomainStatus) *CreateDomainOutput

SetDomainStatus sets the DomainStatus field's value.

func (CreateDomainOutput) String 

func (s CreateDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateOutboundConnectionInput 

type CreateOutboundConnectionInput struct {

	// The connection alias used used by the customer for this cross-cluster connection.
	//
	// ConnectionAlias is a required field
	ConnectionAlias *string `min:"2" type:"string" required:"true"`

	// The AWSDomainInformation for the local OpenSearch domain.
	//
	// LocalDomainInfo is a required field
	LocalDomainInfo *DomainInformationContainer `type:"structure" required:"true"`

	// The AWSDomainInformation for the remote OpenSearch domain.
	//
	// RemoteDomainInfo is a required field
	RemoteDomainInfo *DomainInformationContainer `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the CreateOutboundConnection operation.

func (CreateOutboundConnectionInput) GoString 

func (s CreateOutboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOutboundConnectionInput) SetConnectionAlias 

func (s *CreateOutboundConnectionInput) SetConnectionAlias(v string) *CreateOutboundConnectionInput

SetConnectionAlias sets the ConnectionAlias field's value.

func (*CreateOutboundConnectionInput) SetLocalDomainInfo 

func (s *CreateOutboundConnectionInput) SetLocalDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionInput

SetLocalDomainInfo sets the LocalDomainInfo field's value.

func (*CreateOutboundConnectionInput) SetRemoteDomainInfo 

func (s *CreateOutboundConnectionInput) SetRemoteDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionInput

SetRemoteDomainInfo sets the RemoteDomainInfo field's value.

func (CreateOutboundConnectionInput) String 

func (s CreateOutboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOutboundConnectionInput) Validate 

func (s *CreateOutboundConnectionInput) Validate() error

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

type CreateOutboundConnectionOutput 

type CreateOutboundConnectionOutput struct {

	// The connection alias provided during the create connection request.
	ConnectionAlias *string `min:"2" type:"string"`

	// The unique ID for the created outbound connection, which is used for subsequent
	// operations on the connection.
	ConnectionId *string `min:"10" type:"string"`

	// The OutboundConnectionStatus for the newly created connection.
	ConnectionStatus *OutboundConnectionStatus `type:"structure"`

	// The AWSDomainInformation for the local OpenSearch domain.
	LocalDomainInfo *DomainInformationContainer `type:"structure"`

	// The AWSDomainInformation for the remote OpenSearch domain.
	RemoteDomainInfo *DomainInformationContainer `type:"structure"`
	// contains filtered or unexported fields
}

The result of a CreateOutboundConnection request. Contains the details about the newly created cross-cluster connection.

func (CreateOutboundConnectionOutput) GoString 

func (s CreateOutboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOutboundConnectionOutput) SetConnectionAlias 

func (s *CreateOutboundConnectionOutput) SetConnectionAlias(v string) *CreateOutboundConnectionOutput

SetConnectionAlias sets the ConnectionAlias field's value.

func (*CreateOutboundConnectionOutput) SetConnectionId 

func (s *CreateOutboundConnectionOutput) SetConnectionId(v string) *CreateOutboundConnectionOutput

SetConnectionId sets the ConnectionId field's value.

func (*CreateOutboundConnectionOutput) SetConnectionStatus 

func (s *CreateOutboundConnectionOutput) SetConnectionStatus(v *OutboundConnectionStatus) *CreateOutboundConnectionOutput

SetConnectionStatus sets the ConnectionStatus field's value.

func (*CreateOutboundConnectionOutput) SetLocalDomainInfo 

func (s *CreateOutboundConnectionOutput) SetLocalDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionOutput

SetLocalDomainInfo sets the LocalDomainInfo field's value.

func (*CreateOutboundConnectionOutput) SetRemoteDomainInfo 

func (s *CreateOutboundConnectionOutput) SetRemoteDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionOutput

SetRemoteDomainInfo sets the RemoteDomainInfo field's value.

func (CreateOutboundConnectionOutput) String 

func (s CreateOutboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePackageInput 

type CreatePackageInput struct {

	// Description of the package.
	PackageDescription *string `type:"string"`

	// Unique identifier for the package.
	//
	// PackageName is a required field
	PackageName *string `min:"3" type:"string" required:"true"`

	// The Amazon S3 location from which to import the package.
	//
	// PackageSource is a required field
	PackageSource *PackageSource `type:"structure" required:"true"`

	// Type of package. Currently supports only TXT-DICTIONARY.
	//
	// PackageType is a required field
	PackageType *string `type:"string" required:"true" enum:"PackageType"`
	// contains filtered or unexported fields
}

Container for request parameters to the CreatePackage operation.

func (CreatePackageInput) GoString 

func (s CreatePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePackageInput) SetPackageDescription 

func (s *CreatePackageInput) SetPackageDescription(v string) *CreatePackageInput

SetPackageDescription sets the PackageDescription field's value.

func (*CreatePackageInput) SetPackageName 

func (s *CreatePackageInput) SetPackageName(v string) *CreatePackageInput

SetPackageName sets the PackageName field's value.

func (*CreatePackageInput) SetPackageSource 

func (s *CreatePackageInput) SetPackageSource(v *PackageSource) *CreatePackageInput

SetPackageSource sets the PackageSource field's value.

func (*CreatePackageInput) SetPackageType 

func (s *CreatePackageInput) SetPackageType(v string) *CreatePackageInput

SetPackageType sets the PackageType field's value.

func (CreatePackageInput) String 

func (s CreatePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePackageInput) Validate 

func (s *CreatePackageInput) Validate() error

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

type CreatePackageOutput 

type CreatePackageOutput struct {

	// Information about the package.
	PackageDetails *PackageDetails `type:"structure"`
	// contains filtered or unexported fields
}

Container for the response returned by the CreatePackage operation.

func (CreatePackageOutput) GoString 

func (s CreatePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePackageOutput) SetPackageDetails 

func (s *CreatePackageOutput) SetPackageDetails(v *PackageDetails) *CreatePackageOutput

SetPackageDetails sets the PackageDetails field's value.

func (CreatePackageOutput) String 

func (s CreatePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDomainInput 

type DeleteDomainInput struct {

	// The name of the domain 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 DeleteDomain operation. Specifies the name of the domain you want to delete.

func (DeleteDomainInput) GoString 

func (s DeleteDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (DeleteDomainInput) String 

func (s DeleteDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainInput) Validate 

func (s *DeleteDomainInput) Validate() error

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

type DeleteDomainOutput 

type DeleteDomainOutput struct {

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

The result of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

func (DeleteDomainOutput) GoString 

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainOutput) SetDomainStatus 

func (s *DeleteDomainOutput) SetDomainStatus(v *DomainStatus) *DeleteDomainOutput

SetDomainStatus sets the DomainStatus field's value.

func (DeleteDomainOutput) String 

func (s DeleteDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteInboundConnectionInput 

type DeleteInboundConnectionInput struct {

	// The ID of the inbound connection to permanently delete.
	//
	// ConnectionId is a required field
	ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteInboundConnection operation.

func (DeleteInboundConnectionInput) GoString 

func (s DeleteInboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInboundConnectionInput) SetConnectionId 

func (s *DeleteInboundConnectionInput) SetConnectionId(v string) *DeleteInboundConnectionInput

SetConnectionId sets the ConnectionId field's value.

func (DeleteInboundConnectionInput) String 

func (s DeleteInboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInboundConnectionInput) Validate 

func (s *DeleteInboundConnectionInput) Validate() error

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

type DeleteInboundConnectionOutput 

type DeleteInboundConnectionOutput struct {

	// The InboundConnection of the deleted inbound connection.
	Connection *InboundConnection `type:"structure"`
	// contains filtered or unexported fields
}

The result of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.

func (DeleteInboundConnectionOutput) GoString 

func (s DeleteInboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInboundConnectionOutput) SetConnection 

func (s *DeleteInboundConnectionOutput) SetConnection(v *InboundConnection) *DeleteInboundConnectionOutput

SetConnection sets the Connection field's value.

func (DeleteInboundConnectionOutput) String 

func (s DeleteInboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteOutboundConnectionInput 

type DeleteOutboundConnectionInput struct {

	// The ID of the outbound connection you want to permanently delete.
	//
	// ConnectionId is a required field
	ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteOutboundConnection operation.

func (DeleteOutboundConnectionInput) GoString 

func (s DeleteOutboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOutboundConnectionInput) SetConnectionId 

func (s *DeleteOutboundConnectionInput) SetConnectionId(v string) *DeleteOutboundConnectionInput

SetConnectionId sets the ConnectionId field's value.

func (DeleteOutboundConnectionInput) String 

func (s DeleteOutboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOutboundConnectionInput) Validate 

func (s *DeleteOutboundConnectionInput) Validate() error

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

type DeleteOutboundConnectionOutput 

type DeleteOutboundConnectionOutput struct {

	// The OutboundConnection of the deleted outbound connection.
	Connection *OutboundConnection `type:"structure"`
	// contains filtered or unexported fields
}

The result of a DeleteOutboundConnection operation. Contains details about the deleted outbound connection.

func (DeleteOutboundConnectionOutput) GoString 

func (s DeleteOutboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOutboundConnectionOutput) SetConnection 

func (s *DeleteOutboundConnectionOutput) SetConnection(v *OutboundConnection) *DeleteOutboundConnectionOutput

SetConnection sets the Connection field's value.

func (DeleteOutboundConnectionOutput) String 

func (s DeleteOutboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePackageInput 

type DeletePackageInput struct {

	// The internal ID of the package you want to delete. Use DescribePackages to
	// find this value.
	//
	// PackageID is a required field
	PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the request parameters to the DeletePackage operation.

func (DeletePackageInput) GoString 

func (s DeletePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePackageInput) SetPackageID 

func (s *DeletePackageInput) SetPackageID(v string) *DeletePackageInput

SetPackageID sets the PackageID field's value.

func (DeletePackageInput) String 

func (s DeletePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePackageInput) Validate 

func (s *DeletePackageInput) Validate() error

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

type DeletePackageOutput 

type DeletePackageOutput struct {

	// PackageDetails
	PackageDetails *PackageDetails `type:"structure"`
	// contains filtered or unexported fields
}

Container for the response parameters to the DeletePackage operation.

func (DeletePackageOutput) GoString 

func (s DeletePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePackageOutput) SetPackageDetails 

func (s *DeletePackageOutput) SetPackageDetails(v *PackageDetails) *DeletePackageOutput

SetPackageDetails sets the PackageDetails field's value.

func (DeletePackageOutput) String 

func (s DeletePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainAutoTunesInput 

type DescribeDomainAutoTunesInput struct {

	// The domain name for which you want Auto-Tune action details.
	//
	// 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. If not specified,
	// defaults to 100.
	MaxResults *int64 `type:"integer"`

	// NextToken is sent in case the earlier API call results contain the NextToken.
	// Used for pagination.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainAutoTunes operation.

func (DescribeDomainAutoTunesInput) GoString 

func (s DescribeDomainAutoTunesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainAutoTunesInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*DescribeDomainAutoTunesInput) SetMaxResults 

func (s *DescribeDomainAutoTunesInput) SetMaxResults(v int64) *DescribeDomainAutoTunesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeDomainAutoTunesInput) SetNextToken 

func (s *DescribeDomainAutoTunesInput) SetNextToken(v string) *DescribeDomainAutoTunesInput

SetNextToken sets the NextToken field's value.

func (DescribeDomainAutoTunesInput) String 

func (s DescribeDomainAutoTunesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainAutoTunesInput) Validate 

func (s *DescribeDomainAutoTunesInput) Validate() error

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

type DescribeDomainAutoTunesOutput 

type DescribeDomainAutoTunesOutput struct {

	// The list of setting adjustments that Auto-Tune has made to the domain. See
	// Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	AutoTunes []*AutoTune `type:"list"`

	// An identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

The result of a DescribeDomainAutoTunes request. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.

func (DescribeDomainAutoTunesOutput) GoString 

func (s DescribeDomainAutoTunesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainAutoTunesOutput) SetAutoTunes 

func (s *DescribeDomainAutoTunesOutput) SetAutoTunes(v []*AutoTune) *DescribeDomainAutoTunesOutput

SetAutoTunes sets the AutoTunes field's value.

func (*DescribeDomainAutoTunesOutput) SetNextToken 

func (s *DescribeDomainAutoTunesOutput) SetNextToken(v string) *DescribeDomainAutoTunesOutput

SetNextToken sets the NextToken field's value.

func (DescribeDomainAutoTunesOutput) String 

func (s DescribeDomainAutoTunesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainConfigInput 

type DescribeDomainConfigInput struct {

	// The domain 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 DescribeDomainConfig operation. Specifies the domain name for which you want configuration information.

func (DescribeDomainConfigInput) GoString 

func (s DescribeDomainConfigInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (DescribeDomainConfigInput) String 

func (s DescribeDomainConfigInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigInput) Validate 

func (s *DescribeDomainConfigInput) Validate() error

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

type DescribeDomainConfigOutput 

type DescribeDomainConfigOutput struct {

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

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

func (DescribeDomainConfigOutput) GoString 

func (s DescribeDomainConfigOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigOutput) SetDomainConfig 

func (s *DescribeDomainConfigOutput) SetDomainConfig(v *DomainConfig) *DescribeDomainConfigOutput

SetDomainConfig sets the DomainConfig field's value.

func (DescribeDomainConfigOutput) String 

func (s DescribeDomainConfigOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainInput 

type DescribeDomainInput struct {

	// The name of the 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 DescribeDomain operation.

func (DescribeDomainInput) GoString 

func (s DescribeDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (DescribeDomainInput) String 

func (s DescribeDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainInput) Validate 

func (s *DescribeDomainInput) Validate() error

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

type DescribeDomainOutput 

type DescribeDomainOutput struct {

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

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

func (DescribeDomainOutput) GoString 

func (s DescribeDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainOutput) SetDomainStatus 

func (s *DescribeDomainOutput) SetDomainStatus(v *DomainStatus) *DescribeDomainOutput

SetDomainStatus sets the DomainStatus field's value.

func (DescribeDomainOutput) String 

func (s DescribeDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainsInput 

type DescribeDomainsInput struct {

	// The 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 DescribeDomains operation. By default, the API returns the status of all domains.

func (DescribeDomainsInput) GoString 

func (s DescribeDomainsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainsInput) SetDomainNames 

func (s *DescribeDomainsInput) SetDomainNames(v []*string) *DescribeDomainsInput

SetDomainNames sets the DomainNames field's value.

func (DescribeDomainsInput) String 

func (s DescribeDomainsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainsInput) Validate 

func (s *DescribeDomainsInput) Validate() error

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

type DescribeDomainsOutput 

type DescribeDomainsOutput struct {

	// The status of the domains requested in the DescribeDomains request.
	//
	// DomainStatusList is a required field
	DomainStatusList []*DomainStatus `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeDomainsOutput) GoString 

func (s DescribeDomainsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainsOutput) SetDomainStatusList 

func (s *DescribeDomainsOutput) SetDomainStatusList(v []*DomainStatus) *DescribeDomainsOutput

SetDomainStatusList sets the DomainStatusList field's value.

func (DescribeDomainsOutput) String 

func (s DescribeDomainsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeInboundConnectionsInput 

type DescribeInboundConnectionsInput struct {

	// A list of filters used to match properties for inbound cross-cluster connections.
	// Available Filter values are:
	//    * connection-id
	//
	//    * local-domain-info.domain-name
	//
	//    * local-domain-info.owner-id
	//
	//    * local-domain-info.region
	//
	//    * remote-domain-info.domain-name
	Filters []*Filter `type:"list"`

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

	// If more results are available and NextToken is present, make the next request
	// to the same API with the received NextToken to paginate the remaining results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeInboundConnections operation.

func (DescribeInboundConnectionsInput) GoString 

func (s DescribeInboundConnectionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInboundConnectionsInput) SetFilters 

func (s *DescribeInboundConnectionsInput) SetFilters(v []*Filter) *DescribeInboundConnectionsInput

SetFilters sets the Filters field's value.

func (*DescribeInboundConnectionsInput) SetMaxResults 

func (s *DescribeInboundConnectionsInput) SetMaxResults(v int64) *DescribeInboundConnectionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeInboundConnectionsInput) SetNextToken 

func (s *DescribeInboundConnectionsInput) SetNextToken(v string) *DescribeInboundConnectionsInput

SetNextToken sets the NextToken field's value.

func (DescribeInboundConnectionsInput) String 

func (s DescribeInboundConnectionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInboundConnectionsInput) Validate 

func (s *DescribeInboundConnectionsInput) Validate() error

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

type DescribeInboundConnectionsOutput 

type DescribeInboundConnectionsOutput struct {

	// A list of InboundConnection matching the specified filter criteria.
	Connections []*InboundConnection `type:"list"`

	// If more results are available and NextToken is present, make the next request
	// to the same API with the received NextToken to paginate the remaining results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

The result of a DescribeInboundConnections request. Contains a list of connections matching the filter criteria.

func (DescribeInboundConnectionsOutput) GoString 

func (s DescribeInboundConnectionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInboundConnectionsOutput) SetConnections 

func (s *DescribeInboundConnectionsOutput) SetConnections(v []*InboundConnection) *DescribeInboundConnectionsOutput

SetConnections sets the Connections field's value.

func (*DescribeInboundConnectionsOutput) SetNextToken 

func (s *DescribeInboundConnectionsOutput) SetNextToken(v string) *DescribeInboundConnectionsOutput

SetNextToken sets the NextToken field's value.

func (DescribeInboundConnectionsOutput) String 

func (s DescribeInboundConnectionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeInstanceTypeLimitsInput 

type DescribeInstanceTypeLimitsInput struct {

	// The name of the domain you want to modify. Only include this value if you're
	// querying OpenSearch Limits for an existing domain.
	DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"`

	// Version of OpenSearch for which Limits are needed.
	//
	// EngineVersion is a required field
	EngineVersion *string `location:"uri" locationName:"EngineVersion" min:"14" type:"string" required:"true"`

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

Container for the parameters to the DescribeInstanceTypeLimits operation.

func (DescribeInstanceTypeLimitsInput) GoString 

func (s DescribeInstanceTypeLimitsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceTypeLimitsInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*DescribeInstanceTypeLimitsInput) SetEngineVersion 

func (s *DescribeInstanceTypeLimitsInput) SetEngineVersion(v string) *DescribeInstanceTypeLimitsInput

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeInstanceTypeLimitsInput) SetInstanceType 

func (s *DescribeInstanceTypeLimitsInput) SetInstanceType(v string) *DescribeInstanceTypeLimitsInput

SetInstanceType sets the InstanceType field's value.

func (DescribeInstanceTypeLimitsInput) String 

func (s DescribeInstanceTypeLimitsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceTypeLimitsInput) Validate 

func (s *DescribeInstanceTypeLimitsInput) Validate() error

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

type DescribeInstanceTypeLimitsOutput 

type DescribeInstanceTypeLimitsOutput struct {

	// The role of a given instance and all applicable limits. The role performed
	// by a given OpenSearch instance can be one of the following:
	//    * data: If the given InstanceType is used as a data node
	//
	//    * master: If the given InstanceType is used as a master node
	//
	//    * ultra_warm: If the given InstanceType is used as a warm node
	LimitsByRole map[string]*Limits `type:"map"`
	// contains filtered or unexported fields
}

Container for the parameters received from the DescribeInstanceTypeLimits operation.

func (DescribeInstanceTypeLimitsOutput) GoString 

func (s DescribeInstanceTypeLimitsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceTypeLimitsOutput) SetLimitsByRole 

func (s *DescribeInstanceTypeLimitsOutput) SetLimitsByRole(v map[string]*Limits) *DescribeInstanceTypeLimitsOutput

SetLimitsByRole sets the LimitsByRole field's value.

func (DescribeInstanceTypeLimitsOutput) String 

func (s DescribeInstanceTypeLimitsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOutboundConnectionsInput 

type DescribeOutboundConnectionsInput struct {

	// A list of filters used to match properties for outbound cross-cluster connections.
	// Available Filter names for this operation are:
	//    * connection-id
	//
	//    * remote-domain-info.domain-name
	//
	//    * remote-domain-info.owner-id
	//
	//    * remote-domain-info.region
	//
	//    * local-domain-info.domain-name
	Filters []*Filter `type:"list"`

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

	// NextToken is sent in case the earlier API call results contain the NextToken
	// parameter. Used for pagination.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeOutboundConnections operation.

func (DescribeOutboundConnectionsInput) GoString 

func (s DescribeOutboundConnectionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOutboundConnectionsInput) SetFilters 

func (s *DescribeOutboundConnectionsInput) SetFilters(v []*Filter) *DescribeOutboundConnectionsInput

SetFilters sets the Filters field's value.

func (*DescribeOutboundConnectionsInput) SetMaxResults 

func (s *DescribeOutboundConnectionsInput) SetMaxResults(v int64) *DescribeOutboundConnectionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeOutboundConnectionsInput) SetNextToken 

func (s *DescribeOutboundConnectionsInput) SetNextToken(v string) *DescribeOutboundConnectionsInput

SetNextToken sets the NextToken field's value.

func (DescribeOutboundConnectionsInput) String 

func (s DescribeOutboundConnectionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOutboundConnectionsInput) Validate 

func (s *DescribeOutboundConnectionsInput) Validate() error

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

type DescribeOutboundConnectionsOutput 

type DescribeOutboundConnectionsOutput struct {

	// A list of OutboundConnection matching the specified filter criteria.
	Connections []*OutboundConnection `type:"list"`

	// If more results are available and NextToken is present, make the next request
	// to the same API with the received NextToken to paginate the remaining results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

The result of a DescribeOutboundConnections request. Contains the list of connections matching the filter criteria.

func (DescribeOutboundConnectionsOutput) GoString 

func (s DescribeOutboundConnectionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOutboundConnectionsOutput) SetConnections 

func (s *DescribeOutboundConnectionsOutput) SetConnections(v []*OutboundConnection) *DescribeOutboundConnectionsOutput

SetConnections sets the Connections field's value.

func (*DescribeOutboundConnectionsOutput) SetNextToken 

func (s *DescribeOutboundConnectionsOutput) SetNextToken(v string) *DescribeOutboundConnectionsOutput

SetNextToken sets the NextToken field's value.

func (DescribeOutboundConnectionsOutput) String 

func (s DescribeOutboundConnectionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePackagesFilter 

type DescribePackagesFilter struct {

	// Any field from PackageDetails.
	Name *string `type:"string" enum:"DescribePackagesFilterName"`

	// A list of values for the specified field.
	Value []*string `type:"list"`
	// contains filtered or unexported fields
}

A filter to apply to the DescribePackage response.

func (DescribePackagesFilter) GoString 

func (s DescribePackagesFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesFilter) SetName 

func (s *DescribePackagesFilter) SetName(v string) *DescribePackagesFilter

SetName sets the Name field's value.

func (*DescribePackagesFilter) SetValue 

func (s *DescribePackagesFilter) SetValue(v []*string) *DescribePackagesFilter

SetValue sets the Value field's value.

func (DescribePackagesFilter) String 

func (s DescribePackagesFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePackagesInput 

type DescribePackagesInput struct {

	// Only returns packages that match the DescribePackagesFilterList values.
	Filters []*DescribePackagesFilter `type:"list"`

	// Limits results to a maximum number of packages.
	MaxResults *int64 `type:"integer"`

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the request parameters to the DescribePackage operation.

func (DescribePackagesInput) GoString 

func (s DescribePackagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesInput) SetFilters 

func (s *DescribePackagesInput) SetFilters(v []*DescribePackagesFilter) *DescribePackagesInput

SetFilters sets the Filters field's value.

func (*DescribePackagesInput) SetMaxResults 

func (s *DescribePackagesInput) SetMaxResults(v int64) *DescribePackagesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribePackagesInput) SetNextToken 

func (s *DescribePackagesInput) SetNextToken(v string) *DescribePackagesInput

SetNextToken sets the NextToken field's value.

func (DescribePackagesInput) String 

func (s DescribePackagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePackagesOutput 

type DescribePackagesOutput struct {
	NextToken *string `type:"string"`

	// List of PackageDetails objects.
	PackageDetailsList []*PackageDetails `type:"list"`
	// contains filtered or unexported fields
}

Container for the response returned by the DescribePackages operation.

func (DescribePackagesOutput) GoString 

func (s DescribePackagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesOutput) SetNextToken 

func (s *DescribePackagesOutput) SetNextToken(v string) *DescribePackagesOutput

SetNextToken sets the NextToken field's value.

func (*DescribePackagesOutput) SetPackageDetailsList 

func (s *DescribePackagesOutput) SetPackageDetailsList(v []*PackageDetails) *DescribePackagesOutput

SetPackageDetailsList sets the PackageDetailsList field's value.

func (DescribePackagesOutput) String 

func (s DescribePackagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReservedInstanceOfferingsInput 

type DescribeReservedInstanceOfferingsInput 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"`

	// Provides an identifier to allow retrieval of paginated results.
	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.
	ReservedInstanceOfferingId *string `location:"querystring" locationName:"offeringId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

Container for parameters to DescribeReservedInstanceOfferings

func (DescribeReservedInstanceOfferingsInput) GoString 

func (s DescribeReservedInstanceOfferingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstanceOfferingsInput) SetMaxResults 

func (s *DescribeReservedInstanceOfferingsInput) SetMaxResults(v int64) *DescribeReservedInstanceOfferingsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeReservedInstanceOfferingsInput) SetNextToken 

func (s *DescribeReservedInstanceOfferingsInput) SetNextToken(v string) *DescribeReservedInstanceOfferingsInput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstanceOfferingsInput) SetReservedInstanceOfferingId 

func (s *DescribeReservedInstanceOfferingsInput) SetReservedInstanceOfferingId(v string) *DescribeReservedInstanceOfferingsInput

SetReservedInstanceOfferingId sets the ReservedInstanceOfferingId field's value.

func (DescribeReservedInstanceOfferingsInput) String 

func (s DescribeReservedInstanceOfferingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstanceOfferingsInput) Validate 

func (s *DescribeReservedInstanceOfferingsInput) Validate() error

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

type DescribeReservedInstanceOfferingsOutput 

type DescribeReservedInstanceOfferingsOutput struct {

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

	// List of reserved OpenSearch instance offerings
	ReservedInstanceOfferings []*ReservedInstanceOffering `type:"list"`
	// contains filtered or unexported fields
}

Container for results from DescribeReservedInstanceOfferings

func (DescribeReservedInstanceOfferingsOutput) GoString 

func (s DescribeReservedInstanceOfferingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstanceOfferingsOutput) SetNextToken 

func (s *DescribeReservedInstanceOfferingsOutput) SetNextToken(v string) *DescribeReservedInstanceOfferingsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstanceOfferingsOutput) SetReservedInstanceOfferings 

func (s *DescribeReservedInstanceOfferingsOutput) SetReservedInstanceOfferings(v []*ReservedInstanceOffering) *DescribeReservedInstanceOfferingsOutput

SetReservedInstanceOfferings sets the ReservedInstanceOfferings field's value.

func (DescribeReservedInstanceOfferingsOutput) String 

func (s DescribeReservedInstanceOfferingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReservedInstancesInput 

type DescribeReservedInstancesInput 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"`

	// Provides an identifier to allow retrieval of paginated results.
	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 OpenSearch instance
	// ID.
	ReservedInstanceId *string `location:"querystring" locationName:"reservationId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

Container for parameters to DescribeReservedInstances

func (DescribeReservedInstancesInput) GoString 

func (s DescribeReservedInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstancesInput) SetMaxResults 

func (s *DescribeReservedInstancesInput) SetMaxResults(v int64) *DescribeReservedInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeReservedInstancesInput) SetNextToken 

func (s *DescribeReservedInstancesInput) SetNextToken(v string) *DescribeReservedInstancesInput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstancesInput) SetReservedInstanceId 

func (s *DescribeReservedInstancesInput) SetReservedInstanceId(v string) *DescribeReservedInstancesInput

SetReservedInstanceId sets the ReservedInstanceId field's value.

func (DescribeReservedInstancesInput) String 

func (s DescribeReservedInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstancesInput) Validate 

func (s *DescribeReservedInstancesInput) Validate() error

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

type DescribeReservedInstancesOutput 

type DescribeReservedInstancesOutput struct {

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

	// List of reserved OpenSearch instances.
	ReservedInstances []*ReservedInstance `type:"list"`
	// contains filtered or unexported fields
}

Container for results from DescribeReservedInstances

func (DescribeReservedInstancesOutput) GoString 

func (s DescribeReservedInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstancesOutput) SetNextToken 

func (s *DescribeReservedInstancesOutput) SetNextToken(v string) *DescribeReservedInstancesOutput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstancesOutput) SetReservedInstances 

func (s *DescribeReservedInstancesOutput) SetReservedInstances(v []*ReservedInstance) *DescribeReservedInstancesOutput

SetReservedInstances sets the ReservedInstances field's value.

func (DescribeReservedInstancesOutput) String 

func (s DescribeReservedInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisabledOperationException 

type DisabledOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*DisabledOperationException) Code 

func (s *DisabledOperationException) Code() string

Code returns the exception type name.

func (*DisabledOperationException) Error 

func (s *DisabledOperationException) Error() string

func (DisabledOperationException) GoString 

func (s DisabledOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisabledOperationException) Message 

func (s *DisabledOperationException) Message() string

Message returns the exception's message.

func (*DisabledOperationException) OrigErr 

func (s *DisabledOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DisabledOperationException) RequestID 

func (s *DisabledOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DisabledOperationException) StatusCode 

func (s *DisabledOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DisabledOperationException) String 

func (s DisabledOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DissociatePackageInput 

type DissociatePackageInput struct {

	// The name of the domain to associate the package with.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

	// The internal ID of the package to associate with a domain. Use DescribePackages
	// to find this value.
	//
	// PackageID is a required field
	PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the request parameters to the DissociatePackage operation.

func (DissociatePackageInput) GoString 

func (s DissociatePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DissociatePackageInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*DissociatePackageInput) SetPackageID 

func (s *DissociatePackageInput) SetPackageID(v string) *DissociatePackageInput

SetPackageID sets the PackageID field's value.

func (DissociatePackageInput) String 

func (s DissociatePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DissociatePackageInput) Validate 

func (s *DissociatePackageInput) Validate() error

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

type DissociatePackageOutput 

type DissociatePackageOutput struct {

	// DomainPackageDetails
	DomainPackageDetails *DomainPackageDetails `type:"structure"`
	// contains filtered or unexported fields
}

Container for the response returned by DissociatePackage operation.

func (DissociatePackageOutput) GoString 

func (s DissociatePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DissociatePackageOutput) SetDomainPackageDetails 

func (s *DissociatePackageOutput) SetDomainPackageDetails(v *DomainPackageDetails) *DissociatePackageOutput

SetDomainPackageDetails sets the DomainPackageDetails field's value.

func (DissociatePackageOutput) String 

func (s DissociatePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainConfig 

type DomainConfig struct {

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

	// The AdvancedOptions for the domain. See Advanced options (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options)
	// for more information.
	AdvancedOptions *AdvancedOptionsStatus `type:"structure"`

	// Specifies AdvancedSecurityOptions for the domain.
	AdvancedSecurityOptions *AdvancedSecurityOptionsStatus `type:"structure"`

	// Specifies AutoTuneOptions for the domain.
	AutoTuneOptions *AutoTuneOptionsStatus `type:"structure"`

	// The ClusterConfig for the domain.
	ClusterConfig *ClusterConfigStatus `type:"structure"`

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

	// The DomainEndpointOptions for the domain.
	DomainEndpointOptions *DomainEndpointOptionsStatus `type:"structure"`

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

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

	// String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine
	// version for the OpenSearch or Elasticsearch domain.
	EngineVersion *VersionStatus `type:"structure"`

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

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

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

	// The VPCOptions for the specified domain. For more information, see Launching
	// your Amazon OpenSearch Service domains using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
	VPCOptions *VPCDerivedInfoStatus `type:"structure"`
	// contains filtered or unexported fields
}

The configuration of a domain.

func (DomainConfig) GoString 

func (s DomainConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainConfig) SetAccessPolicies 

func (s *DomainConfig) SetAccessPolicies(v *AccessPoliciesStatus) *DomainConfig

SetAccessPolicies sets the AccessPolicies field's value.

func (*DomainConfig) SetAdvancedOptions 

func (s *DomainConfig) SetAdvancedOptions(v *AdvancedOptionsStatus) *DomainConfig

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*DomainConfig) SetAdvancedSecurityOptions 

func (s *DomainConfig) SetAdvancedSecurityOptions(v *AdvancedSecurityOptionsStatus) *DomainConfig

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*DomainConfig) SetAutoTuneOptions 

func (s *DomainConfig) SetAutoTuneOptions(v *AutoTuneOptionsStatus) *DomainConfig

SetAutoTuneOptions sets the AutoTuneOptions field's value.

func (*DomainConfig) SetClusterConfig 

func (s *DomainConfig) SetClusterConfig(v *ClusterConfigStatus) *DomainConfig

SetClusterConfig sets the ClusterConfig field's value.

func (*DomainConfig) SetCognitoOptions 

func (s *DomainConfig) SetCognitoOptions(v *CognitoOptionsStatus) *DomainConfig

SetCognitoOptions sets the CognitoOptions field's value.

func (*DomainConfig) SetDomainEndpointOptions 

func (s *DomainConfig) SetDomainEndpointOptions(v *DomainEndpointOptionsStatus) *DomainConfig

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*DomainConfig) SetEBSOptions 

func (s *DomainConfig) SetEBSOptions(v *EBSOptionsStatus) *DomainConfig

SetEBSOptions sets the EBSOptions field's value.

func (*DomainConfig) SetEncryptionAtRestOptions 

func (s *DomainConfig) SetEncryptionAtRestOptions(v *EncryptionAtRestOptionsStatus) *DomainConfig

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*DomainConfig) SetEngineVersion 

func (s *DomainConfig) SetEngineVersion(v *VersionStatus) *DomainConfig

SetEngineVersion sets the EngineVersion field's value.

func (*DomainConfig) SetLogPublishingOptions 

func (s *DomainConfig) SetLogPublishingOptions(v *LogPublishingOptionsStatus) *DomainConfig

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*DomainConfig) SetNodeToNodeEncryptionOptions 

func (s *DomainConfig) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptionsStatus) *DomainConfig

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*DomainConfig) SetSnapshotOptions 

func (s *DomainConfig) SetSnapshotOptions(v *SnapshotOptionsStatus) *DomainConfig

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*DomainConfig) SetVPCOptions 

func (s *DomainConfig) SetVPCOptions(v *VPCDerivedInfoStatus) *DomainConfig

SetVPCOptions sets the VPCOptions field's value.

func (DomainConfig) String 

func (s DomainConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainEndpointOptions 

type DomainEndpointOptions struct {

	// The fully qualified domain for your custom endpoint.
	CustomEndpoint *string `min:"1" type:"string"`

	// The ACM certificate ARN for your custom endpoint.
	CustomEndpointCertificateArn *string `min:"20" type:"string"`

	// Whether to enable a custom endpoint for the domain.
	CustomEndpointEnabled *bool `type:"boolean"`

	// Whether only HTTPS endpoint should be enabled for the domain.
	EnforceHTTPS *bool `type:"boolean"`

	// Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
	// Can be one of the following values:
	//    * Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0
	//    and higher.
	//
	//    * Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only
	//    TLSv1.2
	TLSSecurityPolicy *string `type:"string" enum:"TLSSecurityPolicy"`
	// contains filtered or unexported fields
}

Options to configure the endpoint for the domain.

func (DomainEndpointOptions) GoString 

func (s DomainEndpointOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainEndpointOptions) SetCustomEndpoint 

func (s *DomainEndpointOptions) SetCustomEndpoint(v string) *DomainEndpointOptions

SetCustomEndpoint sets the CustomEndpoint field's value.

func (*DomainEndpointOptions) SetCustomEndpointCertificateArn 

func (s *DomainEndpointOptions) SetCustomEndpointCertificateArn(v string) *DomainEndpointOptions

SetCustomEndpointCertificateArn sets the CustomEndpointCertificateArn field's value.

func (*DomainEndpointOptions) SetCustomEndpointEnabled 

func (s *DomainEndpointOptions) SetCustomEndpointEnabled(v bool) *DomainEndpointOptions

SetCustomEndpointEnabled sets the CustomEndpointEnabled field's value.

func (*DomainEndpointOptions) SetEnforceHTTPS 

func (s *DomainEndpointOptions) SetEnforceHTTPS(v bool) *DomainEndpointOptions

SetEnforceHTTPS sets the EnforceHTTPS field's value.

func (*DomainEndpointOptions) SetTLSSecurityPolicy 

func (s *DomainEndpointOptions) SetTLSSecurityPolicy(v string) *DomainEndpointOptions

SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.

func (DomainEndpointOptions) String 

func (s DomainEndpointOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainEndpointOptions) Validate 

func (s *DomainEndpointOptions) Validate() error

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

type DomainEndpointOptionsStatus 

type DomainEndpointOptionsStatus struct {

	// Options to configure the endpoint for the domain.
	//
	// Options is a required field
	Options *DomainEndpointOptions `type:"structure" required:"true"`

	// The status of the endpoint options for the 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 endpoint options for the domain and their current status.

func (DomainEndpointOptionsStatus) GoString 

func (s DomainEndpointOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainEndpointOptionsStatus) SetOptions 

func (s *DomainEndpointOptionsStatus) SetOptions(v *DomainEndpointOptions) *DomainEndpointOptionsStatus

SetOptions sets the Options field's value.

func (*DomainEndpointOptionsStatus) SetStatus 

func (s *DomainEndpointOptionsStatus) SetStatus(v *OptionStatus) *DomainEndpointOptionsStatus

SetStatus sets the Status field's value.

func (DomainEndpointOptionsStatus) String 

func (s DomainEndpointOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainInfo 

type DomainInfo struct {

	// The DomainName.
	DomainName *string `min:"3" type:"string"`

	// Specifies the EngineType of the domain.
	EngineType *string `type:"string" enum:"EngineType"`
	// contains filtered or unexported fields
}

func (DomainInfo) GoString 

func (s DomainInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainInfo) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*DomainInfo) SetEngineType added in v1.40.45 

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

SetEngineType sets the EngineType field's value.

func (DomainInfo) String 

func (s DomainInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainInformationContainer 

type DomainInformationContainer struct {
	AWSDomainInformation *AWSDomainInformation `type:"structure"`
	// contains filtered or unexported fields
}

func (DomainInformationContainer) GoString 

func (s DomainInformationContainer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainInformationContainer) SetAWSDomainInformation 

func (s *DomainInformationContainer) SetAWSDomainInformation(v *AWSDomainInformation) *DomainInformationContainer

SetAWSDomainInformation sets the AWSDomainInformation field's value.

func (DomainInformationContainer) String 

func (s DomainInformationContainer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainInformationContainer) Validate 

func (s *DomainInformationContainer) Validate() error

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

type DomainPackageDetails 

type DomainPackageDetails struct {

	// The name of the domain you've associated a package with.
	DomainName *string `min:"3" type:"string"`

	// State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE,
	// DISSOCIATING, and DISSOCIATION_FAILED.
	DomainPackageStatus *string `type:"string" enum:"DomainPackageStatus"`

	// Additional information if the package is in an error state. Null otherwise.
	ErrorDetails *ErrorDetails `type:"structure"`

	// The timestamp of the most recent update to the package association status.
	LastUpdated *time.Time `type:"timestamp"`

	// The internal ID of the package.
	PackageID *string `type:"string"`

	// User-specified name of the package.
	PackageName *string `min:"3" type:"string"`

	// Currently supports only TXT-DICTIONARY.
	PackageType *string `type:"string" enum:"PackageType"`

	PackageVersion *string `type:"string"`

	// The relative path on Amazon OpenSearch Service nodes, which can be used as
	// synonym_path when the package is a synonym file.
	ReferencePath *string `type:"string"`
	// contains filtered or unexported fields
}

Information on a package associated with a domain.

func (DomainPackageDetails) GoString 

func (s DomainPackageDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainPackageDetails) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*DomainPackageDetails) SetDomainPackageStatus 

func (s *DomainPackageDetails) SetDomainPackageStatus(v string) *DomainPackageDetails

SetDomainPackageStatus sets the DomainPackageStatus field's value.

func (*DomainPackageDetails) SetErrorDetails 

func (s *DomainPackageDetails) SetErrorDetails(v *ErrorDetails) *DomainPackageDetails

SetErrorDetails sets the ErrorDetails field's value.

func (*DomainPackageDetails) SetLastUpdated 

func (s *DomainPackageDetails) SetLastUpdated(v time.Time) *DomainPackageDetails

SetLastUpdated sets the LastUpdated field's value.

func (*DomainPackageDetails) SetPackageID 

func (s *DomainPackageDetails) SetPackageID(v string) *DomainPackageDetails

SetPackageID sets the PackageID field's value.

func (*DomainPackageDetails) SetPackageName 

func (s *DomainPackageDetails) SetPackageName(v string) *DomainPackageDetails

SetPackageName sets the PackageName field's value.

func (*DomainPackageDetails) SetPackageType 

func (s *DomainPackageDetails) SetPackageType(v string) *DomainPackageDetails

SetPackageType sets the PackageType field's value.

func (*DomainPackageDetails) SetPackageVersion 

func (s *DomainPackageDetails) SetPackageVersion(v string) *DomainPackageDetails

SetPackageVersion sets the PackageVersion field's value.

func (*DomainPackageDetails) SetReferencePath 

func (s *DomainPackageDetails) SetReferencePath(v string) *DomainPackageDetails

SetReferencePath sets the ReferencePath field's value.

func (DomainPackageDetails) String 

func (s DomainPackageDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainStatus 

type DomainStatus struct {

	// The Amazon Resource Name (ARN) of a domain. See IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the AWS Identity and Access Management User Guide for more information.
	//
	// ARN is a required field
	ARN *string `min:"20" type:"string" required:"true"`

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

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

	// The current status of the domain's advanced security options.
	AdvancedSecurityOptions *AdvancedSecurityOptions `type:"structure"`

	// The current status of the domain's Auto-Tune options.
	AutoTuneOptions *AutoTuneOptionsOutput_ `type:"structure"`

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

	// The CognitoOptions for the specified domain. For more information, see Configuring
	// Amazon Cognito authentication for OpenSearch Dashboards (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).
	CognitoOptions *CognitoOptions `type:"structure"`

	// The domain creation status. True if the creation of a 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 current status of the domain's endpoint options.
	DomainEndpointOptions *DomainEndpointOptions `type:"structure"`

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

	// The name of a 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.
	EBSOptions *EBSOptions `type:"structure"`

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

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

	// Map containing the 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"`

	EngineVersion *string `min:"14" type:"string"`

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

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

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

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

	// The status of the SnapshotOptions.
	SnapshotOptions *SnapshotOptions `type:"structure"`

	// The status of a domain version upgrade. True if Amazon OpenSearch 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 Launching
	// your Amazon OpenSearch Service domains using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
	VPCOptions *VPCDerivedInfo `type:"structure"`
	// contains filtered or unexported fields
}

The current status of a domain.

func (DomainStatus) GoString 

func (s DomainStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainStatus) SetARN 

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

SetARN sets the ARN field's value.

func (*DomainStatus) SetAccessPolicies 

func (s *DomainStatus) SetAccessPolicies(v string) *DomainStatus

SetAccessPolicies sets the AccessPolicies field's value.

func (*DomainStatus) SetAdvancedOptions 

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

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*DomainStatus) SetAdvancedSecurityOptions 

func (s *DomainStatus) SetAdvancedSecurityOptions(v *AdvancedSecurityOptions) *DomainStatus

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*DomainStatus) SetAutoTuneOptions 

func (s *DomainStatus) SetAutoTuneOptions(v *AutoTuneOptionsOutput_) *DomainStatus

SetAutoTuneOptions sets the AutoTuneOptions field's value.

func (*DomainStatus) SetClusterConfig 

func (s *DomainStatus) SetClusterConfig(v *ClusterConfig) *DomainStatus

SetClusterConfig sets the ClusterConfig field's value.

func (*DomainStatus) SetCognitoOptions 

func (s *DomainStatus) SetCognitoOptions(v *CognitoOptions) *DomainStatus

SetCognitoOptions sets the CognitoOptions field's value.

func (*DomainStatus) SetCreated 

func (s *DomainStatus) SetCreated(v bool) *DomainStatus

SetCreated sets the Created field's value.

func (*DomainStatus) SetDeleted 

func (s *DomainStatus) SetDeleted(v bool) *DomainStatus

SetDeleted sets the Deleted field's value.

func (*DomainStatus) SetDomainEndpointOptions 

func (s *DomainStatus) SetDomainEndpointOptions(v *DomainEndpointOptions) *DomainStatus

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*DomainStatus) SetDomainId 

func (s *DomainStatus) SetDomainId(v string) *DomainStatus

SetDomainId sets the DomainId field's value.

func (*DomainStatus) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*DomainStatus) SetEBSOptions 

func (s *DomainStatus) SetEBSOptions(v *EBSOptions) *DomainStatus

SetEBSOptions sets the EBSOptions field's value.

func (*DomainStatus) SetEncryptionAtRestOptions 

func (s *DomainStatus) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *DomainStatus

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*DomainStatus) SetEndpoint 

func (s *DomainStatus) SetEndpoint(v string) *DomainStatus

SetEndpoint sets the Endpoint field's value.

func (*DomainStatus) SetEndpoints 

func (s *DomainStatus) SetEndpoints(v map[string]*string) *DomainStatus

SetEndpoints sets the Endpoints field's value.

func (*DomainStatus) SetEngineVersion 

func (s *DomainStatus) SetEngineVersion(v string) *DomainStatus

SetEngineVersion sets the EngineVersion field's value.

func (*DomainStatus) SetLogPublishingOptions 

func (s *DomainStatus) SetLogPublishingOptions(v map[string]*LogPublishingOption) *DomainStatus

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*DomainStatus) SetNodeToNodeEncryptionOptions 

func (s *DomainStatus) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptions) *DomainStatus

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*DomainStatus) SetProcessing 

func (s *DomainStatus) SetProcessing(v bool) *DomainStatus

SetProcessing sets the Processing field's value.

func (*DomainStatus) SetServiceSoftwareOptions 

func (s *DomainStatus) SetServiceSoftwareOptions(v *ServiceSoftwareOptions) *DomainStatus

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (*DomainStatus) SetSnapshotOptions 

func (s *DomainStatus) SetSnapshotOptions(v *SnapshotOptions) *DomainStatus

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*DomainStatus) SetUpgradeProcessing 

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

SetUpgradeProcessing sets the UpgradeProcessing field's value.

func (*DomainStatus) SetVPCOptions 

func (s *DomainStatus) SetVPCOptions(v *VPCDerivedInfo) *DomainStatus

SetVPCOptions sets the VPCOptions field's value.

func (DomainStatus) String 

func (s DomainStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DryRunResults added in v1.42.11 

type DryRunResults struct {

	// Specifies the way in which Amazon OpenSearch Service applies the update.
	// Possible responses are Blue/Green (the update requires a blue/green deployment),
	// DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing
	// an update and can't predict the deployment type; try again after the update
	// is complete), and None (the request doesn't include any configuration changes).
	DeploymentType *string `min:"2" type:"string"`

	// Contains an optional message associated with the DryRunResults.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

func (DryRunResults) GoString added in v1.42.11 

func (s DryRunResults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DryRunResults) SetDeploymentType added in v1.42.11 

func (s *DryRunResults) SetDeploymentType(v string) *DryRunResults

SetDeploymentType sets the DeploymentType field's value.

func (*DryRunResults) SetMessage added in v1.42.11 

func (s *DryRunResults) SetMessage(v string) *DryRunResults

SetMessage sets the Message field's value.

func (DryRunResults) String added in v1.42.11 

func (s DryRunResults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Duration 

type Duration struct {

	// The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune
	// for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	Unit *string `type:"string" enum:"TimeUnit"`

	// Integer to specify the value of a maintenance schedule duration. See Auto-Tune
	// for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	Value *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.

func (Duration) GoString 

func (s Duration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Duration) SetUnit 

func (s *Duration) SetUnit(v string) *Duration

SetUnit sets the Unit field's value.

func (*Duration) SetValue 

func (s *Duration) SetValue(v int64) *Duration

SetValue sets the Value field's value.

func (Duration) String 

func (s Duration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Duration) Validate 

func (s *Duration) Validate() error

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

type EBSOptions 

type EBSOptions struct {

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

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

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

func (EBSOptions) GoString 

func (s EBSOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EBSOptions) SetEBSEnabled 

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

SetEBSEnabled sets the EBSEnabled field's value.

func (*EBSOptions) SetIops 

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

SetIops sets the Iops field's value.

func (*EBSOptions) SetVolumeSize 

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

SetVolumeSize sets the VolumeSize field's value.

func (*EBSOptions) SetVolumeType 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EBSOptionsStatus 

type EBSOptionsStatus struct {

	// The EBS options for the specified domain.
	//
	// Options is a required field
	Options *EBSOptions `type:"structure" required:"true"`

	// The status of the EBS options for the specified 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 domain.

func (EBSOptionsStatus) GoString 

func (s EBSOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EBSOptionsStatus) SetOptions 

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

SetOptions sets the Options field's value.

func (*EBSOptionsStatus) SetStatus 

func (s *EBSOptionsStatus) SetStatus(v *OptionStatus) *EBSOptionsStatus

SetStatus sets the Status field's value.

func (EBSOptionsStatus) String 

func (s EBSOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncryptionAtRestOptions 

type EncryptionAtRestOptions struct {

	// The option to enable encryption at rest.
	Enabled *bool `type:"boolean"`

	// The KMS key ID for encryption at rest options.
	KmsKeyId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies encryption at rest options.

func (EncryptionAtRestOptions) GoString 

func (s EncryptionAtRestOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionAtRestOptions) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*EncryptionAtRestOptions) SetKmsKeyId 

func (s *EncryptionAtRestOptions) SetKmsKeyId(v string) *EncryptionAtRestOptions

SetKmsKeyId sets the KmsKeyId field's value.

func (EncryptionAtRestOptions) String 

func (s EncryptionAtRestOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionAtRestOptions) Validate 

func (s *EncryptionAtRestOptions) Validate() error

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

type EncryptionAtRestOptionsStatus 

type EncryptionAtRestOptionsStatus struct {

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

	// The status of the Encryption At Rest options for the specified 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 domain.

func (EncryptionAtRestOptionsStatus) GoString 

func (s EncryptionAtRestOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionAtRestOptionsStatus) SetOptions 

func (s *EncryptionAtRestOptionsStatus) SetOptions(v *EncryptionAtRestOptions) *EncryptionAtRestOptionsStatus

SetOptions sets the Options field's value.

func (*EncryptionAtRestOptionsStatus) SetStatus 

func (s *EncryptionAtRestOptionsStatus) SetStatus(v *OptionStatus) *EncryptionAtRestOptionsStatus

SetStatus sets the Status field's value.

func (EncryptionAtRestOptionsStatus) String 

func (s EncryptionAtRestOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ErrorDetails 

type ErrorDetails struct {
	ErrorMessage *string `type:"string"`

	ErrorType *string `type:"string"`
	// contains filtered or unexported fields
}

func (ErrorDetails) GoString 

func (s ErrorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorDetails) SetErrorMessage 

func (s *ErrorDetails) SetErrorMessage(v string) *ErrorDetails

SetErrorMessage sets the ErrorMessage field's value.

func (*ErrorDetails) SetErrorType 

func (s *ErrorDetails) SetErrorType(v string) *ErrorDetails

SetErrorType sets the ErrorType field's value.

func (ErrorDetails) String 

func (s ErrorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filter 

type Filter struct {

	// The name of the filter.
	Name *string `min:"1" type:"string"`

	// Contains one or more values for the filter.
	Values []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

func (Filter) GoString 

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName 

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetValues 

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String 

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate 

func (s *Filter) Validate() error

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

type GetCompatibleVersionsInput 

type GetCompatibleVersionsInput struct {

	// The name of an 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 the request parameters to GetCompatibleVersions operation.

func (GetCompatibleVersionsInput) GoString 

func (s GetCompatibleVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompatibleVersionsInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (GetCompatibleVersionsInput) String 

func (s GetCompatibleVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompatibleVersionsInput) Validate 

func (s *GetCompatibleVersionsInput) Validate() error

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

type GetCompatibleVersionsOutput 

type GetCompatibleVersionsOutput struct {

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

Container for the response returned by the GetCompatibleVersions operation.

func (GetCompatibleVersionsOutput) GoString 

func (s GetCompatibleVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompatibleVersionsOutput) SetCompatibleVersions 

func (s *GetCompatibleVersionsOutput) SetCompatibleVersions(v []*CompatibleVersionsMap) *GetCompatibleVersionsOutput

SetCompatibleVersions sets the CompatibleVersions field's value.

func (GetCompatibleVersionsOutput) String 

func (s GetCompatibleVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPackageVersionHistoryInput 

type GetPackageVersionHistoryInput struct {

	// Limits results to a maximum number of package versions.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// Returns an audit history of package versions.
	//
	// PackageID is a required field
	PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the request parameters to the GetPackageVersionHistory operation.

func (GetPackageVersionHistoryInput) GoString 

func (s GetPackageVersionHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPackageVersionHistoryInput) SetMaxResults 

func (s *GetPackageVersionHistoryInput) SetMaxResults(v int64) *GetPackageVersionHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetPackageVersionHistoryInput) SetNextToken 

func (s *GetPackageVersionHistoryInput) SetNextToken(v string) *GetPackageVersionHistoryInput

SetNextToken sets the NextToken field's value.

func (*GetPackageVersionHistoryInput) SetPackageID 

func (s *GetPackageVersionHistoryInput) SetPackageID(v string) *GetPackageVersionHistoryInput

SetPackageID sets the PackageID field's value.

func (GetPackageVersionHistoryInput) String 

func (s GetPackageVersionHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPackageVersionHistoryInput) Validate 

func (s *GetPackageVersionHistoryInput) Validate() error

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

type GetPackageVersionHistoryOutput 

type GetPackageVersionHistoryOutput struct {
	NextToken *string `type:"string"`

	PackageID *string `type:"string"`

	// List of PackageVersionHistory objects.
	PackageVersionHistoryList []*PackageVersionHistory `type:"list"`
	// contains filtered or unexported fields
}

Container for response returned by GetPackageVersionHistory operation.

func (GetPackageVersionHistoryOutput) GoString 

func (s GetPackageVersionHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPackageVersionHistoryOutput) SetNextToken 

func (s *GetPackageVersionHistoryOutput) SetNextToken(v string) *GetPackageVersionHistoryOutput

SetNextToken sets the NextToken field's value.

func (*GetPackageVersionHistoryOutput) SetPackageID 

func (s *GetPackageVersionHistoryOutput) SetPackageID(v string) *GetPackageVersionHistoryOutput

SetPackageID sets the PackageID field's value.

func (*GetPackageVersionHistoryOutput) SetPackageVersionHistoryList 

func (s *GetPackageVersionHistoryOutput) SetPackageVersionHistoryList(v []*PackageVersionHistory) *GetPackageVersionHistoryOutput

SetPackageVersionHistoryList sets the PackageVersionHistoryList field's value.

func (GetPackageVersionHistoryOutput) String 

func (s GetPackageVersionHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetUpgradeHistoryInput 

type GetUpgradeHistoryInput struct {

	// The name of an 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 accept the NextToken input to return the next page of results
	// and provide a NextToken output in the response, which you can use to retrieve
	// more results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Container for the request parameters to the GetUpgradeHistory operation.

func (GetUpgradeHistoryInput) GoString 

func (s GetUpgradeHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeHistoryInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*GetUpgradeHistoryInput) SetMaxResults 

func (s *GetUpgradeHistoryInput) SetMaxResults(v int64) *GetUpgradeHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetUpgradeHistoryInput) SetNextToken 

func (s *GetUpgradeHistoryInput) SetNextToken(v string) *GetUpgradeHistoryInput

SetNextToken sets the NextToken field's value.

func (GetUpgradeHistoryInput) String 

func (s GetUpgradeHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeHistoryInput) Validate 

func (s *GetUpgradeHistoryInput) Validate() error

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

type GetUpgradeHistoryOutput 

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 the GetUpgradeHistoryResponse
	// object.
	UpgradeHistories []*UpgradeHistory `type:"list"`
	// contains filtered or unexported fields
}

Container for the response returned by the GetUpgradeHistory operation.

func (GetUpgradeHistoryOutput) GoString 

func (s GetUpgradeHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeHistoryOutput) SetNextToken 

func (s *GetUpgradeHistoryOutput) SetNextToken(v string) *GetUpgradeHistoryOutput

SetNextToken sets the NextToken field's value.

func (*GetUpgradeHistoryOutput) SetUpgradeHistories 

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

SetUpgradeHistories sets the UpgradeHistories field's value.

func (GetUpgradeHistoryOutput) String 

func (s GetUpgradeHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetUpgradeStatusInput 

type GetUpgradeStatusInput struct {

	// The name of an 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 the request parameters to the GetUpgradeStatus operation.

func (GetUpgradeStatusInput) GoString 

func (s GetUpgradeStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeStatusInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (GetUpgradeStatusInput) String 

func (s GetUpgradeStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeStatusInput) Validate 

func (s *GetUpgradeStatusInput) Validate() error

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

type GetUpgradeStatusOutput 

type GetUpgradeStatusOutput struct {

	// One of four statuses an upgrade have, 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 briefly describes the update.
	UpgradeName *string `type:"string"`

	// One of three steps an upgrade or upgrade eligibility check goes through:
	//    * PreUpgradeCheck
	//
	//    * Snapshot
	//
	//    * Upgrade
	UpgradeStep *string `type:"string" enum:"UpgradeStep"`
	// contains filtered or unexported fields
}

Container for the response returned by the GetUpgradeStatus operation.

func (GetUpgradeStatusOutput) GoString 

func (s GetUpgradeStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeStatusOutput) SetStepStatus 

func (s *GetUpgradeStatusOutput) SetStepStatus(v string) *GetUpgradeStatusOutput

SetStepStatus sets the StepStatus field's value.

func (*GetUpgradeStatusOutput) SetUpgradeName 

func (s *GetUpgradeStatusOutput) SetUpgradeName(v string) *GetUpgradeStatusOutput

SetUpgradeName sets the UpgradeName field's value.

func (*GetUpgradeStatusOutput) SetUpgradeStep 

func (s *GetUpgradeStatusOutput) SetUpgradeStep(v string) *GetUpgradeStatusOutput

SetUpgradeStep sets the UpgradeStep field's value.

func (GetUpgradeStatusOutput) String 

func (s GetUpgradeStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InboundConnection 

type InboundConnection struct {

	// The connection ID for the inbound cross-cluster connection.
	ConnectionId *string `min:"10" type:"string"`

	// The InboundConnectionStatus for the outbound connection.
	ConnectionStatus *InboundConnectionStatus `type:"structure"`

	// The AWSDomainInformation for the local OpenSearch domain.
	LocalDomainInfo *DomainInformationContainer `type:"structure"`

	// The AWSDomainInformation for the remote OpenSearch domain.
	RemoteDomainInfo *DomainInformationContainer `type:"structure"`
	// contains filtered or unexported fields
}

Details of an inbound connection.

func (InboundConnection) GoString 

func (s InboundConnection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InboundConnection) SetConnectionId 

func (s *InboundConnection) SetConnectionId(v string) *InboundConnection

SetConnectionId sets the ConnectionId field's value.

func (*InboundConnection) SetConnectionStatus 

func (s *InboundConnection) SetConnectionStatus(v *InboundConnectionStatus) *InboundConnection

SetConnectionStatus sets the ConnectionStatus field's value.

func (*InboundConnection) SetLocalDomainInfo 

func (s *InboundConnection) SetLocalDomainInfo(v *DomainInformationContainer) *InboundConnection

SetLocalDomainInfo sets the LocalDomainInfo field's value.

func (*InboundConnection) SetRemoteDomainInfo 

func (s *InboundConnection) SetRemoteDomainInfo(v *DomainInformationContainer) *InboundConnection

SetRemoteDomainInfo sets the RemoteDomainInfo field's value.

func (InboundConnection) String 

func (s InboundConnection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InboundConnectionStatus 

type InboundConnectionStatus struct {

	// Verbose information for the inbound connection status.
	Message *string `type:"string"`

	// The state code for the inbound connection. Can be one of the following:
	//
	//    * PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote
	//    domain owner.
	//
	//    * APPROVED: Inbound connection is pending acceptance by the remote domain
	//    owner.
	//
	//    * PROVISIONING: Inbound connection provisioning is in progress.
	//
	//    * ACTIVE: Inbound connection is active and ready to use.
	//
	//    * REJECTING: Inbound connection rejection is in process.
	//
	//    * REJECTED: Inbound connection is rejected.
	//
	//    * DELETING: Inbound connection deletion is in progress.
	//
	//    * DELETED: Inbound connection is deleted and can no longer be used.
	StatusCode *string `type:"string" enum:"InboundConnectionStatusCode"`
	// contains filtered or unexported fields
}

The connection status of an inbound cross-cluster connection.

func (InboundConnectionStatus) GoString 

func (s InboundConnectionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InboundConnectionStatus) SetMessage 

func (s *InboundConnectionStatus) SetMessage(v string) *InboundConnectionStatus

SetMessage sets the Message field's value.

func (*InboundConnectionStatus) SetStatusCode 

func (s *InboundConnectionStatus) SetStatusCode(v string) *InboundConnectionStatus

SetStatusCode sets the StatusCode field's value.

func (InboundConnectionStatus) String 

func (s InboundConnectionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceCountLimits 

type InstanceCountLimits struct {

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

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

InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.

func (InstanceCountLimits) GoString 

func (s InstanceCountLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceCountLimits) SetMaximumInstanceCount 

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

SetMaximumInstanceCount sets the MaximumInstanceCount field's value.

func (*InstanceCountLimits) SetMinimumInstanceCount 

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

SetMinimumInstanceCount sets the MinimumInstanceCount field's value.

func (InstanceCountLimits) String 

func (s InstanceCountLimits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceLimits 

type InstanceLimits struct {

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

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

func (InstanceLimits) GoString 

func (s InstanceLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceLimits) SetInstanceCountLimits 

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

SetInstanceCountLimits sets the InstanceCountLimits field's value.

func (InstanceLimits) String 

func (s InstanceLimits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceTypeDetails 

type InstanceTypeDetails struct {
	AdvancedSecurityEnabled *bool `type:"boolean"`

	AppLogsEnabled *bool `type:"boolean"`

	CognitoEnabled *bool `type:"boolean"`

	EncryptionEnabled *bool `type:"boolean"`

	InstanceRole []*string `type:"list"`

	InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

	WarmEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (InstanceTypeDetails) GoString 

func (s InstanceTypeDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceTypeDetails) SetAdvancedSecurityEnabled 

func (s *InstanceTypeDetails) SetAdvancedSecurityEnabled(v bool) *InstanceTypeDetails

SetAdvancedSecurityEnabled sets the AdvancedSecurityEnabled field's value.

func (*InstanceTypeDetails) SetAppLogsEnabled 

func (s *InstanceTypeDetails) SetAppLogsEnabled(v bool) *InstanceTypeDetails

SetAppLogsEnabled sets the AppLogsEnabled field's value.

func (*InstanceTypeDetails) SetCognitoEnabled 

func (s *InstanceTypeDetails) SetCognitoEnabled(v bool) *InstanceTypeDetails

SetCognitoEnabled sets the CognitoEnabled field's value.

func (*InstanceTypeDetails) SetEncryptionEnabled 

func (s *InstanceTypeDetails) SetEncryptionEnabled(v bool) *InstanceTypeDetails

SetEncryptionEnabled sets the EncryptionEnabled field's value.

func (*InstanceTypeDetails) SetInstanceRole 

func (s *InstanceTypeDetails) SetInstanceRole(v []*string) *InstanceTypeDetails

SetInstanceRole sets the InstanceRole field's value.

func (*InstanceTypeDetails) SetInstanceType 

func (s *InstanceTypeDetails) SetInstanceType(v string) *InstanceTypeDetails

SetInstanceType sets the InstanceType field's value.

func (*InstanceTypeDetails) SetWarmEnabled 

func (s *InstanceTypeDetails) SetWarmEnabled(v bool) *InstanceTypeDetails

SetWarmEnabled sets the WarmEnabled field's value.

func (InstanceTypeDetails) String 

func (s InstanceTypeDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalException 

type InternalException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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 (*InternalException) Code 

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error 

func (s *InternalException) Error() string

func (InternalException) GoString 

func (s InternalException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalException) Message 

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr 

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID 

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode 

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String 

func (s InternalException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidPaginationTokenException 

type InvalidPaginationTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

func (*InvalidPaginationTokenException) Code 

func (s *InvalidPaginationTokenException) Code() string

Code returns the exception type name.

func (*InvalidPaginationTokenException) Error 

func (s *InvalidPaginationTokenException) Error() string

func (InvalidPaginationTokenException) GoString 

func (s InvalidPaginationTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidPaginationTokenException) Message 

func (s *InvalidPaginationTokenException) Message() string

Message returns the exception's message.

func (*InvalidPaginationTokenException) OrigErr 

func (s *InvalidPaginationTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPaginationTokenException) RequestID 

func (s *InvalidPaginationTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPaginationTokenException) StatusCode 

func (s *InvalidPaginationTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPaginationTokenException) String 

func (s InvalidPaginationTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidTypeException 

type InvalidTypeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidTypeException) Code 

func (s *InvalidTypeException) Code() string

Code returns the exception type name.

func (*InvalidTypeException) Error 

func (s *InvalidTypeException) Error() string

func (InvalidTypeException) GoString 

func (s InvalidTypeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidTypeException) Message 

func (s *InvalidTypeException) Message() string

Message returns the exception's message.

func (*InvalidTypeException) OrigErr 

func (s *InvalidTypeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTypeException) RequestID 

func (s *InvalidTypeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTypeException) StatusCode 

func (s *InvalidTypeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidTypeException) String 

func (s InvalidTypeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*LimitExceededException) Code 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Limits 

type Limits struct {

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

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

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

Limits for a given InstanceType and for each of its roles. Limits contains the following: StorageTypes , InstanceLimits , and AdditionalLimits

func (Limits) GoString 

func (s Limits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Limits) SetAdditionalLimits 

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

SetAdditionalLimits sets the AdditionalLimits field's value.

func (*Limits) SetInstanceLimits 

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

SetInstanceLimits sets the InstanceLimits field's value.

func (*Limits) SetStorageTypes 

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

SetStorageTypes sets the StorageTypes field's value.

func (Limits) String 

func (s Limits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainNamesInput 

type ListDomainNamesInput struct {

	// Optional parameter to filter the output by domain engine type. Acceptable
	// values are 'Elasticsearch' and 'OpenSearch'.
	EngineType *string `location:"querystring" locationName:"engineType" type:"string" enum:"EngineType"`
	// contains filtered or unexported fields
}

Container for the parameters to the ListDomainNames operation.

func (ListDomainNamesInput) GoString 

func (s ListDomainNamesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainNamesInput) SetEngineType added in v1.40.45 

func (s *ListDomainNamesInput) SetEngineType(v string) *ListDomainNamesInput

SetEngineType sets the EngineType field's value.

func (ListDomainNamesInput) String 

func (s ListDomainNamesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainNamesOutput 

type ListDomainNamesOutput struct {

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

The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

func (ListDomainNamesOutput) GoString 

func (s ListDomainNamesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainNamesOutput) SetDomainNames 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainsForPackageInput 

type ListDomainsForPackageInput struct {

	// Limits the results to a maximum number of domains.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The package for which to list associated domains.
	//
	// PackageID is a required field
	PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the request parameters to the ListDomainsForPackage operation.

func (ListDomainsForPackageInput) GoString 

func (s ListDomainsForPackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsForPackageInput) SetMaxResults 

func (s *ListDomainsForPackageInput) SetMaxResults(v int64) *ListDomainsForPackageInput

SetMaxResults sets the MaxResults field's value.

func (*ListDomainsForPackageInput) SetNextToken 

func (s *ListDomainsForPackageInput) SetNextToken(v string) *ListDomainsForPackageInput

SetNextToken sets the NextToken field's value.

func (*ListDomainsForPackageInput) SetPackageID 

func (s *ListDomainsForPackageInput) SetPackageID(v string) *ListDomainsForPackageInput

SetPackageID sets the PackageID field's value.

func (ListDomainsForPackageInput) String 

func (s ListDomainsForPackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsForPackageInput) Validate 

func (s *ListDomainsForPackageInput) Validate() error

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

type ListDomainsForPackageOutput 

type ListDomainsForPackageOutput struct {

	// List of DomainPackageDetails objects.
	DomainPackageDetailsList []*DomainPackageDetails `type:"list"`

	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the response parameters to the ListDomainsForPackage operation.

func (ListDomainsForPackageOutput) GoString 

func (s ListDomainsForPackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsForPackageOutput) SetDomainPackageDetailsList 

func (s *ListDomainsForPackageOutput) SetDomainPackageDetailsList(v []*DomainPackageDetails) *ListDomainsForPackageOutput

SetDomainPackageDetailsList sets the DomainPackageDetailsList field's value.

func (*ListDomainsForPackageOutput) SetNextToken 

func (s *ListDomainsForPackageOutput) SetNextToken(v string) *ListDomainsForPackageOutput

SetNextToken sets the NextToken field's value.

func (ListDomainsForPackageOutput) String 

func (s ListDomainsForPackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListInstanceTypeDetailsInput 

type ListInstanceTypeDetailsInput struct {

	// The name of an 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"`

	// EngineVersion is a required field
	EngineVersion *string `location:"uri" locationName:"EngineVersion" min:"14" type:"string" required:"true"`

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

	// Paginated APIs accept the NextToken input to return the next page of results
	// and provide a NextToken output in the response, which you can use to retrieve
	// more results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListInstanceTypeDetailsInput) GoString 

func (s ListInstanceTypeDetailsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstanceTypeDetailsInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*ListInstanceTypeDetailsInput) SetEngineVersion 

func (s *ListInstanceTypeDetailsInput) SetEngineVersion(v string) *ListInstanceTypeDetailsInput

SetEngineVersion sets the EngineVersion field's value.

func (*ListInstanceTypeDetailsInput) SetMaxResults 

func (s *ListInstanceTypeDetailsInput) SetMaxResults(v int64) *ListInstanceTypeDetailsInput

SetMaxResults sets the MaxResults field's value.

func (*ListInstanceTypeDetailsInput) SetNextToken 

func (s *ListInstanceTypeDetailsInput) SetNextToken(v string) *ListInstanceTypeDetailsInput

SetNextToken sets the NextToken field's value.

func (ListInstanceTypeDetailsInput) String 

func (s ListInstanceTypeDetailsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstanceTypeDetailsInput) Validate 

func (s *ListInstanceTypeDetailsInput) Validate() error

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

type ListInstanceTypeDetailsOutput 

type ListInstanceTypeDetailsOutput struct {
	InstanceTypeDetails []*InstanceTypeDetails `type:"list"`

	// Paginated APIs accept the NextToken input to return the next page of results
	// and provide a NextToken output in the response, which you can use to retrieve
	// more results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListInstanceTypeDetailsOutput) GoString 

func (s ListInstanceTypeDetailsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstanceTypeDetailsOutput) SetInstanceTypeDetails 

func (s *ListInstanceTypeDetailsOutput) SetInstanceTypeDetails(v []*InstanceTypeDetails) *ListInstanceTypeDetailsOutput

SetInstanceTypeDetails sets the InstanceTypeDetails field's value.

func (*ListInstanceTypeDetailsOutput) SetNextToken 

func (s *ListInstanceTypeDetailsOutput) SetNextToken(v string) *ListInstanceTypeDetailsOutput

SetNextToken sets the NextToken field's value.

func (ListInstanceTypeDetailsOutput) String 

func (s ListInstanceTypeDetailsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPackagesForDomainInput 

type ListPackagesForDomainInput struct {

	// The name of the domain for which you want to list associated packages.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

	// Limits results to a maximum number of packages.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Container for the request parameters to the ListPackagesForDomain operation.

func (ListPackagesForDomainInput) GoString 

func (s ListPackagesForDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPackagesForDomainInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*ListPackagesForDomainInput) SetMaxResults 

func (s *ListPackagesForDomainInput) SetMaxResults(v int64) *ListPackagesForDomainInput

SetMaxResults sets the MaxResults field's value.

func (*ListPackagesForDomainInput) SetNextToken 

func (s *ListPackagesForDomainInput) SetNextToken(v string) *ListPackagesForDomainInput

SetNextToken sets the NextToken field's value.

func (ListPackagesForDomainInput) String 

func (s ListPackagesForDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPackagesForDomainInput) Validate 

func (s *ListPackagesForDomainInput) Validate() error

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

type ListPackagesForDomainOutput 

type ListPackagesForDomainOutput struct {

	// List of DomainPackageDetails objects.
	DomainPackageDetailsList []*DomainPackageDetails `type:"list"`

	// Pagination token to supply to the next call to get the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Container for the response parameters to the ListPackagesForDomain operation.

func (ListPackagesForDomainOutput) GoString 

func (s ListPackagesForDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPackagesForDomainOutput) SetDomainPackageDetailsList 

func (s *ListPackagesForDomainOutput) SetDomainPackageDetailsList(v []*DomainPackageDetails) *ListPackagesForDomainOutput

SetDomainPackageDetailsList sets the DomainPackageDetailsList field's value.

func (*ListPackagesForDomainOutput) SetNextToken 

func (s *ListPackagesForDomainOutput) SetNextToken(v string) *ListPackagesForDomainOutput

SetNextToken sets the NextToken field's value.

func (ListPackagesForDomainOutput) String 

func (s ListPackagesForDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsInput 

type ListTagsInput struct {

	// Specify the ARN of the domain that the tags you want to view are attached
	// to.
	//
	// ARN is a required field
	ARN *string `location:"querystring" locationName:"arn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the ListTags operation. Specify the ARN of the domain that the tags you want to view are attached to.

func (ListTagsInput) GoString 

func (s ListTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsInput) SetARN 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsInput) Validate 

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 domain.
	TagList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

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

func (ListTagsOutput) GoString 

func (s ListTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsOutput) SetTagList 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListVersionsInput 

type ListVersionsInput struct {

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

	// Paginated APIs accept the NextToken input to return the next page of results
	// and provide a NextToken output in the response, which you can use to retrieve
	// more results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters to the ListVersions 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, there are no more results to retrieve.

func (ListVersionsInput) GoString 

func (s ListVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVersionsInput) SetMaxResults 

func (s *ListVersionsInput) SetMaxResults(v int64) *ListVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListVersionsInput) SetNextToken 

func (s *ListVersionsInput) SetNextToken(v string) *ListVersionsInput

SetNextToken sets the NextToken field's value.

func (ListVersionsInput) String 

func (s ListVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListVersionsOutput 

type ListVersionsOutput struct {

	// Paginated APIs accept the NextToken input to return the next page of results
	// and provide a NextToken output in the response, which you can use to retrieve
	// more results.
	NextToken *string `type:"string"`

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

Container for the parameters for response received from the ListVersions operation.

func (ListVersionsOutput) GoString 

func (s ListVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVersionsOutput) SetNextToken 

func (s *ListVersionsOutput) SetNextToken(v string) *ListVersionsOutput

SetNextToken sets the NextToken field's value.

func (*ListVersionsOutput) SetVersions 

func (s *ListVersionsOutput) SetVersions(v []*string) *ListVersionsOutput

SetVersions sets the Versions field's value.

func (ListVersionsOutput) String 

func (s ListVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogPublishingOption 

type LogPublishingOption struct {

	// ARN of the Cloudwatch log group to publish logs to.
	CloudWatchLogsLogGroupArn *string `min:"20" type:"string"`

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

Log Publishing option that is set for a given domain. Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.

  • Enabled: Whether the log publishing for a given log type is enabled or not.

func (LogPublishingOption) GoString 

func (s LogPublishingOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogPublishingOption) SetCloudWatchLogsLogGroupArn 

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

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*LogPublishingOption) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (LogPublishingOption) String 

func (s LogPublishingOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogPublishingOption) Validate 

func (s *LogPublishingOption) Validate() error

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

type LogPublishingOptionsStatus 

type LogPublishingOptionsStatus struct {

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

	// The status of the log publishing options for the 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 

func (s LogPublishingOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogPublishingOptionsStatus) SetOptions 

func (s *LogPublishingOptionsStatus) SetOptions(v map[string]*LogPublishingOption) *LogPublishingOptionsStatus

SetOptions sets the Options field's value.

func (*LogPublishingOptionsStatus) SetStatus 

func (s *LogPublishingOptionsStatus) SetStatus(v *OptionStatus) *LogPublishingOptionsStatus

SetStatus sets the Status field's value.

func (LogPublishingOptionsStatus) String 

func (s LogPublishingOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MasterUserOptions 

type MasterUserOptions struct {

	// ARN for the master user (if IAM is enabled).
	MasterUserARN *string `min:"20" type:"string"`

	// The master user's username, which is stored in the Amazon OpenSearch Service
	// domain's internal database.
	//
	// MasterUserName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MasterUserOptions's
	// String and GoString methods.
	MasterUserName *string `min:"1" type:"string" sensitive:"true"`

	// The master user's password, which is stored in the Amazon OpenSearch Service
	// domain's internal database.
	//
	// MasterUserPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MasterUserOptions's
	// String and GoString methods.
	MasterUserPassword *string `min:"8" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Credentials for the master user: username and password, ARN, or both.

func (MasterUserOptions) GoString 

func (s MasterUserOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MasterUserOptions) SetMasterUserARN 

func (s *MasterUserOptions) SetMasterUserARN(v string) *MasterUserOptions

SetMasterUserARN sets the MasterUserARN field's value.

func (*MasterUserOptions) SetMasterUserName 

func (s *MasterUserOptions) SetMasterUserName(v string) *MasterUserOptions

SetMasterUserName sets the MasterUserName field's value.

func (*MasterUserOptions) SetMasterUserPassword 

func (s *MasterUserOptions) SetMasterUserPassword(v string) *MasterUserOptions

SetMasterUserPassword sets the MasterUserPassword field's value.

func (MasterUserOptions) String 

func (s MasterUserOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MasterUserOptions) Validate 

func (s *MasterUserOptions) Validate() error

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

type NodeToNodeEncryptionOptions 

type NodeToNodeEncryptionOptions struct {

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

The node-to-node encryption options.

func (NodeToNodeEncryptionOptions) GoString 

func (s NodeToNodeEncryptionOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeToNodeEncryptionOptions) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (NodeToNodeEncryptionOptions) String 

func (s NodeToNodeEncryptionOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NodeToNodeEncryptionOptionsStatus 

type NodeToNodeEncryptionOptionsStatus struct {

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

	// The status of the node-to-node encryption options for the specified 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 domain.

func (NodeToNodeEncryptionOptionsStatus) GoString 

func (s NodeToNodeEncryptionOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeToNodeEncryptionOptionsStatus) SetOptions 

func (s *NodeToNodeEncryptionOptionsStatus) SetOptions(v *NodeToNodeEncryptionOptions) *NodeToNodeEncryptionOptionsStatus

SetOptions sets the Options field's value.

func (*NodeToNodeEncryptionOptionsStatus) SetStatus 

func (s *NodeToNodeEncryptionOptionsStatus) SetStatus(v *OptionStatus) *NodeToNodeEncryptionOptionsStatus

SetStatus sets the Status field's value.

func (NodeToNodeEncryptionOptionsStatus) String 

func (s NodeToNodeEncryptionOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OpenSearchService 

type OpenSearchService struct {
	*client.Client
}

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

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

func New 

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

New creates a new instance of the OpenSearchService 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: 

mySession := session.Must(session.NewSession())

// Create a OpenSearchService client from just a session.
svc := opensearchservice.New(mySession)

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

func (*OpenSearchService) AcceptInboundConnection 

func (c *OpenSearchService) AcceptInboundConnection(input *AcceptInboundConnectionInput) (*AcceptInboundConnectionOutput, error)

AcceptInboundConnection API operation for Amazon OpenSearch Service.

Allows the remote domain owner to accept an inbound cross-cluster connection request.

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 OpenSearch Service's API operation AcceptInboundConnection for usage and error information.

Returned Error Types:

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnection

func (*OpenSearchService) AcceptInboundConnectionRequest 

func (c *OpenSearchService) AcceptInboundConnectionRequest(input *AcceptInboundConnectionInput) (req *request.Request, output *AcceptInboundConnectionOutput)

AcceptInboundConnectionRequest generates a "aws/request.Request" representing the client's request for the AcceptInboundConnection 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 AcceptInboundConnection for more information on using the AcceptInboundConnection 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 AcceptInboundConnectionRequest method.
req, resp := client.AcceptInboundConnectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnection

func (*OpenSearchService) AcceptInboundConnectionWithContext 

func (c *OpenSearchService) AcceptInboundConnectionWithContext(ctx aws.Context, input *AcceptInboundConnectionInput, opts ...request.Option) (*AcceptInboundConnectionOutput, error)

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

See AcceptInboundConnection 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 (*OpenSearchService) AddTags 

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

AddTags API operation for Amazon OpenSearch Service.

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

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 OpenSearch Service's API operation AddTags for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTags

func (*OpenSearchService) AddTagsRequest 

func (c *OpenSearchService) 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTags

func (*OpenSearchService) AddTagsWithContext 

func (c *OpenSearchService) 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 (*OpenSearchService) AssociatePackage 

func (c *OpenSearchService) AssociatePackage(input *AssociatePackageInput) (*AssociatePackageOutput, error)

AssociatePackage API operation for Amazon OpenSearch Service.

Associates a package with an Amazon OpenSearch Service 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 OpenSearch Service's API operation AssociatePackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

  • ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage

func (*OpenSearchService) AssociatePackageRequest 

func (c *OpenSearchService) AssociatePackageRequest(input *AssociatePackageInput) (req *request.Request, output *AssociatePackageOutput)

AssociatePackageRequest generates a "aws/request.Request" representing the client's request for the AssociatePackage 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 AssociatePackage for more information on using the AssociatePackage 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 AssociatePackageRequest method.
req, resp := client.AssociatePackageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage

func (*OpenSearchService) AssociatePackageWithContext 

func (c *OpenSearchService) AssociatePackageWithContext(ctx aws.Context, input *AssociatePackageInput, opts ...request.Option) (*AssociatePackageOutput, error)

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

See AssociatePackage 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 (*OpenSearchService) CancelServiceSoftwareUpdate 

func (c *OpenSearchService) CancelServiceSoftwareUpdate(input *CancelServiceSoftwareUpdateInput) (*CancelServiceSoftwareUpdateOutput, error)

CancelServiceSoftwareUpdate API operation for Amazon OpenSearch Service.

Cancels a scheduled service software update for an Amazon OpenSearch Service 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 OpenSearch Service's API operation CancelServiceSoftwareUpdate for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdate

func (*OpenSearchService) CancelServiceSoftwareUpdateRequest 

func (c *OpenSearchService) CancelServiceSoftwareUpdateRequest(input *CancelServiceSoftwareUpdateInput) (req *request.Request, output *CancelServiceSoftwareUpdateOutput)

CancelServiceSoftwareUpdateRequest generates a "aws/request.Request" representing the client's request for the CancelServiceSoftwareUpdate 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 CancelServiceSoftwareUpdate for more information on using the CancelServiceSoftwareUpdate 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 CancelServiceSoftwareUpdateRequest method.
req, resp := client.CancelServiceSoftwareUpdateRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdate

func (*OpenSearchService) CancelServiceSoftwareUpdateWithContext 

func (c *OpenSearchService) CancelServiceSoftwareUpdateWithContext(ctx aws.Context, input *CancelServiceSoftwareUpdateInput, opts ...request.Option) (*CancelServiceSoftwareUpdateOutput, error)

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

See CancelServiceSoftwareUpdate 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 (*OpenSearchService) CreateDomain 

func (c *OpenSearchService) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)

CreateDomain API operation for Amazon OpenSearch Service.

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) in the Amazon OpenSearch 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 OpenSearch Service's API operation CreateDomain for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain

func (*OpenSearchService) CreateDomainRequest 

func (c *OpenSearchService) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)

CreateDomainRequest generates a "aws/request.Request" representing the client's request for the CreateDomain 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 CreateDomain for more information on using the CreateDomain 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 CreateDomainRequest method.
req, resp := client.CreateDomainRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain

func (*OpenSearchService) CreateDomainWithContext 

func (c *OpenSearchService) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)

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

See CreateDomain 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 (*OpenSearchService) CreateOutboundConnection 

func (c *OpenSearchService) CreateOutboundConnection(input *CreateOutboundConnectionInput) (*CreateOutboundConnectionOutput, error)

CreateOutboundConnection API operation for Amazon OpenSearch Service.

Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch 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 OpenSearch Service's API operation CreateOutboundConnection for usage and error information.

Returned Error Types:

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnection

func (*OpenSearchService) CreateOutboundConnectionRequest 

func (c *OpenSearchService) CreateOutboundConnectionRequest(input *CreateOutboundConnectionInput) (req *request.Request, output *CreateOutboundConnectionOutput)

CreateOutboundConnectionRequest generates a "aws/request.Request" representing the client's request for the CreateOutboundConnection 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 CreateOutboundConnection for more information on using the CreateOutboundConnection 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 CreateOutboundConnectionRequest method.
req, resp := client.CreateOutboundConnectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnection

func (*OpenSearchService) CreateOutboundConnectionWithContext 

func (c *OpenSearchService) CreateOutboundConnectionWithContext(ctx aws.Context, input *CreateOutboundConnectionInput, opts ...request.Option) (*CreateOutboundConnectionOutput, error)

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

See CreateOutboundConnection 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 (*OpenSearchService) CreatePackage 

func (c *OpenSearchService) CreatePackage(input *CreatePackageInput) (*CreatePackageOutput, error)

CreatePackage API operation for Amazon OpenSearch Service.

Create a package for use with Amazon OpenSearch 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 OpenSearch Service's API operation CreatePackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage

func (*OpenSearchService) CreatePackageRequest 

func (c *OpenSearchService) CreatePackageRequest(input *CreatePackageInput) (req *request.Request, output *CreatePackageOutput)

CreatePackageRequest generates a "aws/request.Request" representing the client's request for the CreatePackage 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 CreatePackage for more information on using the CreatePackage 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 CreatePackageRequest method.
req, resp := client.CreatePackageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage

func (*OpenSearchService) CreatePackageWithContext 

func (c *OpenSearchService) CreatePackageWithContext(ctx aws.Context, input *CreatePackageInput, opts ...request.Option) (*CreatePackageOutput, error)

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

See CreatePackage 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 (*OpenSearchService) DeleteDomain 

func (c *OpenSearchService) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)

DeleteDomain API operation for Amazon OpenSearch Service.

Permanently deletes the specified 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 OpenSearch Service's API operation DeleteDomain for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain

func (*OpenSearchService) DeleteDomainRequest 

func (c *OpenSearchService) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)

DeleteDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteDomain 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 DeleteDomain for more information on using the DeleteDomain 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 DeleteDomainRequest method.
req, resp := client.DeleteDomainRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain

func (*OpenSearchService) DeleteDomainWithContext 

func (c *OpenSearchService) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)

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

See DeleteDomain 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 (*OpenSearchService) DeleteInboundConnection 

func (c *OpenSearchService) DeleteInboundConnection(input *DeleteInboundConnectionInput) (*DeleteInboundConnectionOutput, error)

DeleteInboundConnection API operation for Amazon OpenSearch Service.

Allows the remote domain owner to delete an existing inbound cross-cluster connection.

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 OpenSearch Service's API operation DeleteInboundConnection for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteInboundConnection

func (*OpenSearchService) DeleteInboundConnectionRequest 

func (c *OpenSearchService) DeleteInboundConnectionRequest(input *DeleteInboundConnectionInput) (req *request.Request, output *DeleteInboundConnectionOutput)

DeleteInboundConnectionRequest generates a "aws/request.Request" representing the client's request for the DeleteInboundConnection 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 DeleteInboundConnection for more information on using the DeleteInboundConnection 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 DeleteInboundConnectionRequest method.
req, resp := client.DeleteInboundConnectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteInboundConnection

func (*OpenSearchService) DeleteInboundConnectionWithContext 

func (c *OpenSearchService) DeleteInboundConnectionWithContext(ctx aws.Context, input *DeleteInboundConnectionInput, opts ...request.Option) (*DeleteInboundConnectionOutput, error)

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

See DeleteInboundConnection 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 (*OpenSearchService) DeleteOutboundConnection 

func (c *OpenSearchService) DeleteOutboundConnection(input *DeleteOutboundConnectionInput) (*DeleteOutboundConnectionOutput, error)

DeleteOutboundConnection API operation for Amazon OpenSearch Service.

Allows the local domain owner to delete an existing outbound cross-cluster connection.

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 OpenSearch Service's API operation DeleteOutboundConnection for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteOutboundConnection

func (*OpenSearchService) DeleteOutboundConnectionRequest 

func (c *OpenSearchService) DeleteOutboundConnectionRequest(input *DeleteOutboundConnectionInput) (req *request.Request, output *DeleteOutboundConnectionOutput)

DeleteOutboundConnectionRequest generates a "aws/request.Request" representing the client's request for the DeleteOutboundConnection 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 DeleteOutboundConnection for more information on using the DeleteOutboundConnection 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 DeleteOutboundConnectionRequest method.
req, resp := client.DeleteOutboundConnectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteOutboundConnection

func (*OpenSearchService) DeleteOutboundConnectionWithContext 

func (c *OpenSearchService) DeleteOutboundConnectionWithContext(ctx aws.Context, input *DeleteOutboundConnectionInput, opts ...request.Option) (*DeleteOutboundConnectionOutput, error)

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

See DeleteOutboundConnection 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 (*OpenSearchService) DeletePackage 

func (c *OpenSearchService) DeletePackage(input *DeletePackageInput) (*DeletePackageOutput, error)

DeletePackage API operation for Amazon OpenSearch Service.

Deletes the package.

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 OpenSearch Service's API operation DeletePackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

  • ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackage

func (*OpenSearchService) DeletePackageRequest 

func (c *OpenSearchService) DeletePackageRequest(input *DeletePackageInput) (req *request.Request, output *DeletePackageOutput)

DeletePackageRequest generates a "aws/request.Request" representing the client's request for the DeletePackage 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 DeletePackage for more information on using the DeletePackage 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 DeletePackageRequest method.
req, resp := client.DeletePackageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackage

func (*OpenSearchService) DeletePackageWithContext 

func (c *OpenSearchService) DeletePackageWithContext(ctx aws.Context, input *DeletePackageInput, opts ...request.Option) (*DeletePackageOutput, error)

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

See DeletePackage 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 (*OpenSearchService) DescribeDomain 

func (c *OpenSearchService) DescribeDomain(input *DescribeDomainInput) (*DescribeDomainOutput, error)

DescribeDomain API operation for Amazon OpenSearch Service.

Returns domain configuration information about the specified 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 OpenSearch Service's API operation DescribeDomain for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain

func (*OpenSearchService) DescribeDomainAutoTunes 

func (c *OpenSearchService) DescribeDomainAutoTunes(input *DescribeDomainAutoTunesInput) (*DescribeDomainAutoTunesOutput, error)

DescribeDomainAutoTunes API operation for Amazon OpenSearch Service.

Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.

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 OpenSearch Service's API operation DescribeDomainAutoTunes for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainAutoTunes

func (*OpenSearchService) DescribeDomainAutoTunesPages 

func (c *OpenSearchService) DescribeDomainAutoTunesPages(input *DescribeDomainAutoTunesInput, fn func(*DescribeDomainAutoTunesOutput, bool) bool) error

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

See DescribeDomainAutoTunes 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 DescribeDomainAutoTunes operation.
pageNum := 0
err := client.DescribeDomainAutoTunesPages(params,
    func(page *opensearchservice.DescribeDomainAutoTunesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) DescribeDomainAutoTunesPagesWithContext 

func (c *OpenSearchService) DescribeDomainAutoTunesPagesWithContext(ctx aws.Context, input *DescribeDomainAutoTunesInput, fn func(*DescribeDomainAutoTunesOutput, bool) bool, opts ...request.Option) error

DescribeDomainAutoTunesPagesWithContext same as DescribeDomainAutoTunesPages 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 (*OpenSearchService) DescribeDomainAutoTunesRequest 

func (c *OpenSearchService) DescribeDomainAutoTunesRequest(input *DescribeDomainAutoTunesInput) (req *request.Request, output *DescribeDomainAutoTunesOutput)

DescribeDomainAutoTunesRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainAutoTunes 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 DescribeDomainAutoTunes for more information on using the DescribeDomainAutoTunes 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 DescribeDomainAutoTunesRequest method.
req, resp := client.DescribeDomainAutoTunesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainAutoTunes

func (*OpenSearchService) DescribeDomainAutoTunesWithContext 

func (c *OpenSearchService) DescribeDomainAutoTunesWithContext(ctx aws.Context, input *DescribeDomainAutoTunesInput, opts ...request.Option) (*DescribeDomainAutoTunesOutput, error)

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

See DescribeDomainAutoTunes 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 (*OpenSearchService) DescribeDomainConfig 

func (c *OpenSearchService) DescribeDomainConfig(input *DescribeDomainConfigInput) (*DescribeDomainConfigOutput, error)

DescribeDomainConfig API operation for Amazon OpenSearch Service.

Provides cluster configuration information about the specified 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 OpenSearch Service's API operation DescribeDomainConfig for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig

func (*OpenSearchService) DescribeDomainConfigRequest 

func (c *OpenSearchService) DescribeDomainConfigRequest(input *DescribeDomainConfigInput) (req *request.Request, output *DescribeDomainConfigOutput)

DescribeDomainConfigRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainConfig 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 DescribeDomainConfig for more information on using the DescribeDomainConfig 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 DescribeDomainConfigRequest method.
req, resp := client.DescribeDomainConfigRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig

func (*OpenSearchService) DescribeDomainConfigWithContext 

func (c *OpenSearchService) DescribeDomainConfigWithContext(ctx aws.Context, input *DescribeDomainConfigInput, opts ...request.Option) (*DescribeDomainConfigOutput, error)

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

See DescribeDomainConfig 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 (*OpenSearchService) DescribeDomainRequest 

func (c *OpenSearchService) DescribeDomainRequest(input *DescribeDomainInput) (req *request.Request, output *DescribeDomainOutput)

DescribeDomainRequest generates a "aws/request.Request" representing the client's request for the DescribeDomain 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 DescribeDomain for more information on using the DescribeDomain 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 DescribeDomainRequest method.
req, resp := client.DescribeDomainRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain

func (*OpenSearchService) DescribeDomainWithContext 

func (c *OpenSearchService) DescribeDomainWithContext(ctx aws.Context, input *DescribeDomainInput, opts ...request.Option) (*DescribeDomainOutput, error)

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

See DescribeDomain 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 (*OpenSearchService) DescribeDomains 

func (c *OpenSearchService) DescribeDomains(input *DescribeDomainsInput) (*DescribeDomainsOutput, error)

DescribeDomains API operation for Amazon OpenSearch Service.

Returns domain configuration information about the specified 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 OpenSearch Service's API operation DescribeDomains for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains

func (*OpenSearchService) DescribeDomainsRequest 

func (c *OpenSearchService) DescribeDomainsRequest(input *DescribeDomainsInput) (req *request.Request, output *DescribeDomainsOutput)

DescribeDomainsRequest generates a "aws/request.Request" representing the client's request for the DescribeDomains 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 DescribeDomains for more information on using the DescribeDomains 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 DescribeDomainsRequest method.
req, resp := client.DescribeDomainsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains

func (*OpenSearchService) DescribeDomainsWithContext 

func (c *OpenSearchService) DescribeDomainsWithContext(ctx aws.Context, input *DescribeDomainsInput, opts ...request.Option) (*DescribeDomainsOutput, error)

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

See DescribeDomains 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 (*OpenSearchService) DescribeInboundConnections 

func (c *OpenSearchService) DescribeInboundConnections(input *DescribeInboundConnectionsInput) (*DescribeInboundConnectionsOutput, error)

DescribeInboundConnections API operation for Amazon OpenSearch Service.

Lists all the inbound cross-cluster connections for a remote 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 OpenSearch Service's API operation DescribeInboundConnections for usage and error information.

Returned Error Types:

  • InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInboundConnections

func (*OpenSearchService) DescribeInboundConnectionsPages 

func (c *OpenSearchService) DescribeInboundConnectionsPages(input *DescribeInboundConnectionsInput, fn func(*DescribeInboundConnectionsOutput, bool) bool) error

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

See DescribeInboundConnections 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 DescribeInboundConnections operation.
pageNum := 0
err := client.DescribeInboundConnectionsPages(params,
    func(page *opensearchservice.DescribeInboundConnectionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) DescribeInboundConnectionsPagesWithContext 

func (c *OpenSearchService) DescribeInboundConnectionsPagesWithContext(ctx aws.Context, input *DescribeInboundConnectionsInput, fn func(*DescribeInboundConnectionsOutput, bool) bool, opts ...request.Option) error

DescribeInboundConnectionsPagesWithContext same as DescribeInboundConnectionsPages 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 (*OpenSearchService) DescribeInboundConnectionsRequest 

func (c *OpenSearchService) DescribeInboundConnectionsRequest(input *DescribeInboundConnectionsInput) (req *request.Request, output *DescribeInboundConnectionsOutput)

DescribeInboundConnectionsRequest generates a "aws/request.Request" representing the client's request for the DescribeInboundConnections 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 DescribeInboundConnections for more information on using the DescribeInboundConnections 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 DescribeInboundConnectionsRequest method.
req, resp := client.DescribeInboundConnectionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInboundConnections

func (*OpenSearchService) DescribeInboundConnectionsWithContext 

func (c *OpenSearchService) DescribeInboundConnectionsWithContext(ctx aws.Context, input *DescribeInboundConnectionsInput, opts ...request.Option) (*DescribeInboundConnectionsOutput, error)

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

See DescribeInboundConnections 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 (*OpenSearchService) DescribeInstanceTypeLimits 

func (c *OpenSearchService) DescribeInstanceTypeLimits(input *DescribeInstanceTypeLimitsInput) (*DescribeInstanceTypeLimitsOutput, error)

DescribeInstanceTypeLimits API operation for Amazon OpenSearch Service.

Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.

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 OpenSearch Service's API operation DescribeInstanceTypeLimits for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInstanceTypeLimits

func (*OpenSearchService) DescribeInstanceTypeLimitsRequest 

func (c *OpenSearchService) DescribeInstanceTypeLimitsRequest(input *DescribeInstanceTypeLimitsInput) (req *request.Request, output *DescribeInstanceTypeLimitsOutput)

DescribeInstanceTypeLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeInstanceTypeLimits 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 DescribeInstanceTypeLimits for more information on using the DescribeInstanceTypeLimits 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 DescribeInstanceTypeLimitsRequest method.
req, resp := client.DescribeInstanceTypeLimitsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInstanceTypeLimits

func (*OpenSearchService) DescribeInstanceTypeLimitsWithContext 

func (c *OpenSearchService) DescribeInstanceTypeLimitsWithContext(ctx aws.Context, input *DescribeInstanceTypeLimitsInput, opts ...request.Option) (*DescribeInstanceTypeLimitsOutput, error)

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

See DescribeInstanceTypeLimits 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 (*OpenSearchService) DescribeOutboundConnections 

func (c *OpenSearchService) DescribeOutboundConnections(input *DescribeOutboundConnectionsInput) (*DescribeOutboundConnectionsOutput, error)

DescribeOutboundConnections API operation for Amazon OpenSearch Service.

Lists all the outbound cross-cluster connections for a local 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 OpenSearch Service's API operation DescribeOutboundConnections for usage and error information.

Returned Error Types:

  • InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnections

func (*OpenSearchService) DescribeOutboundConnectionsPages 

func (c *OpenSearchService) DescribeOutboundConnectionsPages(input *DescribeOutboundConnectionsInput, fn func(*DescribeOutboundConnectionsOutput, bool) bool) error

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

See DescribeOutboundConnections 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 DescribeOutboundConnections operation.
pageNum := 0
err := client.DescribeOutboundConnectionsPages(params,
    func(page *opensearchservice.DescribeOutboundConnectionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) DescribeOutboundConnectionsPagesWithContext 

func (c *OpenSearchService) DescribeOutboundConnectionsPagesWithContext(ctx aws.Context, input *DescribeOutboundConnectionsInput, fn func(*DescribeOutboundConnectionsOutput, bool) bool, opts ...request.Option) error

DescribeOutboundConnectionsPagesWithContext same as DescribeOutboundConnectionsPages 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 (*OpenSearchService) DescribeOutboundConnectionsRequest 

func (c *OpenSearchService) DescribeOutboundConnectionsRequest(input *DescribeOutboundConnectionsInput) (req *request.Request, output *DescribeOutboundConnectionsOutput)

DescribeOutboundConnectionsRequest generates a "aws/request.Request" representing the client's request for the DescribeOutboundConnections 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 DescribeOutboundConnections for more information on using the DescribeOutboundConnections 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 DescribeOutboundConnectionsRequest method.
req, resp := client.DescribeOutboundConnectionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnections

func (*OpenSearchService) DescribeOutboundConnectionsWithContext 

func (c *OpenSearchService) DescribeOutboundConnectionsWithContext(ctx aws.Context, input *DescribeOutboundConnectionsInput, opts ...request.Option) (*DescribeOutboundConnectionsOutput, error)

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

See DescribeOutboundConnections 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 (*OpenSearchService) DescribePackages 

func (c *OpenSearchService) DescribePackages(input *DescribePackagesInput) (*DescribePackagesOutput, error)

DescribePackages API operation for Amazon OpenSearch Service.

Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.

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 OpenSearch Service's API operation DescribePackages for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackages

func (*OpenSearchService) DescribePackagesPages 

func (c *OpenSearchService) DescribePackagesPages(input *DescribePackagesInput, fn func(*DescribePackagesOutput, bool) bool) error

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

See DescribePackages 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 DescribePackages operation.
pageNum := 0
err := client.DescribePackagesPages(params,
    func(page *opensearchservice.DescribePackagesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) DescribePackagesPagesWithContext 

func (c *OpenSearchService) DescribePackagesPagesWithContext(ctx aws.Context, input *DescribePackagesInput, fn func(*DescribePackagesOutput, bool) bool, opts ...request.Option) error

DescribePackagesPagesWithContext same as DescribePackagesPages 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 (*OpenSearchService) DescribePackagesRequest 

func (c *OpenSearchService) DescribePackagesRequest(input *DescribePackagesInput) (req *request.Request, output *DescribePackagesOutput)

DescribePackagesRequest generates a "aws/request.Request" representing the client's request for the DescribePackages 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 DescribePackages for more information on using the DescribePackages 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 DescribePackagesRequest method.
req, resp := client.DescribePackagesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackages

func (*OpenSearchService) DescribePackagesWithContext 

func (c *OpenSearchService) DescribePackagesWithContext(ctx aws.Context, input *DescribePackagesInput, opts ...request.Option) (*DescribePackagesOutput, error)

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

See DescribePackages 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 (*OpenSearchService) DescribeReservedInstanceOfferings 

func (c *OpenSearchService) DescribeReservedInstanceOfferings(input *DescribeReservedInstanceOfferingsInput) (*DescribeReservedInstanceOfferingsOutput, error)

DescribeReservedInstanceOfferings API operation for Amazon OpenSearch Service.

Lists available reserved OpenSearch 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 OpenSearch Service's API operation DescribeReservedInstanceOfferings for usage and error information.

Returned Error Types:

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferings

func (*OpenSearchService) DescribeReservedInstanceOfferingsPages 

func (c *OpenSearchService) DescribeReservedInstanceOfferingsPages(input *DescribeReservedInstanceOfferingsInput, fn func(*DescribeReservedInstanceOfferingsOutput, bool) bool) error

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

See DescribeReservedInstanceOfferings 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 DescribeReservedInstanceOfferings operation.
pageNum := 0
err := client.DescribeReservedInstanceOfferingsPages(params,
    func(page *opensearchservice.DescribeReservedInstanceOfferingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) DescribeReservedInstanceOfferingsPagesWithContext 

func (c *OpenSearchService) DescribeReservedInstanceOfferingsPagesWithContext(ctx aws.Context, input *DescribeReservedInstanceOfferingsInput, fn func(*DescribeReservedInstanceOfferingsOutput, bool) bool, opts ...request.Option) error

DescribeReservedInstanceOfferingsPagesWithContext same as DescribeReservedInstanceOfferingsPages 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 (*OpenSearchService) DescribeReservedInstanceOfferingsRequest 

func (c *OpenSearchService) DescribeReservedInstanceOfferingsRequest(input *DescribeReservedInstanceOfferingsInput) (req *request.Request, output *DescribeReservedInstanceOfferingsOutput)

DescribeReservedInstanceOfferingsRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedInstanceOfferings 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 DescribeReservedInstanceOfferings for more information on using the DescribeReservedInstanceOfferings 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 DescribeReservedInstanceOfferingsRequest method.
req, resp := client.DescribeReservedInstanceOfferingsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferings

func (*OpenSearchService) DescribeReservedInstanceOfferingsWithContext 

func (c *OpenSearchService) DescribeReservedInstanceOfferingsWithContext(ctx aws.Context, input *DescribeReservedInstanceOfferingsInput, opts ...request.Option) (*DescribeReservedInstanceOfferingsOutput, error)

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

See DescribeReservedInstanceOfferings 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 (*OpenSearchService) DescribeReservedInstances 

func (c *OpenSearchService) DescribeReservedInstances(input *DescribeReservedInstancesInput) (*DescribeReservedInstancesOutput, error)

DescribeReservedInstances API operation for Amazon OpenSearch Service.

Returns information about reserved OpenSearch 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 OpenSearch Service's API operation DescribeReservedInstances for usage and error information.

Returned Error Types:

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstances

func (*OpenSearchService) DescribeReservedInstancesPages 

func (c *OpenSearchService) DescribeReservedInstancesPages(input *DescribeReservedInstancesInput, fn func(*DescribeReservedInstancesOutput, bool) bool) error

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

See DescribeReservedInstances 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 DescribeReservedInstances operation.
pageNum := 0
err := client.DescribeReservedInstancesPages(params,
    func(page *opensearchservice.DescribeReservedInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) DescribeReservedInstancesPagesWithContext 

func (c *OpenSearchService) DescribeReservedInstancesPagesWithContext(ctx aws.Context, input *DescribeReservedInstancesInput, fn func(*DescribeReservedInstancesOutput, bool) bool, opts ...request.Option) error

DescribeReservedInstancesPagesWithContext same as DescribeReservedInstancesPages 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 (*OpenSearchService) DescribeReservedInstancesRequest 

func (c *OpenSearchService) DescribeReservedInstancesRequest(input *DescribeReservedInstancesInput) (req *request.Request, output *DescribeReservedInstancesOutput)

DescribeReservedInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedInstances 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 DescribeReservedInstances for more information on using the DescribeReservedInstances 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 DescribeReservedInstancesRequest method.
req, resp := client.DescribeReservedInstancesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstances

func (*OpenSearchService) DescribeReservedInstancesWithContext 

func (c *OpenSearchService) DescribeReservedInstancesWithContext(ctx aws.Context, input *DescribeReservedInstancesInput, opts ...request.Option) (*DescribeReservedInstancesOutput, error)

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

See DescribeReservedInstances 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 (*OpenSearchService) DissociatePackage 

func (c *OpenSearchService) DissociatePackage(input *DissociatePackageInput) (*DissociatePackageOutput, error)

DissociatePackage API operation for Amazon OpenSearch Service.

Dissociates a package from the Amazon OpenSearch Service 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 OpenSearch Service's API operation DissociatePackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

  • ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackage

func (*OpenSearchService) DissociatePackageRequest 

func (c *OpenSearchService) DissociatePackageRequest(input *DissociatePackageInput) (req *request.Request, output *DissociatePackageOutput)

DissociatePackageRequest generates a "aws/request.Request" representing the client's request for the DissociatePackage 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 DissociatePackage for more information on using the DissociatePackage 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 DissociatePackageRequest method.
req, resp := client.DissociatePackageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackage

func (*OpenSearchService) DissociatePackageWithContext 

func (c *OpenSearchService) DissociatePackageWithContext(ctx aws.Context, input *DissociatePackageInput, opts ...request.Option) (*DissociatePackageOutput, error)

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

See DissociatePackage 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 (*OpenSearchService) GetCompatibleVersions 

func (c *OpenSearchService) GetCompatibleVersions(input *GetCompatibleVersionsInput) (*GetCompatibleVersionsOutput, error)

GetCompatibleVersions API operation for Amazon OpenSearch Service.

Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch 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 OpenSearch Service's API operation GetCompatibleVersions for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCompatibleVersions

func (*OpenSearchService) GetCompatibleVersionsRequest 

func (c *OpenSearchService) GetCompatibleVersionsRequest(input *GetCompatibleVersionsInput) (req *request.Request, output *GetCompatibleVersionsOutput)

GetCompatibleVersionsRequest generates a "aws/request.Request" representing the client's request for the GetCompatibleVersions 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 GetCompatibleVersions for more information on using the GetCompatibleVersions 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 GetCompatibleVersionsRequest method.
req, resp := client.GetCompatibleVersionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCompatibleVersions

func (*OpenSearchService) GetCompatibleVersionsWithContext 

func (c *OpenSearchService) GetCompatibleVersionsWithContext(ctx aws.Context, input *GetCompatibleVersionsInput, opts ...request.Option) (*GetCompatibleVersionsOutput, error)

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

See GetCompatibleVersions 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 (*OpenSearchService) GetPackageVersionHistory 

func (c *OpenSearchService) GetPackageVersionHistory(input *GetPackageVersionHistoryInput) (*GetPackageVersionHistoryOutput, error)

GetPackageVersionHistory API operation for Amazon OpenSearch Service.

Returns a list of package versions, along with their creation time and commit message.

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 OpenSearch Service's API operation GetPackageVersionHistory for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistory

func (*OpenSearchService) GetPackageVersionHistoryPages 

func (c *OpenSearchService) GetPackageVersionHistoryPages(input *GetPackageVersionHistoryInput, fn func(*GetPackageVersionHistoryOutput, bool) bool) error

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

See GetPackageVersionHistory 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 GetPackageVersionHistory operation.
pageNum := 0
err := client.GetPackageVersionHistoryPages(params,
    func(page *opensearchservice.GetPackageVersionHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) GetPackageVersionHistoryPagesWithContext 

func (c *OpenSearchService) GetPackageVersionHistoryPagesWithContext(ctx aws.Context, input *GetPackageVersionHistoryInput, fn func(*GetPackageVersionHistoryOutput, bool) bool, opts ...request.Option) error

GetPackageVersionHistoryPagesWithContext same as GetPackageVersionHistoryPages 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 (*OpenSearchService) GetPackageVersionHistoryRequest 

func (c *OpenSearchService) GetPackageVersionHistoryRequest(input *GetPackageVersionHistoryInput) (req *request.Request, output *GetPackageVersionHistoryOutput)

GetPackageVersionHistoryRequest generates a "aws/request.Request" representing the client's request for the GetPackageVersionHistory 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 GetPackageVersionHistory for more information on using the GetPackageVersionHistory 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 GetPackageVersionHistoryRequest method.
req, resp := client.GetPackageVersionHistoryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistory

func (*OpenSearchService) GetPackageVersionHistoryWithContext 

func (c *OpenSearchService) GetPackageVersionHistoryWithContext(ctx aws.Context, input *GetPackageVersionHistoryInput, opts ...request.Option) (*GetPackageVersionHistoryOutput, error)

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

See GetPackageVersionHistory 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 (*OpenSearchService) GetUpgradeHistory 

func (c *OpenSearchService) GetUpgradeHistory(input *GetUpgradeHistoryInput) (*GetUpgradeHistoryOutput, error)

GetUpgradeHistory API operation for Amazon OpenSearch Service.

Retrieves the complete history of the last 10 upgrades 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 OpenSearch Service's API operation GetUpgradeHistory for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeHistory

func (*OpenSearchService) GetUpgradeHistoryPages 

func (c *OpenSearchService) 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 *opensearchservice.GetUpgradeHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) GetUpgradeHistoryPagesWithContext 

func (c *OpenSearchService) 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 (*OpenSearchService) GetUpgradeHistoryRequest 

func (c *OpenSearchService) 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeHistory

func (*OpenSearchService) GetUpgradeHistoryWithContext 

func (c *OpenSearchService) 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 (*OpenSearchService) GetUpgradeStatus 

func (c *OpenSearchService) GetUpgradeStatus(input *GetUpgradeStatusInput) (*GetUpgradeStatusOutput, error)

GetUpgradeStatus API operation for Amazon OpenSearch Service.

Retrieves the latest status of the last upgrade or upgrade eligibility check 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 OpenSearch Service's API operation GetUpgradeStatus for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeStatus

func (*OpenSearchService) GetUpgradeStatusRequest 

func (c *OpenSearchService) 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeStatus

func (*OpenSearchService) GetUpgradeStatusWithContext 

func (c *OpenSearchService) 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 (*OpenSearchService) ListDomainNames 

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

ListDomainNames API operation for Amazon OpenSearch Service.

Returns the names of all 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 OpenSearch Service's API operation ListDomainNames for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNames

func (*OpenSearchService) ListDomainNamesRequest 

func (c *OpenSearchService) 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNames

func (*OpenSearchService) ListDomainNamesWithContext 

func (c *OpenSearchService) 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 (*OpenSearchService) ListDomainsForPackage 

func (c *OpenSearchService) ListDomainsForPackage(input *ListDomainsForPackageInput) (*ListDomainsForPackageOutput, error)

ListDomainsForPackage API operation for Amazon OpenSearch Service.

Lists all Amazon OpenSearch Service domains associated with the package.

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 OpenSearch Service's API operation ListDomainsForPackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackage

func (*OpenSearchService) ListDomainsForPackagePages 

func (c *OpenSearchService) ListDomainsForPackagePages(input *ListDomainsForPackageInput, fn func(*ListDomainsForPackageOutput, bool) bool) error

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

See ListDomainsForPackage 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 ListDomainsForPackage operation.
pageNum := 0
err := client.ListDomainsForPackagePages(params,
    func(page *opensearchservice.ListDomainsForPackageOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) ListDomainsForPackagePagesWithContext 

func (c *OpenSearchService) ListDomainsForPackagePagesWithContext(ctx aws.Context, input *ListDomainsForPackageInput, fn func(*ListDomainsForPackageOutput, bool) bool, opts ...request.Option) error

ListDomainsForPackagePagesWithContext same as ListDomainsForPackagePages 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 (*OpenSearchService) ListDomainsForPackageRequest 

func (c *OpenSearchService) ListDomainsForPackageRequest(input *ListDomainsForPackageInput) (req *request.Request, output *ListDomainsForPackageOutput)

ListDomainsForPackageRequest generates a "aws/request.Request" representing the client's request for the ListDomainsForPackage 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 ListDomainsForPackage for more information on using the ListDomainsForPackage 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 ListDomainsForPackageRequest method.
req, resp := client.ListDomainsForPackageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackage

func (*OpenSearchService) ListDomainsForPackageWithContext 

func (c *OpenSearchService) ListDomainsForPackageWithContext(ctx aws.Context, input *ListDomainsForPackageInput, opts ...request.Option) (*ListDomainsForPackageOutput, error)

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

See ListDomainsForPackage 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 (*OpenSearchService) ListInstanceTypeDetails 

func (c *OpenSearchService) ListInstanceTypeDetails(input *ListInstanceTypeDetailsInput) (*ListInstanceTypeDetailsOutput, error)

ListInstanceTypeDetails API operation for Amazon OpenSearch Service.

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 OpenSearch Service's API operation ListInstanceTypeDetails for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetails

func (*OpenSearchService) ListInstanceTypeDetailsPages 

func (c *OpenSearchService) ListInstanceTypeDetailsPages(input *ListInstanceTypeDetailsInput, fn func(*ListInstanceTypeDetailsOutput, bool) bool) error

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

See ListInstanceTypeDetails 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 ListInstanceTypeDetails operation.
pageNum := 0
err := client.ListInstanceTypeDetailsPages(params,
    func(page *opensearchservice.ListInstanceTypeDetailsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) ListInstanceTypeDetailsPagesWithContext 

func (c *OpenSearchService) ListInstanceTypeDetailsPagesWithContext(ctx aws.Context, input *ListInstanceTypeDetailsInput, fn func(*ListInstanceTypeDetailsOutput, bool) bool, opts ...request.Option) error

ListInstanceTypeDetailsPagesWithContext same as ListInstanceTypeDetailsPages 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 (*OpenSearchService) ListInstanceTypeDetailsRequest 

func (c *OpenSearchService) ListInstanceTypeDetailsRequest(input *ListInstanceTypeDetailsInput) (req *request.Request, output *ListInstanceTypeDetailsOutput)

ListInstanceTypeDetailsRequest generates a "aws/request.Request" representing the client's request for the ListInstanceTypeDetails 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 ListInstanceTypeDetails for more information on using the ListInstanceTypeDetails 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 ListInstanceTypeDetailsRequest method.
req, resp := client.ListInstanceTypeDetailsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetails

func (*OpenSearchService) ListInstanceTypeDetailsWithContext 

func (c *OpenSearchService) ListInstanceTypeDetailsWithContext(ctx aws.Context, input *ListInstanceTypeDetailsInput, opts ...request.Option) (*ListInstanceTypeDetailsOutput, error)

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

See ListInstanceTypeDetails 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 (*OpenSearchService) ListPackagesForDomain 

func (c *OpenSearchService) ListPackagesForDomain(input *ListPackagesForDomainInput) (*ListPackagesForDomainOutput, error)

ListPackagesForDomain API operation for Amazon OpenSearch Service.

Lists all packages associated with the Amazon OpenSearch Service 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 OpenSearch Service's API operation ListPackagesForDomain for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListPackagesForDomain

func (*OpenSearchService) ListPackagesForDomainPages 

func (c *OpenSearchService) ListPackagesForDomainPages(input *ListPackagesForDomainInput, fn func(*ListPackagesForDomainOutput, bool) bool) error

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

See ListPackagesForDomain 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 ListPackagesForDomain operation.
pageNum := 0
err := client.ListPackagesForDomainPages(params,
    func(page *opensearchservice.ListPackagesForDomainOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) ListPackagesForDomainPagesWithContext 

func (c *OpenSearchService) ListPackagesForDomainPagesWithContext(ctx aws.Context, input *ListPackagesForDomainInput, fn func(*ListPackagesForDomainOutput, bool) bool, opts ...request.Option) error

ListPackagesForDomainPagesWithContext same as ListPackagesForDomainPages 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 (*OpenSearchService) ListPackagesForDomainRequest 

func (c *OpenSearchService) ListPackagesForDomainRequest(input *ListPackagesForDomainInput) (req *request.Request, output *ListPackagesForDomainOutput)

ListPackagesForDomainRequest generates a "aws/request.Request" representing the client's request for the ListPackagesForDomain 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 ListPackagesForDomain for more information on using the ListPackagesForDomain 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 ListPackagesForDomainRequest method.
req, resp := client.ListPackagesForDomainRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListPackagesForDomain

func (*OpenSearchService) ListPackagesForDomainWithContext 

func (c *OpenSearchService) ListPackagesForDomainWithContext(ctx aws.Context, input *ListPackagesForDomainInput, opts ...request.Option) (*ListPackagesForDomainOutput, error)

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

See ListPackagesForDomain 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 (*OpenSearchService) ListTags 

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

ListTags API operation for Amazon OpenSearch Service.

Returns all tags for the given 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 OpenSearch Service's API operation ListTags for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListTags

func (*OpenSearchService) ListTagsRequest 

func (c *OpenSearchService) 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListTags

func (*OpenSearchService) ListTagsWithContext 

func (c *OpenSearchService) 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 (*OpenSearchService) ListVersions 

func (c *OpenSearchService) ListVersions(input *ListVersionsInput) (*ListVersionsOutput, error)

ListVersions API operation for Amazon OpenSearch Service.

List all supported versions of OpenSearch and Elasticsearch.

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 OpenSearch Service's API operation ListVersions for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVersions

func (*OpenSearchService) ListVersionsPages 

func (c *OpenSearchService) ListVersionsPages(input *ListVersionsInput, fn func(*ListVersionsOutput, bool) bool) error

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

See ListVersions 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 ListVersions operation.
pageNum := 0
err := client.ListVersionsPages(params,
    func(page *opensearchservice.ListVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OpenSearchService) ListVersionsPagesWithContext 

func (c *OpenSearchService) ListVersionsPagesWithContext(ctx aws.Context, input *ListVersionsInput, fn func(*ListVersionsOutput, bool) bool, opts ...request.Option) error

ListVersionsPagesWithContext same as ListVersionsPages 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 (*OpenSearchService) ListVersionsRequest 

func (c *OpenSearchService) ListVersionsRequest(input *ListVersionsInput) (req *request.Request, output *ListVersionsOutput)

ListVersionsRequest generates a "aws/request.Request" representing the client's request for the ListVersions 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 ListVersions for more information on using the ListVersions 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 ListVersionsRequest method.
req, resp := client.ListVersionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVersions

func (*OpenSearchService) ListVersionsWithContext 

func (c *OpenSearchService) ListVersionsWithContext(ctx aws.Context, input *ListVersionsInput, opts ...request.Option) (*ListVersionsOutput, error)

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

See ListVersions 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 (*OpenSearchService) PurchaseReservedInstanceOffering 

func (c *OpenSearchService) PurchaseReservedInstanceOffering(input *PurchaseReservedInstanceOfferingInput) (*PurchaseReservedInstanceOfferingOutput, error)

PurchaseReservedInstanceOffering API operation for Amazon OpenSearch Service.

Allows you to purchase reserved OpenSearch 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 OpenSearch Service's API operation PurchaseReservedInstanceOffering for usage and error information.

Returned Error Types:

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PurchaseReservedInstanceOffering

func (*OpenSearchService) PurchaseReservedInstanceOfferingRequest 

func (c *OpenSearchService) PurchaseReservedInstanceOfferingRequest(input *PurchaseReservedInstanceOfferingInput) (req *request.Request, output *PurchaseReservedInstanceOfferingOutput)

PurchaseReservedInstanceOfferingRequest generates a "aws/request.Request" representing the client's request for the PurchaseReservedInstanceOffering 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 PurchaseReservedInstanceOffering for more information on using the PurchaseReservedInstanceOffering 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 PurchaseReservedInstanceOfferingRequest method.
req, resp := client.PurchaseReservedInstanceOfferingRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PurchaseReservedInstanceOffering

func (*OpenSearchService) PurchaseReservedInstanceOfferingWithContext 

func (c *OpenSearchService) PurchaseReservedInstanceOfferingWithContext(ctx aws.Context, input *PurchaseReservedInstanceOfferingInput, opts ...request.Option) (*PurchaseReservedInstanceOfferingOutput, error)

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

See PurchaseReservedInstanceOffering 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 (*OpenSearchService) RejectInboundConnection 

func (c *OpenSearchService) RejectInboundConnection(input *RejectInboundConnectionInput) (*RejectInboundConnectionOutput, error)

RejectInboundConnection API operation for Amazon OpenSearch Service.

Allows the remote domain owner to reject an inbound cross-cluster connection request.

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 OpenSearch Service's API operation RejectInboundConnection for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RejectInboundConnection

func (*OpenSearchService) RejectInboundConnectionRequest 

func (c *OpenSearchService) RejectInboundConnectionRequest(input *RejectInboundConnectionInput) (req *request.Request, output *RejectInboundConnectionOutput)

RejectInboundConnectionRequest generates a "aws/request.Request" representing the client's request for the RejectInboundConnection 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 RejectInboundConnection for more information on using the RejectInboundConnection 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 RejectInboundConnectionRequest method.
req, resp := client.RejectInboundConnectionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RejectInboundConnection

func (*OpenSearchService) RejectInboundConnectionWithContext 

func (c *OpenSearchService) RejectInboundConnectionWithContext(ctx aws.Context, input *RejectInboundConnectionInput, opts ...request.Option) (*RejectInboundConnectionOutput, error)

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

See RejectInboundConnection 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 (*OpenSearchService) RemoveTags 

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

RemoveTags API operation for Amazon OpenSearch Service.

Removes the specified set of tags from the given 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 OpenSearch Service's API operation RemoveTags for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RemoveTags

func (*OpenSearchService) RemoveTagsRequest 

func (c *OpenSearchService) 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)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RemoveTags

func (*OpenSearchService) RemoveTagsWithContext 

func (c *OpenSearchService) 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 (*OpenSearchService) StartServiceSoftwareUpdate 

func (c *OpenSearchService) StartServiceSoftwareUpdate(input *StartServiceSoftwareUpdateInput) (*StartServiceSoftwareUpdateOutput, error)

StartServiceSoftwareUpdate API operation for Amazon OpenSearch Service.

Schedules a service software update for an Amazon OpenSearch Service 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 OpenSearch Service's API operation StartServiceSoftwareUpdate for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdate

func (*OpenSearchService) StartServiceSoftwareUpdateRequest 

func (c *OpenSearchService) StartServiceSoftwareUpdateRequest(input *StartServiceSoftwareUpdateInput) (req *request.Request, output *StartServiceSoftwareUpdateOutput)

StartServiceSoftwareUpdateRequest generates a "aws/request.Request" representing the client's request for the StartServiceSoftwareUpdate 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 StartServiceSoftwareUpdate for more information on using the StartServiceSoftwareUpdate 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 StartServiceSoftwareUpdateRequest method.
req, resp := client.StartServiceSoftwareUpdateRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdate

func (*OpenSearchService) StartServiceSoftwareUpdateWithContext 

func (c *OpenSearchService) StartServiceSoftwareUpdateWithContext(ctx aws.Context, input *StartServiceSoftwareUpdateInput, opts ...request.Option) (*StartServiceSoftwareUpdateOutput, error)

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

See StartServiceSoftwareUpdate 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 (*OpenSearchService) UpdateDomainConfig 

func (c *OpenSearchService) UpdateDomainConfig(input *UpdateDomainConfigInput) (*UpdateDomainConfigOutput, error)

UpdateDomainConfig API operation for Amazon OpenSearch Service.

Modifies the cluster configuration of the specified domain, such 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 OpenSearch Service's API operation UpdateDomainConfig for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfig

func (*OpenSearchService) UpdateDomainConfigRequest 

func (c *OpenSearchService) UpdateDomainConfigRequest(input *UpdateDomainConfigInput) (req *request.Request, output *UpdateDomainConfigOutput)

UpdateDomainConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateDomainConfig 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 UpdateDomainConfig for more information on using the UpdateDomainConfig 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 UpdateDomainConfigRequest method.
req, resp := client.UpdateDomainConfigRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfig

func (*OpenSearchService) UpdateDomainConfigWithContext 

func (c *OpenSearchService) UpdateDomainConfigWithContext(ctx aws.Context, input *UpdateDomainConfigInput, opts ...request.Option) (*UpdateDomainConfigOutput, error)

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

See UpdateDomainConfig 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 (*OpenSearchService) UpdatePackage 

func (c *OpenSearchService) UpdatePackage(input *UpdatePackageInput) (*UpdatePackageOutput, error)

UpdatePackage API operation for Amazon OpenSearch Service.

Updates a package for use with Amazon OpenSearch 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 OpenSearch Service's API operation UpdatePackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

  • AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackage

func (*OpenSearchService) UpdatePackageRequest 

func (c *OpenSearchService) UpdatePackageRequest(input *UpdatePackageInput) (req *request.Request, output *UpdatePackageOutput)

UpdatePackageRequest generates a "aws/request.Request" representing the client's request for the UpdatePackage 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 UpdatePackage for more information on using the UpdatePackage 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 UpdatePackageRequest method.
req, resp := client.UpdatePackageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackage

func (*OpenSearchService) UpdatePackageWithContext 

func (c *OpenSearchService) UpdatePackageWithContext(ctx aws.Context, input *UpdatePackageInput, opts ...request.Option) (*UpdatePackageOutput, error)

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

See UpdatePackage 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 (*OpenSearchService) UpgradeDomain 

func (c *OpenSearchService) UpgradeDomain(input *UpgradeDomainInput) (*UpgradeDomainOutput, error)

UpgradeDomain API operation for Amazon OpenSearch Service.

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

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 OpenSearch Service's API operation UpgradeDomain for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeDomain

func (*OpenSearchService) UpgradeDomainRequest 

func (c *OpenSearchService) UpgradeDomainRequest(input *UpgradeDomainInput) (req *request.Request, output *UpgradeDomainOutput)

UpgradeDomainRequest generates a "aws/request.Request" representing the client's request for the UpgradeDomain 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 UpgradeDomain for more information on using the UpgradeDomain 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 UpgradeDomainRequest method.
req, resp := client.UpgradeDomainRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeDomain

func (*OpenSearchService) UpgradeDomainWithContext 

func (c *OpenSearchService) UpgradeDomainWithContext(ctx aws.Context, input *UpgradeDomainInput, opts ...request.Option) (*UpgradeDomainOutput, error)

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

See UpgradeDomain 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 OptionStatus 

type OptionStatus struct {

	// The timestamp of when the entity was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `type:"timestamp" required:"true"`

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

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

	// The timestamp of the last time the entity was updated.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `type:"timestamp" required:"true"`

	// The latest version of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionStatus) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*OptionStatus) SetPendingDeletion 

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

SetPendingDeletion sets the PendingDeletion field's value.

func (*OptionStatus) SetState 

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

SetState sets the State field's value.

func (*OptionStatus) SetUpdateDate 

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

SetUpdateDate sets the UpdateDate field's value.

func (*OptionStatus) SetUpdateVersion 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OutboundConnection 

type OutboundConnection struct {

	// The connection alias for the outbound cross-cluster connection.
	ConnectionAlias *string `min:"2" type:"string"`

	// The connection ID for the outbound cross-cluster connection.
	ConnectionId *string `min:"10" type:"string"`

	// The OutboundConnectionStatus for the outbound connection.
	ConnectionStatus *OutboundConnectionStatus `type:"structure"`

	// The DomainInformation for the local OpenSearch domain.
	LocalDomainInfo *DomainInformationContainer `type:"structure"`

	// The DomainInformation for the remote OpenSearch domain.
	RemoteDomainInfo *DomainInformationContainer `type:"structure"`
	// contains filtered or unexported fields
}

Specifies details about an outbound connection.

func (OutboundConnection) GoString 

func (s OutboundConnection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutboundConnection) SetConnectionAlias 

func (s *OutboundConnection) SetConnectionAlias(v string) *OutboundConnection

SetConnectionAlias sets the ConnectionAlias field's value.

func (*OutboundConnection) SetConnectionId 

func (s *OutboundConnection) SetConnectionId(v string) *OutboundConnection

SetConnectionId sets the ConnectionId field's value.

func (*OutboundConnection) SetConnectionStatus 

func (s *OutboundConnection) SetConnectionStatus(v *OutboundConnectionStatus) *OutboundConnection

SetConnectionStatus sets the ConnectionStatus field's value.

func (*OutboundConnection) SetLocalDomainInfo 

func (s *OutboundConnection) SetLocalDomainInfo(v *DomainInformationContainer) *OutboundConnection

SetLocalDomainInfo sets the LocalDomainInfo field's value.

func (*OutboundConnection) SetRemoteDomainInfo 

func (s *OutboundConnection) SetRemoteDomainInfo(v *DomainInformationContainer) *OutboundConnection

SetRemoteDomainInfo sets the RemoteDomainInfo field's value.

func (OutboundConnection) String 

func (s OutboundConnection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OutboundConnectionStatus 

type OutboundConnectionStatus struct {

	// Verbose information for the outbound connection status.
	Message *string `type:"string"`

	// The state code for the outbound connection. Can be one of the following:
	//
	//    * VALIDATING: The outbound connection request is being validated.
	//
	//    * VALIDATION_FAILED: Validation failed for the connection request.
	//
	//    * PENDING_ACCEPTANCE: Outbound connection request is validated and is
	//    not yet accepted by the remote domain owner.
	//
	//    * APPROVED: Outbound connection has been approved by the remote domain
	//    owner for getting provisioned.
	//
	//    * PROVISIONING: Outbound connection request is in process.
	//
	//    * ACTIVE: Outbound connection is active and ready to use.
	//
	//    * REJECTING: Outbound connection rejection by remote domain owner is in
	//    progress.
	//
	//    * REJECTED: Outbound connection request is rejected by remote domain owner.
	//
	//    * DELETING: Outbound connection deletion is in progress.
	//
	//    * DELETED: Outbound connection is deleted and can no longer be used.
	StatusCode *string `type:"string" enum:"OutboundConnectionStatusCode"`
	// contains filtered or unexported fields
}

The connection status of an outbound cross-cluster connection.

func (OutboundConnectionStatus) GoString 

func (s OutboundConnectionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutboundConnectionStatus) SetMessage 

func (s *OutboundConnectionStatus) SetMessage(v string) *OutboundConnectionStatus

SetMessage sets the Message field's value.

func (*OutboundConnectionStatus) SetStatusCode 

func (s *OutboundConnectionStatus) SetStatusCode(v string) *OutboundConnectionStatus

SetStatusCode sets the StatusCode field's value.

func (OutboundConnectionStatus) String 

func (s OutboundConnectionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PackageDetails 

type PackageDetails struct {
	AvailablePackageVersion *string `type:"string"`

	// The timestamp of when the package was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Additional information if the package is in an error state. Null otherwise.
	ErrorDetails *ErrorDetails `type:"structure"`

	LastUpdatedAt *time.Time `type:"timestamp"`

	// User-specified description of the package.
	PackageDescription *string `type:"string"`

	// Internal ID of the package.
	PackageID *string `type:"string"`

	// User-specified name of the package.
	PackageName *string `min:"3" type:"string"`

	// Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE,
	// DELETING, and DELETE_FAILED.
	PackageStatus *string `type:"string" enum:"PackageStatus"`

	// Currently supports only TXT-DICTIONARY.
	PackageType *string `type:"string" enum:"PackageType"`
	// contains filtered or unexported fields
}

Basic information about a package.

func (PackageDetails) GoString 

func (s PackageDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PackageDetails) SetAvailablePackageVersion 

func (s *PackageDetails) SetAvailablePackageVersion(v string) *PackageDetails

SetAvailablePackageVersion sets the AvailablePackageVersion field's value.

func (*PackageDetails) SetCreatedAt 

func (s *PackageDetails) SetCreatedAt(v time.Time) *PackageDetails

SetCreatedAt sets the CreatedAt field's value.

func (*PackageDetails) SetErrorDetails 

func (s *PackageDetails) SetErrorDetails(v *ErrorDetails) *PackageDetails

SetErrorDetails sets the ErrorDetails field's value.

func (*PackageDetails) SetLastUpdatedAt 

func (s *PackageDetails) SetLastUpdatedAt(v time.Time) *PackageDetails

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*PackageDetails) SetPackageDescription 

func (s *PackageDetails) SetPackageDescription(v string) *PackageDetails

SetPackageDescription sets the PackageDescription field's value.

func (*PackageDetails) SetPackageID 

func (s *PackageDetails) SetPackageID(v string) *PackageDetails

SetPackageID sets the PackageID field's value.

func (*PackageDetails) SetPackageName 

func (s *PackageDetails) SetPackageName(v string) *PackageDetails

SetPackageName sets the PackageName field's value.

func (*PackageDetails) SetPackageStatus 

func (s *PackageDetails) SetPackageStatus(v string) *PackageDetails

SetPackageStatus sets the PackageStatus field's value.

func (*PackageDetails) SetPackageType 

func (s *PackageDetails) SetPackageType(v string) *PackageDetails

SetPackageType sets the PackageType field's value.

func (PackageDetails) String 

func (s PackageDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PackageSource 

type PackageSource struct {

	// The name of the Amazon S3 bucket containing the package.
	S3BucketName *string `min:"3" type:"string"`

	// Key (file name) of the package.
	S3Key *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Amazon S3 location for importing the package specified as S3BucketName and S3Key

func (PackageSource) GoString 

func (s PackageSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PackageSource) SetS3BucketName 

func (s *PackageSource) SetS3BucketName(v string) *PackageSource

SetS3BucketName sets the S3BucketName field's value.

func (*PackageSource) SetS3Key 

func (s *PackageSource) SetS3Key(v string) *PackageSource

SetS3Key sets the S3Key field's value.

func (PackageSource) String 

func (s PackageSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PackageSource) Validate 

func (s *PackageSource) Validate() error

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

type PackageVersionHistory 

type PackageVersionHistory struct {

	// A message associated with the package version.
	CommitMessage *string `type:"string"`

	// The timestamp of when the package was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The package version.
	PackageVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Details of a package version.

func (PackageVersionHistory) GoString 

func (s PackageVersionHistory) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PackageVersionHistory) SetCommitMessage 

func (s *PackageVersionHistory) SetCommitMessage(v string) *PackageVersionHistory

SetCommitMessage sets the CommitMessage field's value.

func (*PackageVersionHistory) SetCreatedAt 

func (s *PackageVersionHistory) SetCreatedAt(v time.Time) *PackageVersionHistory

SetCreatedAt sets the CreatedAt field's value.

func (*PackageVersionHistory) SetPackageVersion 

func (s *PackageVersionHistory) SetPackageVersion(v string) *PackageVersionHistory

SetPackageVersion sets the PackageVersion field's value.

func (PackageVersionHistory) String 

func (s PackageVersionHistory) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PurchaseReservedInstanceOfferingInput 

type PurchaseReservedInstanceOfferingInput struct {

	// The number of OpenSearch 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 OpenSearch instance offering to purchase.
	//
	// ReservedInstanceOfferingId is a required field
	ReservedInstanceOfferingId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for parameters to PurchaseReservedInstanceOffering

func (PurchaseReservedInstanceOfferingInput) GoString 

func (s PurchaseReservedInstanceOfferingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedInstanceOfferingInput) SetInstanceCount 

func (s *PurchaseReservedInstanceOfferingInput) SetInstanceCount(v int64) *PurchaseReservedInstanceOfferingInput

SetInstanceCount sets the InstanceCount field's value.

func (*PurchaseReservedInstanceOfferingInput) SetReservationName 

func (s *PurchaseReservedInstanceOfferingInput) SetReservationName(v string) *PurchaseReservedInstanceOfferingInput

SetReservationName sets the ReservationName field's value.

func (*PurchaseReservedInstanceOfferingInput) SetReservedInstanceOfferingId 

func (s *PurchaseReservedInstanceOfferingInput) SetReservedInstanceOfferingId(v string) *PurchaseReservedInstanceOfferingInput

SetReservedInstanceOfferingId sets the ReservedInstanceOfferingId field's value.

func (PurchaseReservedInstanceOfferingInput) String 

func (s PurchaseReservedInstanceOfferingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedInstanceOfferingInput) Validate 

func (s *PurchaseReservedInstanceOfferingInput) Validate() error

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

type PurchaseReservedInstanceOfferingOutput 

type PurchaseReservedInstanceOfferingOutput struct {

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

	// Details of the reserved OpenSearch instance which was purchased.
	ReservedInstanceId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a PurchaseReservedInstanceOffering operation.

func (PurchaseReservedInstanceOfferingOutput) GoString 

func (s PurchaseReservedInstanceOfferingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedInstanceOfferingOutput) SetReservationName 

func (s *PurchaseReservedInstanceOfferingOutput) SetReservationName(v string) *PurchaseReservedInstanceOfferingOutput

SetReservationName sets the ReservationName field's value.

func (*PurchaseReservedInstanceOfferingOutput) SetReservedInstanceId 

func (s *PurchaseReservedInstanceOfferingOutput) SetReservedInstanceId(v string) *PurchaseReservedInstanceOfferingOutput

SetReservedInstanceId sets the ReservedInstanceId field's value.

func (PurchaseReservedInstanceOfferingOutput) String 

func (s PurchaseReservedInstanceOfferingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecurringCharge 

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 OpenSearch instance, or for a reserved OpenSearch instance offering.

func (RecurringCharge) GoString 

func (s RecurringCharge) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecurringCharge) SetRecurringChargeAmount 

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

SetRecurringChargeAmount sets the RecurringChargeAmount field's value.

func (*RecurringCharge) SetRecurringChargeFrequency 

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

SetRecurringChargeFrequency sets the RecurringChargeFrequency field's value.

func (RecurringCharge) String 

func (s RecurringCharge) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RejectInboundConnectionInput 

type RejectInboundConnectionInput struct {

	// The ID of the inbound connection to reject.
	//
	// ConnectionId is a required field
	ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the RejectInboundConnection operation.

func (RejectInboundConnectionInput) GoString 

func (s RejectInboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RejectInboundConnectionInput) SetConnectionId 

func (s *RejectInboundConnectionInput) SetConnectionId(v string) *RejectInboundConnectionInput

SetConnectionId sets the ConnectionId field's value.

func (RejectInboundConnectionInput) String 

func (s RejectInboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RejectInboundConnectionInput) Validate 

func (s *RejectInboundConnectionInput) Validate() error

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

type RejectInboundConnectionOutput 

type RejectInboundConnectionOutput struct {

	// The InboundConnection of the rejected inbound connection.
	Connection *InboundConnection `type:"structure"`
	// contains filtered or unexported fields
}

The result of a RejectInboundConnection operation. Contains details about the rejected inbound connection.

func (RejectInboundConnectionOutput) GoString 

func (s RejectInboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RejectInboundConnectionOutput) SetConnection 

func (s *RejectInboundConnectionOutput) SetConnection(v *InboundConnection) *RejectInboundConnectionOutput

SetConnection sets the Connection field's value.

func (RejectInboundConnectionOutput) String 

func (s RejectInboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveTagsInput 

type RemoveTagsInput struct {

	// The ARN of the domain from which you want to delete the specified tags.
	//
	// ARN is a required field
	ARN *string `min:"20" type:"string" required:"true"`

	// The TagKey list you want to remove from the 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 domain from which you want to remove the specified TagKey.

func (RemoveTagsInput) GoString 

func (s RemoveTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsInput) SetARN 

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

SetARN sets the ARN field's value.

func (*RemoveTagsInput) SetTagKeys 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsInput) Validate 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveTagsOutput) String 

func (s RemoveTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReservedInstance 

type ReservedInstance struct {
	BillingSubscriptionId *int64 `type:"long"`

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

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

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

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

	// The OpenSearch instance type offered by the reserved instance offering.
	InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

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

	// 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.
	ReservedInstanceId *string `min:"36" type:"string"`

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

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

	// The state of the reserved OpenSearch 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 OpenSearch instance.

func (ReservedInstance) GoString 

func (s ReservedInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReservedInstance) SetBillingSubscriptionId 

func (s *ReservedInstance) SetBillingSubscriptionId(v int64) *ReservedInstance

SetBillingSubscriptionId sets the BillingSubscriptionId field's value.

func (*ReservedInstance) SetCurrencyCode 

func (s *ReservedInstance) SetCurrencyCode(v string) *ReservedInstance

SetCurrencyCode sets the CurrencyCode field's value.

func (*ReservedInstance) SetDuration 

func (s *ReservedInstance) SetDuration(v int64) *ReservedInstance

SetDuration sets the Duration field's value.

func (*ReservedInstance) SetFixedPrice 

func (s *ReservedInstance) SetFixedPrice(v float64) *ReservedInstance

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedInstance) SetInstanceCount 

func (s *ReservedInstance) SetInstanceCount(v int64) *ReservedInstance

SetInstanceCount sets the InstanceCount field's value.

func (*ReservedInstance) SetInstanceType 

func (s *ReservedInstance) SetInstanceType(v string) *ReservedInstance

SetInstanceType sets the InstanceType field's value.

func (*ReservedInstance) SetPaymentOption 

func (s *ReservedInstance) SetPaymentOption(v string) *ReservedInstance

SetPaymentOption sets the PaymentOption field's value.

func (*ReservedInstance) SetRecurringCharges 

func (s *ReservedInstance) SetRecurringCharges(v []*RecurringCharge) *ReservedInstance

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedInstance) SetReservationName 

func (s *ReservedInstance) SetReservationName(v string) *ReservedInstance

SetReservationName sets the ReservationName field's value.

func (*ReservedInstance) SetReservedInstanceId 

func (s *ReservedInstance) SetReservedInstanceId(v string) *ReservedInstance

SetReservedInstanceId sets the ReservedInstanceId field's value.

func (*ReservedInstance) SetReservedInstanceOfferingId 

func (s *ReservedInstance) SetReservedInstanceOfferingId(v string) *ReservedInstance

SetReservedInstanceOfferingId sets the ReservedInstanceOfferingId field's value.

func (*ReservedInstance) SetStartTime 

func (s *ReservedInstance) SetStartTime(v time.Time) *ReservedInstance

SetStartTime sets the StartTime field's value.

func (*ReservedInstance) SetState 

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

SetState sets the State field's value.

func (*ReservedInstance) SetUsagePrice 

func (s *ReservedInstance) SetUsagePrice(v float64) *ReservedInstance

SetUsagePrice sets the UsagePrice field's value.

func (ReservedInstance) String 

func (s ReservedInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReservedInstanceOffering 

type ReservedInstanceOffering struct {

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

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

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

	// The OpenSearch instance type offered by the reserved instance offering.
	InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

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

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

	// The OpenSearch reserved instance offering identifier.
	ReservedInstanceOfferingId *string `min:"36" 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 OpenSearch instance offering.

func (ReservedInstanceOffering) GoString 

func (s ReservedInstanceOffering) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReservedInstanceOffering) SetCurrencyCode 

func (s *ReservedInstanceOffering) SetCurrencyCode(v string) *ReservedInstanceOffering

SetCurrencyCode sets the CurrencyCode field's value.

func (*ReservedInstanceOffering) SetDuration 

func (s *ReservedInstanceOffering) SetDuration(v int64) *ReservedInstanceOffering

SetDuration sets the Duration field's value.

func (*ReservedInstanceOffering) SetFixedPrice 

func (s *ReservedInstanceOffering) SetFixedPrice(v float64) *ReservedInstanceOffering

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedInstanceOffering) SetInstanceType 

func (s *ReservedInstanceOffering) SetInstanceType(v string) *ReservedInstanceOffering

SetInstanceType sets the InstanceType field's value.

func (*ReservedInstanceOffering) SetPaymentOption 

func (s *ReservedInstanceOffering) SetPaymentOption(v string) *ReservedInstanceOffering

SetPaymentOption sets the PaymentOption field's value.

func (*ReservedInstanceOffering) SetRecurringCharges 

func (s *ReservedInstanceOffering) SetRecurringCharges(v []*RecurringCharge) *ReservedInstanceOffering

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedInstanceOffering) SetReservedInstanceOfferingId 

func (s *ReservedInstanceOffering) SetReservedInstanceOfferingId(v string) *ReservedInstanceOffering

SetReservedInstanceOfferingId sets the ReservedInstanceOfferingId field's value.

func (*ReservedInstanceOffering) SetUsagePrice 

func (s *ReservedInstanceOffering) SetUsagePrice(v float64) *ReservedInstanceOffering

SetUsagePrice sets the UsagePrice field's value.

func (ReservedInstanceOffering) String 

func (s ReservedInstanceOffering) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceAlreadyExistsException) Code 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SAMLIdp 

type SAMLIdp struct {

	// The unique entity ID of the application in SAML identity provider.
	//
	// EntityId is a required field
	EntityId *string `min:"8" type:"string" required:"true"`

	// The metadata of the SAML application in XML format.
	//
	// MetadataContent is a required field
	MetadataContent *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The SAML identity povider's information.

func (SAMLIdp) GoString 

func (s SAMLIdp) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SAMLIdp) SetEntityId 

func (s *SAMLIdp) SetEntityId(v string) *SAMLIdp

SetEntityId sets the EntityId field's value.

func (*SAMLIdp) SetMetadataContent 

func (s *SAMLIdp) SetMetadataContent(v string) *SAMLIdp

SetMetadataContent sets the MetadataContent field's value.

func (SAMLIdp) String 

func (s SAMLIdp) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SAMLIdp) Validate 

func (s *SAMLIdp) Validate() error

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

type SAMLOptionsInput_ 

type SAMLOptionsInput_ struct {

	// True if SAML is enabled.
	Enabled *bool `type:"boolean"`

	// The SAML Identity Provider's information.
	Idp *SAMLIdp `type:"structure"`

	// The backend role that the SAML master user is mapped to.
	MasterBackendRole *string `min:"1" type:"string"`

	// The SAML master username, which is stored in the Amazon OpenSearch Service
	// domain's internal database.
	//
	// MasterUserName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SAMLOptionsInput_'s
	// String and GoString methods.
	MasterUserName *string `min:"1" type:"string" sensitive:"true"`

	// Element of the SAML assertion to use for backend roles. Default is roles.
	RolesKey *string `type:"string"`

	// The duration, in minutes, after which a user session becomes inactive. Acceptable
	// values are between 1 and 1440, and the default value is 60.
	SessionTimeoutMinutes *int64 `type:"integer"`

	// Element of the SAML assertion to use for username. Default is NameID.
	SubjectKey *string `type:"string"`
	// contains filtered or unexported fields
}

The SAML application configuration for the domain.

func (SAMLOptionsInput_) GoString 

func (s SAMLOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SAMLOptionsInput_) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*SAMLOptionsInput_) SetIdp 

func (s *SAMLOptionsInput_) SetIdp(v *SAMLIdp) *SAMLOptionsInput_

SetIdp sets the Idp field's value.

func (*SAMLOptionsInput_) SetMasterBackendRole 

func (s *SAMLOptionsInput_) SetMasterBackendRole(v string) *SAMLOptionsInput_

SetMasterBackendRole sets the MasterBackendRole field's value.

func (*SAMLOptionsInput_) SetMasterUserName 

func (s *SAMLOptionsInput_) SetMasterUserName(v string) *SAMLOptionsInput_

SetMasterUserName sets the MasterUserName field's value.

func (*SAMLOptionsInput_) SetRolesKey 

func (s *SAMLOptionsInput_) SetRolesKey(v string) *SAMLOptionsInput_

SetRolesKey sets the RolesKey field's value.

func (*SAMLOptionsInput_) SetSessionTimeoutMinutes 

func (s *SAMLOptionsInput_) SetSessionTimeoutMinutes(v int64) *SAMLOptionsInput_

SetSessionTimeoutMinutes sets the SessionTimeoutMinutes field's value.

func (*SAMLOptionsInput_) SetSubjectKey 

func (s *SAMLOptionsInput_) SetSubjectKey(v string) *SAMLOptionsInput_

SetSubjectKey sets the SubjectKey field's value.

func (SAMLOptionsInput_) String 

func (s SAMLOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SAMLOptionsInput_) Validate 

func (s *SAMLOptionsInput_) Validate() error

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

type SAMLOptionsOutput_ 

type SAMLOptionsOutput_ struct {

	// True if SAML is enabled.
	Enabled *bool `type:"boolean"`

	// Describes the SAML identity provider's information.
	Idp *SAMLIdp `type:"structure"`

	// The key used for matching the SAML roles attribute.
	RolesKey *string `type:"string"`

	// The duration, in minutes, after which a user session becomes inactive.
	SessionTimeoutMinutes *int64 `type:"integer"`

	// The key used for matching the SAML subject attribute.
	SubjectKey *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the SAML application configured for the domain.

func (SAMLOptionsOutput_) GoString 

func (s SAMLOptionsOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SAMLOptionsOutput_) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*SAMLOptionsOutput_) SetIdp 

func (s *SAMLOptionsOutput_) SetIdp(v *SAMLIdp) *SAMLOptionsOutput_

SetIdp sets the Idp field's value.

func (*SAMLOptionsOutput_) SetRolesKey 

func (s *SAMLOptionsOutput_) SetRolesKey(v string) *SAMLOptionsOutput_

SetRolesKey sets the RolesKey field's value.

func (*SAMLOptionsOutput_) SetSessionTimeoutMinutes 

func (s *SAMLOptionsOutput_) SetSessionTimeoutMinutes(v int64) *SAMLOptionsOutput_

SetSessionTimeoutMinutes sets the SessionTimeoutMinutes field's value.

func (*SAMLOptionsOutput_) SetSubjectKey 

func (s *SAMLOptionsOutput_) SetSubjectKey(v string) *SAMLOptionsOutput_

SetSubjectKey sets the SubjectKey field's value.

func (SAMLOptionsOutput_) String 

func (s SAMLOptionsOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScheduledAutoTuneDetails 

type ScheduledAutoTuneDetails struct {

	// The Auto-Tune action description.
	Action *string `type:"string"`

	// The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
	ActionType *string `type:"string" enum:"ScheduledAutoTuneActionType"`

	// The timestamp of the Auto-Tune action scheduled for the domain.
	Date *time.Time `type:"timestamp"`

	// The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
	Severity *string `type:"string" enum:"ScheduledAutoTuneSeverityType"`
	// contains filtered or unexported fields
}

Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.

func (ScheduledAutoTuneDetails) GoString 

func (s ScheduledAutoTuneDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduledAutoTuneDetails) SetAction 

func (s *ScheduledAutoTuneDetails) SetAction(v string) *ScheduledAutoTuneDetails

SetAction sets the Action field's value.

func (*ScheduledAutoTuneDetails) SetActionType 

func (s *ScheduledAutoTuneDetails) SetActionType(v string) *ScheduledAutoTuneDetails

SetActionType sets the ActionType field's value.

func (*ScheduledAutoTuneDetails) SetDate 

func (s *ScheduledAutoTuneDetails) SetDate(v time.Time) *ScheduledAutoTuneDetails

SetDate sets the Date field's value.

func (*ScheduledAutoTuneDetails) SetSeverity 

func (s *ScheduledAutoTuneDetails) SetSeverity(v string) *ScheduledAutoTuneDetails

SetSeverity sets the Severity field's value.

func (ScheduledAutoTuneDetails) String 

func (s ScheduledAutoTuneDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceSoftwareOptions 

type ServiceSoftwareOptions struct {

	// The 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're able to cancel your service software version update. False
	// if you can't cancel your service software update.
	Cancellable *bool `type:"boolean"`

	// The current service software version 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 a service software is never automatically updated. False if a service
	// software is automatically updated after AutomatedUpdateDate.
	OptionalDeployment *bool `type:"boolean"`

	// True if you're able to update your service software version. False if you
	// can't 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 domain service software options.

func (ServiceSoftwareOptions) GoString 

func (s ServiceSoftwareOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceSoftwareOptions) SetAutomatedUpdateDate 

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

SetAutomatedUpdateDate sets the AutomatedUpdateDate field's value.

func (*ServiceSoftwareOptions) SetCancellable 

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

SetCancellable sets the Cancellable field's value.

func (*ServiceSoftwareOptions) SetCurrentVersion 

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

SetCurrentVersion sets the CurrentVersion field's value.

func (*ServiceSoftwareOptions) SetDescription 

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

SetDescription sets the Description field's value.

func (*ServiceSoftwareOptions) SetNewVersion 

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

SetNewVersion sets the NewVersion field's value.

func (*ServiceSoftwareOptions) SetOptionalDeployment 

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

SetOptionalDeployment sets the OptionalDeployment field's value.

func (*ServiceSoftwareOptions) SetUpdateAvailable 

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

SetUpdateAvailable sets the UpdateAvailable field's value.

func (*ServiceSoftwareOptions) SetUpdateStatus 

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

SetUpdateStatus sets the UpdateStatus field's value.

func (ServiceSoftwareOptions) String 

func (s ServiceSoftwareOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SnapshotOptions 

type SnapshotOptions struct {

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

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

func (SnapshotOptions) GoString 

func (s SnapshotOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SnapshotOptions) SetAutomatedSnapshotStartHour 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SnapshotOptionsStatus 

type SnapshotOptionsStatus struct {

	// The daily snapshot options specified for the domain.
	//
	// Options is a required field
	Options *SnapshotOptions `type:"structure" required:"true"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SnapshotOptionsStatus) SetOptions 

func (s *SnapshotOptionsStatus) SetOptions(v *SnapshotOptions) *SnapshotOptionsStatus

SetOptions sets the Options field's value.

func (*SnapshotOptionsStatus) SetStatus 

func (s *SnapshotOptionsStatus) SetStatus(v *OptionStatus) *SnapshotOptionsStatus

SetStatus sets the Status field's value.

func (SnapshotOptionsStatus) String 

func (s SnapshotOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartServiceSoftwareUpdateInput 

type StartServiceSoftwareUpdateInput 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 StartServiceSoftwareUpdate operation. Specifies the name of the domain to schedule a service software update for.

func (StartServiceSoftwareUpdateInput) GoString 

func (s StartServiceSoftwareUpdateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartServiceSoftwareUpdateInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (StartServiceSoftwareUpdateInput) String 

func (s StartServiceSoftwareUpdateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartServiceSoftwareUpdateInput) Validate 

func (s *StartServiceSoftwareUpdateInput) Validate() error

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

type StartServiceSoftwareUpdateOutput 

type StartServiceSoftwareUpdateOutput struct {

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

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

func (StartServiceSoftwareUpdateOutput) GoString 

func (s StartServiceSoftwareUpdateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartServiceSoftwareUpdateOutput) SetServiceSoftwareOptions 

func (s *StartServiceSoftwareUpdateOutput) SetServiceSoftwareOptions(v *ServiceSoftwareOptions) *StartServiceSoftwareUpdateOutput

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (StartServiceSoftwareUpdateOutput) String 

func (s StartServiceSoftwareUpdateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageType 

type StorageType struct {

	// Sub-type of the given storage type. List of available sub-storage options:
	// "instance" storageType has no storageSubType. "ebs" storageType has the following
	// valid storageSubTypes: standard gp2 io1 See VolumeType for more information
	// regarding each EBS storage option.
	StorageSubTypeName *string `type:"string"`

	// Limits that are applicable for the given storage type.
	StorageTypeLimits []*StorageTypeLimit `type:"list"`

	// Type of storage. List of available storage options: instance Built-in storage
	// available for the instance ebs Elastic block storage attached to the 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 a given InstanceType.

func (StorageType) GoString 

func (s StorageType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageType) SetStorageSubTypeName 

func (s *StorageType) SetStorageSubTypeName(v string) *StorageType

SetStorageSubTypeName sets the StorageSubTypeName field's value.

func (*StorageType) SetStorageTypeLimits 

func (s *StorageType) SetStorageTypeLimits(v []*StorageTypeLimit) *StorageType

SetStorageTypeLimits sets the StorageTypeLimits field's value.

func (*StorageType) SetStorageTypeName 

func (s *StorageType) SetStorageTypeName(v string) *StorageType

SetStorageTypeName sets the StorageTypeName field's value.

func (StorageType) String 

func (s StorageType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageTypeLimit 

type StorageTypeLimit struct {

	// Name of storage limits that are applicable for the given storage type. If
	// StorageType is "ebs", the following storage options are applicable: MinimumVolumeSize
	// Minimum amount of volume size that is applicable for the given storage type.
	// Can be empty if not applicable. MaximumVolumeSize Maximum amount of volume
	// size that is applicable for the given storage type. Can be empty if not applicable.
	// MaximumIops Maximum amount of Iops that is applicable for given the storage
	// type. Can be empty if not applicable. MinimumIops Minimum amount of Iops
	// that is applicable for given the storage type. Can be empty if 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 the given storage type.

func (StorageTypeLimit) GoString 

func (s StorageTypeLimit) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageTypeLimit) SetLimitName 

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

SetLimitName sets the LimitName field's value.

func (*StorageTypeLimit) SetLimitValues 

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

SetLimitValues sets the LimitValues field's value.

func (StorageTypeLimit) String 

func (s StorageTypeLimit) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag 

type Tag struct {

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

	// The TagValue, the value assigned to the corresponding tag key. Tag values
	// can be null and don't 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
}

A key value pair for a resource tag.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type UpdateDomainConfigInput 

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

	// Specifies advanced security options.
	AdvancedSecurityOptions *AdvancedSecurityOptionsInput_ `type:"structure"`

	// Specifies Auto-Tune options.
	AutoTuneOptions *AutoTuneOptions `type:"structure"`

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

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

	// Options to specify configuration that will be applied to the domain endpoint.
	DomainEndpointOptions *DomainEndpointOptions `type:"structure"`

	// The name of the domain you're updating.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

	// This flag, when set to True, specifies whether the UpdateDomain request should
	// return the results of validation checks (DryRunResults) without actually
	// applying the change.
	DryRun *bool `type:"boolean"`

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

	// Specifies encryption of data at rest options.
	EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

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

	// Specifies node-to-node encryption options.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions `type:"structure"`

	// 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 the VPC endpoint.
	// For more information, see Launching your Amazon OpenSearch Service domains
	// using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
	VPCOptions *VPCOptions `type:"structure"`
	// contains filtered or unexported fields
}

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

func (UpdateDomainConfigInput) GoString 

func (s UpdateDomainConfigInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainConfigInput) SetAccessPolicies 

func (s *UpdateDomainConfigInput) SetAccessPolicies(v string) *UpdateDomainConfigInput

SetAccessPolicies sets the AccessPolicies field's value.

func (*UpdateDomainConfigInput) SetAdvancedOptions 

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

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*UpdateDomainConfigInput) SetAdvancedSecurityOptions 

func (s *UpdateDomainConfigInput) SetAdvancedSecurityOptions(v *AdvancedSecurityOptionsInput_) *UpdateDomainConfigInput

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*UpdateDomainConfigInput) SetAutoTuneOptions 

func (s *UpdateDomainConfigInput) SetAutoTuneOptions(v *AutoTuneOptions) *UpdateDomainConfigInput

SetAutoTuneOptions sets the AutoTuneOptions field's value.

func (*UpdateDomainConfigInput) SetClusterConfig 

func (s *UpdateDomainConfigInput) SetClusterConfig(v *ClusterConfig) *UpdateDomainConfigInput

SetClusterConfig sets the ClusterConfig field's value.

func (*UpdateDomainConfigInput) SetCognitoOptions 

func (s *UpdateDomainConfigInput) SetCognitoOptions(v *CognitoOptions) *UpdateDomainConfigInput

SetCognitoOptions sets the CognitoOptions field's value.

func (*UpdateDomainConfigInput) SetDomainEndpointOptions 

func (s *UpdateDomainConfigInput) SetDomainEndpointOptions(v *DomainEndpointOptions) *UpdateDomainConfigInput

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*UpdateDomainConfigInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*UpdateDomainConfigInput) SetDryRun added in v1.42.11 

func (s *UpdateDomainConfigInput) SetDryRun(v bool) *UpdateDomainConfigInput

SetDryRun sets the DryRun field's value.

func (*UpdateDomainConfigInput) SetEBSOptions 

func (s *UpdateDomainConfigInput) SetEBSOptions(v *EBSOptions) *UpdateDomainConfigInput

SetEBSOptions sets the EBSOptions field's value.

func (*UpdateDomainConfigInput) SetEncryptionAtRestOptions 

func (s *UpdateDomainConfigInput) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *UpdateDomainConfigInput

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*UpdateDomainConfigInput) SetLogPublishingOptions 

func (s *UpdateDomainConfigInput) SetLogPublishingOptions(v map[string]*LogPublishingOption) *UpdateDomainConfigInput

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*UpdateDomainConfigInput) SetNodeToNodeEncryptionOptions 

func (s *UpdateDomainConfigInput) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptions) *UpdateDomainConfigInput

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*UpdateDomainConfigInput) SetSnapshotOptions 

func (s *UpdateDomainConfigInput) SetSnapshotOptions(v *SnapshotOptions) *UpdateDomainConfigInput

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*UpdateDomainConfigInput) SetVPCOptions 

func (s *UpdateDomainConfigInput) SetVPCOptions(v *VPCOptions) *UpdateDomainConfigInput

SetVPCOptions sets the VPCOptions field's value.

func (UpdateDomainConfigInput) String 

func (s UpdateDomainConfigInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainConfigInput) Validate 

func (s *UpdateDomainConfigInput) Validate() error

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

type UpdateDomainConfigOutput 

type UpdateDomainConfigOutput struct {

	// The status of the updated domain.
	//
	// DomainConfig is a required field
	DomainConfig *DomainConfig `type:"structure" required:"true"`

	// Contains result of DryRun.
	DryRunResults *DryRunResults `type:"structure"`
	// contains filtered or unexported fields
}

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

func (UpdateDomainConfigOutput) GoString 

func (s UpdateDomainConfigOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainConfigOutput) SetDomainConfig 

func (s *UpdateDomainConfigOutput) SetDomainConfig(v *DomainConfig) *UpdateDomainConfigOutput

SetDomainConfig sets the DomainConfig field's value.

func (*UpdateDomainConfigOutput) SetDryRunResults added in v1.42.11 

func (s *UpdateDomainConfigOutput) SetDryRunResults(v *DryRunResults) *UpdateDomainConfigOutput

SetDryRunResults sets the DryRunResults field's value.

func (UpdateDomainConfigOutput) String 

func (s UpdateDomainConfigOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdatePackageInput 

type UpdatePackageInput struct {

	// A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.
	CommitMessage *string `type:"string"`

	// A new description of the package.
	PackageDescription *string `type:"string"`

	// The unique identifier for the package.
	//
	// PackageID is a required field
	PackageID *string `type:"string" required:"true"`

	// The Amazon S3 location for importing the package specified as S3BucketName
	// and S3Key
	//
	// PackageSource is a required field
	PackageSource *PackageSource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Container for request parameters to the UpdatePackage operation.

func (UpdatePackageInput) GoString 

func (s UpdatePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePackageInput) SetCommitMessage 

func (s *UpdatePackageInput) SetCommitMessage(v string) *UpdatePackageInput

SetCommitMessage sets the CommitMessage field's value.

func (*UpdatePackageInput) SetPackageDescription 

func (s *UpdatePackageInput) SetPackageDescription(v string) *UpdatePackageInput

SetPackageDescription sets the PackageDescription field's value.

func (*UpdatePackageInput) SetPackageID 

func (s *UpdatePackageInput) SetPackageID(v string) *UpdatePackageInput

SetPackageID sets the PackageID field's value.

func (*UpdatePackageInput) SetPackageSource 

func (s *UpdatePackageInput) SetPackageSource(v *PackageSource) *UpdatePackageInput

SetPackageSource sets the PackageSource field's value.

func (UpdatePackageInput) String 

func (s UpdatePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePackageInput) Validate 

func (s *UpdatePackageInput) Validate() error

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

type UpdatePackageOutput 

type UpdatePackageOutput struct {

	// Information about the package.
	PackageDetails *PackageDetails `type:"structure"`
	// contains filtered or unexported fields
}

Container for the response returned by the UpdatePackage operation.

func (UpdatePackageOutput) GoString 

func (s UpdatePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePackageOutput) SetPackageDetails 

func (s *UpdatePackageOutput) SetPackageDetails(v *PackageDetails) *UpdatePackageOutput

SetPackageDetails sets the PackageDetails field's value.

func (UpdatePackageOutput) String 

func (s UpdatePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpgradeDomainInput 

type UpgradeDomainInput struct {

	// Exposes select native OpenSearch configuration values from opensearch.yml.
	// Currently, the following advanced options are available:
	//
	//    * Option to allow references to indices in an HTTP request body. Must
	//    be false when configuring access to individual sub-resources. By default,
	//    the value is true. See Advanced cluster parameters for more information.
	//
	//    * Option to specify the percentage of heap space allocated to field data.
	//    By default, this setting is unbounded.
	//
	// For more information, see Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).
	AdvancedOptions map[string]*string `type:"map"`

	// The name of an 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"`

	// When true, indicates that an upgrade eligibility check needs to be performed.
	// Does not actually perform the upgrade.
	PerformCheckOnly *bool `type:"boolean"`

	// The version of OpenSearch you intend to upgrade the domain to.
	//
	// TargetVersion is a required field
	TargetVersion *string `min:"14" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the request parameters to UpgradeDomain operation.

func (UpgradeDomainInput) GoString 

func (s UpgradeDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeDomainInput) SetAdvancedOptions 

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

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*UpgradeDomainInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*UpgradeDomainInput) SetPerformCheckOnly 

func (s *UpgradeDomainInput) SetPerformCheckOnly(v bool) *UpgradeDomainInput

SetPerformCheckOnly sets the PerformCheckOnly field's value.

func (*UpgradeDomainInput) SetTargetVersion 

func (s *UpgradeDomainInput) SetTargetVersion(v string) *UpgradeDomainInput

SetTargetVersion sets the TargetVersion field's value.

func (UpgradeDomainInput) String 

func (s UpgradeDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeDomainInput) Validate 

func (s *UpgradeDomainInput) Validate() error

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

type UpgradeDomainOutput 

type UpgradeDomainOutput struct {

	// Exposes select native OpenSearch configuration values from opensearch.yml.
	// Currently, the following advanced options are available:
	//
	//    * Option to allow references to indices in an HTTP request body. Must
	//    be false when configuring access to individual sub-resources. By default,
	//    the value is true. See Advanced cluster parameters for more information.
	//
	//    * Option to specify the percentage of heap space allocated to field data.
	//    By default, this setting is unbounded.
	//
	// For more information, see Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).
	AdvancedOptions map[string]*string `type:"map"`

	// The name of an 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"`

	// When true, indicates that an upgrade eligibility check needs to be performed.
	// Does not actually perform the upgrade.
	PerformCheckOnly *bool `type:"boolean"`

	// The version of OpenSearch that you intend to upgrade the domain to.
	TargetVersion *string `min:"14" type:"string"`

	UpgradeId *string `type:"string"`
	// contains filtered or unexported fields
}

Container for response returned by UpgradeDomain operation.

func (UpgradeDomainOutput) GoString 

func (s UpgradeDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeDomainOutput) SetAdvancedOptions 

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

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*UpgradeDomainOutput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*UpgradeDomainOutput) SetPerformCheckOnly 

func (s *UpgradeDomainOutput) SetPerformCheckOnly(v bool) *UpgradeDomainOutput

SetPerformCheckOnly sets the PerformCheckOnly field's value.

func (*UpgradeDomainOutput) SetTargetVersion 

func (s *UpgradeDomainOutput) SetTargetVersion(v string) *UpgradeDomainOutput

SetTargetVersion sets the TargetVersion field's value.

func (*UpgradeDomainOutput) SetUpgradeId 

func (s *UpgradeDomainOutput) SetUpgradeId(v string) *UpgradeDomainOutput

SetUpgradeId sets the UpgradeId field's value.

func (UpgradeDomainOutput) String 

func (s UpgradeDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpgradeHistory 

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 part of a specific upgrade or upgrade eligibility check.
	StepsList []*UpgradeStepItem `type:"list"`

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

	// The current status of the upgrade. 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 

func (s UpgradeHistory) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeHistory) SetStartTimestamp 

func (s *UpgradeHistory) SetStartTimestamp(v time.Time) *UpgradeHistory

SetStartTimestamp sets the StartTimestamp field's value.

func (*UpgradeHistory) SetStepsList 

func (s *UpgradeHistory) SetStepsList(v []*UpgradeStepItem) *UpgradeHistory

SetStepsList sets the StepsList field's value.

func (*UpgradeHistory) SetUpgradeName 

func (s *UpgradeHistory) SetUpgradeName(v string) *UpgradeHistory

SetUpgradeName sets the UpgradeName field's value.

func (*UpgradeHistory) SetUpgradeStatus 

func (s *UpgradeHistory) SetUpgradeStatus(v string) *UpgradeHistory

SetUpgradeStatus sets the UpgradeStatus field's value.

func (UpgradeHistory) String 

func (s UpgradeHistory) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpgradeStepItem 

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 the progress percentage of a particular
	// step.
	ProgressPercent *float64 `type:"double"`

	// One of three steps an upgrade or upgrade eligibility check goes through:
	//    * PreUpgradeCheck
	//
	//    * Snapshot
	//
	//    * Upgrade
	UpgradeStep *string `type:"string" enum:"UpgradeStep"`

	// The current status of the 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 

func (s UpgradeStepItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeStepItem) SetIssues 

func (s *UpgradeStepItem) SetIssues(v []*string) *UpgradeStepItem

SetIssues sets the Issues field's value.

func (*UpgradeStepItem) SetProgressPercent 

func (s *UpgradeStepItem) SetProgressPercent(v float64) *UpgradeStepItem

SetProgressPercent sets the ProgressPercent field's value.

func (*UpgradeStepItem) SetUpgradeStep 

func (s *UpgradeStepItem) SetUpgradeStep(v string) *UpgradeStepItem

SetUpgradeStep sets the UpgradeStep field's value.

func (*UpgradeStepItem) SetUpgradeStepStatus 

func (s *UpgradeStepItem) SetUpgradeStepStatus(v string) *UpgradeStepItem

SetUpgradeStepStatus sets the UpgradeStepStatus field's value.

func (UpgradeStepItem) String 

func (s UpgradeStepItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VPCDerivedInfo 

type VPCDerivedInfo struct {

	// The Availability Zones for the domain. Exists only if the domain was created
	// with VPCOptions.
	AvailabilityZones []*string `type:"list"`

	// The security groups for the VPC endpoint.
	SecurityGroupIds []*string `type:"list"`

	// The subnets for the VPC endpoint.
	SubnetIds []*string `type:"list"`

	// The VPC ID for the 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 the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).

func (VPCDerivedInfo) GoString 

func (s VPCDerivedInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VPCDerivedInfo) SetAvailabilityZones 

func (s *VPCDerivedInfo) SetAvailabilityZones(v []*string) *VPCDerivedInfo

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*VPCDerivedInfo) SetSecurityGroupIds 

func (s *VPCDerivedInfo) SetSecurityGroupIds(v []*string) *VPCDerivedInfo

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VPCDerivedInfo) SetSubnetIds 

func (s *VPCDerivedInfo) SetSubnetIds(v []*string) *VPCDerivedInfo

SetSubnetIds sets the SubnetIds field's value.

func (*VPCDerivedInfo) SetVPCId 

func (s *VPCDerivedInfo) SetVPCId(v string) *VPCDerivedInfo

SetVPCId sets the VPCId field's value.

func (VPCDerivedInfo) String 

func (s VPCDerivedInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VPCDerivedInfoStatus 

type VPCDerivedInfoStatus struct {

	// The VPC options for the specified domain.
	//
	// Options is a required field
	Options *VPCDerivedInfo `type:"structure" required:"true"`

	// The status of the VPC options for the specified 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 domain.

func (VPCDerivedInfoStatus) GoString 

func (s VPCDerivedInfoStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VPCDerivedInfoStatus) SetOptions 

func (s *VPCDerivedInfoStatus) SetOptions(v *VPCDerivedInfo) *VPCDerivedInfoStatus

SetOptions sets the Options field's value.

func (*VPCDerivedInfoStatus) SetStatus 

func (s *VPCDerivedInfoStatus) SetStatus(v *OptionStatus) *VPCDerivedInfoStatus

SetStatus sets the Status field's value.

func (VPCDerivedInfoStatus) String 

func (s VPCDerivedInfoStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VPCOptions 

type VPCOptions struct {

	// The security groups for the VPC endpoint.
	SecurityGroupIds []*string `type:"list"`

	// The subnets for the VPC endpoint.
	SubnetIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).

func (VPCOptions) GoString 

func (s VPCOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VPCOptions) SetSecurityGroupIds 

func (s *VPCOptions) SetSecurityGroupIds(v []*string) *VPCOptions

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VPCOptions) SetSubnetIds 

func (s *VPCOptions) SetSubnetIds(v []*string) *VPCOptions

SetSubnetIds sets the SubnetIds field's value.

func (VPCOptions) String 

func (s VPCOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An exception for missing / invalid input fields. Gives http status code of 400.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VersionStatus 

type VersionStatus struct {

	// The OpenSearch version for the specified OpenSearch domain.
	//
	// Options is a required field
	Options *string `min:"14" type:"string" required:"true"`

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

The status of the OpenSearch version options for the specified OpenSearch domain.

func (VersionStatus) GoString 

func (s VersionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VersionStatus) SetOptions 

func (s *VersionStatus) SetOptions(v string) *VersionStatus

SetOptions sets the Options field's value.

func (*VersionStatus) SetStatus 

func (s *VersionStatus) SetStatus(v *OptionStatus) *VersionStatus

SetStatus sets the Status field's value.

func (VersionStatus) String 

func (s VersionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ZoneAwarenessConfig 

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
}

The zone awareness configuration for the domain cluster, such as the number of availability zones.

func (ZoneAwarenessConfig) GoString 

func (s ZoneAwarenessConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ZoneAwarenessConfig) SetAvailabilityZoneCount 

func (s *ZoneAwarenessConfig) SetAvailabilityZoneCount(v int64) *ZoneAwarenessConfig

SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.

func (ZoneAwarenessConfig) String 

func (s ZoneAwarenessConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package opensearchserviceiface provides an interface to enable mocking the Amazon OpenSearch Service service client for testing your code.
 Package opensearchserviceiface provides an interface to enable mocking the Amazon OpenSearch 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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.