types

package
v1.10.11 Latest Latest
Warning

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

 Go to latest Published: Oct 21, 2022 License: Apache-2.0 Imports: 4 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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).
	//
	// This member is required.
	DomainName *string

	OwnerId *string

	Region *string
	// contains filtered or unexported fields
}

type AccessDeniedException 

type AccessDeniedException struct {
	Message *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) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

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.
	//
	// This member is required.
	Options *string

	// The status of the access policy for the domain. See OptionStatus for the status
	// information that's included.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

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

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
	//  This attribute is present on the master node
	// only to specify how much data nodes up to which given ESPartitionInstanceType
	// can support as master node.
	// * MaximumNumberOfDataNodesWithoutMasterNode
	//  This
	// attribute is present on data node only to specify how much data nodes of given
	// ESPartitionInstanceType up to which you don't need any master nodes to govern
	// them.
	LimitName *string

	// Value for a given AdditionalLimit$LimitName .
	LimitValues []string
	// contains filtered or unexported fields
}

List of limits that are specific to a given InstanceType and for each of its InstanceRole .

type AdvancedOptionsStatus 

type AdvancedOptionsStatus struct {

	// The status of advanced options for the specified domain.
	//
	// This member is required.
	Options map[string]string

	// The OptionStatus for advanced options for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// 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 (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) 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).

type AdvancedSecurityOptions 

type AdvancedSecurityOptions struct {

	// Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
	AnonymousAuthDisableDate *time.Time

	// True if Anonymous auth is enabled. Anonymous auth can be enabled only when
	// AdvancedSecurity is enabled on existing domains.
	AnonymousAuthEnabled *bool

	// True if advanced security is enabled.
	Enabled *bool

	// True if the internal user database is enabled.
	InternalUserDatabaseEnabled *bool

	// Describes the SAML application configured for a domain.
	SAMLOptions *SAMLOptionsOutput
	// contains filtered or unexported fields
}

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

type AdvancedSecurityOptionsInput 

type AdvancedSecurityOptionsInput struct {

	// True if Anonymous auth is enabled. Anonymous auth can be enabled only when
	// AdvancedSecurity is enabled on existing domains.
	AnonymousAuthEnabled *bool

	// True if advanced security is enabled.
	Enabled *bool

	// True if the internal user database is enabled.
	InternalUserDatabaseEnabled *bool

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

	// The SAML application configuration for the domain.
	SAMLOptions *SAMLOptionsInput
	// 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).

type AdvancedSecurityOptionsStatus 

type AdvancedSecurityOptionsStatus struct {

	// Advanced security options for the specified domain.
	//
	// This member is required.
	Options *AdvancedSecurityOptions

	// Status of the advanced security options for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The status of advanced security options for the specified domain.

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

	// Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
	AutoTuneType AutoTuneType
	// contains filtered or unexported fields
}

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

type AutoTuneDesiredState 

type AutoTuneDesiredState string
const (
	AutoTuneDesiredStateEnabled  AutoTuneDesiredState = "ENABLED"
	AutoTuneDesiredStateDisabled AutoTuneDesiredState = "DISABLED"
)

Enum values for AutoTuneDesiredState

func (AutoTuneDesiredState) Values 

func (AutoTuneDesiredState) Values() []AutoTuneDesiredState

Values returns all known values for AutoTuneDesiredState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

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

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

	// The timestamp at which the Auto-Tune maintenance schedule starts.
	StartAt *time.Time
	// 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.

type AutoTuneOptions 

type AutoTuneOptions struct {

	// The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
	DesiredState 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

	// The rollback state while disabling Auto-Tune for the domain. Valid values are
	// NO_ROLLBACK and DEFAULT_ROLLBACK.
	RollbackOnDisable 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.

type AutoTuneOptionsInput 

type AutoTuneOptionsInput struct {

	// The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
	DesiredState 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
	// contains filtered or unexported fields
}

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

type AutoTuneOptionsOutput 

type AutoTuneOptionsOutput struct {

	// The error message while enabling or disabling Auto-Tune.
	ErrorMessage *string

	// The AutoTuneState for the domain.
	State AutoTuneState
	// contains filtered or unexported fields
}

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

type AutoTuneOptionsStatus 

type AutoTuneOptionsStatus struct {

	// Specifies Auto-Tune options for the domain.
	Options *AutoTuneOptions

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

The Auto-Tune status for the domain.

type AutoTuneState 

type AutoTuneState string
const (
	AutoTuneStateEnabled                       AutoTuneState = "ENABLED"
	AutoTuneStateDisabled                      AutoTuneState = "DISABLED"
	AutoTuneStateEnableInProgress              AutoTuneState = "ENABLE_IN_PROGRESS"
	AutoTuneStateDisableInProgress             AutoTuneState = "DISABLE_IN_PROGRESS"
	AutoTuneStateDisabledAndRollbackScheduled  AutoTuneState = "DISABLED_AND_ROLLBACK_SCHEDULED"
	AutoTuneStateDisabledAndRollbackInProgress AutoTuneState = "DISABLED_AND_ROLLBACK_IN_PROGRESS"
	AutoTuneStateDisabledAndRollbackComplete   AutoTuneState = "DISABLED_AND_ROLLBACK_COMPLETE"
	AutoTuneStateDisabledAndRollbackError      AutoTuneState = "DISABLED_AND_ROLLBACK_ERROR"
	AutoTuneStateError                         AutoTuneState = "ERROR"
)

Enum values for AutoTuneState

func (AutoTuneState) Values 

func (AutoTuneState) Values() []AutoTuneState

Values returns all known values for AutoTuneState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AutoTuneStatus 

type AutoTuneStatus struct {

	// The timestamp of the Auto-Tune options creation date.
	//
	// This member is required.
	CreationDate *time.Time

	// The AutoTuneState for the domain.
	//
	// This member is required.
	State AutoTuneState

	// The timestamp of when the Auto-Tune options were last updated.
	//
	// This member is required.
	UpdateDate *time.Time

	// The error message while enabling or disabling Auto-Tune.
	ErrorMessage *string

	// Indicates whether the domain is being deleted.
	PendingDeletion *bool

	// The latest version of the Auto-Tune options.
	UpdateVersion int32
	// contains filtered or unexported fields
}

Provides the current Auto-Tune status for the domain.

type AutoTuneType 

type AutoTuneType string
const (
	AutoTuneTypeScheduledAction AutoTuneType = "SCHEDULED_ACTION"
)

Enum values for AutoTuneType

func (AutoTuneType) Values 

func (AutoTuneType) Values() []AutoTuneType

Values returns all known values for AutoTuneType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BaseException 

type BaseException struct {
	Message *string
	// contains filtered or unexported fields
}

An error occurred while processing the request.

func (*BaseException) Error 

func (e *BaseException) Error() string

func (*BaseException) ErrorCode 

func (e *BaseException) ErrorCode() string

func (*BaseException) ErrorFault 

func (e *BaseException) ErrorFault() smithy.ErrorFault

func (*BaseException) ErrorMessage 

func (e *BaseException) ErrorMessage() string

type ChangeProgressDetails added in v1.8.0 

type ChangeProgressDetails struct {

	// The unique change identifier associated with a specific domain configuration
	// change.
	ChangeId *string

	// Contains an optional message associated with the domain configuration change.
	Message *string
	// contains filtered or unexported fields
}

Specifies change details of the domain configuration change.

type ChangeProgressStage added in v1.8.0 

type ChangeProgressStage struct {

	// The description of the progress stage.
	Description *string

	// The last updated timestamp of the progress stage.
	LastUpdated *time.Time

	// The name of the specific progress stage.
	Name *string

	// The overall status of a specific progress stage.
	Status *string
	// contains filtered or unexported fields
}

A progress stage details of a specific domain configuration change.

type ChangeProgressStatusDetails added in v1.8.0 

type ChangeProgressStatusDetails struct {

	// The unique change identifier associated with a specific domain configuration
	// change.
	ChangeId *string

	// The specific stages that the domain is going through to perform the
	// configuration change.
	ChangeProgressStages []ChangeProgressStage

	// The list of properties involved in the domain configuration change that are
	// completed.
	CompletedProperties []string

	// The list of properties involved in the domain configuration change that are
	// still in pending.
	PendingProperties []string

	// The time at which the configuration change is made on the domain.
	StartTime *time.Time

	// The overall status of the domain configuration change. This field can take the
	// following values: PENDING, PROCESSING, COMPLETED and FAILED
	Status OverallChangeStatus

	// The total number of stages required for the configuration change.
	TotalNumberOfStages int32
	// contains filtered or unexported fields
}

The progress details of a specific domain configuration change.

type ClusterConfig 

type ClusterConfig struct {

	// Specifies the ColdStorageOptions config for a Domain
	ColdStorageOptions *ColdStorageOptions

	// Total number of dedicated master nodes, active and on standby, for the cluster.
	DedicatedMasterCount *int32

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

	// The instance type for a dedicated master node.
	DedicatedMasterType OpenSearchPartitionInstanceType

	// The number of instances in the specified domain cluster.
	InstanceCount *int32

	// The instance type for an OpenSearch cluster. UltraWarm instance types are not
	// supported for data instances.
	InstanceType OpenSearchPartitionInstanceType

	// The number of UltraWarm nodes in the cluster.
	WarmCount *int32

	// True to enable UltraWarm storage.
	WarmEnabled *bool

	// The instance type for the OpenSearch cluster's warm nodes.
	WarmType OpenSearchWarmPartitionInstanceType

	// The zone awareness configuration for a domain when zone awareness is enabled.
	ZoneAwarenessConfig *ZoneAwarenessConfig

	// 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
	// contains filtered or unexported fields
}

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

type ClusterConfigStatus 

type ClusterConfigStatus struct {

	// The cluster configuration for the specified domain.
	//
	// This member is required.
	Options *ClusterConfig

	// The cluster configuration status for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The configuration status for the specified domain.

type CognitoOptions 

type CognitoOptions struct {

	// The option to enable Cognito for OpenSearch Dashboards authentication.
	Enabled *bool

	// The Cognito identity pool ID for OpenSearch Dashboards authentication.
	IdentityPoolId *string

	// The role ARN that provides OpenSearch permissions for accessing Cognito
	// resources.
	RoleArn *string

	// The Cognito user pool ID for OpenSearch Dashboards authentication.
	UserPoolId *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).

type CognitoOptionsStatus 

type CognitoOptionsStatus struct {

	// Cognito options for the specified domain.
	//
	// This member is required.
	Options *CognitoOptions

	// The status of the Cognito options for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The status of the Cognito options for the specified domain.

type ColdStorageOptions 

type ColdStorageOptions struct {

	// Enable cold storage option. Accepted values true or false
	//
	// This member is required.
	Enabled *bool
	// contains filtered or unexported fields
}

Specifies the configuration for cold storage options such as enabled

type CompatibleVersionsMap 

type CompatibleVersionsMap struct {

	// The current version of OpenSearch a domain is on.
	SourceVersion *string

	// List of supported OpenSearch versions.
	TargetVersions []string
	// contains filtered or unexported fields
}

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

type ConflictException 

type ConflictException struct {
	Message *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) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DeploymentStatus 

type DeploymentStatus string
const (
	DeploymentStatusPendingUpdate DeploymentStatus = "PENDING_UPDATE"
	DeploymentStatusInProgress    DeploymentStatus = "IN_PROGRESS"
	DeploymentStatusCompleted     DeploymentStatus = "COMPLETED"
	DeploymentStatusNotEligible   DeploymentStatus = "NOT_ELIGIBLE"
	DeploymentStatusEligible      DeploymentStatus = "ELIGIBLE"
)

Enum values for DeploymentStatus

func (DeploymentStatus) Values 

func (DeploymentStatus) Values() []DeploymentStatus

Values returns all known values for DeploymentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DescribePackagesFilter 

type DescribePackagesFilter struct {

	// Any field from PackageDetails.
	Name DescribePackagesFilterName

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

A filter to apply to the DescribePackage response.

type DescribePackagesFilterName 

type DescribePackagesFilterName string
const (
	DescribePackagesFilterNamePackageID     DescribePackagesFilterName = "PackageID"
	DescribePackagesFilterNamePackageName   DescribePackagesFilterName = "PackageName"
	DescribePackagesFilterNamePackageStatus DescribePackagesFilterName = "PackageStatus"
)

Enum values for DescribePackagesFilterName

func (DescribePackagesFilterName) Values 

func (DescribePackagesFilterName) Values() []DescribePackagesFilterName

Values returns all known values for DescribePackagesFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DisabledOperationException 

type DisabledOperationException struct {
	Message *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) Error 

func (e *DisabledOperationException) Error() string

func (*DisabledOperationException) ErrorCode 

func (e *DisabledOperationException) ErrorCode() string

func (*DisabledOperationException) ErrorFault 

func (e *DisabledOperationException) ErrorFault() smithy.ErrorFault

func (*DisabledOperationException) ErrorMessage 

func (e *DisabledOperationException) ErrorMessage() string

type DomainConfig 

type DomainConfig struct {

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *AccessPoliciesStatus

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

	// Specifies AdvancedSecurityOptions for the domain.
	AdvancedSecurityOptions *AdvancedSecurityOptionsStatus

	// Specifies AutoTuneOptions for the domain.
	AutoTuneOptions *AutoTuneOptionsStatus

	// Specifies change details of the domain configuration change.
	ChangeProgressDetails *ChangeProgressDetails

	// The ClusterConfig for the domain.
	ClusterConfig *ClusterConfigStatus

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

	// The DomainEndpointOptions for the domain.
	DomainEndpointOptions *DomainEndpointOptionsStatus

	// The EBSOptions for the domain.
	EBSOptions *EBSOptionsStatus

	// The EncryptionAtRestOptions for the domain.
	EncryptionAtRestOptions *EncryptionAtRestOptionsStatus

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

	// Log publishing options for the given domain.
	LogPublishingOptions *LogPublishingOptionsStatus

	// The NodeToNodeEncryptionOptions for the domain.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus

	// The SnapshotOptions for the domain.
	SnapshotOptions *SnapshotOptionsStatus

	// 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
	// contains filtered or unexported fields
}

The configuration of a domain.

type DomainEndpointOptions 

type DomainEndpointOptions struct {

	// The fully qualified domain for your custom endpoint.
	CustomEndpoint *string

	// The ACM certificate ARN for your custom endpoint.
	CustomEndpointCertificateArn *string

	// Whether to enable a custom endpoint for the domain.
	CustomEndpointEnabled *bool

	// Whether only HTTPS endpoint should be enabled for the domain.
	EnforceHTTPS *bool

	// 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 TLSSecurityPolicy
	// contains filtered or unexported fields
}

Options to configure the endpoint for the domain.

type DomainEndpointOptionsStatus 

type DomainEndpointOptionsStatus struct {

	// Options to configure the endpoint for the domain.
	//
	// This member is required.
	Options *DomainEndpointOptions

	// The status of the endpoint options for the domain. See OptionStatus for the
	// status information that's included.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The configured endpoint options for the domain and their current status.

type DomainInfo 

type DomainInfo struct {

	// The DomainName.
	DomainName *string

	// Specifies the EngineType of the domain.
	EngineType EngineType
	// contains filtered or unexported fields
}

type DomainInformationContainer 

type DomainInformationContainer struct {
	AWSDomainInformation *AWSDomainInformation
	// contains filtered or unexported fields
}

type DomainPackageDetails 

type DomainPackageDetails struct {

	// The name of the domain you've associated a package with.
	DomainName *string

	// State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE,
	// DISSOCIATING, and DISSOCIATION_FAILED.
	DomainPackageStatus DomainPackageStatus

	// Additional information if the package is in an error state. Null otherwise.
	ErrorDetails *ErrorDetails

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

	// The internal ID of the package.
	PackageID *string

	// User-specified name of the package.
	PackageName *string

	// Currently supports only TXT-DICTIONARY.
	PackageType PackageType

	PackageVersion *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
	// contains filtered or unexported fields
}

Information on a package associated with a domain.

type DomainPackageStatus 

type DomainPackageStatus string
const (
	DomainPackageStatusAssociating        DomainPackageStatus = "ASSOCIATING"
	DomainPackageStatusAssociationFailed  DomainPackageStatus = "ASSOCIATION_FAILED"
	DomainPackageStatusActive             DomainPackageStatus = "ACTIVE"
	DomainPackageStatusDissociating       DomainPackageStatus = "DISSOCIATING"
	DomainPackageStatusDissociationFailed DomainPackageStatus = "DISSOCIATION_FAILED"
)

Enum values for DomainPackageStatus

func (DomainPackageStatus) Values 

func (DomainPackageStatus) Values() []DomainPackageStatus

Values returns all known values for DomainPackageStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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.
	//
	// This member is required.
	ARN *string

	// The type and number of instances in the domain.
	//
	// This member is required.
	ClusterConfig *ClusterConfig

	// The unique identifier for the specified domain.
	//
	// This member is required.
	DomainId *string

	// 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).
	//
	// This member is required.
	DomainName *string

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string

	// The status of the AdvancedOptions.
	AdvancedOptions map[string]string

	// The current status of the domain's advanced security options.
	AdvancedSecurityOptions *AdvancedSecurityOptions

	// The current status of the domain's Auto-Tune options.
	AutoTuneOptions *AutoTuneOptionsOutput

	// Specifies change details of the domain configuration change.
	ChangeProgressDetails *ChangeProgressDetails

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

	// The domain creation status. True if the creation of a domain is complete.  False
	// if domain creation is still in progress.
	Created *bool

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

	// The current status of the domain's endpoint options.
	DomainEndpointOptions *DomainEndpointOptions

	// The EBSOptions for the specified domain.
	EBSOptions *EBSOptions

	// The status of the EncryptionAtRestOptions.
	EncryptionAtRestOptions *EncryptionAtRestOptions

	// The domain endpoint that you use to submit index and search requests.
	Endpoint *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

	EngineVersion *string

	// Log publishing options for the given domain.
	LogPublishingOptions map[string]LogPublishingOption

	// The status of the NodeToNodeEncryptionOptions.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions

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

	// The current status of the domain's service software.
	ServiceSoftwareOptions *ServiceSoftwareOptions

	// The status of the SnapshotOptions.
	SnapshotOptions *SnapshotOptions

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

	// 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
	// contains filtered or unexported fields
}

The current status of a domain.

type DryRunResults added in v1.4.0 

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

	// Contains an optional message associated with the DryRunResults.
	Message *string
	// contains filtered or unexported fields
}

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

type EBSOptions 

type EBSOptions struct {

	// Whether EBS-based storage is enabled.
	EBSEnabled *bool

	// The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
	Iops *int32

	// The Throughput for GP3 EBS volume (SSD).
	Throughput *int32

	// Integer to specify the size of an EBS volume.
	VolumeSize *int32

	// The volume type for EBS-based storage.
	VolumeType VolumeType
	// contains filtered or unexported fields
}

Options to enable, disable, and specify the properties of EBS storage volumes.

type EBSOptionsStatus 

type EBSOptionsStatus struct {

	// The EBS options for the specified domain.
	//
	// This member is required.
	Options *EBSOptions

	// The status of the EBS options for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the EBS options for the specified domain.

type EncryptionAtRestOptions 

type EncryptionAtRestOptions struct {

	// The option to enable encryption at rest.
	Enabled *bool

	// The KMS key ID for encryption at rest options.
	KmsKeyId *string
	// contains filtered or unexported fields
}

Specifies encryption at rest options.

type EncryptionAtRestOptionsStatus 

type EncryptionAtRestOptionsStatus struct {

	// The Encryption At Rest options for the specified domain.
	//
	// This member is required.
	Options *EncryptionAtRestOptions

	// The status of the Encryption At Rest options for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the encryption At Rest options for the specified domain.

type EngineType added in v1.1.0 

type EngineType string
const (
	EngineTypeOpenSearch    EngineType = "OpenSearch"
	EngineTypeElasticsearch EngineType = "Elasticsearch"
)

Enum values for EngineType

func (EngineType) Values added in v1.1.0 

func (EngineType) Values() []EngineType

Values returns all known values for EngineType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ErrorDetails 

type ErrorDetails struct {
	ErrorMessage *string

	ErrorType *string
	// contains filtered or unexported fields
}

type Filter 

type Filter struct {

	// The name of the filter.
	Name *string

	// Contains one or more values for the filter.
	Values []string
	// 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.

type InboundConnection 

type InboundConnection struct {

	// The connection ID for the inbound cross-cluster connection.
	ConnectionId *string

	// The InboundConnectionStatus for the outbound connection.
	ConnectionStatus *InboundConnectionStatus

	// The AWSDomainInformation for the local OpenSearch domain.
	LocalDomainInfo *DomainInformationContainer

	// The AWSDomainInformation for the remote OpenSearch domain.
	RemoteDomainInfo *DomainInformationContainer
	// contains filtered or unexported fields
}

Details of an inbound connection.

type InboundConnectionStatus 

type InboundConnectionStatus struct {

	// Verbose information for the inbound connection status.
	Message *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 InboundConnectionStatusCode
	// contains filtered or unexported fields
}

The connection status of an inbound cross-cluster connection.

type InboundConnectionStatusCode 

type InboundConnectionStatusCode string
const (
	InboundConnectionStatusCodePendingAcceptance InboundConnectionStatusCode = "PENDING_ACCEPTANCE"
	InboundConnectionStatusCodeApproved          InboundConnectionStatusCode = "APPROVED"
	InboundConnectionStatusCodeProvisioning      InboundConnectionStatusCode = "PROVISIONING"
	InboundConnectionStatusCodeActive            InboundConnectionStatusCode = "ACTIVE"
	InboundConnectionStatusCodeRejecting         InboundConnectionStatusCode = "REJECTING"
	InboundConnectionStatusCodeRejected          InboundConnectionStatusCode = "REJECTED"
	InboundConnectionStatusCodeDeleting          InboundConnectionStatusCode = "DELETING"
	InboundConnectionStatusCodeDeleted           InboundConnectionStatusCode = "DELETED"
)

Enum values for InboundConnectionStatusCode

func (InboundConnectionStatusCode) Values 

func (InboundConnectionStatusCode) Values() []InboundConnectionStatusCode

Values returns all known values for InboundConnectionStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InstanceCountLimits 

type InstanceCountLimits struct {

	// Maximum number of instances that can be instantiated for a given InstanceType.
	MaximumInstanceCount int32

	// Minimum number of instances that can be instantiated for a given InstanceType.
	MinimumInstanceCount int32
	// 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.

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
	// contains filtered or unexported fields
}

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

type InstanceTypeDetails 

type InstanceTypeDetails struct {
	AdvancedSecurityEnabled *bool

	AppLogsEnabled *bool

	CognitoEnabled *bool

	EncryptionEnabled *bool

	InstanceRole []string

	InstanceType OpenSearchPartitionInstanceType

	WarmEnabled *bool
	// contains filtered or unexported fields
}

type InternalException 

type InternalException struct {
	Message *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) Error 

func (e *InternalException) Error() string

func (*InternalException) ErrorCode 

func (e *InternalException) ErrorCode() string

func (*InternalException) ErrorFault 

func (e *InternalException) ErrorFault() smithy.ErrorFault

func (*InternalException) ErrorMessage 

func (e *InternalException) ErrorMessage() string

type InvalidPaginationTokenException 

type InvalidPaginationTokenException struct {
	Message *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) Error 

func (e *InvalidPaginationTokenException) Error() string

func (*InvalidPaginationTokenException) ErrorCode 

func (e *InvalidPaginationTokenException) ErrorCode() string

func (*InvalidPaginationTokenException) ErrorFault 

func (e *InvalidPaginationTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidPaginationTokenException) ErrorMessage 

func (e *InvalidPaginationTokenException) ErrorMessage() string

type InvalidTypeException 

type InvalidTypeException struct {
	Message *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) Error 

func (e *InvalidTypeException) Error() string

func (*InvalidTypeException) ErrorCode 

func (e *InvalidTypeException) ErrorCode() string

func (*InvalidTypeException) ErrorFault 

func (e *InvalidTypeException) ErrorFault() smithy.ErrorFault

func (*InvalidTypeException) ErrorMessage 

func (e *InvalidTypeException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *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) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type Limits 

type Limits struct {

	// List of additional limits that are specific to a given InstanceType and for each
	// of its InstanceRole .
	AdditionalLimits []AdditionalLimit

	// InstanceLimits represents the list of instance-related attributes that are
	// available for a given InstanceType.
	InstanceLimits *InstanceLimits

	// Storage-related types and attributes that are available for a given
	// InstanceType.
	StorageTypes []StorageType
	// contains filtered or unexported fields
}

Limits for a given InstanceType and for each of its roles.

Limits contains the following: StorageTypes, InstanceLimits, and AdditionalLimits

type LogPublishingOption 

type LogPublishingOption struct {

	// ARN of the Cloudwatch log group to publish logs to.
	CloudWatchLogsLogGroupArn *string

	// Whether the given log publishing option is enabled or not.
	Enabled *bool
	// 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.

type LogPublishingOptionsStatus 

type LogPublishingOptionsStatus struct {

	// The log publishing options configured for the domain.
	Options map[string]LogPublishingOption

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

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

type LogType 

type LogType string
const (
	LogTypeIndexSlowLogs     LogType = "INDEX_SLOW_LOGS"
	LogTypeSearchSlowLogs    LogType = "SEARCH_SLOW_LOGS"
	LogTypeEsApplicationLogs LogType = "ES_APPLICATION_LOGS"
	LogTypeAuditLogs         LogType = "AUDIT_LOGS"
)

Enum values for LogType

func (LogType) Values 

func (LogType) Values() []LogType

Values returns all known values for LogType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MasterUserOptions 

type MasterUserOptions struct {

	// ARN for the master user (if IAM is enabled).
	MasterUserARN *string

	// The master user's username, which is stored in the Amazon OpenSearch Service
	// domain's internal database.
	MasterUserName *string

	// The master user's password, which is stored in the Amazon OpenSearch Service
	// domain's internal database.
	MasterUserPassword *string
	// contains filtered or unexported fields
}

Credentials for the master user: username and password, ARN, or both.

type NodeToNodeEncryptionOptions 

type NodeToNodeEncryptionOptions struct {

	// True to enable node-to-node encryption.
	Enabled *bool
	// contains filtered or unexported fields
}

The node-to-node encryption options.

type NodeToNodeEncryptionOptionsStatus 

type NodeToNodeEncryptionOptionsStatus struct {

	// The node-to-node encryption options for the specified domain.
	//
	// This member is required.
	Options *NodeToNodeEncryptionOptions

	// The status of the node-to-node encryption options for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

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

type OpenSearchPartitionInstanceType 

type OpenSearchPartitionInstanceType string
const (
	OpenSearchPartitionInstanceTypeM3MediumSearch         OpenSearchPartitionInstanceType = "m3.medium.search"
	OpenSearchPartitionInstanceTypeM3LargeSearch          OpenSearchPartitionInstanceType = "m3.large.search"
	OpenSearchPartitionInstanceTypeM3XlargeSearch         OpenSearchPartitionInstanceType = "m3.xlarge.search"
	OpenSearchPartitionInstanceTypeM32xlargeSearch        OpenSearchPartitionInstanceType = "m3.2xlarge.search"
	OpenSearchPartitionInstanceTypeM4LargeSearch          OpenSearchPartitionInstanceType = "m4.large.search"
	OpenSearchPartitionInstanceTypeM4XlargeSearch         OpenSearchPartitionInstanceType = "m4.xlarge.search"
	OpenSearchPartitionInstanceTypeM42xlargeSearch        OpenSearchPartitionInstanceType = "m4.2xlarge.search"
	OpenSearchPartitionInstanceTypeM44xlargeSearch        OpenSearchPartitionInstanceType = "m4.4xlarge.search"
	OpenSearchPartitionInstanceTypeM410xlargeSearch       OpenSearchPartitionInstanceType = "m4.10xlarge.search"
	OpenSearchPartitionInstanceTypeM5LargeSearch          OpenSearchPartitionInstanceType = "m5.large.search"
	OpenSearchPartitionInstanceTypeM5XlargeSearch         OpenSearchPartitionInstanceType = "m5.xlarge.search"
	OpenSearchPartitionInstanceTypeM52xlargeSearch        OpenSearchPartitionInstanceType = "m5.2xlarge.search"
	OpenSearchPartitionInstanceTypeM54xlargeSearch        OpenSearchPartitionInstanceType = "m5.4xlarge.search"
	OpenSearchPartitionInstanceTypeM512xlargeSearch       OpenSearchPartitionInstanceType = "m5.12xlarge.search"
	OpenSearchPartitionInstanceTypeM524xlargeSearch       OpenSearchPartitionInstanceType = "m5.24xlarge.search"
	OpenSearchPartitionInstanceTypeR5LargeSearch          OpenSearchPartitionInstanceType = "r5.large.search"
	OpenSearchPartitionInstanceTypeR5XlargeSearch         OpenSearchPartitionInstanceType = "r5.xlarge.search"
	OpenSearchPartitionInstanceTypeR52xlargeSearch        OpenSearchPartitionInstanceType = "r5.2xlarge.search"
	OpenSearchPartitionInstanceTypeR54xlargeSearch        OpenSearchPartitionInstanceType = "r5.4xlarge.search"
	OpenSearchPartitionInstanceTypeR512xlargeSearch       OpenSearchPartitionInstanceType = "r5.12xlarge.search"
	OpenSearchPartitionInstanceTypeR524xlargeSearch       OpenSearchPartitionInstanceType = "r5.24xlarge.search"
	OpenSearchPartitionInstanceTypeC5LargeSearch          OpenSearchPartitionInstanceType = "c5.large.search"
	OpenSearchPartitionInstanceTypeC5XlargeSearch         OpenSearchPartitionInstanceType = "c5.xlarge.search"
	OpenSearchPartitionInstanceTypeC52xlargeSearch        OpenSearchPartitionInstanceType = "c5.2xlarge.search"
	OpenSearchPartitionInstanceTypeC54xlargeSearch        OpenSearchPartitionInstanceType = "c5.4xlarge.search"
	OpenSearchPartitionInstanceTypeC59xlargeSearch        OpenSearchPartitionInstanceType = "c5.9xlarge.search"
	OpenSearchPartitionInstanceTypeC518xlargeSearch       OpenSearchPartitionInstanceType = "c5.18xlarge.search"
	OpenSearchPartitionInstanceTypeT3NanoSearch           OpenSearchPartitionInstanceType = "t3.nano.search"
	OpenSearchPartitionInstanceTypeT3MicroSearch          OpenSearchPartitionInstanceType = "t3.micro.search"
	OpenSearchPartitionInstanceTypeT3SmallSearch          OpenSearchPartitionInstanceType = "t3.small.search"
	OpenSearchPartitionInstanceTypeT3MediumSearch         OpenSearchPartitionInstanceType = "t3.medium.search"
	OpenSearchPartitionInstanceTypeT3LargeSearch          OpenSearchPartitionInstanceType = "t3.large.search"
	OpenSearchPartitionInstanceTypeT3XlargeSearch         OpenSearchPartitionInstanceType = "t3.xlarge.search"
	OpenSearchPartitionInstanceTypeT32xlargeSearch        OpenSearchPartitionInstanceType = "t3.2xlarge.search"
	OpenSearchPartitionInstanceTypeUltrawarm1MediumSearch OpenSearchPartitionInstanceType = "ultrawarm1.medium.search"
	OpenSearchPartitionInstanceTypeUltrawarm1LargeSearch  OpenSearchPartitionInstanceType = "ultrawarm1.large.search"
	OpenSearchPartitionInstanceTypeUltrawarm1XlargeSearch OpenSearchPartitionInstanceType = "ultrawarm1.xlarge.search"
	OpenSearchPartitionInstanceTypeT2MicroSearch          OpenSearchPartitionInstanceType = "t2.micro.search"
	OpenSearchPartitionInstanceTypeT2SmallSearch          OpenSearchPartitionInstanceType = "t2.small.search"
	OpenSearchPartitionInstanceTypeT2MediumSearch         OpenSearchPartitionInstanceType = "t2.medium.search"
	OpenSearchPartitionInstanceTypeR3LargeSearch          OpenSearchPartitionInstanceType = "r3.large.search"
	OpenSearchPartitionInstanceTypeR3XlargeSearch         OpenSearchPartitionInstanceType = "r3.xlarge.search"
	OpenSearchPartitionInstanceTypeR32xlargeSearch        OpenSearchPartitionInstanceType = "r3.2xlarge.search"
	OpenSearchPartitionInstanceTypeR34xlargeSearch        OpenSearchPartitionInstanceType = "r3.4xlarge.search"
	OpenSearchPartitionInstanceTypeR38xlargeSearch        OpenSearchPartitionInstanceType = "r3.8xlarge.search"
	OpenSearchPartitionInstanceTypeI2XlargeSearch         OpenSearchPartitionInstanceType = "i2.xlarge.search"
	OpenSearchPartitionInstanceTypeI22xlargeSearch        OpenSearchPartitionInstanceType = "i2.2xlarge.search"
	OpenSearchPartitionInstanceTypeD2XlargeSearch         OpenSearchPartitionInstanceType = "d2.xlarge.search"
	OpenSearchPartitionInstanceTypeD22xlargeSearch        OpenSearchPartitionInstanceType = "d2.2xlarge.search"
	OpenSearchPartitionInstanceTypeD24xlargeSearch        OpenSearchPartitionInstanceType = "d2.4xlarge.search"
	OpenSearchPartitionInstanceTypeD28xlargeSearch        OpenSearchPartitionInstanceType = "d2.8xlarge.search"
	OpenSearchPartitionInstanceTypeC4LargeSearch          OpenSearchPartitionInstanceType = "c4.large.search"
	OpenSearchPartitionInstanceTypeC4XlargeSearch         OpenSearchPartitionInstanceType = "c4.xlarge.search"
	OpenSearchPartitionInstanceTypeC42xlargeSearch        OpenSearchPartitionInstanceType = "c4.2xlarge.search"
	OpenSearchPartitionInstanceTypeC44xlargeSearch        OpenSearchPartitionInstanceType = "c4.4xlarge.search"
	OpenSearchPartitionInstanceTypeC48xlargeSearch        OpenSearchPartitionInstanceType = "c4.8xlarge.search"
	OpenSearchPartitionInstanceTypeR4LargeSearch          OpenSearchPartitionInstanceType = "r4.large.search"
	OpenSearchPartitionInstanceTypeR4XlargeSearch         OpenSearchPartitionInstanceType = "r4.xlarge.search"
	OpenSearchPartitionInstanceTypeR42xlargeSearch        OpenSearchPartitionInstanceType = "r4.2xlarge.search"
	OpenSearchPartitionInstanceTypeR44xlargeSearch        OpenSearchPartitionInstanceType = "r4.4xlarge.search"
	OpenSearchPartitionInstanceTypeR48xlargeSearch        OpenSearchPartitionInstanceType = "r4.8xlarge.search"
	OpenSearchPartitionInstanceTypeR416xlargeSearch       OpenSearchPartitionInstanceType = "r4.16xlarge.search"
	OpenSearchPartitionInstanceTypeI3LargeSearch          OpenSearchPartitionInstanceType = "i3.large.search"
	OpenSearchPartitionInstanceTypeI3XlargeSearch         OpenSearchPartitionInstanceType = "i3.xlarge.search"
	OpenSearchPartitionInstanceTypeI32xlargeSearch        OpenSearchPartitionInstanceType = "i3.2xlarge.search"
	OpenSearchPartitionInstanceTypeI34xlargeSearch        OpenSearchPartitionInstanceType = "i3.4xlarge.search"
	OpenSearchPartitionInstanceTypeI38xlargeSearch        OpenSearchPartitionInstanceType = "i3.8xlarge.search"
	OpenSearchPartitionInstanceTypeI316xlargeSearch       OpenSearchPartitionInstanceType = "i3.16xlarge.search"
	OpenSearchPartitionInstanceTypeR6gLargeSearch         OpenSearchPartitionInstanceType = "r6g.large.search"
	OpenSearchPartitionInstanceTypeR6gXlargeSearch        OpenSearchPartitionInstanceType = "r6g.xlarge.search"
	OpenSearchPartitionInstanceTypeR6g2xlargeSearch       OpenSearchPartitionInstanceType = "r6g.2xlarge.search"
	OpenSearchPartitionInstanceTypeR6g4xlargeSearch       OpenSearchPartitionInstanceType = "r6g.4xlarge.search"
	OpenSearchPartitionInstanceTypeR6g8xlargeSearch       OpenSearchPartitionInstanceType = "r6g.8xlarge.search"
	OpenSearchPartitionInstanceTypeR6g12xlargeSearch      OpenSearchPartitionInstanceType = "r6g.12xlarge.search"
	OpenSearchPartitionInstanceTypeM6gLargeSearch         OpenSearchPartitionInstanceType = "m6g.large.search"
	OpenSearchPartitionInstanceTypeM6gXlargeSearch        OpenSearchPartitionInstanceType = "m6g.xlarge.search"
	OpenSearchPartitionInstanceTypeM6g2xlargeSearch       OpenSearchPartitionInstanceType = "m6g.2xlarge.search"
	OpenSearchPartitionInstanceTypeM6g4xlargeSearch       OpenSearchPartitionInstanceType = "m6g.4xlarge.search"
	OpenSearchPartitionInstanceTypeM6g8xlargeSearch       OpenSearchPartitionInstanceType = "m6g.8xlarge.search"
	OpenSearchPartitionInstanceTypeM6g12xlargeSearch      OpenSearchPartitionInstanceType = "m6g.12xlarge.search"
	OpenSearchPartitionInstanceTypeC6gLargeSearch         OpenSearchPartitionInstanceType = "c6g.large.search"
	OpenSearchPartitionInstanceTypeC6gXlargeSearch        OpenSearchPartitionInstanceType = "c6g.xlarge.search"
	OpenSearchPartitionInstanceTypeC6g2xlargeSearch       OpenSearchPartitionInstanceType = "c6g.2xlarge.search"
	OpenSearchPartitionInstanceTypeC6g4xlargeSearch       OpenSearchPartitionInstanceType = "c6g.4xlarge.search"
	OpenSearchPartitionInstanceTypeC6g8xlargeSearch       OpenSearchPartitionInstanceType = "c6g.8xlarge.search"
	OpenSearchPartitionInstanceTypeC6g12xlargeSearch      OpenSearchPartitionInstanceType = "c6g.12xlarge.search"
	OpenSearchPartitionInstanceTypeR6gdLargeSearch        OpenSearchPartitionInstanceType = "r6gd.large.search"
	OpenSearchPartitionInstanceTypeR6gdXlargeSearch       OpenSearchPartitionInstanceType = "r6gd.xlarge.search"
	OpenSearchPartitionInstanceTypeR6gd2xlargeSearch      OpenSearchPartitionInstanceType = "r6gd.2xlarge.search"
	OpenSearchPartitionInstanceTypeR6gd4xlargeSearch      OpenSearchPartitionInstanceType = "r6gd.4xlarge.search"
	OpenSearchPartitionInstanceTypeR6gd8xlargeSearch      OpenSearchPartitionInstanceType = "r6gd.8xlarge.search"
	OpenSearchPartitionInstanceTypeR6gd12xlargeSearch     OpenSearchPartitionInstanceType = "r6gd.12xlarge.search"
	OpenSearchPartitionInstanceTypeR6gd16xlargeSearch     OpenSearchPartitionInstanceType = "r6gd.16xlarge.search"
	OpenSearchPartitionInstanceTypeT4gSmallSearch         OpenSearchPartitionInstanceType = "t4g.small.search"
	OpenSearchPartitionInstanceTypeT4gMediumSearch        OpenSearchPartitionInstanceType = "t4g.medium.search"
)

Enum values for OpenSearchPartitionInstanceType

func (OpenSearchPartitionInstanceType) Values 

func (OpenSearchPartitionInstanceType) Values() []OpenSearchPartitionInstanceType

Values returns all known values for OpenSearchPartitionInstanceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OpenSearchWarmPartitionInstanceType 

type OpenSearchWarmPartitionInstanceType string
const (
	OpenSearchWarmPartitionInstanceTypeUltrawarm1MediumSearch OpenSearchWarmPartitionInstanceType = "ultrawarm1.medium.search"
	OpenSearchWarmPartitionInstanceTypeUltrawarm1LargeSearch  OpenSearchWarmPartitionInstanceType = "ultrawarm1.large.search"
	OpenSearchWarmPartitionInstanceTypeUltrawarm1XlargeSearch OpenSearchWarmPartitionInstanceType = "ultrawarm1.xlarge.search"
)

Enum values for OpenSearchWarmPartitionInstanceType

func (OpenSearchWarmPartitionInstanceType) Values 

func (OpenSearchWarmPartitionInstanceType) Values() []OpenSearchWarmPartitionInstanceType

Values returns all known values for OpenSearchWarmPartitionInstanceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OptionState 

type OptionState string
const (
	OptionStateRequiresIndexDocuments OptionState = "RequiresIndexDocuments"
	OptionStateProcessing             OptionState = "Processing"
	OptionStateActive                 OptionState = "Active"
)

Enum values for OptionState

func (OptionState) Values 

func (OptionState) Values() []OptionState

Values returns all known values for OptionState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OptionStatus 

type OptionStatus struct {

	// The timestamp of when the entity was created.
	//
	// This member is required.
	CreationDate *time.Time

	// Provides the OptionState for the domain.
	//
	// This member is required.
	State OptionState

	// The timestamp of the last time the entity was updated.
	//
	// This member is required.
	UpdateDate *time.Time

	// Indicates whether the domain is being deleted.
	PendingDeletion *bool

	// The latest version of the entity.
	UpdateVersion int32
	// contains filtered or unexported fields
}

Provides the current status of the entity.

type OutboundConnection 

type OutboundConnection struct {

	// The connection alias for the outbound cross-cluster connection.
	ConnectionAlias *string

	// The connection ID for the outbound cross-cluster connection.
	ConnectionId *string

	// The OutboundConnectionStatus for the outbound connection.
	ConnectionStatus *OutboundConnectionStatus

	// The DomainInformation for the local OpenSearch domain.
	LocalDomainInfo *DomainInformationContainer

	// The DomainInformation for the remote OpenSearch domain.
	RemoteDomainInfo *DomainInformationContainer
	// contains filtered or unexported fields
}

Specifies details about an outbound connection.

type OutboundConnectionStatus 

type OutboundConnectionStatus struct {

	// Verbose information for the outbound connection status.
	Message *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 OutboundConnectionStatusCode
	// contains filtered or unexported fields
}

The connection status of an outbound cross-cluster connection.

type OutboundConnectionStatusCode 

type OutboundConnectionStatusCode string
const (
	OutboundConnectionStatusCodeValidating        OutboundConnectionStatusCode = "VALIDATING"
	OutboundConnectionStatusCodeValidationFailed  OutboundConnectionStatusCode = "VALIDATION_FAILED"
	OutboundConnectionStatusCodePendingAcceptance OutboundConnectionStatusCode = "PENDING_ACCEPTANCE"
	OutboundConnectionStatusCodeApproved          OutboundConnectionStatusCode = "APPROVED"
	OutboundConnectionStatusCodeProvisioning      OutboundConnectionStatusCode = "PROVISIONING"
	OutboundConnectionStatusCodeActive            OutboundConnectionStatusCode = "ACTIVE"
	OutboundConnectionStatusCodeRejecting         OutboundConnectionStatusCode = "REJECTING"
	OutboundConnectionStatusCodeRejected          OutboundConnectionStatusCode = "REJECTED"
	OutboundConnectionStatusCodeDeleting          OutboundConnectionStatusCode = "DELETING"
	OutboundConnectionStatusCodeDeleted           OutboundConnectionStatusCode = "DELETED"
)

Enum values for OutboundConnectionStatusCode

func (OutboundConnectionStatusCode) Values 

func (OutboundConnectionStatusCode) Values() []OutboundConnectionStatusCode

Values returns all known values for OutboundConnectionStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OverallChangeStatus added in v1.8.0 

type OverallChangeStatus string
const (
	OverallChangeStatusPending    OverallChangeStatus = "PENDING"
	OverallChangeStatusProcessing OverallChangeStatus = "PROCESSING"
	OverallChangeStatusCompleted  OverallChangeStatus = "COMPLETED"
	OverallChangeStatusFailed     OverallChangeStatus = "FAILED"
)

Enum values for OverallChangeStatus

func (OverallChangeStatus) Values added in v1.8.0 

func (OverallChangeStatus) Values() []OverallChangeStatus

Values returns all known values for OverallChangeStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PackageDetails 

type PackageDetails struct {
	AvailablePackageVersion *string

	// The timestamp of when the package was created.
	CreatedAt *time.Time

	// Additional information if the package is in an error state. Null otherwise.
	ErrorDetails *ErrorDetails

	LastUpdatedAt *time.Time

	// User-specified description of the package.
	PackageDescription *string

	// Internal ID of the package.
	PackageID *string

	// User-specified name of the package.
	PackageName *string

	// Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE,
	// DELETING, and DELETE_FAILED.
	PackageStatus PackageStatus

	// Currently supports only TXT-DICTIONARY.
	PackageType PackageType
	// contains filtered or unexported fields
}

Basic information about a package.

type PackageSource 

type PackageSource struct {

	// The name of the Amazon S3 bucket containing the package.
	S3BucketName *string

	// Key (file name) of the package.
	S3Key *string
	// contains filtered or unexported fields
}

The Amazon S3 location for importing the package specified as S3BucketName and S3Key

type PackageStatus 

type PackageStatus string
const (
	PackageStatusCopying          PackageStatus = "COPYING"
	PackageStatusCopyFailed       PackageStatus = "COPY_FAILED"
	PackageStatusValidating       PackageStatus = "VALIDATING"
	PackageStatusValidationFailed PackageStatus = "VALIDATION_FAILED"
	PackageStatusAvailable        PackageStatus = "AVAILABLE"
	PackageStatusDeleting         PackageStatus = "DELETING"
	PackageStatusDeleted          PackageStatus = "DELETED"
	PackageStatusDeleteFailed     PackageStatus = "DELETE_FAILED"
)

Enum values for PackageStatus

func (PackageStatus) Values 

func (PackageStatus) Values() []PackageStatus

Values returns all known values for PackageStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PackageType 

type PackageType string
const (
	PackageTypeTxtDictionary PackageType = "TXT-DICTIONARY"
)

Enum values for PackageType

func (PackageType) Values 

func (PackageType) Values() []PackageType

Values returns all known values for PackageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PackageVersionHistory 

type PackageVersionHistory struct {

	// A message associated with the package version.
	CommitMessage *string

	// The timestamp of when the package was created.
	CreatedAt *time.Time

	// The package version.
	PackageVersion *string
	// contains filtered or unexported fields
}

Details of a package version.

type RecurringCharge 

type RecurringCharge struct {

	// The monetary amount of the recurring charge.
	RecurringChargeAmount *float64

	// The frequency of the recurring charge.
	RecurringChargeFrequency *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.

type ReservedInstance 

type ReservedInstance struct {
	BillingSubscriptionId *int64

	// The currency code for the reserved OpenSearch instance offering.
	CurrencyCode *string

	// The duration, in seconds, for which the OpenSearch instance is reserved.
	Duration int32

	// The upfront fixed charge you will paid to purchase the specific reserved
	// OpenSearch instance offering.
	FixedPrice *float64

	// The number of OpenSearch instances that have been reserved.
	InstanceCount int32

	// The OpenSearch instance type offered by the reserved instance offering.
	InstanceType OpenSearchPartitionInstanceType

	// The payment option as defined in the reserved OpenSearch instance offering.
	PaymentOption ReservedInstancePaymentOption

	// The charge to your account regardless of whether you are creating any domains
	// using the instance offering.
	RecurringCharges []RecurringCharge

	// The customer-specified identifier to track this reservation.
	ReservationName *string

	// The unique identifier for the reservation.
	ReservedInstanceId *string

	// The offering identifier.
	ReservedInstanceOfferingId *string

	// The time the reservation started.
	StartTime *time.Time

	// The state of the reserved OpenSearch instance.
	State *string

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

Details of a reserved OpenSearch instance.

type ReservedInstanceOffering 

type ReservedInstanceOffering struct {

	// The currency code for the reserved OpenSearch instance offering.
	CurrencyCode *string

	// The duration, in seconds, for which the offering will reserve the OpenSearch
	// instance.
	Duration int32

	// The upfront fixed charge you will pay to purchase the specific reserved
	// OpenSearch instance offering.
	FixedPrice *float64

	// The OpenSearch instance type offered by the reserved instance offering.
	InstanceType OpenSearchPartitionInstanceType

	// Payment option for the reserved OpenSearch instance offering
	PaymentOption ReservedInstancePaymentOption

	// The charge to your account regardless of whether you are creating any domains
	// using the instance offering.
	RecurringCharges []RecurringCharge

	// The OpenSearch reserved instance offering identifier.
	ReservedInstanceOfferingId *string

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

Details of a reserved OpenSearch instance offering.

type ReservedInstancePaymentOption 

type ReservedInstancePaymentOption string
const (
	ReservedInstancePaymentOptionAllUpfront     ReservedInstancePaymentOption = "ALL_UPFRONT"
	ReservedInstancePaymentOptionPartialUpfront ReservedInstancePaymentOption = "PARTIAL_UPFRONT"
	ReservedInstancePaymentOptionNoUpfront      ReservedInstancePaymentOption = "NO_UPFRONT"
)

Enum values for ReservedInstancePaymentOption

func (ReservedInstancePaymentOption) Values 

func (ReservedInstancePaymentOption) Values() []ReservedInstancePaymentOption

Values returns all known values for ReservedInstancePaymentOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *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) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RollbackOnDisable 

type RollbackOnDisable string
const (
	RollbackOnDisableNoRollback      RollbackOnDisable = "NO_ROLLBACK"
	RollbackOnDisableDefaultRollback RollbackOnDisable = "DEFAULT_ROLLBACK"
)

Enum values for RollbackOnDisable

func (RollbackOnDisable) Values 

func (RollbackOnDisable) Values() []RollbackOnDisable

Values returns all known values for RollbackOnDisable. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SAMLIdp 

type SAMLIdp struct {

	// The unique entity ID of the application in SAML identity provider.
	//
	// This member is required.
	EntityId *string

	// The metadata of the SAML application in XML format.
	//
	// This member is required.
	MetadataContent *string
	// contains filtered or unexported fields
}

The SAML identity povider's information.

type SAMLOptionsInput 

type SAMLOptionsInput struct {

	// True if SAML is enabled.
	Enabled *bool

	// The SAML Identity Provider's information.
	Idp *SAMLIdp

	// The backend role that the SAML master user is mapped to.
	MasterBackendRole *string

	// The SAML master username, which is stored in the Amazon OpenSearch Service
	// domain's internal database.
	MasterUserName *string

	// Element of the SAML assertion to use for backend roles. Default is roles.
	RolesKey *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 *int32

	// Element of the SAML assertion to use for username. Default is NameID.
	SubjectKey *string
	// contains filtered or unexported fields
}

The SAML application configuration for the domain.

type SAMLOptionsOutput 

type SAMLOptionsOutput struct {

	// True if SAML is enabled.
	Enabled *bool

	// Describes the SAML identity provider's information.
	Idp *SAMLIdp

	// The key used for matching the SAML roles attribute.
	RolesKey *string

	// The duration, in minutes, after which a user session becomes inactive.
	SessionTimeoutMinutes *int32

	// The key used for matching the SAML subject attribute.
	SubjectKey *string
	// contains filtered or unexported fields
}

Describes the SAML application configured for the domain.

type ScheduledAutoTuneActionType 

type ScheduledAutoTuneActionType string
const (
	ScheduledAutoTuneActionTypeJvmHeapSizeTuning ScheduledAutoTuneActionType = "JVM_HEAP_SIZE_TUNING"
	ScheduledAutoTuneActionTypeJvmYoungGenTuning ScheduledAutoTuneActionType = "JVM_YOUNG_GEN_TUNING"
)

Enum values for ScheduledAutoTuneActionType

func (ScheduledAutoTuneActionType) Values 

func (ScheduledAutoTuneActionType) Values() []ScheduledAutoTuneActionType

Values returns all known values for ScheduledAutoTuneActionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ScheduledAutoTuneDetails 

type ScheduledAutoTuneDetails struct {

	// The Auto-Tune action description.
	Action *string

	// The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and
	// JVM_YOUNG_GEN_TUNING.
	ActionType ScheduledAutoTuneActionType

	// The timestamp of the Auto-Tune action scheduled for the domain.
	Date *time.Time

	// The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
	Severity 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.

type ScheduledAutoTuneSeverityType 

type ScheduledAutoTuneSeverityType string
const (
	ScheduledAutoTuneSeverityTypeLow    ScheduledAutoTuneSeverityType = "LOW"
	ScheduledAutoTuneSeverityTypeMedium ScheduledAutoTuneSeverityType = "MEDIUM"
	ScheduledAutoTuneSeverityTypeHigh   ScheduledAutoTuneSeverityType = "HIGH"
)

Enum values for ScheduledAutoTuneSeverityType

func (ScheduledAutoTuneSeverityType) Values 

func (ScheduledAutoTuneSeverityType) Values() []ScheduledAutoTuneSeverityType

Values returns all known values for ScheduledAutoTuneSeverityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

	// True if you're able to cancel your service software version update. False if you
	// can't cancel your service software update.
	Cancellable *bool

	// The current service software version present on the domain.
	CurrentVersion *string

	// The description of the UpdateStatus.
	Description *string

	// The new service software version if one is available.
	NewVersion *string

	// True if a service software is never automatically updated. False if a service
	// software is automatically updated after AutomatedUpdateDate.
	OptionalDeployment *bool

	// True if you're able to update your service software version. False if you can't
	// update your service software version.
	UpdateAvailable *bool

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

The current options of an domain service software options.

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 *int32
	// 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.

type SnapshotOptionsStatus 

type SnapshotOptionsStatus struct {

	// The daily snapshot options specified for the domain.
	//
	// This member is required.
	Options *SnapshotOptions

	// The status of a daily automated snapshot.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of a daily automated snapshot.

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
	//
	// * gp3
	//
	// * io1
	//
	// See
	// VolumeType for more information regarding each EBS storage option.
	StorageSubTypeName *string

	// Limits that are applicable for the given storage type.
	StorageTypeLimits []StorageTypeLimit

	// 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
	// contains filtered or unexported fields
}

StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.

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.
	// * MaximumThroughput
	//  Maximum amount of
	// Throughput that is applicable for given the storage type. Can be empty if not
	// applicable.
	// * MinimumThroughput
	//  Minimum amount of Throughput that is applicable
	// for given the storage type. Can be empty if not applicable.
	LimitName *string

	// Values for the StorageTypeLimit$LimitName .
	LimitValues []string
	// contains filtered or unexported fields
}

Limits that are applicable for the given storage type.

type TLSSecurityPolicy 

type TLSSecurityPolicy string
const (
	TLSSecurityPolicyPolicyMinTls10201907 TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"
	TLSSecurityPolicyPolicyMinTls12201907 TLSSecurityPolicy = "Policy-Min-TLS-1-2-2019-07"
)

Enum values for TLSSecurityPolicy

func (TLSSecurityPolicy) Values 

func (TLSSecurityPolicy) Values() []TLSSecurityPolicy

Values returns all known values for TLSSecurityPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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.
	//
	// This member is required.
	Key *string

	// 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
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A key value pair for a resource tag.

type TimeUnit 

type TimeUnit string
const (
	TimeUnitHours TimeUnit = "HOURS"
)

Enum values for TimeUnit

func (TimeUnit) Values 

func (TimeUnit) Values() []TimeUnit

Values returns all known values for TimeUnit. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

	// A list of UpgradeStepItem s representing information about each step performed
	// as part of a specific upgrade or upgrade eligibility check.
	StepsList []UpgradeStepItem

	// A string that briefly describes the upgrade.
	UpgradeName *string

	// The current status of the upgrade. The status can take one of the following
	// values:
	//
	// * In Progress
	//
	// * Succeeded
	//
	// * Succeeded with Issues
	//
	// * Failed
	UpgradeStatus UpgradeStatus
	// contains filtered or unexported fields
}

History of the last 10 upgrades and upgrade eligibility checks.

type UpgradeStatus 

type UpgradeStatus string
const (
	UpgradeStatusInProgress          UpgradeStatus = "IN_PROGRESS"
	UpgradeStatusSucceeded           UpgradeStatus = "SUCCEEDED"
	UpgradeStatusSucceededWithIssues UpgradeStatus = "SUCCEEDED_WITH_ISSUES"
	UpgradeStatusFailed              UpgradeStatus = "FAILED"
)

Enum values for UpgradeStatus

func (UpgradeStatus) Values 

func (UpgradeStatus) Values() []UpgradeStatus

Values returns all known values for UpgradeStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UpgradeStep 

type UpgradeStep string
const (
	UpgradeStepPreUpgradeCheck UpgradeStep = "PRE_UPGRADE_CHECK"
	UpgradeStepSnapshot        UpgradeStep = "SNAPSHOT"
	UpgradeStepUpgrade         UpgradeStep = "UPGRADE"
)

Enum values for UpgradeStep

func (UpgradeStep) Values 

func (UpgradeStep) Values() []UpgradeStep

Values returns all known values for UpgradeStep. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UpgradeStepItem 

type UpgradeStepItem struct {

	// A list of strings containing detailed information about the errors encountered
	// in a particular step.
	Issues []string

	// The floating point value representing the progress percentage of a particular
	// step.
	ProgressPercent *float64

	// One of three steps an upgrade or upgrade eligibility check goes through:
	//
	// *
	// PreUpgradeCheck
	//
	// * Snapshot
	//
	// * Upgrade
	UpgradeStep UpgradeStep

	// The current status of the upgrade. The status can take one of the following
	// values:
	//
	// * In Progress
	//
	// * Succeeded
	//
	// * Succeeded with Issues
	//
	// * Failed
	UpgradeStepStatus UpgradeStatus
	// contains filtered or unexported fields
}

Represents a single step of the upgrade or upgrade eligibility check workflow.

type VPCDerivedInfo 

type VPCDerivedInfo struct {

	// The Availability Zones for the domain. Exists only if the domain was created
	// with VPCOptions.
	AvailabilityZones []string

	// The security groups for the VPC endpoint.
	SecurityGroupIds []string

	// The subnets for the VPC endpoint.
	SubnetIds []string

	// The VPC ID for the domain. Exists only if the domain was created with
	// VPCOptions.
	VPCId *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).

type VPCDerivedInfoStatus 

type VPCDerivedInfoStatus struct {

	// The VPC options for the specified domain.
	//
	// This member is required.
	Options *VPCDerivedInfo

	// The status of the VPC options for the specified domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

Status of the VPC options for the specified domain.

type VPCOptions 

type VPCOptions struct {

	// The security groups for the VPC endpoint.
	SecurityGroupIds []string

	// The subnets for the VPC endpoint.
	SubnetIds []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).

type ValidationException 

type ValidationException struct {
	Message *string
	// contains filtered or unexported fields
}

An exception for missing / invalid input fields. Gives http status code of 400.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VersionStatus 

type VersionStatus struct {

	// The OpenSearch version for the specified OpenSearch domain.
	//
	// This member is required.
	Options *string

	// The status of the OpenSearch version options for the specified OpenSearch
	// domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The status of the OpenSearch version options for the specified OpenSearch domain.

type VolumeType 

type VolumeType string
const (
	VolumeTypeStandard VolumeType = "standard"
	VolumeTypeGp2      VolumeType = "gp2"
	VolumeTypeIo1      VolumeType = "io1"
	VolumeTypeGp3      VolumeType = "gp3"
)

Enum values for VolumeType

func (VolumeType) Values 

func (VolumeType) Values() []VolumeType

Values returns all known values for VolumeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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 *int32
	// contains filtered or unexported fields
}

The zone awareness configuration for the domain cluster, such as the number of availability zones.

Source Files

View all Source files

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.