types

package
v1.17.3 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPolicyDetail 

type AccessPolicyDetail struct {

	// The date the policy was created.
	CreatedDate *int64

	// The description of the policy.
	Description *string

	// The timestamp of when the policy was last modified.
	LastModifiedDate *int64

	// The name of the policy.
	Name *string

	// The JSON policy document without any whitespaces.
	Policy document.Interface

	// The version of the policy.
	PolicyVersion *string

	// The type of access policy.
	Type AccessPolicyType
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless access policy.

type AccessPolicyStats 

type AccessPolicyStats struct {

	// The number of data access policies in the current account.
	DataPolicyCount *int64
	// contains filtered or unexported fields
}

Statistics for an OpenSearch Serverless access policy.

type AccessPolicySummary 

type AccessPolicySummary struct {

	// The Epoch time when the access policy was created.
	CreatedDate *int64

	// The description of the access policy.
	Description *string

	// The date and time when the collection was last modified.
	LastModifiedDate *int64

	// The name of the access policy.
	Name *string

	// The version of the policy.
	PolicyVersion *string

	// The type of access policy. Currently, the only available type is data .
	Type AccessPolicyType
	// contains filtered or unexported fields
}

A summary of the data access policy.

type AccessPolicyType 

type AccessPolicyType string
const (
	// data policy type
	AccessPolicyTypeData AccessPolicyType = "data"
)

Enum values for AccessPolicyType

func (AccessPolicyType) Values 

func (AccessPolicyType) Values() []AccessPolicyType

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

type AccountSettingsDetail struct {

	// The maximum capacity limits for all OpenSearch Serverless collections, in
	// OpenSearch Compute Units (OCUs). These limits are used to scale your collections
	// based on the current workload. For more information, see [Managing capacity limits for Amazon OpenSearch Serverless].
	//
	// [Managing capacity limits for Amazon OpenSearch Serverless]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html
	CapacityLimits *CapacityLimits
	// contains filtered or unexported fields
}

OpenSearch Serverless-related information for the current account.

type CapacityLimits 

type CapacityLimits struct {

	// The maximum indexing capacity for collections.
	MaxIndexingCapacityInOCU *int32

	// The maximum search capacity for collections.
	MaxSearchCapacityInOCU *int32
	// contains filtered or unexported fields
}

The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

type CollectionDetail 

type CollectionDetail struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string

	// Collection-specific endpoint used to submit index, search, and data upload
	// requests to an OpenSearch Serverless collection.
	CollectionEndpoint *string

	// The Epoch time when the collection was created.
	CreatedDate *int64

	// Collection-specific endpoint used to access OpenSearch Dashboards.
	DashboardEndpoint *string

	// A description of the collection.
	Description *string

	// A failure code associated with the request.
	FailureCode *string

	// A message associated with the failure code.
	FailureMessage *string

	// A unique identifier for the collection.
	Id *string

	// The ARN of the Amazon Web Services KMS key used to encrypt the collection.
	KmsKeyArn *string

	// The date and time when the collection was last modified.
	LastModifiedDate *int64

	// The name of the collection.
	Name *string

	// Details about an OpenSearch Serverless collection.
	StandbyReplicas StandbyReplicas

	// The current status of the collection.
	Status CollectionStatus

	// The type of collection.
	Type CollectionType
	// contains filtered or unexported fields
}

Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

type CollectionErrorDetail 

