types

package
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AWSDomainInformation 

type AWSDomainInformation struct {

	// Name of the domain.
	//
	// This member is required.
	DomainName *string

	// The Amazon Web Services account ID of the domain owner.
	OwnerId *string

	// The Amazon Web Services Region in which the domain is located.
	Region *string
	// contains filtered or unexported fields
}

Information about an Amazon OpenSearch Service domain.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occurred because you don't have permissions to access the resource.

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. For more information, see [Configuring access policies].
	//
	// [Configuring access policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies
	//
	// This member is required.
	Options *string

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

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

type ActionSeverity 

type ActionSeverity string
const (
	ActionSeverityHigh   ActionSeverity = "HIGH"
	ActionSeverityMedium ActionSeverity = "MEDIUM"
	ActionSeverityLow    ActionSeverity = "LOW"
)

Enum values for ActionSeverity

func (ActionSeverity) Values 

func (ActionSeverity) Values() []ActionSeverity

Values returns all known values for ActionSeverity. 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 ActionStatus 

type ActionStatus string
const (
	ActionStatusPendingUpdate ActionStatus = "PENDING_UPDATE"
	ActionStatusInProgress    ActionStatus = "IN_PROGRESS"
	ActionStatusFailed        ActionStatus = "FAILED"
	ActionStatusCompleted     ActionStatus = "COMPLETED"
	ActionStatusNotEligible   ActionStatus = "NOT_ELIGIBLE"
	ActionStatusEligible      ActionStatus = "ELIGIBLE"
)

Enum values for ActionStatus

func (ActionStatus) Values 

func (ActionStatus) Values() []ActionStatus

Values returns all known values for ActionStatus. 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 ActionType 

type ActionType string
const (
	ActionTypeServiceSoftwareUpdate ActionType = "SERVICE_SOFTWARE_UPDATE"
	ActionTypeJvmHeapSizeTuning     ActionType = "JVM_HEAP_SIZE_TUNING"
	ActionTypeJvmYoungGenTuning     ActionType = "JVM_YOUNG_GEN_TUNING"
)

Enum values for ActionType

func (ActionType) Values 

func (ActionType) Values() []ActionType

Values returns all known values for ActionType. 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 AdditionalLimit 

type AdditionalLimit struct {

	//   - MaximumNumberOfDataNodesSupported - This attribute only applies to master
	//   nodes and specifies the maximum number of data nodes of a given instance type a
	//   master node can support.
	//
	//   - MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to
	//   data nodes and specifies the maximum number of data nodes of a given instance
	//   type can exist without a master node governing them.
	LimitName *string

	//  The values of the additional instance type limits.
	LimitValues []string
	// contains filtered or unexported fields
}

List of limits that are specific to a given instance type.

type AdvancedOptionsStatus 