type CollectionErrorDetail struct {

	// The error code for the request. For example, NOT_FOUND .
	ErrorCode *string

	// A description of the error. For example, The specified Collection is not found.
	ErrorMessage *string

	// If the request contains collection IDs, the response includes the IDs provided
	// in the request.
	Id *string

	// If the request contains collection names, the response includes the names
	// provided in the request.
	Name *string
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

type CollectionFilters 

type CollectionFilters struct {

	// The name of the collection.
	Name *string

	// The current status of the collection.
	Status CollectionStatus
	// contains filtered or unexported fields
}

A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.

type CollectionStatus 

type CollectionStatus string
const (
	// Creating collection resource
	CollectionStatusCreating CollectionStatus = "CREATING"
	// Deleting collection resource
	CollectionStatusDeleting CollectionStatus = "DELETING"
	// Collection resource is ready to use
	CollectionStatusActive CollectionStatus = "ACTIVE"
	// Collection resource create or delete failed
	CollectionStatusFailed CollectionStatus = "FAILED"
)

Enum values for CollectionStatus

func (CollectionStatus) Values 

func (CollectionStatus) Values() []CollectionStatus

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

type CollectionSummary struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string

	// The unique identifier of the collection.
	Id *string

	// The name of the collection.
	Name *string

	// The current status of the collection.
	Status CollectionStatus
	// contains filtered or unexported fields
}

Details about each OpenSearch Serverless collection.

type CollectionType 

type CollectionType string
const (
	// Search collection type
	CollectionTypeSearch CollectionType = "SEARCH"
	// Timeseries collection type
	CollectionTypeTimeseries CollectionType = "TIMESERIES"
	// Vectorsearch collection type
	CollectionTypeVectorsearch CollectionType = "VECTORSEARCH"
)

Enum values for CollectionType

func (CollectionType) Values 

func (CollectionType) Values() []CollectionType

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

When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.

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 CreateCollectionDetail 

type CreateCollectionDetail struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string

	// The Epoch time when the collection was created.
	CreatedDate *int64

	// A description of the collection.
	Description *string

	// The unique identifier of the collection.
	Id *string

	// The Amazon Resource Name (ARN) of the KMS key with which to encrypt the
	// collection.
	KmsKeyArn *string

	// The date and time when the collection was last modified.
	LastModifiedDate *int64

	// The name of the collection.
	Name *string

	// Creates details about an OpenSearch Serverless collection.
	StandbyReplicas StandbyReplicas

	// The current status of the collection.
	Status CollectionStatus

	// The type of collection.
	Type CollectionType
	// contains filtered or unexported fields
}

Details about the created OpenSearch Serverless collection.

type CreateIamIdentityCenterConfigOptions added in v1.17.0 

type CreateIamIdentityCenterConfigOptions struct {

	// The ARN of the IAM Identity Center instance used to integrate with OpenSearch
	// Serverless.
	//
	// This member is required.
	InstanceArn *string

	// The group attribute for this IAM Identity Center integration. Defaults to
	// GroupId .
	GroupAttribute IamIdentityCenterGroupAttribute

	// The user attribute for this IAM Identity Center integration. Defaults to UserId .
	UserAttribute IamIdentityCenterUserAttribute
	// contains filtered or unexported fields
}

Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.

type CreateVpcEndpointDetail 

type CreateVpcEndpointDetail struct {

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

	// The name of the endpoint.
	Name *string

	// The current status in the endpoint creation process.
	Status VpcEndpointStatus
	// contains filtered or unexported fields
}

Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

type DeleteCollectionDetail 

type DeleteCollectionDetail struct {

	// The unique identifier of the collection.
	Id *string

	// The name of the collection.
	Name *string

	// The current status of the collection.
	Status CollectionStatus
	// contains filtered or unexported fields
}

Details about a deleted OpenSearch Serverless collection.

type DeleteVpcEndpointDetail 

type DeleteVpcEndpointDetail struct {

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

	// The name of the endpoint.
	Name *string

	// The current status of the endpoint deletion process.
	Status VpcEndpointStatus
	// contains filtered or unexported fields
}

Deletion details for an OpenSearch Serverless-managed interface endpoint.

type EffectiveLifecyclePolicyDetail added in v1.6.0 