type AdvancedOptionsStatus struct {

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

	// The status of 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. The following options are available:

  • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

  • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

  • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

  • "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

type AdvancedSecurityOptions 

type AdvancedSecurityOptions struct {

	// Date and time when the migration period will be disabled. Only necessary when [enabling fine-grained access control on an existing domain].
	//
	// [enabling fine-grained access control on an existing domain]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing
	AnonymousAuthDisableDate *time.Time

	// True if a 30-day migration period is enabled, during which administrators can
	// create role mappings. Only necessary when [enabling fine-grained access control on an existing domain].
	//
	// [enabling fine-grained access control on an existing domain]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing
	AnonymousAuthEnabled *bool

	// True if fine-grained access control is enabled.
	Enabled *bool

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

	// Container for information about the SAML configuration for OpenSearch
	// Dashboards.
	SAMLOptions *SAMLOptionsOutput
	// contains filtered or unexported fields
}

Container for fine-grained access control settings.

type AdvancedSecurityOptionsInput 

type AdvancedSecurityOptionsInput struct {

	// True to enable a 30-day migration period during which administrators can create
	// role mappings. Only necessary when [enabling fine-grained access control on an existing domain].
	//
	// [enabling fine-grained access control on an existing domain]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing
	AnonymousAuthEnabled *bool

	// True to enable fine-grained access control.
	Enabled *bool

	// True to enable the internal user database.
	InternalUserDatabaseEnabled *bool

	// Container for information about the master user.
	MasterUserOptions *MasterUserOptions

	// Container for information about the SAML configuration for OpenSearch
	// Dashboards.
	SAMLOptions *SAMLOptionsInput
	// contains filtered or unexported fields
}

Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.

type AdvancedSecurityOptionsStatus 

type AdvancedSecurityOptionsStatus struct {

	// Container for fine-grained access control settings.
	//
	// This member is required.
	Options *AdvancedSecurityOptions

	// Status of the fine-grained access control settings for a domain.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The status of fine-grained access control settings for a domain.

type AuthorizedPrincipal 

type AuthorizedPrincipal struct {

	// The [IAM principal] that is allowed access to the domain.
	//
	// [IAM principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html
	Principal *string

	// The type of principal.
	PrincipalType PrincipalType
	// contains filtered or unexported fields
}

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

type AutoTune 

type AutoTune struct {

	// Details about an Auto-Tune action.
	AutoTuneDetails *AutoTuneDetails

	// The type of Auto-Tune action.
	AutoTuneType AutoTuneType
	// contains filtered or unexported fields
}

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

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 {

	// Container for details about a scheduled Auto-Tune action.
	ScheduledAutoTuneDetails *ScheduledAutoTuneDetails
	// contains filtered or unexported fields
}

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service .

type AutoTuneMaintenanceSchedule 

type AutoTuneMaintenanceSchedule struct {

	// A cron expression for a recurring maintenance schedule during which Auto-Tune
	// can deploy changes.
	CronExpressionForRecurrence *string

	// The duration of the maintenance schedule. For example, "Duration": {"Value": 2,
	// "Unit": "HOURS"} .
	Duration *Duration

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

This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

type AutoTuneOptions 

type AutoTuneOptions struct {

	// Whether Auto-Tune is enabled or disabled.
	DesiredState AutoTuneDesiredState

	// DEPRECATED. Use [off-peak window] instead.
	//
	// A list of maintenance schedules during which Auto-Tune can deploy changes.
	//
	// [off-peak window]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
	MaintenanceSchedules []AutoTuneMaintenanceSchedule

	// When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune
	// settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If
	// you specify DEFAULT_ROLLBACK , you must include a MaintenanceSchedule in the
	// request. Otherwise, OpenSearch Service is unable to perform the rollback.
	RollbackOnDisable RollbackOnDisable

	// Whether to use the domain's [off-peak window] to deploy configuration changes on the domain
	// rather than a maintenance schedule.
	//
	// [off-peak window]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
	UseOffPeakWindow *bool
	// contains filtered or unexported fields
}

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

type AutoTuneOptionsInput 

type AutoTuneOptionsInput struct {

	// Whether Auto-Tune is enabled or disabled.
	DesiredState AutoTuneDesiredState

	// A list of maintenance schedules during which Auto-Tune can deploy changes.
	// Maintenance windows are deprecated and have been replaced with [off-peak windows].
	//
	// [off-peak windows]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
	MaintenanceSchedules []AutoTuneMaintenanceSchedule

	// Whether to schedule Auto-Tune optimizations that require blue/green deployments
	// during the domain's configured daily off-peak window.
	UseOffPeakWindow *bool
	// contains filtered or unexported fields
}

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

type AutoTuneOptionsOutput 

type AutoTuneOptionsOutput struct {

	// Any errors that occurred while enabling or disabling Auto-Tune.
	ErrorMessage *string

	// The current state of Auto-Tune on the domain.
	State AutoTuneState

	// Whether the domain's off-peak window will be used to deploy Auto-Tune changes
	// rather than a maintenance schedule.
	UseOffPeakWindow *bool
	// contains filtered or unexported fields
}

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

type AutoTuneOptionsStatus 

type AutoTuneOptionsStatus struct {

	// Auto-Tune settings for updating a domain.
	Options *AutoTuneOptions

	// The current status of Auto-Tune for a 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 {

	// Date and time when Auto-Tune was enabled for the domain.
	//
	// This member is required.
	CreationDate *time.Time

	// The current state of Auto-Tune on the domain.
	//
	// This member is required.
	State AutoTuneState

	// Date and time when the Auto-Tune options were last updated for the domain.
	//
	// This member is required.
	UpdateDate *time.Time

	// Any errors that occurred 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
}

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

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 AvailabilityZoneInfo 

type AvailabilityZoneInfo struct {

	// The name of the Availability Zone.
	AvailabilityZoneName *string

	// The number of data nodes active in the Availability Zone.
	AvailableDataNodeCount *string

	// The total number of data nodes configured in the Availability Zone.
	ConfiguredDataNodeCount *string

	// The total number of primary and replica shards in the Availability Zone.
	TotalShards *string

	// The total number of primary and replica shards that aren't allocated to any of
	// the nodes in the Availability Zone.
	TotalUnAssignedShards *string

	// The current state of the Availability Zone. Current options are Active and
	// StandBy .
	//
	//   - Active - Data nodes in the Availability Zone are in use.
	//
	//   - StandBy - Data nodes in the Availability Zone are in a standby state.
	//
	//   - NotAvailable - Unable to retrieve information.
	ZoneStatus ZoneStatus
	// contains filtered or unexported fields
}

Information about an Availability Zone on a domain.

type BaseException 

type BaseException struct {
	Message *string

	ErrorCodeOverride *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 CancelledChangeProperty 

type CancelledChangeProperty struct {

	// The current value of the property, after the change was cancelled.
	ActiveValue *string

	// The pending value of the property that was cancelled. This would have been the
	// eventual value of the property if the chance had not been cancelled.
	CancelledValue *string

	// The name of the property whose change was cancelled.
	PropertyName *string
	// contains filtered or unexported fields
}

A property change that was cancelled for an Amazon OpenSearch Service domain.

type ChangeProgressDetails 

type ChangeProgressDetails struct {

	// The ID of the configuration change.
	ChangeId *string

	// The current status of the configuration change.
	ConfigChangeStatus ConfigChangeStatus

	// The IAM principal who initiated the configuration change.
	InitiatedBy InitiatedBy

	// The last time that the configuration change was updated.
	LastUpdatedTime *time.Time

	// A message corresponding to the status of the configuration change.
	Message *string

	// The time that the configuration change was initiated, in Universal Coordinated
	// Time (UTC).
	StartTime *time.Time
	// contains filtered or unexported fields
}

Container for information about a configuration change happening on a domain.

type ChangeProgressStage 

type ChangeProgressStage struct {

	// The description of the stage.
	Description *string

	// The most recent updated timestamp of the stage.
	LastUpdated *time.Time

	// The name of the stage.
	Name *string

	// The status of the stage.
	Status *string
	// contains filtered or unexported fields
}

Progress details for each stage of a domain update.

type ChangeProgressStatusDetails 

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 in the domain configuration change that have completed.
	CompletedProperties []string

	// The current status of the configuration change.
	ConfigChangeStatus ConfigChangeStatus

	// The IAM principal who initiated the configuration change.
	InitiatedBy InitiatedBy

	// The last time that the status of the configuration change was updated.
	LastUpdatedTime *time.Time

	// The list of properties in the domain configuration change that are still
	// 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.
	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 {

	// Container for cold storage configuration options.
	ColdStorageOptions *ColdStorageOptions

	// Number of dedicated master nodes in the cluster. This number must be greater
	// than 2 and not 4, otherwise you receive a validation exception.
	DedicatedMasterCount *int32

	// Indicates whether dedicated master nodes are enabled for the cluster. True if
	// the cluster will use a dedicated master node. False if the cluster will not.
	DedicatedMasterEnabled *bool

	// OpenSearch Service instance type of the dedicated master nodes in the cluster.
	DedicatedMasterType OpenSearchPartitionInstanceType

	// Number of data nodes in the cluster. This number must be greater than 1,
	// otherwise you receive a validation exception.
	InstanceCount *int32

	// Instance type of data nodes in the cluster.
	InstanceType OpenSearchPartitionInstanceType

	// A boolean that indicates whether a multi-AZ domain is turned on with a standby
	// AZ. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service].
	//
	// [Configuring a multi-AZ domain in Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html
	MultiAZWithStandbyEnabled *bool

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

	// Whether to enable warm storage for the cluster.
	WarmEnabled *bool

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

	// Container for zone awareness configuration options. Only required if
	// ZoneAwarenessEnabled is true .
	ZoneAwarenessConfig *ZoneAwarenessConfig

	// Indicates whether multiple Availability Zones are enabled. For more
	// information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service].
	//
	// [Configuring a multi-AZ domain in Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html
	ZoneAwarenessEnabled *bool
	// contains filtered or unexported fields
}

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

type ClusterConfigStatus 

type ClusterConfigStatus struct {

	// Cluster configuration options for the specified domain.
	//
	// This member is required.
	Options *ClusterConfig

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

The cluster configuration status for a domain.

type CognitoOptions 

type CognitoOptions struct {

	// Whether to enable or disable Amazon Cognito authentication for OpenSearch
	// Dashboards.
	Enabled *bool

	// The Amazon Cognito identity pool ID that you want OpenSearch Service to use for
	// OpenSearch Dashboards authentication.
	IdentityPoolId *string

	// The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to
	// configure your user pool and identity pool.
	RoleArn *string

	// The Amazon Cognito user pool ID that you want OpenSearch Service to use for
	// OpenSearch Dashboards authentication.
	UserPoolId *string
	// contains filtered or unexported fields
}

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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 {

	// Whether to enable or disable cold storage on the domain. You must enable
	// UltraWarm storage to enable cold storage.
	//
	// This member is required.
	Enabled *bool
	// contains filtered or unexported fields
}

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

type CompatibleVersionsMap 

type CompatibleVersionsMap struct {

	// The current version that the OpenSearch Service domain is running.
	SourceVersion *string

	// The possible versions that you can upgrade the domain to.
	TargetVersions []string
	// contains filtered or unexported fields
}

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

type ConfigChangeStatus 

type ConfigChangeStatus string
const (
	ConfigChangeStatusPending          ConfigChangeStatus = "Pending"
	ConfigChangeStatusInitializing     ConfigChangeStatus = "Initializing"
	ConfigChangeStatusValidating       ConfigChangeStatus = "Validating"
	ConfigChangeStatusValidationFailed ConfigChangeStatus = "ValidationFailed"
	ConfigChangeStatusApplyingChanges  ConfigChangeStatus = "ApplyingChanges"
	ConfigChangeStatusCompleted        ConfigChangeStatus = "Completed"
	ConfigChangeStatusPendingUserInput ConfigChangeStatus = "PendingUserInput"
	ConfigChangeStatusCancelled        ConfigChangeStatus = "Cancelled"
)

Enum values for ConfigChangeStatus

func (ConfigChangeStatus) Values 

func (ConfigChangeStatus) Values() []ConfigChangeStatus

Values returns all known values for ConfigChangeStatus. 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 ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occurred because the client attempts to remove a resource that is currently in use.

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 ConnectionMode 

type ConnectionMode string
const (
	ConnectionModeDirect      ConnectionMode = "DIRECT"
	ConnectionModeVpcEndpoint ConnectionMode = "VPC_ENDPOINT"
)

Enum values for ConnectionMode

func (ConnectionMode) Values 

func (ConnectionMode) Values() []ConnectionMode

Values returns all known values for ConnectionMode. 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 ConnectionProperties 

type ConnectionProperties struct {

	// The connection properties for cross cluster search.
	CrossClusterSearch *CrossClusterSearchConnectionProperties

	// The Endpoint attribute cannot be modified.
	//
	// The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.
	Endpoint *string
	// contains filtered or unexported fields
}

The connection properties of an outbound connection.

type CrossClusterSearchConnectionProperties 

type CrossClusterSearchConnectionProperties struct {

	// The status of the SkipUnavailable setting for the outbound connection. This
	// feature allows you to specify some clusters as optional and ensure that your
	// cross-cluster queries return partial results despite failures on one or more
	// remote clusters.
	SkipUnavailable SkipUnavailableStatus
	// contains filtered or unexported fields
}

Cross-cluster search specific connection properties.

type DataSourceDetails 

type DataSourceDetails struct {

	// The type of data source.
	DataSourceType DataSourceType

	// A description of the data source.
	Description *string

	// The name of the data source.
	Name *string

	// The status of the data source.
	Status DataSourceStatus
	// contains filtered or unexported fields
}

Details about a direct-query data source.

type DataSourceStatus 

type DataSourceStatus string
const (
	DataSourceStatusActive   DataSourceStatus = "ACTIVE"
	DataSourceStatusDisabled DataSourceStatus = "DISABLED"
)

Enum values for DataSourceStatus

func (DataSourceStatus) Values 

func (DataSourceStatus) Values() []DataSourceStatus

Values returns all known values for DataSourceStatus. 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 DataSourceType 

type DataSourceType interface {
	// contains filtered or unexported methods
}

The type of data source.

The following types satisfy this interface: 

DataSourceTypeMemberS3GlueDataCatalog
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/opensearch/types"
	"fmt"
)

func main() {
	var union types.DataSourceType
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DataSourceTypeMemberS3GlueDataCatalog:
		_ = v.Value // Value is types.S3GlueDataCatalog

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *types.S3GlueDataCatalog

Output:

type DataSourceTypeMemberS3GlueDataCatalog 

type DataSourceTypeMemberS3GlueDataCatalog struct {
	Value S3GlueDataCatalog
	// contains filtered or unexported fields
}

An Amazon S3 data source.

type DependencyFailureException 

type DependencyFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

func (*DependencyFailureException) Error 

func (e *DependencyFailureException) Error() string

func (*DependencyFailureException) ErrorCode 

func (e *DependencyFailureException) ErrorCode() string

func (*DependencyFailureException) ErrorFault 

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

func (*DependencyFailureException) ErrorMessage 

func (e *DependencyFailureException) 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 non-empty list of values for the specified filter 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"
	DescribePackagesFilterNamePackageType   DescribePackagesFilterName = "PackageType"
	DescribePackagesFilterNameEngineVersion DescribePackagesFilterName = "EngineVersion"
)

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occured because the client wanted to access an unsupported operation.

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 {

	// Specifies the access policies for the domain.
	AccessPolicies *AccessPoliciesStatus

	// Key-value pairs to specify advanced configuration options. For more
	// information, see [Advanced options].
	//
	// [Advanced options]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
	AdvancedOptions *AdvancedOptionsStatus

	// Container for fine-grained access control settings for the domain.
	AdvancedSecurityOptions *AdvancedSecurityOptionsStatus

	// Container for Auto-Tune settings for the domain.
	AutoTuneOptions *AutoTuneOptionsStatus

	// Container for information about the progress of an existing configuration
	// change.
	ChangeProgressDetails *ChangeProgressDetails

	// Container for the cluster configuration of a the domain.
	ClusterConfig *ClusterConfigStatus

	// Container for Amazon Cognito options for the domain.
	CognitoOptions *CognitoOptionsStatus

	// Additional options for the domain endpoint, such as whether to require HTTPS
	// for all traffic.
	DomainEndpointOptions *DomainEndpointOptionsStatus

	// Container for EBS options configured for the domain.
	EBSOptions *EBSOptionsStatus

	// Key-value pairs to enable encryption at rest.
	EncryptionAtRestOptions *EncryptionAtRestOptionsStatus

	// The OpenSearch or Elasticsearch version that the domain is running.
	EngineVersion *VersionStatus

	// Choose either dual stack or IPv4 as your IP address type. Dual stack allows you
	// to share domain resources across IPv4 and IPv6 address types, and is the
	// recommended option. If you set your IP address type to dual stack, you can't
	// change your address type later.
	IPAddressType *IPAddressTypeStatus

	// Key-value pairs to configure log publishing.
	LogPublishingOptions *LogPublishingOptionsStatus

	// Information about the domain properties that are currently being modified.
	ModifyingProperties []ModifyingProperties

	// Whether node-to-node encryption is enabled or disabled.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus

	// Container for off-peak window options for the domain.
	OffPeakWindowOptions *OffPeakWindowOptionsStatus

	// DEPRECATED. Container for parameters required to configure automated snapshots
	// of domain indexes.
	SnapshotOptions *SnapshotOptionsStatus

	// Software update options for the domain.
	SoftwareUpdateOptions *SoftwareUpdateOptionsStatus

	// The current VPC options for the domain and the status of any updates to their
	// configuration.
	VPCOptions *VPCDerivedInfoStatus
	// contains filtered or unexported fields
}

Container for the configuration of an OpenSearch Service domain.

type DomainEndpointOptions 

type DomainEndpointOptions struct {

	// The fully qualified URL for the custom endpoint.
	CustomEndpoint *string

	// The ARN for your security certificate, managed in Amazon Web Services
	// Certificate Manager (ACM).
	CustomEndpointCertificateArn *string

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

	// True to require that all traffic to the domain arrive over HTTPS.
	EnforceHTTPS *bool

	// Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
	// The policy can be one of the following values:
	//
	//   - Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version
	//   1.0 to TLS version 1.2
	//
	//   - Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS
	//   version 1.2
	//
	//   - Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS
	//   version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
	TLSSecurityPolicy TLSSecurityPolicy
	// contains filtered or unexported fields
}

Options to configure a custom endpoint for an OpenSearch Service domain.

type DomainEndpointOptionsStatus 

type DomainEndpointOptionsStatus struct {

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

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

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

type DomainHealth 

type DomainHealth string
const (
	DomainHealthRed          DomainHealth = "Red"
	DomainHealthYellow       DomainHealth = "Yellow"
	DomainHealthGreen        DomainHealth = "Green"
	DomainHealthNotAvailable DomainHealth = "NotAvailable"
)

Enum values for DomainHealth

func (DomainHealth) Values 

func (DomainHealth) Values() []DomainHealth

Values returns all known values for DomainHealth. 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 DomainInfo 

type DomainInfo struct {

	// Name of the domain.
	DomainName *string

	// The type of search engine that the domain is running. OpenSearch for an
	// OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
	EngineType EngineType
	// contains filtered or unexported fields
}

Information about an OpenSearch Service domain.

type DomainInformationContainer 

type DomainInformationContainer struct {

	// Information about an Amazon OpenSearch Service domain.
	AWSDomainInformation *AWSDomainInformation
	// contains filtered or unexported fields
}

Container for information about an OpenSearch Service domain.

type DomainMaintenanceDetails 

type DomainMaintenanceDetails struct {

	// The name of the action.
	Action MaintenanceType

	// The time at which the action was created.
	CreatedAt *time.Time

	// The name of the domain.
	DomainName *string

	// The ID of the requested action.
	MaintenanceId *string

	// The ID of the data node.
	NodeId *string

	// The status of the action.
	Status MaintenanceStatus

	// The status message for the action.
	StatusMessage *string

	// The time at which the action was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Container for the domain maintenance details.

type DomainNodesStatus 

type DomainNodesStatus struct {

	// The Availability Zone of the node.
	AvailabilityZone *string

	// The instance type information of the node.
	InstanceType OpenSearchPartitionInstanceType

	// The ID of the node.
	NodeId *string

	// Indicates if the node is active or in standby.
	NodeStatus NodeStatus

	// Indicates whether the nodes is a data, master, or ultrawarm node.
	NodeType NodeType

	// The storage size of the node, in GiB.
	StorageSize *string

	// Indicates if the node has EBS or instance storage.
	StorageType *string

	// If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only
	// applicable for data nodes.
	StorageVolumeType VolumeType
	// contains filtered or unexported fields
}

Container for information about nodes on the domain.

type DomainPackageDetails 

type DomainPackageDetails struct {

	// Name of the domain that the package is associated with.
	DomainName *string

	// State of the association.
	DomainPackageStatus DomainPackageStatus

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

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

	// Internal ID of the package.
	PackageID *string

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

	// The type of package.
	PackageType PackageType

	// The current version of the package.
	PackageVersion *string

	// The relative path of the package on the OpenSearch Service cluster nodes. This
	// is synonym_path when the package is for synonym files.
	ReferencePath *string
	// contains filtered or unexported fields
}

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

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 DomainProcessingStatusType 

type DomainProcessingStatusType string
const (
	DomainProcessingStatusTypeCreating  DomainProcessingStatusType = "Creating"
	DomainProcessingStatusTypeActive    DomainProcessingStatusType = "Active"
	DomainProcessingStatusTypeModifying DomainProcessingStatusType = "Modifying"
	DomainProcessingStatusTypeUpgrading DomainProcessingStatusType = "UpgradingEngineVersion"
	DomainProcessingStatusTypeUpdating  DomainProcessingStatusType = "UpdatingServiceSoftware"
	DomainProcessingStatusTypeIsolated  DomainProcessingStatusType = "Isolated"
	DomainProcessingStatusTypeDeleting  DomainProcessingStatusType = "Deleting"
)

Enum values for DomainProcessingStatusType

func (DomainProcessingStatusType) Values 

func (DomainProcessingStatusType) Values() []DomainProcessingStatusType

Values returns all known values for DomainProcessingStatusType. 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 DomainState 

type DomainState string
const (
	DomainStateActive       DomainState = "Active"
	DomainStateProcessing   DomainState = "Processing"
	DomainStateNotAvailable DomainState = "NotAvailable"
)

Enum values for DomainState

func (DomainState) Values 

func (DomainState) Values() []DomainState

Values returns all known values for DomainState. 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 the domain. For more information, see [IAM identifiers] in the
	// AWS Identity and Access Management User Guide.
	//
	// [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
	//
	// This member is required.
	ARN *string

	// Container for the cluster configuration of the domain.
	//
	// This member is required.
	ClusterConfig *ClusterConfig

	// Unique identifier for the domain.
	//
	// This member is required.
	DomainId *string

	// Name of the domain. Domain names are unique across all domains owned by the
	// same account within an Amazon Web Services Region.
	//
	// This member is required.
	DomainName *string

	// Identity and Access Management (IAM) policy document specifying the access
	// policies for the domain.
	AccessPolicies *string

	// Key-value pairs that specify advanced configuration options.
	AdvancedOptions map[string]string

	// Settings for fine-grained access control.
	AdvancedSecurityOptions *AdvancedSecurityOptions

	// Auto-Tune settings for the domain.
	AutoTuneOptions *AutoTuneOptionsOutput

	// Information about a configuration change happening on the domain.
	ChangeProgressDetails *ChangeProgressDetails

	// Key-value pairs to configure Amazon Cognito authentication for OpenSearch
	// Dashboards.
	CognitoOptions *CognitoOptions

	// Creation status of an OpenSearch Service domain. True if domain creation is
	// complete. False if domain creation is still in progress.
	Created *bool

	// Deletion status of an OpenSearch Service domain. True if domain deletion is
	// complete. False if domain deletion is still in progress. Once deletion is
	// complete, the status of the domain is no longer returned.
	Deleted *bool

	// Additional options for the domain endpoint, such as whether to require HTTPS
	// for all traffic.
	DomainEndpointOptions *DomainEndpointOptions

	// The dual stack hosted zone ID for the domain.
	DomainEndpointV2HostedZoneId *string

	// The status of any changes that are currently in progress for the domain.
	DomainProcessingStatus DomainProcessingStatusType

	// Container for EBS-based storage settings for the domain.
	EBSOptions *EBSOptions

	// Encryption at rest settings for the domain.
	EncryptionAtRestOptions *EncryptionAtRestOptions

	// Domain-specific endpoint used to submit index, search, and data upload requests
	// to the domain.
	Endpoint *string

	// If IPAddressType to set to dualstack , a version 2 domain endpoint is
	// provisioned. This endpoint functions like a normal endpoint, except that it
	// works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4
	// IP addresses.
	EndpointV2 *string

	// The key-value pair that exists if the OpenSearch Service domain uses VPC
	// endpoints. For example:
	//
	//   - IPv4 IP addresses -
	//   'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
	//
	//   - Dual stack IP addresses -
	//   'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
	Endpoints map[string]string

	// Version of OpenSearch or Elasticsearch that the domain is running, in the
	// format Elasticsearch_X.Y or OpenSearch_X.Y .
	EngineVersion *string

	// The type of IP addresses supported by the endpoint for the domain.
	IPAddressType IPAddressType

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

	// Information about the domain properties that are currently being modified.
	ModifyingProperties []ModifyingProperties

	// Whether node-to-node encryption is enabled or disabled.
	NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions

	// Options that specify a custom 10-hour window during which OpenSearch Service
	// can perform configuration changes on the domain.
	OffPeakWindowOptions *OffPeakWindowOptions

	// The status of the domain configuration. True if 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

	// DEPRECATED. Container for parameters required to configure automated snapshots
	// of domain indexes.
	SnapshotOptions *SnapshotOptions

	// Service software update options for the domain.
	SoftwareUpdateOptions *SoftwareUpdateOptions

	// The status of a domain version upgrade to a new version of OpenSearch or
	// Elasticsearch. True if OpenSearch Service is in the process of a version
	// upgrade. False if the configuration is active.
	UpgradeProcessing *bool

	// The VPC configuration for the domain.
	VPCOptions *VPCDerivedInfo
	// contains filtered or unexported fields
}

The current status of an OpenSearch Service domain.

type DryRunMode 

type DryRunMode string
const (
	DryRunModeBasic   DryRunMode = "Basic"
	DryRunModeVerbose DryRunMode = "Verbose"
)

Enum values for DryRunMode

func (DryRunMode) Values 

func (DryRunMode) Values() []DryRunMode

Values returns all known values for DryRunMode. 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 DryRunProgressStatus 

type DryRunProgressStatus struct {

	// The timestamp when the dry run was initiated.
	//
	// This member is required.
	CreationDate *string

	// The unique identifier of the dry run.
	//
	// This member is required.
	DryRunId *string

	// The current status of the dry run.
	//
	// This member is required.
	DryRunStatus *string

	// The timestamp when the dry run was last updated.
	//
	// This member is required.
	UpdateDate *string

	// Any validation failures that occurred as a result of the dry run.
	ValidationFailures []ValidationFailure
	// contains filtered or unexported fields
}

Information about the progress of a pre-upgrade dry run analysis.

type DryRunResults 

type DryRunResults struct {

	//  Specifies the way in which OpenSearch Service will apply an update. Possible
	// values are:
	//
	//   - Blue/Green - The update requires a blue/green deployment.
	//
	//   - DynamicUpdate - No blue/green deployment required
	//
	//   - Undetermined - The domain is in the middle of an update and can't predict
	//   the deployment type. Try again after the update is complete.
	//
	//   - None - The request doesn't include any configuration changes.
	DeploymentType *string

	// A message corresponding to the deployment type.
	Message *string
	// contains filtered or unexported fields
}

Results of a dry run performed in an update domain request.

type Duration 

type Duration struct {

	// The unit of measurement for the duration of a maintenance schedule.
	Unit TimeUnit

	// Integer to specify the value of a maintenance schedule duration.
	Value *int64
	// contains filtered or unexported fields
}

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

type EBSOptions 

type EBSOptions struct {

	// Indicates whether EBS volumes are attached to data nodes in an OpenSearch
	// Service domain.
	EBSEnabled *bool

	// Specifies the baseline input/output (I/O) performance of EBS volumes attached
	// to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume
	// types.
	Iops *int32

	// Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
	// Applicable only for the gp3 volume type.
	Throughput *int32

	// Specifies the size (in GiB) of EBS volumes attached to data nodes.
	VolumeSize *int32

	// Specifies the type of EBS volumes attached to data nodes.
	VolumeType VolumeType
	// contains filtered or unexported fields
}

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

type EBSOptionsStatus 

type EBSOptionsStatus struct {

	// The configured 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
}

The status of the EBS options for the specified OpenSearch Service domain.

type EncryptionAtRestOptions 

type EncryptionAtRestOptions struct {

	// True to enable encryption at rest.
	Enabled *bool

	// The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .
	KmsKeyId *string
	// contains filtered or unexported fields
}

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.

type EncryptionAtRestOptionsStatus 

type EncryptionAtRestOptionsStatus struct {

	// 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 OpenSearch Service domain.

type EngineType 

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

Enum values for EngineType

func (EngineType) Values 

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 EnvironmentInfo 

type EnvironmentInfo struct {

	//  A list of AvailabilityZoneInfo for the domain.
	AvailabilityZoneInformation []AvailabilityZoneInfo
	// contains filtered or unexported fields
}

Information about the active domain environment.

type ErrorDetails 

type ErrorDetails struct {

	// A message describing the error.
	ErrorMessage *string

	// The type of error that occurred.
	ErrorType *string
	// contains filtered or unexported fields
}

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

type Filter 

type Filter struct {

	// The name of the filter.
	Name *string

	// 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. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

type IPAddressType 

type IPAddressType string
const (
	IPAddressTypeIpv4      IPAddressType = "ipv4"
	IPAddressTypeDualstack IPAddressType = "dualstack"
)

Enum values for IPAddressType

func (IPAddressType) Values 

func (IPAddressType) Values() []IPAddressType

Values returns all known values for IPAddressType. 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 IPAddressTypeStatus 

type IPAddressTypeStatus struct {

	// The IP address options for the domain.
	//
	// This member is required.
	Options IPAddressType

	// Provides the current status of an entity.
	//
	// This member is required.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The IP address type status for the domain.

type InboundConnection 

type InboundConnection struct {

	// The unique identifier of the connection.
	ConnectionId *string

	// The connection mode.
	ConnectionMode ConnectionMode

	// The current status of the connection.
	ConnectionStatus *InboundConnectionStatus

	// Information about the source (local) domain.
	LocalDomainInfo *DomainInformationContainer

	// Information about the destination (remote) domain.
	RemoteDomainInfo *DomainInformationContainer
	// contains filtered or unexported fields
}

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

type InboundConnectionStatus 

type InboundConnectionStatus struct {

	// Information about the connection.
	Message *string

	// The status code for the 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 is being provisioned.
	//
	//   - 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 status of an inbound cross-cluster connection for OpenSearch Service.

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 InitiatedBy 

type InitiatedBy string
const (
	InitiatedByCustomer InitiatedBy = "CUSTOMER"
	InitiatedByService  InitiatedBy = "SERVICE"
)

Enum values for InitiatedBy

func (InitiatedBy) Values 

func (InitiatedBy) Values() []InitiatedBy

Values returns all known values for InitiatedBy. 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 {

	// The minimum allowed number of instances.
	MaximumInstanceCount int32

	// The maximum allowed number of instances.
	MinimumInstanceCount int32
	// contains filtered or unexported fields
}

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

type InstanceLimits 

type InstanceLimits struct {

	// Limits on the number of instances that can be created for a given instance type.
	InstanceCountLimits *InstanceCountLimits
	// contains filtered or unexported fields
}

Instance-related attributes that are available for a given instance type.

type InstanceTypeDetails 

type InstanceTypeDetails struct {

	// Whether fine-grained access control is supported for the instance type.
	AdvancedSecurityEnabled *bool

	// Whether logging is supported for the instance type.
	AppLogsEnabled *bool

	// The supported Availability Zones for the instance type.
	AvailabilityZones []string

	// Whether Amazon Cognito access is supported for the instance type.
	CognitoEnabled *bool

	// Whether encryption at rest and node-to-node encryption are supported for the
	// instance type.
	EncryptionEnabled *bool

	// Whether the instance acts as a data node, a dedicated master node, or an
	// UltraWarm node.
	InstanceRole []string

	// The instance type.
	InstanceType OpenSearchPartitionInstanceType

	// Whether UltraWarm is supported for the instance type.
	WarmEnabled *bool
	// contains filtered or unexported fields
}

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

type InternalException 

type InternalException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Request processing failed because of an unknown error, exception, or internal failure.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Request processing failed because you provided an invalid pagination token.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for trying to create or access a sub-resource that's either invalid or not supported.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for trying to create more than the allowed number of resources or sub-resources.

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 instance type for each
	// of its instance roles.
	AdditionalLimits []AdditionalLimit

	// The limits for a given instance type.
	InstanceLimits *InstanceLimits

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

Limits for a given instance type and for each of its roles.

type LogPublishingOption 

type LogPublishingOption struct {

	// The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
	CloudWatchLogsLogGroupArn *string

	// Whether the log should be published.
	Enabled *bool
	// contains filtered or unexported fields
}

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

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

type MaintenanceStatus string
const (
	MaintenanceStatusPending    MaintenanceStatus = "PENDING"
	MaintenanceStatusInProgress MaintenanceStatus = "IN_PROGRESS"
	MaintenanceStatusCompleted  MaintenanceStatus = "COMPLETED"
	MaintenanceStatusFailed     MaintenanceStatus = "FAILED"
	MaintenanceStatusTimedOut   MaintenanceStatus = "TIMED_OUT"
)

Enum values for MaintenanceStatus

func (MaintenanceStatus) Values 

func (MaintenanceStatus) Values() []MaintenanceStatus

Values returns all known values for MaintenanceStatus. 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 MaintenanceType 

type MaintenanceType string
const (
	MaintenanceTypeRebootNode           MaintenanceType = "REBOOT_NODE"
	MaintenanceTypeRestartSearchProcess MaintenanceType = "RESTART_SEARCH_PROCESS"
	MaintenanceTypeRestartDashboard     MaintenanceType = "RESTART_DASHBOARD"
)

Enum values for MaintenanceType

func (MaintenanceType) Values 

func (MaintenanceType) Values() []MaintenanceType

Values returns all known values for MaintenanceType. 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 MasterNodeStatus 

type MasterNodeStatus string
const (
	MasterNodeStatusAvailable   MasterNodeStatus = "Available"
	MasterNodeStatusUnAvailable MasterNodeStatus = "UnAvailable"
)

Enum values for MasterNodeStatus

func (MasterNodeStatus) Values 

func (MasterNodeStatus) Values() []MasterNodeStatus

Values returns all known values for MasterNodeStatus. 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 {

	// Amazon Resource Name (ARN) for the master user. Only specify if
	// InternalUserDatabaseEnabled is false .
	MasterUserARN *string

	// User name for the master user. Only specify if InternalUserDatabaseEnabled is
	// true .
	MasterUserName *string

	// Password for the master user. Only specify if InternalUserDatabaseEnabled is
	// true .
	MasterUserPassword *string
	// contains filtered or unexported fields
}

Credentials for the master user for a domain.

type ModifyingProperties 

type ModifyingProperties struct {

	// The current value of the domain property that is being modified.
	ActiveValue *string

	// The name of the property that is currently being modified.
	Name *string

	// The value that the property that is currently being modified will eventually
	// have.
	PendingValue *string

	// The type of value that is currently being modified. Properties can have two
	// types:
	//
	//   - PLAIN_TEXT : Contain direct values such as "1", "True", or "c5.large.search".
	//
	//   - STRINGIFIED_JSON : Contain content in JSON format, such as
	//   {"Enabled":"True"}".
	ValueType PropertyValueType
	// contains filtered or unexported fields
}

Information about the domain properties that are currently being modified.

type NodeStatus 

type NodeStatus string
const (
	NodeStatusActive       NodeStatus = "Active"
	NodeStatusStandBy      NodeStatus = "StandBy"
	NodeStatusNotAvailable NodeStatus = "NotAvailable"
)

Enum values for NodeStatus

func (NodeStatus) Values 

func (NodeStatus) Values() []NodeStatus

Values returns all known values for NodeStatus. 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 NodeToNodeEncryptionOptions 

type NodeToNodeEncryptionOptions struct {

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

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

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 NodeType 

type NodeType string
const (
	NodeTypeData      NodeType = "Data"
	NodeTypeUltrawarm NodeType = "Ultrawarm"
	NodeTypeMaster    NodeType = "Master"
)

Enum values for NodeType

func (NodeType) Values 

func (NodeType) Values() []NodeType

Values returns all known values for NodeType. 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 OffPeakWindow 

type OffPeakWindow struct {

	// A custom start time for the off-peak window, in Coordinated Universal Time
	// (UTC). The window length will always be 10 hours, so you can't specify an end
	// time. For example, if you specify 11:00 P.M. UTC as a start time, the end time
	// will automatically be set to 9:00 A.M.
	WindowStartTime *WindowStartTime
	// contains filtered or unexported fields
}

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.

If you don't specify a window start time, it defaults to 10:00 P.M. local time.

For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.

type OffPeakWindowOptions 

type OffPeakWindowOptions struct {

	// Whether to enable an off-peak window.
	//
	// This option is only available when modifying a domain created prior to February
	// 16, 2023, not when creating a new domain. All domains created after this date
	// have the off-peak window enabled by default. You can't disable the off-peak
	// window after it's enabled for a domain.
	Enabled *bool

	// Off-peak window settings for the domain.
	OffPeakWindow *OffPeakWindow
	// contains filtered or unexported fields
}

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

type OffPeakWindowOptionsStatus 

type OffPeakWindowOptionsStatus struct {

	// The domain's off-peak window configuration.
	Options *OffPeakWindowOptions

	// The current status of off-peak window options.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The status of off-peak window options for a 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"
	OpenSearchPartitionInstanceTypeOr1MediumSearch        OpenSearchPartitionInstanceType = "or1.medium.search"
	OpenSearchPartitionInstanceTypeOr1LargeSearch         OpenSearchPartitionInstanceType = "or1.large.search"
	OpenSearchPartitionInstanceTypeOr1XlargeSearch        OpenSearchPartitionInstanceType = "or1.xlarge.search"
	OpenSearchPartitionInstanceTypeOr12xlargeSearch       OpenSearchPartitionInstanceType = "or1.2xlarge.search"
	OpenSearchPartitionInstanceTypeOr14xlargeSearch       OpenSearchPartitionInstanceType = "or1.4xlarge.search"
	OpenSearchPartitionInstanceTypeOr18xlargeSearch       OpenSearchPartitionInstanceType = "or1.8xlarge.search"
	OpenSearchPartitionInstanceTypeOr112xlargeSearch      OpenSearchPartitionInstanceType = "or1.12xlarge.search"
	OpenSearchPartitionInstanceTypeOr116xlargeSearch      OpenSearchPartitionInstanceType = "or1.16xlarge.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 when the entity was created.
	//
	// This member is required.
	CreationDate *time.Time

	// The state of the entity.
	//
	// 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 entity is being deleted.
	PendingDeletion *bool

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

Provides the current status of an entity.

type OutboundConnection 

type OutboundConnection struct {

	// Name of the connection.
	ConnectionAlias *string

	// Unique identifier of the connection.
	ConnectionId *string

	// The connection mode.
	ConnectionMode ConnectionMode

	// Properties for the outbound connection.
	ConnectionProperties *ConnectionProperties

	// Status of the connection.
	ConnectionStatus *OutboundConnectionStatus

	// Information about the source (local) domain.
	LocalDomainInfo *DomainInformationContainer

	// Information about the destination (remote) domain.
	RemoteDomainInfo *DomainInformationContainer
	// contains filtered or unexported fields
}

Specifies details about an outbound cross-cluster connection.

type OutboundConnectionStatus 

type OutboundConnectionStatus struct {

	// Verbose information for the outbound connection.
	Message *string

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

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

Enum values for OverallChangeStatus

func (OverallChangeStatus) Values 

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 {

	// The package version.
	AvailablePackageVersion *string

	// If the package is a ZIP-PLUGIN package, additional information about plugin
	// properties.
	AvailablePluginProperties *PluginProperties

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

	// Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
	// OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
	EngineVersion *string

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

	// Date and time when the package was last updated.
	LastUpdatedAt *time.Time

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

	// The unique identifier of the package.
	PackageID *string

	// The user-specified name of the package.
	PackageName *string

	// The current status of the package. The available options are AVAILABLE , COPYING
	// , COPY_FAILED , VALIDATNG , VALIDATION_FAILED , DELETING , and DELETE_FAILED .
	PackageStatus PackageStatus

	// The type of package.
	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 to import the package from.

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"
	PackageTypeZipPlugin     PackageType = "ZIP-PLUGIN"
)

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 when it was uploaded.
	CommitMessage *string

	// The date and time when the package was created.
	CreatedAt *time.Time

	// The package version.
	PackageVersion *string

	// Additional information about plugin properties if the package is a ZIP-PLUGIN
	// package.
	PluginProperties *PluginProperties
	// contains filtered or unexported fields
}

Details about a package version.

type PluginProperties 

type PluginProperties struct {

	// The name of the class to load.
	ClassName *string

	// The description of the plugin.
	Description *string

	// The name of the plugin.
	Name *string

	// The uncompressed size of the plugin.
	UncompressedSizeInBytes *int64

	// The version of the plugin.
	Version *string
	// contains filtered or unexported fields
}

Basic information about the plugin.

type PrincipalType 

type PrincipalType string
const (
	PrincipalTypeAwsAccount PrincipalType = "AWS_ACCOUNT"
	PrincipalTypeAwsService PrincipalType = "AWS_SERVICE"
)

Enum values for PrincipalType

func (PrincipalType) Values 

func (PrincipalType) Values() []PrincipalType

Values returns all known values for PrincipalType. 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 PropertyValueType 

type PropertyValueType string
const (
	PropertyValueTypePlainText       PropertyValueType = "PLAIN_TEXT"
	PropertyValueTypeStringifiedJson PropertyValueType = "STRINGIFIED_JSON"
)

Enum values for PropertyValueType

func (PropertyValueType) Values 

func (PropertyValueType) Values() []PropertyValueType

Values returns all known values for PropertyValueType. 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 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 an OpenSearch Reserved Instance, or for a Reserved Instance offering.

type ReservedInstance 

type ReservedInstance struct {

	// The unique identifier of the billing subscription.
	BillingSubscriptionId *int64

	// The currency code for the 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
	// Instance offering.
	FixedPrice *float64

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

	// The OpenSearch instance type offered by theReserved Instance offering.
	InstanceType OpenSearchPartitionInstanceType

	// The payment option as defined in the Reserved Instance offering.
	PaymentOption ReservedInstancePaymentOption

	// The recurring charge to your account, regardless of whether you create any
	// domains using the Reserved Instance offering.
	RecurringCharges []RecurringCharge

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

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

	// The unique identifier of the Reserved Instance offering.
	ReservedInstanceOfferingId *string

	// The date and time when the reservation was purchased.
	StartTime *time.Time

	// The state of the Reserved Instance.
	State *string

	// The hourly rate at which you're charged for the domain using this Reserved
	// Instance.
	UsagePrice *float64
	// contains filtered or unexported fields
}

Details of an OpenSearch Reserved Instance.

type ReservedInstanceOffering 

type ReservedInstanceOffering struct {

	// The currency code for the Reserved 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
	// Instance offering.
	FixedPrice *float64

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

	// Payment option for the Reserved Instance offering
	PaymentOption ReservedInstancePaymentOption

	// The recurring charge to your account, regardless of whether you creates any
	// domains using the offering.
	RecurringCharges []RecurringCharge

	// The unique identifier of the Reserved Instance offering.
	ReservedInstanceOfferingId *string

	// The hourly rate at which you're charged for the domain using this Reserved
	// Instance.
	UsagePrice *float64
	// contains filtered or unexported fields
}

Details of an OpenSearch Reserved 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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for creating a resource that already exists.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for accessing or deleting a resource that doesn't exist.

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 S3GlueDataCatalog 

type S3GlueDataCatalog struct {

	// >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
	RoleArn *string
	// contains filtered or unexported fields
}

Information about the Amazon S3 Glue Data Catalog.

type SAMLIdp 

type SAMLIdp struct {

	// The unique entity ID of the application in the 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 information.

type SAMLOptionsInput 

type SAMLOptionsInput struct {

	// True to enable SAML authentication for a domain.
	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 user name, which is stored in the domain's internal user
	// 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 the user name. Default is NameID .
	SubjectKey *string
	// contains filtered or unexported fields
}

The SAML authentication configuration for an Amazon OpenSearch Service 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 ScheduleAt 

type ScheduleAt string
const (
	ScheduleAtNow           ScheduleAt = "NOW"
	ScheduleAtTimestamp     ScheduleAt = "TIMESTAMP"
	ScheduleAtOffPeakWindow ScheduleAt = "OFF_PEAK_WINDOW"
)

Enum values for ScheduleAt

func (ScheduleAt) Values 

func (ScheduleAt) Values() []ScheduleAt

Values returns all known values for ScheduleAt. 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 ScheduledAction 

type ScheduledAction struct {

	// The unique identifier of the scheduled action.
	//
	// This member is required.
	Id *string

	// The time when the change is scheduled to happen.
	//
	// This member is required.
	ScheduledTime *int64

	// The severity of the action.
	//
	// This member is required.
	Severity ActionSeverity

	// The type of action that will be taken on the domain.
	//
	// This member is required.
	Type ActionType

	// Whether or not the scheduled action is cancellable.
	Cancellable *bool

	// A description of the action to be taken.
	Description *string

	// Whether the action is required or optional.
	Mandatory *bool

	// Whether the action was scheduled manually ( CUSTOMER , or by OpenSearch Service
	// automatically ( SYSTEM ).
	ScheduledBy ScheduledBy

	// The current status of the scheduled action.
	Status ActionStatus
	// contains filtered or unexported fields
}

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software updateor a blue/green Auto-Tune enhancement.

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 {

	// A description of the Auto-Tune action.
	Action *string

	// The type of Auto-Tune action.
	ActionType ScheduledAutoTuneActionType

	// The date and time when the Auto-Tune action is scheduled for the domain.
	Date *time.Time

	// The severity of the Auto-Tune action. Valid values are LOW , MEDIUM , and HIGH .
	Severity ScheduledAutoTuneSeverityType
	// contains filtered or unexported fields
}

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service .

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 ScheduledBy 

type ScheduledBy string
const (
	ScheduledByCustomer ScheduledBy = "CUSTOMER"
	ScheduledBySystem   ScheduledBy = "SYSTEM"
)

Enum values for ScheduledBy

func (ScheduledBy) Values 

func (ScheduledBy) Values() []ScheduledBy

Values returns all known values for ScheduledBy. 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

	// A description of the service software update status.
	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 the automated update date.
	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.
	UpdateStatus DeploymentStatus
	// contains filtered or unexported fields
}

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

type SkipUnavailableStatus 

type SkipUnavailableStatus string
const (
	SkipUnavailableStatusEnabled  SkipUnavailableStatus = "ENABLED"
	SkipUnavailableStatusDisabled SkipUnavailableStatus = "DISABLED"
)

Enum values for SkipUnavailableStatus

func (SkipUnavailableStatus) Values 

func (SkipUnavailableStatus) Values() []SkipUnavailableStatus

Values returns all known values for SkipUnavailableStatus. 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 SlotNotAvailableException 

type SlotNotAvailableException struct {
	Message *string

	ErrorCodeOverride *string

	SlotSuggestions []int64
	// contains filtered or unexported fields
}

An exception for attempting to schedule a domain action during an unavailable time slot.

func (*SlotNotAvailableException) Error 

func (e *SlotNotAvailableException) Error() string

func (*SlotNotAvailableException) ErrorCode 

func (e *SlotNotAvailableException) ErrorCode() string

func (*SlotNotAvailableException) ErrorFault 

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

func (*SlotNotAvailableException) ErrorMessage 

func (e *SlotNotAvailableException) ErrorMessage() string

type SnapshotOptions 

type SnapshotOptions struct {

	// The time, in UTC format, when OpenSearch 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 OpenSearch 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
}

Container for information about a daily automated snapshot for an OpenSearch Service domain.

type SoftwareUpdateOptions 

type SoftwareUpdateOptions struct {

	// Whether automatic service software updates are enabled for the domain.
	AutoSoftwareUpdateEnabled *bool
	// contains filtered or unexported fields
}

Options for configuring service software updates for a domain.

type SoftwareUpdateOptionsStatus 

type SoftwareUpdateOptionsStatus struct {

	// The service software update options for a domain.
	Options *SoftwareUpdateOptions

	// The status of service software update options, including creation date and last
	// updated date.
	Status *OptionStatus
	// contains filtered or unexported fields
}

The status of the service software options for a domain.

type StorageType 

type StorageType struct {

	// The storage sub-type, such as gp3 or io1 .
	StorageSubTypeName *string

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

	// The name of the storage type.
	StorageTypeName *string
	// contains filtered or unexported fields
}

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

type StorageTypeLimit 

type StorageTypeLimit struct {

	//  Name of storage limits that are applicable for the given storage type. If
	// StorageType is ebs , the following options are available:
	//
	//   - MinimumVolumeSize - Minimum volume size that is available for the given
	//   storage type. Can be empty if not applicable.
	//
	//   - MaximumVolumeSize - Maximum volume size that is available for the given
	//   storage type. Can be empty if not applicable.
	//
	//   - MaximumIops - Maximum amount of IOPS that is available for the given the
	//   storage type. Can be empty if not applicable.
	//
	//   - MinimumIops - Minimum amount of IOPS that is available for the given the
	//   storage type. Can be empty if not applicable.
	//
	//   - MaximumThroughput - Maximum amount of throughput that is available for the
	//   given the storage type. Can be empty if not applicable.
	//
	//   - MinimumThroughput - Minimum amount of throughput that is available for the
	//   given the storage type. Can be empty if not applicable.
	LimitName *string

	// The limit values.
	LimitValues []string
	// contains filtered or unexported fields
}

Limits that are applicable for the given Amazon OpenSearch Service 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"
	TLSSecurityPolicyPolicyMinTls12Pfs202310 TLSSecurityPolicy = "Policy-Min-TLS-1-2-PFS-2023-10"
)

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 tag key. Tag keys must be unique for the domain to which they are attached.
	//
	// This member is required.
	Key *string

	// 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 tag (key-value pair) for an Amazon OpenSearch Service resource.

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 UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpgradeHistory 

type UpgradeHistory struct {

	// UTC timestamp at which the upgrade API call was made, in the format
	// yyyy-MM-ddTHH:mm:ssZ .
	StartTimestamp *time.Time

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

	// A string that 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 for an Amazon OpenSearch Service domain.

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 that 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 an upgrade or upgrade eligibility check workflow.

type VPCDerivedInfo 

type VPCDerivedInfo struct {

	// The list of Availability Zones associated with the VPC subnets.
	AvailabilityZones []string

	// The list of security group IDs associated with the VPC endpoints for the domain.
	SecurityGroupIds []string

	// A list of subnet IDs associated with the VPC endpoints for the domain.
	SubnetIds []string

	// The ID for your VPC. Amazon VPC generates this value when you create a VPC.
	VPCId *string
	// contains filtered or unexported fields
}

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions .

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 a specified domain.

type VPCOptions 

type VPCOptions struct {

	// The list of security group IDs associated with the VPC endpoints for the
	// domain. If you do not provide a security group ID, OpenSearch Service uses the
	// default security group for the VPC.
	SecurityGroupIds []string

	// A list of subnet IDs associated with the VPC endpoints for the domain. If your
	// domain uses multiple Availability Zones, you need to provide two subnet IDs, one
	// per zone. Otherwise, provide only one.
	SubnetIds []string
	// contains filtered or unexported fields
}

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for accessing or deleting a resource that doesn't exist.

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 ValidationFailure 

type ValidationFailure struct {

	// The error code of the failure.
	Code *string

	// A message corresponding to the failure.
	Message *string
	// contains filtered or unexported fields
}

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

type VersionStatus 

type VersionStatus struct {

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

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

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service 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 VpcEndpoint 

type VpcEndpoint struct {

	// The Amazon Resource Name (ARN) of the domain associated with the endpoint.
	DomainArn *string

	// The connection endpoint ID for connecting to the domain.
	Endpoint *string

	// The current status of the endpoint.
	Status VpcEndpointStatus

	// The unique identifier of the endpoint.
	VpcEndpointId *string

	// The creator of the endpoint.
	VpcEndpointOwner *string

	// Options to specify the subnets and security groups for an Amazon OpenSearch
	// Service VPC endpoint.
	VpcOptions *VPCDerivedInfo
	// contains filtered or unexported fields
}

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

type VpcEndpointError 

type VpcEndpointError struct {

	// The code associated with the error.
	ErrorCode VpcEndpointErrorCode

	// A message describing the error.
	ErrorMessage *string

	// The unique identifier of the endpoint.
	VpcEndpointId *string
	// contains filtered or unexported fields
}

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

type VpcEndpointErrorCode 

type VpcEndpointErrorCode string
const (
	VpcEndpointErrorCodeEndpointNotFound VpcEndpointErrorCode = "ENDPOINT_NOT_FOUND"
	VpcEndpointErrorCodeServerError      VpcEndpointErrorCode = "SERVER_ERROR"
)

Enum values for VpcEndpointErrorCode

func (VpcEndpointErrorCode) Values 

func (VpcEndpointErrorCode) Values() []VpcEndpointErrorCode

Values returns all known values for VpcEndpointErrorCode. 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 VpcEndpointStatus 

type VpcEndpointStatus string
const (
	VpcEndpointStatusCreating     VpcEndpointStatus = "CREATING"
	VpcEndpointStatusCreateFailed VpcEndpointStatus = "CREATE_FAILED"
	VpcEndpointStatusActive       VpcEndpointStatus = "ACTIVE"
	VpcEndpointStatusUpdating     VpcEndpointStatus = "UPDATING"
	VpcEndpointStatusUpdateFailed VpcEndpointStatus = "UPDATE_FAILED"
	VpcEndpointStatusDeleting     VpcEndpointStatus = "DELETING"
	VpcEndpointStatusDeleteFailed VpcEndpointStatus = "DELETE_FAILED"
)

Enum values for VpcEndpointStatus

func (VpcEndpointStatus) Values 

func (VpcEndpointStatus) Values() []VpcEndpointStatus

Values returns all known values for VpcEndpointStatus. 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 VpcEndpointSummary 

type VpcEndpointSummary struct {

	// The Amazon Resource Name (ARN) of the domain associated with the endpoint.
	DomainArn *string

	// The current status of the endpoint.
	Status VpcEndpointStatus

	// The unique identifier of the endpoint.
	VpcEndpointId *string

	// The creator of the endpoint.
	VpcEndpointOwner *string
	// contains filtered or unexported fields
}

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

type WindowStartTime 

type WindowStartTime struct {

	// The start hour of the window in Coordinated Universal Time (UTC), using 24-hour
	// time. For example, 17 refers to 5:00 P.M. UTC.
	//
	// This member is required.
	Hours int64

	// The start minute of the window, in UTC.
	//
	// This member is required.
	Minutes int64
	// contains filtered or unexported fields
}

The desired start time for an off-peak maintenance window.

type ZoneAwarenessConfig 

type ZoneAwarenessConfig struct {

	// If you enabled multiple Availability Zones, this value is the number of zones
	// that you want the domain to use. Valid values are 2 and 3 . If your domain is
	// provisioned within a VPC, this value be equal to number of subnets.
	AvailabilityZoneCount *int32
	// contains filtered or unexported fields
}

The zone awareness configuration for an Amazon OpenSearch Service domain.

type ZoneStatus 

type ZoneStatus string
const (
	ZoneStatusActive       ZoneStatus = "Active"
	ZoneStatusStandBy      ZoneStatus = "StandBy"
	ZoneStatusNotAvailable ZoneStatus = "NotAvailable"
)

Enum values for ZoneStatus

func (ZoneStatus) Values 

func (ZoneStatus) Values() []ZoneStatus

Values returns all known values for ZoneStatus. 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.

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.