type EffectiveLifecyclePolicyDetail struct {

	// The minimum number of index retention days set. That is an optional param that
	// will return as true if the minimum number of days or hours is not set to a
	// index resource.
	NoMinRetentionPeriod *bool

	// The name of the lifecycle policy.
	PolicyName *string

	// The name of the OpenSearch Serverless index resource.
	Resource *string

	// The type of OpenSearch Serverless resource. Currently, the only supported
	// resource is index .
	ResourceType ResourceType

	// The minimum number of index retention in days or hours. This is an optional
	// parameter that will return only if it’s set.
	RetentionPeriod *string

	// The type of lifecycle policy.
	Type LifecyclePolicyType
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

type EffectiveLifecyclePolicyErrorDetail added in v1.6.0 

type EffectiveLifecyclePolicyErrorDetail struct {

	// The error code for the request.
	ErrorCode *string

	// A description of the error. For example, The specified Index resource is not
	// found .
	ErrorMessage *string

	// The name of OpenSearch Serverless index resource.
	Resource *string

	// The type of lifecycle policy.
	Type LifecyclePolicyType
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

type IamIdentityCenterConfigOptions added in v1.17.0 

type IamIdentityCenterConfigOptions struct {

	// The ARN of the IAM Identity Center application used to integrate with
	// OpenSearch Serverless.
	ApplicationArn *string

	// The description of the IAM Identity Center application used to integrate with
	// OpenSearch Serverless.
	ApplicationDescription *string

	// The name of the IAM Identity Center application used to integrate with
	// OpenSearch Serverless.
	ApplicationName *string

	// The group attribute for this IAM Identity Center integration. Defaults to
	// GroupId .
	GroupAttribute IamIdentityCenterGroupAttribute

	// The ARN of the IAM Identity Center instance used to integrate with OpenSearch
	// Serverless.
	InstanceArn *string

	// The user attribute for this IAM Identity Center integration. Defaults to UserId
	UserAttribute IamIdentityCenterUserAttribute
	// contains filtered or unexported fields
}

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

type IamIdentityCenterGroupAttribute added in v1.17.0 

type IamIdentityCenterGroupAttribute string
const (
	// Group ID
	IamIdentityCenterGroupAttributeGroupId IamIdentityCenterGroupAttribute = "GroupId"
	// Group Name
	IamIdentityCenterGroupAttributeGroupName IamIdentityCenterGroupAttribute = "GroupName"
)

Enum values for IamIdentityCenterGroupAttribute

func (IamIdentityCenterGroupAttribute) Values added in v1.17.0 

func (IamIdentityCenterGroupAttribute) Values() []IamIdentityCenterGroupAttribute

Values returns all known values for IamIdentityCenterGroupAttribute. 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 IamIdentityCenterUserAttribute added in v1.17.0 

type IamIdentityCenterUserAttribute string
const (
	// User ID
	IamIdentityCenterUserAttributeUserId IamIdentityCenterUserAttribute = "UserId"
	// User Name
	IamIdentityCenterUserAttributeUserName IamIdentityCenterUserAttribute = "UserName"
	// Email
	IamIdentityCenterUserAttributeEmail IamIdentityCenterUserAttribute = "Email"
)

Enum values for IamIdentityCenterUserAttribute

func (IamIdentityCenterUserAttribute) Values added in v1.17.0 

func (IamIdentityCenterUserAttribute) Values() []IamIdentityCenterUserAttribute

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

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Thrown when an error internal to the service occurs while processing a request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

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

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type LifecyclePolicyDetail added in v1.6.0 

type LifecyclePolicyDetail struct {

	// The date the lifecycle policy was created.
	CreatedDate *int64

	// The description of the lifecycle policy.
	Description *string

	// The timestamp of when the lifecycle policy was last modified.
	LastModifiedDate *int64

	// The name of the lifecycle policy.
	Name *string

	// The JSON policy document without any whitespaces.
	Policy document.Interface

	// The version of the lifecycle policy.
	PolicyVersion *string

	// The type of lifecycle policy.
	Type LifecyclePolicyType
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless lifecycle policy.

type LifecyclePolicyErrorDetail added in v1.6.0 

type LifecyclePolicyErrorDetail struct {

	// The error code for the request. For example, NOT_FOUND .
	ErrorCode *string

	// A description of the error. For example, The specified Lifecycle Policy is not
	// found .
	ErrorMessage *string

	// The name of the lifecycle policy.
	Name *string

	// The type of lifecycle policy.
	Type LifecyclePolicyType
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

type LifecyclePolicyIdentifier added in v1.6.0 

type LifecyclePolicyIdentifier struct {

	// The name of the lifecycle policy.
	//
	// This member is required.
	Name *string

	// The type of lifecycle policy.
	//
	// This member is required.
	Type LifecyclePolicyType
	// contains filtered or unexported fields
}

The unique identifiers of policy types and policy names.

type LifecyclePolicyResourceIdentifier added in v1.6.0 

type LifecyclePolicyResourceIdentifier struct {

	// The name of the OpenSearch Serverless ilndex resource.
	//
	// This member is required.
	Resource *string

	// The type of lifecycle policy.
	//
	// This member is required.
	Type LifecyclePolicyType
	// contains filtered or unexported fields
}

The unique identifiers of policy types and resource names.

type LifecyclePolicyStats added in v1.6.0 

type LifecyclePolicyStats struct {

	// The number of retention lifecycle policies in the current account.
	RetentionPolicyCount *int64
	// contains filtered or unexported fields
}

Statistics for an OpenSearch Serverless lifecycle policy.

type LifecyclePolicySummary added in v1.6.0 

type LifecyclePolicySummary struct {

	// The Epoch time when the lifecycle policy was created.
	CreatedDate *int64

	// The description of the lifecycle policy.
	Description *string

	// The date and time when the lifecycle policy was last modified.
	LastModifiedDate *int64

	// The name of the lifecycle policy.
	Name *string

	// The version of the lifecycle policy.
	PolicyVersion *string

	// The type of lifecycle policy.
	Type LifecyclePolicyType
	// contains filtered or unexported fields
}

A summary of the lifecycle policy.

type LifecyclePolicyType added in v1.6.0 

type LifecyclePolicyType string
const (
	// retention policy type
	LifecyclePolicyTypeRetention LifecyclePolicyType = "retention"
)

Enum values for LifecyclePolicyType

func (LifecyclePolicyType) Values added in v1.6.0 

func (LifecyclePolicyType) Values() []LifecyclePolicyType

Values returns all known values for LifecyclePolicyType. 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 OcuLimitExceededException added in v1.2.0 

type OcuLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.

func (*OcuLimitExceededException) Error added in v1.2.0 

func (e *OcuLimitExceededException) Error() string

func (*OcuLimitExceededException) ErrorCode added in v1.2.0 

func (e *OcuLimitExceededException) ErrorCode() string

func (*OcuLimitExceededException) ErrorFault added in v1.2.0 

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

func (*OcuLimitExceededException) ErrorMessage added in v1.2.0 

func (e *OcuLimitExceededException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Thrown when accessing or deleting a resource that does not 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 ResourceType added in v1.6.0 

type ResourceType string
const (
	// index resource type
	ResourceTypeIndex ResourceType = "index"
)

Enum values for ResourceType

func (ResourceType) Values added in v1.6.0 

func (ResourceType) Values() []ResourceType

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

type SamlConfigOptions struct {

	// The XML IdP metadata file generated from your identity provider.
	//
	// This member is required.
	Metadata *string

	// The group attribute for this SAML integration.
	GroupAttribute *string

	// The session timeout, in minutes. Default is 60 minutes (12 hours).
	SessionTimeout *int32

	// A user attribute for this SAML integration.
	UserAttribute *string
	// contains filtered or unexported fields
}

Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

type SecurityConfigDetail 

type SecurityConfigDetail struct {

	// The version of the security configuration.
	ConfigVersion *string

	// The date the configuration was created.
	CreatedDate *int64

	// The description of the security configuration.
	Description *string

	// Describes IAM Identity Center options in the form of a key-value map.
	IamIdentityCenterOptions *IamIdentityCenterConfigOptions

	// The unique identifier of the security configuration.
	Id *string

	// The timestamp of when the configuration was last modified.
	LastModifiedDate *int64

	// SAML options for the security configuration in the form of a key-value map.
	SamlOptions *SamlConfigOptions

	// The type of security configuration.
	Type SecurityConfigType
	// contains filtered or unexported fields
}

Details about a security configuration for OpenSearch Serverless.

type SecurityConfigStats 

type SecurityConfigStats struct {

	// The number of security configurations in the current account.
	SamlConfigCount *int64
	// contains filtered or unexported fields
}

Statistics for an OpenSearch Serverless security configuration.

type SecurityConfigSummary 

type SecurityConfigSummary struct {

	// The version of the security configuration.
	ConfigVersion *string

	// The Epoch time when the security configuration was created.
	CreatedDate *int64

	// The description of the security configuration.
	Description *string

	// The unique identifier of the security configuration.
	Id *string

	// The timestamp of when the configuration was last modified.
	LastModifiedDate *int64

	// The type of security configuration.
	Type SecurityConfigType
	// contains filtered or unexported fields
}

A summary of a security configuration for OpenSearch Serverless.

type SecurityConfigType 

type SecurityConfigType string
const (
	// saml provider
	SecurityConfigTypeSaml SecurityConfigType = "saml"
	// iam identity center
	SecurityConfigTypeIamidentitycenter SecurityConfigType = "iamidentitycenter"
)

Enum values for SecurityConfigType

func (SecurityConfigType) Values 

func (SecurityConfigType) Values() []SecurityConfigType

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

type SecurityPolicyDetail struct {

	// The date the policy was created.
	CreatedDate *int64

	// The description of the security policy.
	Description *string

	// The timestamp of when the policy was last modified.
	LastModifiedDate *int64

	// The name of the policy.
	Name *string

	// The JSON policy document without any whitespaces.
	Policy document.Interface

	// The version of the policy.
	PolicyVersion *string

	// The type of security policy.
	Type SecurityPolicyType
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless security policy.

type SecurityPolicyStats 

type SecurityPolicyStats struct {

	// The number of encryption policies in the current account.
	EncryptionPolicyCount *int64

	// The number of network policies in the current account.
	NetworkPolicyCount *int64
	// contains filtered or unexported fields
}

Statistics for an OpenSearch Serverless security policy.

type SecurityPolicySummary 

type SecurityPolicySummary struct {

	// The date the policy was created.
	CreatedDate *int64

	// The description of the security policy.
	Description *string

	// The timestamp of when the policy was last modified.
	LastModifiedDate *int64

	// The name of the policy.
	Name *string

	// The version of the policy.
	PolicyVersion *string

	// The type of security policy.
	Type SecurityPolicyType
	// contains filtered or unexported fields
}

A summary of a security policy for OpenSearch Serverless.

type SecurityPolicyType 

type SecurityPolicyType string
const (
	// encryption policy type
	SecurityPolicyTypeEncryption SecurityPolicyType = "encryption"
	// network policy type
	SecurityPolicyTypeNetwork SecurityPolicyType = "network"
)

Enum values for SecurityPolicyType

func (SecurityPolicyType) Values 

func (SecurityPolicyType) Values() []SecurityPolicyType

Values returns all known values for SecurityPolicyType. 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 ServiceQuotaExceededException added in v1.2.0 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

Thrown when you attempt to create more resources than the service allows based on service quotas.

func (*ServiceQuotaExceededException) Error added in v1.2.0 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode added in v1.2.0 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault added in v1.2.0 

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

func (*ServiceQuotaExceededException) ErrorMessage added in v1.2.0 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type StandbyReplicas added in v1.9.0 

type StandbyReplicas string
const (
	// Standby replicas enabled
	StandbyReplicasEnabled StandbyReplicas = "ENABLED"
	// Standby replicas disabled
	StandbyReplicasDisabled StandbyReplicas = "DISABLED"
)

Enum values for StandbyReplicas

func (StandbyReplicas) Values added in v1.9.0 

func (StandbyReplicas) Values() []StandbyReplicas

Values returns all known values for StandbyReplicas. 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 key to use in the tag.
	//
	// This member is required.
	Key *string

	// The value of the tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A map of key-value pairs associated to an OpenSearch Serverless resource.

type UpdateCollectionDetail 

type UpdateCollectionDetail struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string

	// The date and time when the collection was created.
	CreatedDate *int64

	// The description of the collection.
	Description *string

	// The unique identifier of the collection.
	Id *string

	// The date and time when the collection was last modified.
	LastModifiedDate *int64

	// The name of the collection.
	Name *string

	// The current status of the collection.
	Status CollectionStatus

	// The collection type.
	Type CollectionType
	// contains filtered or unexported fields
}

Details about an updated OpenSearch Serverless collection.

type UpdateIamIdentityCenterConfigOptions added in v1.17.0 

type UpdateIamIdentityCenterConfigOptions struct {

	// The group attribute for this IAM Identity Center integration. Defaults to
	// GroupId .
	GroupAttribute IamIdentityCenterGroupAttribute

	// The user attribute for this IAM Identity Center integration. Defaults to UserId .
	UserAttribute IamIdentityCenterUserAttribute
	// contains filtered or unexported fields
}

Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.

type UpdateVpcEndpointDetail 

type UpdateVpcEndpointDetail struct {

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

	// The timestamp of when the endpoint was last modified.
	LastModifiedDate *int64

	// The name of the endpoint.
	Name *string

	// The unique identifiers of the security groups that define the ports, protocols,
	// and sources for inbound traffic that you are authorizing into your endpoint.
	SecurityGroupIds []string

	// The current status of the endpoint update process.
	Status VpcEndpointStatus

	// The ID of the subnets from which you access OpenSearch Serverless.
	SubnetIds []string
	// contains filtered or unexported fields
}

Update details for an OpenSearch Serverless-managed interface endpoint.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Thrown when the HTTP request contains invalid input or is missing required input.

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 VpcEndpointDetail 

type VpcEndpointDetail struct {

	// The date the endpoint was created.
	CreatedDate *int64

	// A failure code associated with the request.
	FailureCode *string

	// A message associated with the failure code.
	FailureMessage *string

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

	// The name of the endpoint.
	Name *string

	// The unique identifiers of the security groups that define the ports, protocols,
	// and sources for inbound traffic that you are authorizing into your endpoint.
	SecurityGroupIds []string

	// The current status of the endpoint.
	Status VpcEndpointStatus

	// The ID of the subnets from which you access OpenSearch Serverless.
	SubnetIds []string

	// The ID of the VPC from which you access OpenSearch Serverless.
	VpcId *string
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless-managed interface endpoint.

type VpcEndpointErrorDetail 

type VpcEndpointErrorDetail struct {

	// The error code for the failed request.
	ErrorCode *string

	// An error message describing the reason for the failure.
	ErrorMessage *string

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

Error information for a failed BatchGetVpcEndpoint request.

type VpcEndpointFilters 

type VpcEndpointFilters struct {

	// The current status of the endpoint.
	Status VpcEndpointStatus
	// contains filtered or unexported fields
}

Filter the results of a ListVpcEndpoints request.

type VpcEndpointStatus 

type VpcEndpointStatus string
const (
	// Pending VPCEndpoint resource
	VpcEndpointStatusPending VpcEndpointStatus = "PENDING"
	// Deleting VPCEndpoint resource
	VpcEndpointStatusDeleting VpcEndpointStatus = "DELETING"
	// VPCEndpoint resource is ready to use
	VpcEndpointStatusActive VpcEndpointStatus = "ACTIVE"
	// VPCEndpoint resource create or delete failed
	VpcEndpointStatusFailed VpcEndpointStatus = "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 unique identifier of the endpoint.
	Id *string

	// The name of the endpoint.
	Name *string

	// The current status of the endpoint.
	Status VpcEndpointStatus
	// contains filtered or unexported fields
}

The VPC endpoint object.

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.