opensearchserverless

package
v1.49.13 Latest Latest
Warning

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

 Go to latest Published: Dec 29, 2023 License: Apache-2.0 Imports: 9 Imported by: 6

Documentation

Overview

Package opensearchserverless provides the client and types for making API requests to OpenSearch Service Serverless.

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless? (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html)

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

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

Using the Client

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

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

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

See the OpenSearch Service Serverless client OpenSearchServerless for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/opensearchserverless/#New

Index

Constants

View Source 
const (
	// CollectionStatusCreating is a CollectionStatus enum value
	CollectionStatusCreating = "CREATING"

	// CollectionStatusDeleting is a CollectionStatus enum value
	CollectionStatusDeleting = "DELETING"

	// CollectionStatusActive is a CollectionStatus enum value
	CollectionStatusActive = "ACTIVE"

	// CollectionStatusFailed is a CollectionStatus enum value
	CollectionStatusFailed = "FAILED"
)
View Source 
const (
	// CollectionTypeSearch is a CollectionType enum value
	CollectionTypeSearch = "SEARCH"

	// CollectionTypeTimeseries is a CollectionType enum value
	CollectionTypeTimeseries = "TIMESERIES"

	// CollectionTypeVectorsearch is a CollectionType enum value
	CollectionTypeVectorsearch = "VECTORSEARCH"
)
View Source 
const (
	// SecurityPolicyTypeEncryption is a SecurityPolicyType enum value
	SecurityPolicyTypeEncryption = "encryption"

	// SecurityPolicyTypeNetwork is a SecurityPolicyType enum value
	SecurityPolicyTypeNetwork = "network"
)
View Source 
const (
	// StandbyReplicasEnabled is a StandbyReplicas enum value
	StandbyReplicasEnabled = "ENABLED"

	// StandbyReplicasDisabled is a StandbyReplicas enum value
	StandbyReplicasDisabled = "DISABLED"
)
View Source 
const (
	// VpcEndpointStatusPending is a VpcEndpointStatus enum value
	VpcEndpointStatusPending = "PENDING"

	// VpcEndpointStatusDeleting is a VpcEndpointStatus enum value
	VpcEndpointStatusDeleting = "DELETING"

	// VpcEndpointStatusActive is a VpcEndpointStatus enum value
	VpcEndpointStatusActive = "ACTIVE"

	// VpcEndpointStatusFailed is a VpcEndpointStatus enum value
	VpcEndpointStatusFailed = "FAILED"
)
View Source 
const (

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

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Thrown when an error internal to the service occurs while processing a request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeOcuLimitExceededException for service response error code
	// "OcuLimitExceededException".
	//
	// Thrown when the collection you're attempting to create results in a number
	// of search or indexing OCUs that exceeds the account limit.
	ErrCodeOcuLimitExceededException = "OcuLimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Thrown when accessing or deleting a resource that does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// Thrown when you attempt to create more resources than the service allows
	// based on service quotas.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Thrown when the HTTP request contains invalid input or is missing required
	// input.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "OpenSearchServerless" // Name of service.
	EndpointsID = "aoss"                 // ID to lookup a service endpoint with.
	ServiceID   = "OpenSearchServerless" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// AccessPolicyTypeData is a AccessPolicyType enum value
	AccessPolicyTypeData = "data"
)
View Source 
const (
	// LifecyclePolicyTypeRetention is a LifecyclePolicyType enum value
	LifecyclePolicyTypeRetention = "retention"
)
View Source 
const (
	// ResourceTypeIndex is a ResourceType enum value
	ResourceTypeIndex = "index"
)
View Source 
const (
	// SecurityConfigTypeSaml is a SecurityConfigType enum value
	SecurityConfigTypeSaml = "saml"
)

Variables

This section is empty.

Functions

func AccessPolicyType_Values 

func AccessPolicyType_Values() []string

AccessPolicyType_Values returns all elements of the AccessPolicyType enum

func CollectionStatus_Values 

func CollectionStatus_Values() []string

CollectionStatus_Values returns all elements of the CollectionStatus enum

func CollectionType_Values 

func CollectionType_Values() []string

CollectionType_Values returns all elements of the CollectionType enum

func LifecyclePolicyType_Values added in v1.46.3 

func LifecyclePolicyType_Values() []string

LifecyclePolicyType_Values returns all elements of the LifecyclePolicyType enum

func ResourceType_Values added in v1.46.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func SecurityConfigType_Values 

func SecurityConfigType_Values() []string

SecurityConfigType_Values returns all elements of the SecurityConfigType enum

func SecurityPolicyType_Values 

func SecurityPolicyType_Values() []string

SecurityPolicyType_Values returns all elements of the SecurityPolicyType enum

func StandbyReplicas_Values added in v1.48.8 

func StandbyReplicas_Values() []string

StandbyReplicas_Values returns all elements of the StandbyReplicas enum

func VpcEndpointStatus_Values 

func VpcEndpointStatus_Values() []string

VpcEndpointStatus_Values returns all elements of the VpcEndpointStatus enum

Types

type AccessPolicyDetail 

type AccessPolicyDetail struct {

	// The date the policy was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

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

	// The timestamp of when the policy was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the policy.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The version of the policy.
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string"`

	// The type of access policy.
	Type *string `locationName:"type" type:"string" enum:"AccessPolicyType"`
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless access policy.

func (AccessPolicyDetail) GoString 

func (s AccessPolicyDetail) GoString() string

GoString returns the string representation.

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

func (*AccessPolicyDetail) SetCreatedDate 

func (s *AccessPolicyDetail) SetCreatedDate(v int64) *AccessPolicyDetail

SetCreatedDate sets the CreatedDate field's value.

func (*AccessPolicyDetail) SetDescription 

func (s *AccessPolicyDetail) SetDescription(v string) *AccessPolicyDetail

SetDescription sets the Description field's value.

func (*AccessPolicyDetail) SetLastModifiedDate 

func (s *AccessPolicyDetail) SetLastModifiedDate(v int64) *AccessPolicyDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*AccessPolicyDetail) SetName 

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

SetName sets the Name field's value.

func (*AccessPolicyDetail) SetPolicyVersion 

func (s *AccessPolicyDetail) SetPolicyVersion(v string) *AccessPolicyDetail

SetPolicyVersion sets the PolicyVersion field's value.

func (*AccessPolicyDetail) SetType 

func (s *AccessPolicyDetail) SetType(v string) *AccessPolicyDetail

SetType sets the Type field's value.

func (AccessPolicyDetail) String 

func (s AccessPolicyDetail) String() string

String returns the string representation.

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

type AccessPolicyStats 

type AccessPolicyStats struct {

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

Statistics for an OpenSearch Serverless access policy.

func (AccessPolicyStats) GoString 

func (s AccessPolicyStats) GoString() string

GoString returns the string representation.

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

func (*AccessPolicyStats) SetDataPolicyCount 

func (s *AccessPolicyStats) SetDataPolicyCount(v int64) *AccessPolicyStats

SetDataPolicyCount sets the DataPolicyCount field's value.

func (AccessPolicyStats) String 

func (s AccessPolicyStats) String() string

String returns the string representation.

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

type AccessPolicySummary 

type AccessPolicySummary struct {

	// The Epoch time when the access policy was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the access policy.
	Description *string `locationName:"description" type:"string"`

	// The date and time when the collection was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the access policy.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The version of the policy.
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string"`

	// The type of access policy. Currently, the only available type is data.
	Type *string `locationName:"type" type:"string" enum:"AccessPolicyType"`
	// contains filtered or unexported fields
}

A summary of the data access policy.

func (AccessPolicySummary) GoString 

func (s AccessPolicySummary) GoString() string

GoString returns the string representation.

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

func (*AccessPolicySummary) SetCreatedDate 

func (s *AccessPolicySummary) SetCreatedDate(v int64) *AccessPolicySummary

SetCreatedDate sets the CreatedDate field's value.

func (*AccessPolicySummary) SetDescription 

func (s *AccessPolicySummary) SetDescription(v string) *AccessPolicySummary

SetDescription sets the Description field's value.

func (*AccessPolicySummary) SetLastModifiedDate 

func (s *AccessPolicySummary) SetLastModifiedDate(v int64) *AccessPolicySummary

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*AccessPolicySummary) SetName 

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

SetName sets the Name field's value.

func (*AccessPolicySummary) SetPolicyVersion 

func (s *AccessPolicySummary) SetPolicyVersion(v string) *AccessPolicySummary

SetPolicyVersion sets the PolicyVersion field's value.

func (*AccessPolicySummary) SetType 

func (s *AccessPolicySummary) SetType(v string) *AccessPolicySummary

SetType sets the Type field's value.

func (AccessPolicySummary) String 

func (s AccessPolicySummary) String() string

String returns the string representation.

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

type 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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html).
	CapacityLimits *CapacityLimits `locationName:"capacityLimits" type:"structure"`
	// contains filtered or unexported fields
}

OpenSearch Serverless-related information for the current account.

func (AccountSettingsDetail) GoString 

func (s AccountSettingsDetail) GoString() string

GoString returns the string representation.

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

func (*AccountSettingsDetail) SetCapacityLimits 

func (s *AccountSettingsDetail) SetCapacityLimits(v *CapacityLimits) *AccountSettingsDetail

SetCapacityLimits sets the CapacityLimits field's value.

func (AccountSettingsDetail) String 

func (s AccountSettingsDetail) String() string

String returns the string representation.

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

type BatchGetCollectionInput 

type BatchGetCollectionInput struct {

	// A list of collection IDs. You can't provide names and IDs in the same request.
	// The ID is part of the collection endpoint. You can also retrieve it using
	// the ListCollections (https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html)
	// API.
	Ids []*string `locationName:"ids" min:"1" type:"list"`

	// A list of collection names. You can't provide names and IDs in the same request.
	Names []*string `locationName:"names" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetCollectionInput) GoString 

func (s BatchGetCollectionInput) GoString() string

GoString returns the string representation.

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

func (*BatchGetCollectionInput) SetIds 

func (s *BatchGetCollectionInput) SetIds(v []*string) *BatchGetCollectionInput

SetIds sets the Ids field's value.

func (*BatchGetCollectionInput) SetNames 

func (s *BatchGetCollectionInput) SetNames(v []*string) *BatchGetCollectionInput

SetNames sets the Names field's value.

func (BatchGetCollectionInput) String 

func (s BatchGetCollectionInput) String() string

String returns the string representation.

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

func (*BatchGetCollectionInput) Validate 

func (s *BatchGetCollectionInput) Validate() error

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

type BatchGetCollectionOutput 

type BatchGetCollectionOutput struct {

	// Details about each collection.
	CollectionDetails []*CollectionDetail `locationName:"collectionDetails" type:"list"`

	// Error information for the request.
	CollectionErrorDetails []*CollectionErrorDetail `locationName:"collectionErrorDetails" type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetCollectionOutput) GoString 

func (s BatchGetCollectionOutput) GoString() string

GoString returns the string representation.

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

func (*BatchGetCollectionOutput) SetCollectionDetails 

func (s *BatchGetCollectionOutput) SetCollectionDetails(v []*CollectionDetail) *BatchGetCollectionOutput

SetCollectionDetails sets the CollectionDetails field's value.

func (*BatchGetCollectionOutput) SetCollectionErrorDetails 

func (s *BatchGetCollectionOutput) SetCollectionErrorDetails(v []*CollectionErrorDetail) *BatchGetCollectionOutput

SetCollectionErrorDetails sets the CollectionErrorDetails field's value.

func (BatchGetCollectionOutput) String 

func (s BatchGetCollectionOutput) String() string

String returns the string representation.

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

type BatchGetEffectiveLifecyclePolicyInput added in v1.46.3 

type BatchGetEffectiveLifecyclePolicyInput struct {

	// The unique identifiers of policy types and resource names.
	//
	// ResourceIdentifiers is a required field
	ResourceIdentifiers []*LifecyclePolicyResourceIdentifier `locationName:"resourceIdentifiers" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetEffectiveLifecyclePolicyInput) GoString added in v1.46.3 

func (s BatchGetEffectiveLifecyclePolicyInput) GoString() string

GoString returns the string representation.

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

func (*BatchGetEffectiveLifecyclePolicyInput) SetResourceIdentifiers added in v1.46.3 

func (s *BatchGetEffectiveLifecyclePolicyInput) SetResourceIdentifiers(v []*LifecyclePolicyResourceIdentifier) *BatchGetEffectiveLifecyclePolicyInput

SetResourceIdentifiers sets the ResourceIdentifiers field's value.

func (BatchGetEffectiveLifecyclePolicyInput) String added in v1.46.3 

func (s BatchGetEffectiveLifecyclePolicyInput) String() string

String returns the string representation.

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

func (*BatchGetEffectiveLifecyclePolicyInput) Validate added in v1.46.3 

func (s *BatchGetEffectiveLifecyclePolicyInput) Validate() error

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

type BatchGetEffectiveLifecyclePolicyOutput added in v1.46.3 

type BatchGetEffectiveLifecyclePolicyOutput struct {

	// A list of lifecycle policies applied to the OpenSearch Serverless indexes.
	EffectiveLifecyclePolicyDetails []*EffectiveLifecyclePolicyDetail `locationName:"effectiveLifecyclePolicyDetails" type:"list"`

	// A list of resources for which retrieval failed.
	EffectiveLifecyclePolicyErrorDetails []*EffectiveLifecyclePolicyErrorDetail `locationName:"effectiveLifecyclePolicyErrorDetails" type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetEffectiveLifecyclePolicyOutput) GoString added in v1.46.3 

func (s BatchGetEffectiveLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

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

func (*BatchGetEffectiveLifecyclePolicyOutput) SetEffectiveLifecyclePolicyDetails added in v1.46.3 

func (s *BatchGetEffectiveLifecyclePolicyOutput) SetEffectiveLifecyclePolicyDetails(v []*EffectiveLifecyclePolicyDetail) *BatchGetEffectiveLifecyclePolicyOutput

SetEffectiveLifecyclePolicyDetails sets the EffectiveLifecyclePolicyDetails field's value.

func (*BatchGetEffectiveLifecyclePolicyOutput) SetEffectiveLifecyclePolicyErrorDetails added in v1.46.3 

func (s *BatchGetEffectiveLifecyclePolicyOutput) SetEffectiveLifecyclePolicyErrorDetails(v []*EffectiveLifecyclePolicyErrorDetail) *BatchGetEffectiveLifecyclePolicyOutput

SetEffectiveLifecyclePolicyErrorDetails sets the EffectiveLifecyclePolicyErrorDetails field's value.

func (BatchGetEffectiveLifecyclePolicyOutput) String added in v1.46.3 

func (s BatchGetEffectiveLifecyclePolicyOutput) String() string

String returns the string representation.

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

type BatchGetLifecyclePolicyInput added in v1.46.3 

type BatchGetLifecyclePolicyInput struct {

	// The unique identifiers of policy types and policy names.
	//
	// Identifiers is a required field
	Identifiers []*LifecyclePolicyIdentifier `locationName:"identifiers" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetLifecyclePolicyInput) GoString added in v1.46.3 

func (s BatchGetLifecyclePolicyInput) GoString() string

GoString returns the string representation.

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

func (*BatchGetLifecyclePolicyInput) SetIdentifiers added in v1.46.3 

func (s *BatchGetLifecyclePolicyInput) SetIdentifiers(v []*LifecyclePolicyIdentifier) *BatchGetLifecyclePolicyInput

SetIdentifiers sets the Identifiers field's value.

func (BatchGetLifecyclePolicyInput) String added in v1.46.3 

func (s BatchGetLifecyclePolicyInput) String() string

String returns the string representation.

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

func (*BatchGetLifecyclePolicyInput) Validate added in v1.46.3 

func (s *BatchGetLifecyclePolicyInput) Validate() error

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

type BatchGetLifecyclePolicyOutput added in v1.46.3 

type BatchGetLifecyclePolicyOutput struct {

	// A list of lifecycle policies matched to the input policy name and policy
	// type.
	LifecyclePolicyDetails []*LifecyclePolicyDetail `locationName:"lifecyclePolicyDetails" type:"list"`

	// A list of lifecycle policy names and policy types for which retrieval failed.
	LifecyclePolicyErrorDetails []*LifecyclePolicyErrorDetail `locationName:"lifecyclePolicyErrorDetails" type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetLifecyclePolicyOutput) GoString added in v1.46.3 

func (s BatchGetLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

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

func (*BatchGetLifecyclePolicyOutput) SetLifecyclePolicyDetails added in v1.46.3 

func (s *BatchGetLifecyclePolicyOutput) SetLifecyclePolicyDetails(v []*LifecyclePolicyDetail) *BatchGetLifecyclePolicyOutput

SetLifecyclePolicyDetails sets the LifecyclePolicyDetails field's value.

func (*BatchGetLifecyclePolicyOutput) SetLifecyclePolicyErrorDetails added in v1.46.3 

func (s *BatchGetLifecyclePolicyOutput) SetLifecyclePolicyErrorDetails(v []*LifecyclePolicyErrorDetail) *BatchGetLifecyclePolicyOutput

SetLifecyclePolicyErrorDetails sets the LifecyclePolicyErrorDetails field's value.

func (BatchGetLifecyclePolicyOutput) String added in v1.46.3 

func (s BatchGetLifecyclePolicyOutput) String() string

String returns the string representation.

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

type BatchGetVpcEndpointInput 

type BatchGetVpcEndpointInput struct {

	// A list of VPC endpoint identifiers.
	//
	// Ids is a required field
	Ids []*string `locationName:"ids" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetVpcEndpointInput) GoString 

func (s BatchGetVpcEndpointInput) GoString() string

GoString returns the string representation.

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

func (*BatchGetVpcEndpointInput) SetIds 

func (s *BatchGetVpcEndpointInput) SetIds(v []*string) *BatchGetVpcEndpointInput

SetIds sets the Ids field's value.

func (BatchGetVpcEndpointInput) String 

func (s BatchGetVpcEndpointInput) String() string

String returns the string representation.

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

func (*BatchGetVpcEndpointInput) Validate 

func (s *BatchGetVpcEndpointInput) Validate() error

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

type BatchGetVpcEndpointOutput 

type BatchGetVpcEndpointOutput struct {

	// Details about the specified VPC endpoint.
	VpcEndpointDetails []*VpcEndpointDetail `locationName:"vpcEndpointDetails" type:"list"`

	// Error information for a failed request.
	VpcEndpointErrorDetails []*VpcEndpointErrorDetail `locationName:"vpcEndpointErrorDetails" type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetVpcEndpointOutput) GoString 

func (s BatchGetVpcEndpointOutput) GoString() string

GoString returns the string representation.

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

func (*BatchGetVpcEndpointOutput) SetVpcEndpointDetails 

func (s *BatchGetVpcEndpointOutput) SetVpcEndpointDetails(v []*VpcEndpointDetail) *BatchGetVpcEndpointOutput

SetVpcEndpointDetails sets the VpcEndpointDetails field's value.

func (*BatchGetVpcEndpointOutput) SetVpcEndpointErrorDetails 

func (s *BatchGetVpcEndpointOutput) SetVpcEndpointErrorDetails(v []*VpcEndpointErrorDetail) *BatchGetVpcEndpointOutput

SetVpcEndpointErrorDetails sets the VpcEndpointErrorDetails field's value.

func (BatchGetVpcEndpointOutput) String 

func (s BatchGetVpcEndpointOutput) String() string

String returns the string representation.

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

type CapacityLimits 

type CapacityLimits struct {

	// The maximum indexing capacity for collections.
	MaxIndexingCapacityInOCU *int64 `locationName:"maxIndexingCapacityInOCU" min:"2" type:"integer"`

	// The maximum search capacity for collections.
	MaxSearchCapacityInOCU *int64 `locationName:"maxSearchCapacityInOCU" min:"2" type:"integer"`
	// 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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html).

func (CapacityLimits) GoString 

func (s CapacityLimits) GoString() string

GoString returns the string representation.

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

func (*CapacityLimits) SetMaxIndexingCapacityInOCU 

func (s *CapacityLimits) SetMaxIndexingCapacityInOCU(v int64) *CapacityLimits

SetMaxIndexingCapacityInOCU sets the MaxIndexingCapacityInOCU field's value.

func (*CapacityLimits) SetMaxSearchCapacityInOCU 

func (s *CapacityLimits) SetMaxSearchCapacityInOCU(v int64) *CapacityLimits

SetMaxSearchCapacityInOCU sets the MaxSearchCapacityInOCU field's value.

func (CapacityLimits) String 

func (s CapacityLimits) String() string

String returns the string representation.

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

func (*CapacityLimits) Validate 

func (s *CapacityLimits) Validate() error

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

type CollectionDetail 

type CollectionDetail struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string `locationName:"arn" type:"string"`

	// Collection-specific endpoint used to submit index, search, and data upload
	// requests to an OpenSearch Serverless collection.
	CollectionEndpoint *string `locationName:"collectionEndpoint" type:"string"`

	// The Epoch time when the collection was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// Collection-specific endpoint used to access OpenSearch Dashboards.
	DashboardEndpoint *string `locationName:"dashboardEndpoint" type:"string"`

	// A description of the collection.
	Description *string `locationName:"description" type:"string"`

	// A unique identifier for the collection.
	Id *string `locationName:"id" min:"3" type:"string"`

	// The ARN of the Amazon Web Services KMS key used to encrypt the collection.
	KmsKeyArn *string `locationName:"kmsKeyArn" type:"string"`

	// The date and time when the collection was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the collection.
	Name *string `locationName:"name" min:"3" type:"string"`

	// Details about an OpenSearch Serverless collection.
	StandbyReplicas *string `locationName:"standbyReplicas" type:"string" enum:"StandbyReplicas"`

	// The current status of the collection.
	Status *string `locationName:"status" type:"string" enum:"CollectionStatus"`

	// The type of collection.
	Type *string `locationName:"type" type:"string" enum:"CollectionType"`
	// contains filtered or unexported fields
}

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

func (CollectionDetail) GoString 

func (s CollectionDetail) GoString() string

GoString returns the string representation.

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

func (*CollectionDetail) SetArn 

func (s *CollectionDetail) SetArn(v string) *CollectionDetail

SetArn sets the Arn field's value.

func (*CollectionDetail) SetCollectionEndpoint 

func (s *CollectionDetail) SetCollectionEndpoint(v string) *CollectionDetail

SetCollectionEndpoint sets the CollectionEndpoint field's value.

func (*CollectionDetail) SetCreatedDate 

func (s *CollectionDetail) SetCreatedDate(v int64) *CollectionDetail

SetCreatedDate sets the CreatedDate field's value.

func (*CollectionDetail) SetDashboardEndpoint 

func (s *CollectionDetail) SetDashboardEndpoint(v string) *CollectionDetail

SetDashboardEndpoint sets the DashboardEndpoint field's value.

func (*CollectionDetail) SetDescription 

func (s *CollectionDetail) SetDescription(v string) *CollectionDetail

SetDescription sets the Description field's value.

func (*CollectionDetail) SetId 

func (s *CollectionDetail) SetId(v string) *CollectionDetail

SetId sets the Id field's value.

func (*CollectionDetail) SetKmsKeyArn 

func (s *CollectionDetail) SetKmsKeyArn(v string) *CollectionDetail

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*CollectionDetail) SetLastModifiedDate 

func (s *CollectionDetail) SetLastModifiedDate(v int64) *CollectionDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*CollectionDetail) SetName 

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

SetName sets the Name field's value.

func (*CollectionDetail) SetStandbyReplicas added in v1.48.8 

func (s *CollectionDetail) SetStandbyReplicas(v string) *CollectionDetail

SetStandbyReplicas sets the StandbyReplicas field's value.

func (*CollectionDetail) SetStatus 

func (s *CollectionDetail) SetStatus(v string) *CollectionDetail

SetStatus sets the Status field's value.

func (*CollectionDetail) SetType 

func (s *CollectionDetail) SetType(v string) *CollectionDetail

SetType sets the Type field's value.

func (CollectionDetail) String 

func (s CollectionDetail) String() string

String returns the string representation.

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

type CollectionErrorDetail 

type CollectionErrorDetail struct {

	// The error code for the request. For example, NOT_FOUND.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// A description of the error. For example, The specified Collection is not
	// found.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// If the request contains collection IDs, the response includes the IDs provided
	// in the request.
	Id *string `locationName:"id" min:"3" type:"string"`

	// If the request contains collection names, the response includes the names
	// provided in the request.
	Name *string `locationName:"name" min:"3" type:"string"`
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

func (CollectionErrorDetail) GoString 

func (s CollectionErrorDetail) GoString() string

GoString returns the string representation.

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

func (*CollectionErrorDetail) SetErrorCode 

func (s *CollectionErrorDetail) SetErrorCode(v string) *CollectionErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*CollectionErrorDetail) SetErrorMessage 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*CollectionErrorDetail) SetId 

func (s *CollectionErrorDetail) SetId(v string) *CollectionErrorDetail

SetId sets the Id field's value.

func (*CollectionErrorDetail) SetName 

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

SetName sets the Name field's value.

func (CollectionErrorDetail) String 

func (s CollectionErrorDetail) String() string

String returns the string representation.

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

type CollectionFilters 

type CollectionFilters struct {

	// The name of the collection.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The current status of the collection.
	Status *string `locationName:"status" type:"string" enum:"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.

func (CollectionFilters) GoString 

func (s CollectionFilters) GoString() string

GoString returns the string representation.

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

func (*CollectionFilters) SetName 

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

SetName sets the Name field's value.

func (*CollectionFilters) SetStatus 

func (s *CollectionFilters) SetStatus(v string) *CollectionFilters

SetStatus sets the Status field's value.

func (CollectionFilters) String 

func (s CollectionFilters) String() string

String returns the string representation.

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

func (*CollectionFilters) Validate 

func (s *CollectionFilters) Validate() error

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

type CollectionSummary 

type CollectionSummary struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string `locationName:"arn" type:"string"`

	// The unique identifier of the collection.
	Id *string `locationName:"id" min:"3" type:"string"`

	// The name of the collection.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The current status of the collection.
	Status *string `locationName:"status" type:"string" enum:"CollectionStatus"`
	// contains filtered or unexported fields
}

Details about each OpenSearch Serverless collection.

func (CollectionSummary) GoString 

func (s CollectionSummary) GoString() string

GoString returns the string representation.

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

func (*CollectionSummary) SetArn 

func (s *CollectionSummary) SetArn(v string) *CollectionSummary

SetArn sets the Arn field's value.

func (*CollectionSummary) SetId 

func (s *CollectionSummary) SetId(v string) *CollectionSummary

SetId sets the Id field's value.

func (*CollectionSummary) SetName 

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

SetName sets the Name field's value.

func (*CollectionSummary) SetStatus 

func (s *CollectionSummary) SetStatus(v string) *CollectionSummary

SetStatus sets the Status field's value.

func (CollectionSummary) String 

func (s CollectionSummary) String() string

String returns the string representation.

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

type ConflictException 

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

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

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

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

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

type CreateAccessPolicyInput 

type CreateAccessPolicyInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string `locationName:"description" type:"string"`

	// The name of the policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The JSON policy document to use as the content for the policy.
	//
	// Policy is a required field
	Policy *string `locationName:"policy" min:"1" type:"string" required:"true"`

	// The type of policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AccessPolicyType"`
	// contains filtered or unexported fields
}

func (CreateAccessPolicyInput) GoString 

func (s CreateAccessPolicyInput) GoString() string

GoString returns the string representation.

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

func (*CreateAccessPolicyInput) SetClientToken 

func (s *CreateAccessPolicyInput) SetClientToken(v string) *CreateAccessPolicyInput

SetClientToken sets the ClientToken field's value.

func (*CreateAccessPolicyInput) SetDescription 

func (s *CreateAccessPolicyInput) SetDescription(v string) *CreateAccessPolicyInput

SetDescription sets the Description field's value.

func (*CreateAccessPolicyInput) SetName 

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

SetName sets the Name field's value.

func (*CreateAccessPolicyInput) SetPolicy 

func (s *CreateAccessPolicyInput) SetPolicy(v string) *CreateAccessPolicyInput

SetPolicy sets the Policy field's value.

func (*CreateAccessPolicyInput) SetType 

func (s *CreateAccessPolicyInput) SetType(v string) *CreateAccessPolicyInput

SetType sets the Type field's value.

func (CreateAccessPolicyInput) String 

func (s CreateAccessPolicyInput) String() string

String returns the string representation.

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

func (*CreateAccessPolicyInput) Validate 

func (s *CreateAccessPolicyInput) Validate() error

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

type CreateAccessPolicyOutput 

type CreateAccessPolicyOutput struct {

	// Details about the created access policy.
	AccessPolicyDetail *AccessPolicyDetail `locationName:"accessPolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAccessPolicyOutput) GoString 

func (s CreateAccessPolicyOutput) GoString() string

GoString returns the string representation.

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

func (*CreateAccessPolicyOutput) SetAccessPolicyDetail 

func (s *CreateAccessPolicyOutput) SetAccessPolicyDetail(v *AccessPolicyDetail) *CreateAccessPolicyOutput

SetAccessPolicyDetail sets the AccessPolicyDetail field's value.

func (CreateAccessPolicyOutput) String 

func (s CreateAccessPolicyOutput) String() string

String returns the string representation.

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

type CreateCollectionDetail 

type CreateCollectionDetail struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string `locationName:"arn" type:"string"`

	// The Epoch time when the collection was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// A description of the collection.
	Description *string `locationName:"description" type:"string"`

	// The unique identifier of the collection.
	Id *string `locationName:"id" min:"3" type:"string"`

	// The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
	KmsKeyArn *string `locationName:"kmsKeyArn" type:"string"`

	// The date and time when the collection was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the collection.
	Name *string `locationName:"name" min:"3" type:"string"`

	// Creates details about an OpenSearch Serverless collection.
	StandbyReplicas *string `locationName:"standbyReplicas" type:"string" enum:"StandbyReplicas"`

	// The current status of the collection.
	Status *string `locationName:"status" type:"string" enum:"CollectionStatus"`

	// The type of collection.
	Type *string `locationName:"type" type:"string" enum:"CollectionType"`
	// contains filtered or unexported fields
}

Details about the created OpenSearch Serverless collection.

func (CreateCollectionDetail) GoString 

func (s CreateCollectionDetail) GoString() string

GoString returns the string representation.

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

func (*CreateCollectionDetail) SetArn 

func (s *CreateCollectionDetail) SetArn(v string) *CreateCollectionDetail

SetArn sets the Arn field's value.

func (*CreateCollectionDetail) SetCreatedDate 

func (s *CreateCollectionDetail) SetCreatedDate(v int64) *CreateCollectionDetail

SetCreatedDate sets the CreatedDate field's value.

func (*CreateCollectionDetail) SetDescription 

func (s *CreateCollectionDetail) SetDescription(v string) *CreateCollectionDetail

SetDescription sets the Description field's value.

func (*CreateCollectionDetail) SetId 

func (s *CreateCollectionDetail) SetId(v string) *CreateCollectionDetail

SetId sets the Id field's value.

func (*CreateCollectionDetail) SetKmsKeyArn 

func (s *CreateCollectionDetail) SetKmsKeyArn(v string) *CreateCollectionDetail

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*CreateCollectionDetail) SetLastModifiedDate 

func (s *CreateCollectionDetail) SetLastModifiedDate(v int64) *CreateCollectionDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*CreateCollectionDetail) SetName 

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

SetName sets the Name field's value.

func (*CreateCollectionDetail) SetStandbyReplicas added in v1.48.8 

func (s *CreateCollectionDetail) SetStandbyReplicas(v string) *CreateCollectionDetail

SetStandbyReplicas sets the StandbyReplicas field's value.

func (*CreateCollectionDetail) SetStatus 

func (s *CreateCollectionDetail) SetStatus(v string) *CreateCollectionDetail

SetStatus sets the Status field's value.

func (*CreateCollectionDetail) SetType 

func (s *CreateCollectionDetail) SetType(v string) *CreateCollectionDetail

SetType sets the Type field's value.

func (CreateCollectionDetail) String 

func (s CreateCollectionDetail) String() string

String returns the string representation.

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

type CreateCollectionInput 

type CreateCollectionInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// Description of the collection.
	Description *string `locationName:"description" type:"string"`

	// Name of the collection.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// Indicates whether standby replicas should be used for a collection.
	StandbyReplicas *string `locationName:"standbyReplicas" type:"string" enum:"StandbyReplicas"`

	// An arbitrary set of tags (key–value pairs) to associate with the OpenSearch
	// Serverless collection.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The type of collection.
	Type *string `locationName:"type" type:"string" enum:"CollectionType"`
	// contains filtered or unexported fields
}

func (CreateCollectionInput) GoString 

func (s CreateCollectionInput) GoString() string

GoString returns the string representation.

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

func (*CreateCollectionInput) SetClientToken 

func (s *CreateCollectionInput) SetClientToken(v string) *CreateCollectionInput

SetClientToken sets the ClientToken field's value.

func (*CreateCollectionInput) SetDescription 

func (s *CreateCollectionInput) SetDescription(v string) *CreateCollectionInput

SetDescription sets the Description field's value.

func (*CreateCollectionInput) SetName 

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

SetName sets the Name field's value.

func (*CreateCollectionInput) SetStandbyReplicas added in v1.48.8 

func (s *CreateCollectionInput) SetStandbyReplicas(v string) *CreateCollectionInput

SetStandbyReplicas sets the StandbyReplicas field's value.

func (*CreateCollectionInput) SetTags 

func (s *CreateCollectionInput) SetTags(v []*Tag) *CreateCollectionInput

SetTags sets the Tags field's value.

func (*CreateCollectionInput) SetType 

func (s *CreateCollectionInput) SetType(v string) *CreateCollectionInput

SetType sets the Type field's value.

func (CreateCollectionInput) String 

func (s CreateCollectionInput) String() string

String returns the string representation.

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

func (*CreateCollectionInput) Validate 

func (s *CreateCollectionInput) Validate() error

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

type CreateCollectionOutput 

type CreateCollectionOutput struct {

	// Details about the collection.
	CreateCollectionDetail *CreateCollectionDetail `locationName:"createCollectionDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCollectionOutput) GoString 

func (s CreateCollectionOutput) GoString() string

GoString returns the string representation.

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

func (*CreateCollectionOutput) SetCreateCollectionDetail 

func (s *CreateCollectionOutput) SetCreateCollectionDetail(v *CreateCollectionDetail) *CreateCollectionOutput

SetCreateCollectionDetail sets the CreateCollectionDetail field's value.

func (CreateCollectionOutput) String 

func (s CreateCollectionOutput) String() string

String returns the string representation.

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

type CreateLifecyclePolicyInput added in v1.46.3 

type CreateLifecyclePolicyInput struct {

	// A unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the lifecycle policy.
	Description *string `locationName:"description" type:"string"`

	// The name of the lifecycle policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The JSON policy document to use as the content for the lifecycle policy.
	//
	// Policy is a required field
	Policy *string `locationName:"policy" min:"1" type:"string" required:"true"`

	// The type of lifecycle policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

func (CreateLifecyclePolicyInput) GoString added in v1.46.3 

func (s CreateLifecyclePolicyInput) GoString() string

GoString returns the string representation.

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

func (*CreateLifecyclePolicyInput) SetClientToken added in v1.46.3 

func (s *CreateLifecyclePolicyInput) SetClientToken(v string) *CreateLifecyclePolicyInput

SetClientToken sets the ClientToken field's value.

func (*CreateLifecyclePolicyInput) SetDescription added in v1.46.3 

func (s *CreateLifecyclePolicyInput) SetDescription(v string) *CreateLifecyclePolicyInput

SetDescription sets the Description field's value.

func (*CreateLifecyclePolicyInput) SetName added in v1.46.3 

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

SetName sets the Name field's value.

func (*CreateLifecyclePolicyInput) SetPolicy added in v1.46.3 

func (s *CreateLifecyclePolicyInput) SetPolicy(v string) *CreateLifecyclePolicyInput

SetPolicy sets the Policy field's value.

func (*CreateLifecyclePolicyInput) SetType added in v1.46.3 

func (s *CreateLifecyclePolicyInput) SetType(v string) *CreateLifecyclePolicyInput

SetType sets the Type field's value.

func (CreateLifecyclePolicyInput) String added in v1.46.3 

func (s CreateLifecyclePolicyInput) String() string

String returns the string representation.

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

func (*CreateLifecyclePolicyInput) Validate added in v1.46.3 

func (s *CreateLifecyclePolicyInput) Validate() error

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

type CreateLifecyclePolicyOutput added in v1.46.3 

type CreateLifecyclePolicyOutput struct {

	// Details about the created lifecycle policy.
	LifecyclePolicyDetail *LifecyclePolicyDetail `locationName:"lifecyclePolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateLifecyclePolicyOutput) GoString added in v1.46.3 

func (s CreateLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

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

func (*CreateLifecyclePolicyOutput) SetLifecyclePolicyDetail added in v1.46.3 

func (s *CreateLifecyclePolicyOutput) SetLifecyclePolicyDetail(v *LifecyclePolicyDetail) *CreateLifecyclePolicyOutput

SetLifecyclePolicyDetail sets the LifecyclePolicyDetail field's value.

func (CreateLifecyclePolicyOutput) String added in v1.46.3 

func (s CreateLifecyclePolicyOutput) String() string

String returns the string representation.

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

type CreateSecurityConfigInput 

type CreateSecurityConfigInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the security configuration.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The name of the security configuration.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// Describes SAML options in in the form of a key-value map. This field is required
	// if you specify saml for the type parameter.
	SamlOptions *SamlConfigOptions `locationName:"samlOptions" type:"structure"`

	// The type of security configuration.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SecurityConfigType"`
	// contains filtered or unexported fields
}

func (CreateSecurityConfigInput) GoString 

func (s CreateSecurityConfigInput) GoString() string

GoString returns the string representation.

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

func (*CreateSecurityConfigInput) SetClientToken 

func (s *CreateSecurityConfigInput) SetClientToken(v string) *CreateSecurityConfigInput

SetClientToken sets the ClientToken field's value.

func (*CreateSecurityConfigInput) SetDescription 

func (s *CreateSecurityConfigInput) SetDescription(v string) *CreateSecurityConfigInput

SetDescription sets the Description field's value.

func (*CreateSecurityConfigInput) SetName 

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

SetName sets the Name field's value.

func (*CreateSecurityConfigInput) SetSamlOptions 

func (s *CreateSecurityConfigInput) SetSamlOptions(v *SamlConfigOptions) *CreateSecurityConfigInput

SetSamlOptions sets the SamlOptions field's value.

func (*CreateSecurityConfigInput) SetType 

func (s *CreateSecurityConfigInput) SetType(v string) *CreateSecurityConfigInput

SetType sets the Type field's value.

func (CreateSecurityConfigInput) String 

func (s CreateSecurityConfigInput) String() string

String returns the string representation.

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

func (*CreateSecurityConfigInput) Validate 

func (s *CreateSecurityConfigInput) Validate() error

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

type CreateSecurityConfigOutput 

type CreateSecurityConfigOutput struct {

	// Details about the created security configuration.
	SecurityConfigDetail *SecurityConfigDetail `locationName:"securityConfigDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSecurityConfigOutput) GoString 

func (s CreateSecurityConfigOutput) GoString() string

GoString returns the string representation.

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

func (*CreateSecurityConfigOutput) SetSecurityConfigDetail 

func (s *CreateSecurityConfigOutput) SetSecurityConfigDetail(v *SecurityConfigDetail) *CreateSecurityConfigOutput

SetSecurityConfigDetail sets the SecurityConfigDetail field's value.

func (CreateSecurityConfigOutput) String 

func (s CreateSecurityConfigOutput) String() string

String returns the string representation.

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

type CreateSecurityPolicyInput 

type CreateSecurityPolicyInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string `locationName:"description" type:"string"`

	// The name of the policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The JSON policy document to use as the content for the new policy.
	//
	// Policy is a required field
	Policy *string `locationName:"policy" min:"1" type:"string" required:"true"`

	// The type of security policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SecurityPolicyType"`
	// contains filtered or unexported fields
}

func (CreateSecurityPolicyInput) GoString 

func (s CreateSecurityPolicyInput) GoString() string

GoString returns the string representation.

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

func (*CreateSecurityPolicyInput) SetClientToken 

func (s *CreateSecurityPolicyInput) SetClientToken(v string) *CreateSecurityPolicyInput

SetClientToken sets the ClientToken field's value.

func (*CreateSecurityPolicyInput) SetDescription 

func (s *CreateSecurityPolicyInput) SetDescription(v string) *CreateSecurityPolicyInput

SetDescription sets the Description field's value.

func (*CreateSecurityPolicyInput) SetName 

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

SetName sets the Name field's value.

func (*CreateSecurityPolicyInput) SetPolicy 

func (s *CreateSecurityPolicyInput) SetPolicy(v string) *CreateSecurityPolicyInput

SetPolicy sets the Policy field's value.

func (*CreateSecurityPolicyInput) SetType 

func (s *CreateSecurityPolicyInput) SetType(v string) *CreateSecurityPolicyInput

SetType sets the Type field's value.

func (CreateSecurityPolicyInput) String 

func (s CreateSecurityPolicyInput) String() string

String returns the string representation.

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

func (*CreateSecurityPolicyInput) Validate 

func (s *CreateSecurityPolicyInput) Validate() error

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

type CreateSecurityPolicyOutput 

type CreateSecurityPolicyOutput struct {

	// Details about the created security policy.
	SecurityPolicyDetail *SecurityPolicyDetail `locationName:"securityPolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSecurityPolicyOutput) GoString 

func (s CreateSecurityPolicyOutput) GoString() string

GoString returns the string representation.

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

func (*CreateSecurityPolicyOutput) SetSecurityPolicyDetail 

func (s *CreateSecurityPolicyOutput) SetSecurityPolicyDetail(v *SecurityPolicyDetail) *CreateSecurityPolicyOutput

SetSecurityPolicyDetail sets the SecurityPolicyDetail field's value.

func (CreateSecurityPolicyOutput) String 

func (s CreateSecurityPolicyOutput) String() string

String returns the string representation.

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

type CreateVpcEndpointDetail 

type CreateVpcEndpointDetail struct {

	// The unique identifier of the endpoint.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The name of the endpoint.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The current status in the endpoint creation process.
	Status *string `locationName:"status" type:"string" enum:"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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

func (CreateVpcEndpointDetail) GoString 

func (s CreateVpcEndpointDetail) GoString() string

GoString returns the string representation.

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

func (*CreateVpcEndpointDetail) SetId 

func (s *CreateVpcEndpointDetail) SetId(v string) *CreateVpcEndpointDetail

SetId sets the Id field's value.

func (*CreateVpcEndpointDetail) SetName 

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

SetName sets the Name field's value.

func (*CreateVpcEndpointDetail) SetStatus 

func (s *CreateVpcEndpointDetail) SetStatus(v string) *CreateVpcEndpointDetail

SetStatus sets the Status field's value.

func (CreateVpcEndpointDetail) String 

func (s CreateVpcEndpointDetail) String() string

String returns the string representation.

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

type CreateVpcEndpointInput 

type CreateVpcEndpointInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The name of the interface endpoint.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// 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 `locationName:"securityGroupIds" min:"1" type:"list"`

	// The ID of one or more subnets from which you'll access OpenSearch Serverless.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationName:"subnetIds" min:"1" type:"list" required:"true"`

	// The ID of the VPC from which you'll access OpenSearch Serverless.
	//
	// VpcId is a required field
	VpcId *string `locationName:"vpcId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVpcEndpointInput) GoString 

func (s CreateVpcEndpointInput) GoString() string

GoString returns the string representation.

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

func (*CreateVpcEndpointInput) SetClientToken 

func (s *CreateVpcEndpointInput) SetClientToken(v string) *CreateVpcEndpointInput

SetClientToken sets the ClientToken field's value.

func (*CreateVpcEndpointInput) SetName 

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

SetName sets the Name field's value.

func (*CreateVpcEndpointInput) SetSecurityGroupIds 

func (s *CreateVpcEndpointInput) SetSecurityGroupIds(v []*string) *CreateVpcEndpointInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateVpcEndpointInput) SetSubnetIds 

func (s *CreateVpcEndpointInput) SetSubnetIds(v []*string) *CreateVpcEndpointInput

SetSubnetIds sets the SubnetIds field's value.

func (*CreateVpcEndpointInput) SetVpcId 

func (s *CreateVpcEndpointInput) SetVpcId(v string) *CreateVpcEndpointInput

SetVpcId sets the VpcId field's value.

func (CreateVpcEndpointInput) String 

func (s CreateVpcEndpointInput) String() string

String returns the string representation.

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

func (*CreateVpcEndpointInput) Validate 

func (s *CreateVpcEndpointInput) Validate() error

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

type CreateVpcEndpointOutput 

type CreateVpcEndpointOutput struct {

	// Details about the created interface VPC endpoint.
	CreateVpcEndpointDetail *CreateVpcEndpointDetail `locationName:"createVpcEndpointDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateVpcEndpointOutput) GoString 

func (s CreateVpcEndpointOutput) GoString() string

GoString returns the string representation.

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

func (*CreateVpcEndpointOutput) SetCreateVpcEndpointDetail 

func (s *CreateVpcEndpointOutput) SetCreateVpcEndpointDetail(v *CreateVpcEndpointDetail) *CreateVpcEndpointOutput

SetCreateVpcEndpointDetail sets the CreateVpcEndpointDetail field's value.

func (CreateVpcEndpointOutput) String 

func (s CreateVpcEndpointOutput) String() string

String returns the string representation.

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

type DeleteAccessPolicyInput 

type DeleteAccessPolicyInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The name of the policy to delete.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The type of policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AccessPolicyType"`
	// contains filtered or unexported fields
}

func (DeleteAccessPolicyInput) GoString 

func (s DeleteAccessPolicyInput) GoString() string

GoString returns the string representation.

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

func (*DeleteAccessPolicyInput) SetClientToken 

func (s *DeleteAccessPolicyInput) SetClientToken(v string) *DeleteAccessPolicyInput

SetClientToken sets the ClientToken field's value.

func (*DeleteAccessPolicyInput) SetName 

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

SetName sets the Name field's value.

func (*DeleteAccessPolicyInput) SetType 

func (s *DeleteAccessPolicyInput) SetType(v string) *DeleteAccessPolicyInput

SetType sets the Type field's value.

func (DeleteAccessPolicyInput) String 

func (s DeleteAccessPolicyInput) String() string

String returns the string representation.

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

func (*DeleteAccessPolicyInput) Validate 

func (s *DeleteAccessPolicyInput) Validate() error

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

type DeleteAccessPolicyOutput 

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

func (DeleteAccessPolicyOutput) GoString 

func (s DeleteAccessPolicyOutput) GoString() string

GoString returns the string representation.

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

func (DeleteAccessPolicyOutput) String 

func (s DeleteAccessPolicyOutput) String() string

String returns the string representation.

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

type DeleteCollectionDetail 

type DeleteCollectionDetail struct {

	// The unique identifier of the collection.
	Id *string `locationName:"id" min:"3" type:"string"`

	// The name of the collection.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The current status of the collection.
	Status *string `locationName:"status" type:"string" enum:"CollectionStatus"`
	// contains filtered or unexported fields
}

Details about a deleted OpenSearch Serverless collection.

func (DeleteCollectionDetail) GoString 

func (s DeleteCollectionDetail) GoString() string

GoString returns the string representation.

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

func (*DeleteCollectionDetail) SetId 

func (s *DeleteCollectionDetail) SetId(v string) *DeleteCollectionDetail

SetId sets the Id field's value.

func (*DeleteCollectionDetail) SetName 

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

SetName sets the Name field's value.

func (*DeleteCollectionDetail) SetStatus 

func (s *DeleteCollectionDetail) SetStatus(v string) *DeleteCollectionDetail

SetStatus sets the Status field's value.

func (DeleteCollectionDetail) String 

func (s DeleteCollectionDetail) String() string

String returns the string representation.

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

type DeleteCollectionInput 

type DeleteCollectionInput struct {

	// A unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The unique identifier of the collection. For example, 1iu5usc406kd. The ID
	// is part of the collection endpoint. You can also retrieve it using the ListCollections
	// (https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html)
	// API.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCollectionInput) GoString 

func (s DeleteCollectionInput) GoString() string

GoString returns the string representation.

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

func (*DeleteCollectionInput) SetClientToken 

func (s *DeleteCollectionInput) SetClientToken(v string) *DeleteCollectionInput

SetClientToken sets the ClientToken field's value.

func (*DeleteCollectionInput) SetId 

func (s *DeleteCollectionInput) SetId(v string) *DeleteCollectionInput

SetId sets the Id field's value.

func (DeleteCollectionInput) String 

func (s DeleteCollectionInput) String() string

String returns the string representation.

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

func (*DeleteCollectionInput) Validate 

func (s *DeleteCollectionInput) Validate() error

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

type DeleteCollectionOutput 

type DeleteCollectionOutput struct {

	// Details of the deleted collection.
	DeleteCollectionDetail *DeleteCollectionDetail `locationName:"deleteCollectionDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteCollectionOutput) GoString 

func (s DeleteCollectionOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteCollectionOutput) SetDeleteCollectionDetail 

func (s *DeleteCollectionOutput) SetDeleteCollectionDetail(v *DeleteCollectionDetail) *DeleteCollectionOutput

SetDeleteCollectionDetail sets the DeleteCollectionDetail field's value.

func (DeleteCollectionOutput) String 

func (s DeleteCollectionOutput) String() string

String returns the string representation.

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

type DeleteLifecyclePolicyInput added in v1.46.3 

type DeleteLifecyclePolicyInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The name of the policy to delete.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The type of lifecycle policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

func (DeleteLifecyclePolicyInput) GoString added in v1.46.3 

func (s DeleteLifecyclePolicyInput) GoString() string

GoString returns the string representation.

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

func (*DeleteLifecyclePolicyInput) SetClientToken added in v1.46.3 

func (s *DeleteLifecyclePolicyInput) SetClientToken(v string) *DeleteLifecyclePolicyInput

SetClientToken sets the ClientToken field's value.

func (*DeleteLifecyclePolicyInput) SetName added in v1.46.3 

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

SetName sets the Name field's value.

func (*DeleteLifecyclePolicyInput) SetType added in v1.46.3 

func (s *DeleteLifecyclePolicyInput) SetType(v string) *DeleteLifecyclePolicyInput

SetType sets the Type field's value.

func (DeleteLifecyclePolicyInput) String added in v1.46.3 

func (s DeleteLifecyclePolicyInput) String() string

String returns the string representation.

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

func (*DeleteLifecyclePolicyInput) Validate added in v1.46.3 

func (s *DeleteLifecyclePolicyInput) Validate() error

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

type DeleteLifecyclePolicyOutput added in v1.46.3 

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

func (DeleteLifecyclePolicyOutput) GoString added in v1.46.3 

func (s DeleteLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

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

func (DeleteLifecyclePolicyOutput) String added in v1.46.3 

func (s DeleteLifecyclePolicyOutput) String() string

String returns the string representation.

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

type DeleteSecurityConfigInput 

type DeleteSecurityConfigInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>.
	// For example, saml/123456789123/OKTADev.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSecurityConfigInput) GoString 

func (s DeleteSecurityConfigInput) GoString() string

GoString returns the string representation.

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

func (*DeleteSecurityConfigInput) SetClientToken 

func (s *DeleteSecurityConfigInput) SetClientToken(v string) *DeleteSecurityConfigInput

SetClientToken sets the ClientToken field's value.

func (*DeleteSecurityConfigInput) SetId 

func (s *DeleteSecurityConfigInput) SetId(v string) *DeleteSecurityConfigInput

SetId sets the Id field's value.

func (DeleteSecurityConfigInput) String 

func (s DeleteSecurityConfigInput) String() string

String returns the string representation.

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

func (*DeleteSecurityConfigInput) Validate 

func (s *DeleteSecurityConfigInput) Validate() error

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

type DeleteSecurityConfigOutput 

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

func (DeleteSecurityConfigOutput) GoString 

func (s DeleteSecurityConfigOutput) GoString() string

GoString returns the string representation.

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

func (DeleteSecurityConfigOutput) String 

func (s DeleteSecurityConfigOutput) String() string

String returns the string representation.

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

type DeleteSecurityPolicyInput 

type DeleteSecurityPolicyInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The name of the policy to delete.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The type of policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SecurityPolicyType"`
	// contains filtered or unexported fields
}

func (DeleteSecurityPolicyInput) GoString 

func (s DeleteSecurityPolicyInput) GoString() string

GoString returns the string representation.

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

func (*DeleteSecurityPolicyInput) SetClientToken 

func (s *DeleteSecurityPolicyInput) SetClientToken(v string) *DeleteSecurityPolicyInput

SetClientToken sets the ClientToken field's value.

func (*DeleteSecurityPolicyInput) SetName 

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

SetName sets the Name field's value.

func (*DeleteSecurityPolicyInput) SetType 

func (s *DeleteSecurityPolicyInput) SetType(v string) *DeleteSecurityPolicyInput

SetType sets the Type field's value.

func (DeleteSecurityPolicyInput) String 

func (s DeleteSecurityPolicyInput) String() string

String returns the string representation.

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

func (*DeleteSecurityPolicyInput) Validate 

func (s *DeleteSecurityPolicyInput) Validate() error

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

type DeleteSecurityPolicyOutput 

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

func (DeleteSecurityPolicyOutput) GoString 

func (s DeleteSecurityPolicyOutput) GoString() string

GoString returns the string representation.

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

func (DeleteSecurityPolicyOutput) String 

func (s DeleteSecurityPolicyOutput) String() string

String returns the string representation.

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

type DeleteVpcEndpointDetail 

type DeleteVpcEndpointDetail struct {

	// The unique identifier of the endpoint.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The name of the endpoint.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The current status of the endpoint deletion process.
	Status *string `locationName:"status" type:"string" enum:"VpcEndpointStatus"`
	// contains filtered or unexported fields
}

Deletion details for an OpenSearch Serverless-managed interface endpoint.

func (DeleteVpcEndpointDetail) GoString 

func (s DeleteVpcEndpointDetail) GoString() string

GoString returns the string representation.

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

func (*DeleteVpcEndpointDetail) SetId 

func (s *DeleteVpcEndpointDetail) SetId(v string) *DeleteVpcEndpointDetail

SetId sets the Id field's value.

func (*DeleteVpcEndpointDetail) SetName 

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

SetName sets the Name field's value.

func (*DeleteVpcEndpointDetail) SetStatus 

func (s *DeleteVpcEndpointDetail) SetStatus(v string) *DeleteVpcEndpointDetail

SetStatus sets the Status field's value.

func (DeleteVpcEndpointDetail) String 

func (s DeleteVpcEndpointDetail) String() string

String returns the string representation.

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

type DeleteVpcEndpointInput 

type DeleteVpcEndpointInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The VPC endpoint identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVpcEndpointInput) GoString 

func (s DeleteVpcEndpointInput) GoString() string

GoString returns the string representation.

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

func (*DeleteVpcEndpointInput) SetClientToken 

func (s *DeleteVpcEndpointInput) SetClientToken(v string) *DeleteVpcEndpointInput

SetClientToken sets the ClientToken field's value.

func (*DeleteVpcEndpointInput) SetId 

func (s *DeleteVpcEndpointInput) SetId(v string) *DeleteVpcEndpointInput

SetId sets the Id field's value.

func (DeleteVpcEndpointInput) String 

func (s DeleteVpcEndpointInput) String() string

String returns the string representation.

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

func (*DeleteVpcEndpointInput) Validate 

func (s *DeleteVpcEndpointInput) Validate() error

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

type DeleteVpcEndpointOutput 

type DeleteVpcEndpointOutput struct {

	// Details about the deleted endpoint.
	DeleteVpcEndpointDetail *DeleteVpcEndpointDetail `locationName:"deleteVpcEndpointDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteVpcEndpointOutput) GoString 

func (s DeleteVpcEndpointOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteVpcEndpointOutput) SetDeleteVpcEndpointDetail 

func (s *DeleteVpcEndpointOutput) SetDeleteVpcEndpointDetail(v *DeleteVpcEndpointDetail) *DeleteVpcEndpointOutput

SetDeleteVpcEndpointDetail sets the DeleteVpcEndpointDetail field's value.

func (DeleteVpcEndpointOutput) String 

func (s DeleteVpcEndpointOutput) String() string

String returns the string representation.

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

type EffectiveLifecyclePolicyDetail added in v1.46.3 

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 `locationName:"noMinRetentionPeriod" type:"boolean"`

	// The name of the lifecycle policy.
	PolicyName *string `locationName:"policyName" min:"3" type:"string"`

	// The name of the OpenSearch Serverless index resource.
	Resource *string `locationName:"resource" type:"string"`

	// The type of OpenSearch Serverless resource. Currently, the only supported
	// resource is index.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"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 `locationName:"retentionPeriod" type:"string"`

	// The type of lifecycle policy.
	Type *string `locationName:"type" type:"string" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

func (EffectiveLifecyclePolicyDetail) GoString added in v1.46.3 

func (s EffectiveLifecyclePolicyDetail) GoString() string

GoString returns the string representation.

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

func (*EffectiveLifecyclePolicyDetail) SetNoMinRetentionPeriod added in v1.46.3 

func (s *EffectiveLifecyclePolicyDetail) SetNoMinRetentionPeriod(v bool) *EffectiveLifecyclePolicyDetail

SetNoMinRetentionPeriod sets the NoMinRetentionPeriod field's value.

func (*EffectiveLifecyclePolicyDetail) SetPolicyName added in v1.46.3 

func (s *EffectiveLifecyclePolicyDetail) SetPolicyName(v string) *EffectiveLifecyclePolicyDetail

SetPolicyName sets the PolicyName field's value.

func (*EffectiveLifecyclePolicyDetail) SetResource added in v1.46.3 

func (s *EffectiveLifecyclePolicyDetail) SetResource(v string) *EffectiveLifecyclePolicyDetail

SetResource sets the Resource field's value.

func (*EffectiveLifecyclePolicyDetail) SetResourceType added in v1.46.3 

func (s *EffectiveLifecyclePolicyDetail) SetResourceType(v string) *EffectiveLifecyclePolicyDetail

SetResourceType sets the ResourceType field's value.

func (*EffectiveLifecyclePolicyDetail) SetRetentionPeriod added in v1.46.3 

func (s *EffectiveLifecyclePolicyDetail) SetRetentionPeriod(v string) *EffectiveLifecyclePolicyDetail

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*EffectiveLifecyclePolicyDetail) SetType added in v1.46.3 

func (s *EffectiveLifecyclePolicyDetail) SetType(v string) *EffectiveLifecyclePolicyDetail

SetType sets the Type field's value.

func (EffectiveLifecyclePolicyDetail) String added in v1.46.3 

func (s EffectiveLifecyclePolicyDetail) String() string

String returns the string representation.

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

type EffectiveLifecyclePolicyErrorDetail added in v1.46.3 

type EffectiveLifecyclePolicyErrorDetail struct {

	// The error code for the request.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// A description of the error. For example, The specified Index resource is
	// not found.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The name of OpenSearch Serverless index resource.
	Resource *string `locationName:"resource" type:"string"`

	// The type of lifecycle policy.
	Type *string `locationName:"type" type:"string" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

func (EffectiveLifecyclePolicyErrorDetail) GoString added in v1.46.3 

func (s EffectiveLifecyclePolicyErrorDetail) GoString() string

GoString returns the string representation.

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

func (*EffectiveLifecyclePolicyErrorDetail) SetErrorCode added in v1.46.3 

func (s *EffectiveLifecyclePolicyErrorDetail) SetErrorCode(v string) *EffectiveLifecyclePolicyErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*EffectiveLifecyclePolicyErrorDetail) SetErrorMessage added in v1.46.3 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*EffectiveLifecyclePolicyErrorDetail) SetResource added in v1.46.3 

func (s *EffectiveLifecyclePolicyErrorDetail) SetResource(v string) *EffectiveLifecyclePolicyErrorDetail

SetResource sets the Resource field's value.

func (*EffectiveLifecyclePolicyErrorDetail) SetType added in v1.46.3 

func (s *EffectiveLifecyclePolicyErrorDetail) SetType(v string) *EffectiveLifecyclePolicyErrorDetail

SetType sets the Type field's value.

func (EffectiveLifecyclePolicyErrorDetail) String added in v1.46.3 

func (s EffectiveLifecyclePolicyErrorDetail) String() string

String returns the string representation.

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

type GetAccessPolicyInput 

type GetAccessPolicyInput struct {

	// The name of the access policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// Tye type of policy. Currently, the only supported value is data.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AccessPolicyType"`
	// contains filtered or unexported fields
}

func (GetAccessPolicyInput) GoString 

func (s GetAccessPolicyInput) GoString() string

GoString returns the string representation.

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

func (*GetAccessPolicyInput) SetName 

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

SetName sets the Name field's value.

func (*GetAccessPolicyInput) SetType 

func (s *GetAccessPolicyInput) SetType(v string) *GetAccessPolicyInput

SetType sets the Type field's value.

func (GetAccessPolicyInput) String 

func (s GetAccessPolicyInput) String() string

String returns the string representation.

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

func (*GetAccessPolicyInput) Validate 

func (s *GetAccessPolicyInput) Validate() error

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

type GetAccessPolicyOutput 

type GetAccessPolicyOutput struct {

	// Details about the requested access policy.
	AccessPolicyDetail *AccessPolicyDetail `locationName:"accessPolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (GetAccessPolicyOutput) GoString 

func (s GetAccessPolicyOutput) GoString() string

GoString returns the string representation.

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

func (*GetAccessPolicyOutput) SetAccessPolicyDetail 

func (s *GetAccessPolicyOutput) SetAccessPolicyDetail(v *AccessPolicyDetail) *GetAccessPolicyOutput

SetAccessPolicyDetail sets the AccessPolicyDetail field's value.

func (GetAccessPolicyOutput) String 

func (s GetAccessPolicyOutput) String() string

String returns the string representation.

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

type GetAccountSettingsInput 

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

func (GetAccountSettingsInput) GoString 

func (s GetAccountSettingsInput) GoString() string

GoString returns the string representation.

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

func (GetAccountSettingsInput) String 

func (s GetAccountSettingsInput) String() string

String returns the string representation.

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

type GetAccountSettingsOutput 

type GetAccountSettingsOutput struct {

	// OpenSearch Serverless-related details for the current account.
	AccountSettingsDetail *AccountSettingsDetail `locationName:"accountSettingsDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (GetAccountSettingsOutput) GoString 

func (s GetAccountSettingsOutput) GoString() string

GoString returns the string representation.

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

func (*GetAccountSettingsOutput) SetAccountSettingsDetail 

func (s *GetAccountSettingsOutput) SetAccountSettingsDetail(v *AccountSettingsDetail) *GetAccountSettingsOutput

SetAccountSettingsDetail sets the AccountSettingsDetail field's value.

func (GetAccountSettingsOutput) String 

func (s GetAccountSettingsOutput) String() string

String returns the string representation.

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

type GetPoliciesStatsInput 

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

func (GetPoliciesStatsInput) GoString 

func (s GetPoliciesStatsInput) GoString() string

GoString returns the string representation.

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

func (GetPoliciesStatsInput) String 

func (s GetPoliciesStatsInput) String() string

String returns the string representation.

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

type GetPoliciesStatsOutput 

type GetPoliciesStatsOutput struct {

	// Information about the data access policies in your account.
	AccessPolicyStats *AccessPolicyStats `type:"structure"`

	// Information about the lifecycle policies in your account.
	LifecyclePolicyStats *LifecyclePolicyStats `type:"structure"`

	// Information about the security configurations in your account.
	SecurityConfigStats *SecurityConfigStats `type:"structure"`

	// Information about the security policies in your account.
	SecurityPolicyStats *SecurityPolicyStats `type:"structure"`

	// The total number of OpenSearch Serverless security policies and configurations
	// in your account.
	TotalPolicyCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (GetPoliciesStatsOutput) GoString 

func (s GetPoliciesStatsOutput) GoString() string

GoString returns the string representation.

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

func (*GetPoliciesStatsOutput) SetAccessPolicyStats 

func (s *GetPoliciesStatsOutput) SetAccessPolicyStats(v *AccessPolicyStats) *GetPoliciesStatsOutput

SetAccessPolicyStats sets the AccessPolicyStats field's value.

func (*GetPoliciesStatsOutput) SetLifecyclePolicyStats added in v1.46.3 

func (s *GetPoliciesStatsOutput) SetLifecyclePolicyStats(v *LifecyclePolicyStats) *GetPoliciesStatsOutput

SetLifecyclePolicyStats sets the LifecyclePolicyStats field's value.

func (*GetPoliciesStatsOutput) SetSecurityConfigStats 

func (s *GetPoliciesStatsOutput) SetSecurityConfigStats(v *SecurityConfigStats) *GetPoliciesStatsOutput

SetSecurityConfigStats sets the SecurityConfigStats field's value.

func (*GetPoliciesStatsOutput) SetSecurityPolicyStats 

func (s *GetPoliciesStatsOutput) SetSecurityPolicyStats(v *SecurityPolicyStats) *GetPoliciesStatsOutput

SetSecurityPolicyStats sets the SecurityPolicyStats field's value.

func (*GetPoliciesStatsOutput) SetTotalPolicyCount 

func (s *GetPoliciesStatsOutput) SetTotalPolicyCount(v int64) *GetPoliciesStatsOutput

SetTotalPolicyCount sets the TotalPolicyCount field's value.

func (GetPoliciesStatsOutput) String 

func (s GetPoliciesStatsOutput) String() string

String returns the string representation.

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

type GetSecurityConfigInput 

type GetSecurityConfigInput struct {

	// The unique identifier of the security configuration.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSecurityConfigInput) GoString 

func (s GetSecurityConfigInput) GoString() string

GoString returns the string representation.

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

func (*GetSecurityConfigInput) SetId 

func (s *GetSecurityConfigInput) SetId(v string) *GetSecurityConfigInput

SetId sets the Id field's value.

func (GetSecurityConfigInput) String 

func (s GetSecurityConfigInput) String() string

String returns the string representation.

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

func (*GetSecurityConfigInput) Validate 

func (s *GetSecurityConfigInput) Validate() error

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

type GetSecurityConfigOutput 

type GetSecurityConfigOutput struct {

	// Details of the requested security configuration.
	SecurityConfigDetail *SecurityConfigDetail `locationName:"securityConfigDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (GetSecurityConfigOutput) GoString 

func (s GetSecurityConfigOutput) GoString() string

GoString returns the string representation.

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

func (*GetSecurityConfigOutput) SetSecurityConfigDetail 

func (s *GetSecurityConfigOutput) SetSecurityConfigDetail(v *SecurityConfigDetail) *GetSecurityConfigOutput

SetSecurityConfigDetail sets the SecurityConfigDetail field's value.

func (GetSecurityConfigOutput) String 

func (s GetSecurityConfigOutput) String() string

String returns the string representation.

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

type GetSecurityPolicyInput 

type GetSecurityPolicyInput struct {

	// The name of the security policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The type of security policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SecurityPolicyType"`
	// contains filtered or unexported fields
}

func (GetSecurityPolicyInput) GoString 

func (s GetSecurityPolicyInput) GoString() string

GoString returns the string representation.

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

func (*GetSecurityPolicyInput) SetName 

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

SetName sets the Name field's value.

func (*GetSecurityPolicyInput) SetType 

func (s *GetSecurityPolicyInput) SetType(v string) *GetSecurityPolicyInput

SetType sets the Type field's value.

func (GetSecurityPolicyInput) String 

func (s GetSecurityPolicyInput) String() string

String returns the string representation.

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

func (*GetSecurityPolicyInput) Validate 

func (s *GetSecurityPolicyInput) Validate() error

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

type GetSecurityPolicyOutput 

type GetSecurityPolicyOutput struct {

	// Details about the requested security policy.
	SecurityPolicyDetail *SecurityPolicyDetail `locationName:"securityPolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (GetSecurityPolicyOutput) GoString 

func (s GetSecurityPolicyOutput) GoString() string

GoString returns the string representation.

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

func (*GetSecurityPolicyOutput) SetSecurityPolicyDetail 

func (s *GetSecurityPolicyOutput) SetSecurityPolicyDetail(v *SecurityPolicyDetail) *GetSecurityPolicyOutput

SetSecurityPolicyDetail sets the SecurityPolicyDetail field's value.

func (GetSecurityPolicyOutput) String 

func (s GetSecurityPolicyOutput) String() string

String returns the string representation.

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

type InternalServerException 

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

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

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

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

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

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

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

type LifecyclePolicyDetail added in v1.46.3 

type LifecyclePolicyDetail struct {

	// The date the lifecycle policy was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the lifecycle policy.
	Description *string `locationName:"description" type:"string"`

	// The timestamp of when the lifecycle policy was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the lifecycle policy.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The version of the lifecycle policy.
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string"`

	// The type of lifecycle policy.
	Type *string `locationName:"type" type:"string" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless lifecycle policy.

func (LifecyclePolicyDetail) GoString added in v1.46.3 

func (s LifecyclePolicyDetail) GoString() string

GoString returns the string representation.

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

func (*LifecyclePolicyDetail) SetCreatedDate added in v1.46.3 

func (s *LifecyclePolicyDetail) SetCreatedDate(v int64) *LifecyclePolicyDetail

SetCreatedDate sets the CreatedDate field's value.

func (*LifecyclePolicyDetail) SetDescription added in v1.46.3 

func (s *LifecyclePolicyDetail) SetDescription(v string) *LifecyclePolicyDetail

SetDescription sets the Description field's value.

func (*LifecyclePolicyDetail) SetLastModifiedDate added in v1.46.3 

func (s *LifecyclePolicyDetail) SetLastModifiedDate(v int64) *LifecyclePolicyDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*LifecyclePolicyDetail) SetName added in v1.46.3 

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

SetName sets the Name field's value.

func (*LifecyclePolicyDetail) SetPolicyVersion added in v1.46.3 

func (s *LifecyclePolicyDetail) SetPolicyVersion(v string) *LifecyclePolicyDetail

SetPolicyVersion sets the PolicyVersion field's value.

func (*LifecyclePolicyDetail) SetType added in v1.46.3 

func (s *LifecyclePolicyDetail) SetType(v string) *LifecyclePolicyDetail

SetType sets the Type field's value.

func (LifecyclePolicyDetail) String added in v1.46.3 

func (s LifecyclePolicyDetail) String() string

String returns the string representation.

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

type LifecyclePolicyErrorDetail added in v1.46.3 

type LifecyclePolicyErrorDetail struct {

	// The error code for the request. For example, NOT_FOUND.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// A description of the error. For example, The specified Lifecycle Policy is
	// not found.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The name of the lifecycle policy.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The type of lifecycle policy.
	Type *string `locationName:"type" type:"string" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

Error information for an OpenSearch Serverless request.

func (LifecyclePolicyErrorDetail) GoString added in v1.46.3 

func (s LifecyclePolicyErrorDetail) GoString() string

GoString returns the string representation.

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

func (*LifecyclePolicyErrorDetail) SetErrorCode added in v1.46.3 

func (s *LifecyclePolicyErrorDetail) SetErrorCode(v string) *LifecyclePolicyErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*LifecyclePolicyErrorDetail) SetErrorMessage added in v1.46.3 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*LifecyclePolicyErrorDetail) SetName added in v1.46.3 

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

SetName sets the Name field's value.

func (*LifecyclePolicyErrorDetail) SetType added in v1.46.3 

func (s *LifecyclePolicyErrorDetail) SetType(v string) *LifecyclePolicyErrorDetail

SetType sets the Type field's value.

func (LifecyclePolicyErrorDetail) String added in v1.46.3 

func (s LifecyclePolicyErrorDetail) String() string

String returns the string representation.

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

type LifecyclePolicyIdentifier added in v1.46.3 

type LifecyclePolicyIdentifier struct {

	// The name of the lifecycle policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The type of lifecycle policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

The unique identifiers of policy types and policy names.

func (LifecyclePolicyIdentifier) GoString added in v1.46.3 

func (s LifecyclePolicyIdentifier) GoString() string

GoString returns the string representation.

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

func (*LifecyclePolicyIdentifier) SetName added in v1.46.3 

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

SetName sets the Name field's value.

func (*LifecyclePolicyIdentifier) SetType added in v1.46.3 

func (s *LifecyclePolicyIdentifier) SetType(v string) *LifecyclePolicyIdentifier

SetType sets the Type field's value.

func (LifecyclePolicyIdentifier) String added in v1.46.3 

func (s LifecyclePolicyIdentifier) String() string

String returns the string representation.

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

func (*LifecyclePolicyIdentifier) Validate added in v1.46.3 

func (s *LifecyclePolicyIdentifier) Validate() error

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

type LifecyclePolicyResourceIdentifier added in v1.46.3 

type LifecyclePolicyResourceIdentifier struct {

	// The name of the OpenSearch Serverless ilndex resource.
	//
	// Resource is a required field
	Resource *string `locationName:"resource" type:"string" required:"true"`

	// The type of lifecycle policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

The unique identifiers of policy types and resource names.

func (LifecyclePolicyResourceIdentifier) GoString added in v1.46.3 

func (s LifecyclePolicyResourceIdentifier) GoString() string

GoString returns the string representation.

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

func (*LifecyclePolicyResourceIdentifier) SetResource added in v1.46.3 

func (s *LifecyclePolicyResourceIdentifier) SetResource(v string) *LifecyclePolicyResourceIdentifier

SetResource sets the Resource field's value.

func (*LifecyclePolicyResourceIdentifier) SetType added in v1.46.3 

func (s *LifecyclePolicyResourceIdentifier) SetType(v string) *LifecyclePolicyResourceIdentifier

SetType sets the Type field's value.

func (LifecyclePolicyResourceIdentifier) String added in v1.46.3 

func (s LifecyclePolicyResourceIdentifier) String() string

String returns the string representation.

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

func (*LifecyclePolicyResourceIdentifier) Validate added in v1.46.3 

func (s *LifecyclePolicyResourceIdentifier) Validate() error

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

type LifecyclePolicyStats added in v1.46.3 

type LifecyclePolicyStats struct {

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

Statistics for an OpenSearch Serverless lifecycle policy.

func (LifecyclePolicyStats) GoString added in v1.46.3 

func (s LifecyclePolicyStats) GoString() string

GoString returns the string representation.

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

func (*LifecyclePolicyStats) SetRetentionPolicyCount added in v1.46.3 

func (s *LifecyclePolicyStats) SetRetentionPolicyCount(v int64) *LifecyclePolicyStats

SetRetentionPolicyCount sets the RetentionPolicyCount field's value.

func (LifecyclePolicyStats) String added in v1.46.3 

func (s LifecyclePolicyStats) String() string

String returns the string representation.

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

type LifecyclePolicySummary added in v1.46.3 

type LifecyclePolicySummary struct {

	// The Epoch time when the lifecycle policy was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the lifecycle policy.
	Description *string `locationName:"description" type:"string"`

	// The date and time when the lifecycle policy was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the lifecycle policy.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The version of the lifecycle policy.
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string"`

	// The type of lifecycle policy.
	Type *string `locationName:"type" type:"string" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

A summary of the lifecycle policy.

func (LifecyclePolicySummary) GoString added in v1.46.3 

func (s LifecyclePolicySummary) GoString() string

GoString returns the string representation.

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

func (*LifecyclePolicySummary) SetCreatedDate added in v1.46.3 

func (s *LifecyclePolicySummary) SetCreatedDate(v int64) *LifecyclePolicySummary

SetCreatedDate sets the CreatedDate field's value.

func (*LifecyclePolicySummary) SetDescription added in v1.46.3 

func (s *LifecyclePolicySummary) SetDescription(v string) *LifecyclePolicySummary

SetDescription sets the Description field's value.

func (*LifecyclePolicySummary) SetLastModifiedDate added in v1.46.3 

func (s *LifecyclePolicySummary) SetLastModifiedDate(v int64) *LifecyclePolicySummary

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*LifecyclePolicySummary) SetName added in v1.46.3 

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

SetName sets the Name field's value.

func (*LifecyclePolicySummary) SetPolicyVersion added in v1.46.3 

func (s *LifecyclePolicySummary) SetPolicyVersion(v string) *LifecyclePolicySummary

SetPolicyVersion sets the PolicyVersion field's value.

func (*LifecyclePolicySummary) SetType added in v1.46.3 

func (s *LifecyclePolicySummary) SetType(v string) *LifecyclePolicySummary

SetType sets the Type field's value.

func (LifecyclePolicySummary) String added in v1.46.3 

func (s LifecyclePolicySummary) String() string

String returns the string representation.

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

type ListAccessPoliciesInput 

type ListAccessPoliciesInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results. The default is 20.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// If your initial ListAccessPolicies operation returns a nextToken, you can
	// include the returned nextToken in subsequent ListAccessPolicies operations,
	// which returns results in the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Resource filters (can be collections or indexes) that policies can apply
	// to.
	Resource []*string `locationName:"resource" min:"1" type:"list"`

	// The type of access policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AccessPolicyType"`
	// contains filtered or unexported fields
}

func (ListAccessPoliciesInput) GoString 

func (s ListAccessPoliciesInput) GoString() string

GoString returns the string representation.

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

func (*ListAccessPoliciesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListAccessPoliciesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListAccessPoliciesInput) SetResource 

func (s *ListAccessPoliciesInput) SetResource(v []*string) *ListAccessPoliciesInput

SetResource sets the Resource field's value.

func (*ListAccessPoliciesInput) SetType 

func (s *ListAccessPoliciesInput) SetType(v string) *ListAccessPoliciesInput

SetType sets the Type field's value.

func (ListAccessPoliciesInput) String 

func (s ListAccessPoliciesInput) String() string

String returns the string representation.

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

func (*ListAccessPoliciesInput) Validate 

func (s *ListAccessPoliciesInput) Validate() error

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

type ListAccessPoliciesOutput 

type ListAccessPoliciesOutput struct {

	// Details about the requested access policies.
	AccessPolicySummaries []*AccessPolicySummary `locationName:"accessPolicySummaries" type:"list"`

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAccessPoliciesOutput) GoString 

func (s ListAccessPoliciesOutput) GoString() string

GoString returns the string representation.

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

func (*ListAccessPoliciesOutput) SetAccessPolicySummaries 

func (s *ListAccessPoliciesOutput) SetAccessPolicySummaries(v []*AccessPolicySummary) *ListAccessPoliciesOutput

SetAccessPolicySummaries sets the AccessPolicySummaries field's value.

func (*ListAccessPoliciesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListAccessPoliciesOutput) String 

func (s ListAccessPoliciesOutput) String() string

String returns the string representation.

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

type ListCollectionsInput 

type ListCollectionsInput struct {

	// A list of filter names and values that you can use for requests.
	CollectionFilters *CollectionFilters `locationName:"collectionFilters" type:"structure"`

	// The maximum number of results to return. Default is 20. You can use nextToken
	// to get the next page of results.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// If your initial ListCollections operation returns a nextToken, you can include
	// the returned nextToken in subsequent ListCollections operations, which returns
	// results in the next page.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListCollectionsInput) GoString 

func (s ListCollectionsInput) GoString() string

GoString returns the string representation.

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

func (*ListCollectionsInput) SetCollectionFilters 

func (s *ListCollectionsInput) SetCollectionFilters(v *CollectionFilters) *ListCollectionsInput

SetCollectionFilters sets the CollectionFilters field's value.

func (*ListCollectionsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListCollectionsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListCollectionsInput) String 

func (s ListCollectionsInput) String() string

String returns the string representation.

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

func (*ListCollectionsInput) Validate 

func (s *ListCollectionsInput) Validate() error

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

type ListCollectionsOutput 

type ListCollectionsOutput struct {

	// Details about each collection.
	CollectionSummaries []*CollectionSummary `locationName:"collectionSummaries" type:"list"`

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListCollectionsOutput) GoString 

func (s ListCollectionsOutput) GoString() string

GoString returns the string representation.

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

func (*ListCollectionsOutput) SetCollectionSummaries 

func (s *ListCollectionsOutput) SetCollectionSummaries(v []*CollectionSummary) *ListCollectionsOutput

SetCollectionSummaries sets the CollectionSummaries field's value.

func (*ListCollectionsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListCollectionsOutput) String 

func (s ListCollectionsOutput) String() string

String returns the string representation.

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

type ListLifecyclePoliciesInput added in v1.46.3 

type ListLifecyclePoliciesInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use use nextToken to get the next page of results. The default is
	// 10.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// If your initial ListLifecyclePolicies operation returns a nextToken, you
	// can include the returned nextToken in subsequent ListLifecyclePolicies operations,
	// which returns results in the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Resource filters that policies can apply to. Currently, the only supported
	// resource type is index.
	Resources []*string `locationName:"resources" min:"1" type:"list"`

	// The type of lifecycle policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

func (ListLifecyclePoliciesInput) GoString added in v1.46.3 

func (s ListLifecyclePoliciesInput) GoString() string

GoString returns the string representation.

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

func (*ListLifecyclePoliciesInput) SetMaxResults added in v1.46.3 

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

SetMaxResults sets the MaxResults field's value.

func (*ListLifecyclePoliciesInput) SetNextToken added in v1.46.3 

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

SetNextToken sets the NextToken field's value.

func (*ListLifecyclePoliciesInput) SetResources added in v1.46.3 

func (s *ListLifecyclePoliciesInput) SetResources(v []*string) *ListLifecyclePoliciesInput

SetResources sets the Resources field's value.

func (*ListLifecyclePoliciesInput) SetType added in v1.46.3 

func (s *ListLifecyclePoliciesInput) SetType(v string) *ListLifecyclePoliciesInput

SetType sets the Type field's value.

func (ListLifecyclePoliciesInput) String added in v1.46.3 

func (s ListLifecyclePoliciesInput) String() string

String returns the string representation.

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

func (*ListLifecyclePoliciesInput) Validate added in v1.46.3 

func (s *ListLifecyclePoliciesInput) Validate() error

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

type ListLifecyclePoliciesOutput added in v1.46.3 

type ListLifecyclePoliciesOutput struct {

	// Details about the requested lifecycle policies.
	LifecyclePolicySummaries []*LifecyclePolicySummary `locationName:"lifecyclePolicySummaries" type:"list"`

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListLifecyclePoliciesOutput) GoString added in v1.46.3 

func (s ListLifecyclePoliciesOutput) GoString() string

GoString returns the string representation.

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

func (*ListLifecyclePoliciesOutput) SetLifecyclePolicySummaries added in v1.46.3 

func (s *ListLifecyclePoliciesOutput) SetLifecyclePolicySummaries(v []*LifecyclePolicySummary) *ListLifecyclePoliciesOutput

SetLifecyclePolicySummaries sets the LifecyclePolicySummaries field's value.

func (*ListLifecyclePoliciesOutput) SetNextToken added in v1.46.3 

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

SetNextToken sets the NextToken field's value.

func (ListLifecyclePoliciesOutput) String added in v1.46.3 

func (s ListLifecyclePoliciesOutput) String() string

String returns the string representation.

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

type ListSecurityConfigsInput 

type ListSecurityConfigsInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results. The default is 20.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// If your initial ListSecurityConfigs operation returns a nextToken, you can
	// include the returned nextToken in subsequent ListSecurityConfigs operations,
	// which returns results in the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The type of security configuration.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SecurityConfigType"`
	// contains filtered or unexported fields
}

func (ListSecurityConfigsInput) GoString 

func (s ListSecurityConfigsInput) GoString() string

GoString returns the string representation.

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

func (*ListSecurityConfigsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityConfigsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSecurityConfigsInput) SetType 

func (s *ListSecurityConfigsInput) SetType(v string) *ListSecurityConfigsInput

SetType sets the Type field's value.

func (ListSecurityConfigsInput) String 

func (s ListSecurityConfigsInput) String() string

String returns the string representation.

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

func (*ListSecurityConfigsInput) Validate 

func (s *ListSecurityConfigsInput) Validate() error

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

type ListSecurityConfigsOutput 

type ListSecurityConfigsOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Details about the security configurations in your account.
	SecurityConfigSummaries []*SecurityConfigSummary `locationName:"securityConfigSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListSecurityConfigsOutput) GoString 

func (s ListSecurityConfigsOutput) GoString() string

GoString returns the string representation.

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

func (*ListSecurityConfigsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSecurityConfigsOutput) SetSecurityConfigSummaries 

func (s *ListSecurityConfigsOutput) SetSecurityConfigSummaries(v []*SecurityConfigSummary) *ListSecurityConfigsOutput

SetSecurityConfigSummaries sets the SecurityConfigSummaries field's value.

func (ListSecurityConfigsOutput) String 

func (s ListSecurityConfigsOutput) String() string

String returns the string representation.

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

type ListSecurityPoliciesInput 

type ListSecurityPoliciesInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results. The default is 20.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// If your initial ListSecurityPolicies operation returns a nextToken, you can
	// include the returned nextToken in subsequent ListSecurityPolicies operations,
	// which returns results in the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Resource filters (can be collection or indexes) that policies can apply to.
	Resource []*string `locationName:"resource" min:"1" type:"list"`

	// The type of policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SecurityPolicyType"`
	// contains filtered or unexported fields
}

func (ListSecurityPoliciesInput) GoString 

func (s ListSecurityPoliciesInput) GoString() string

GoString returns the string representation.

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

func (*ListSecurityPoliciesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityPoliciesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSecurityPoliciesInput) SetResource 

func (s *ListSecurityPoliciesInput) SetResource(v []*string) *ListSecurityPoliciesInput

SetResource sets the Resource field's value.

func (*ListSecurityPoliciesInput) SetType 

func (s *ListSecurityPoliciesInput) SetType(v string) *ListSecurityPoliciesInput

SetType sets the Type field's value.

func (ListSecurityPoliciesInput) String 

func (s ListSecurityPoliciesInput) String() string

String returns the string representation.

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

func (*ListSecurityPoliciesInput) Validate 

func (s *ListSecurityPoliciesInput) Validate() error

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

type ListSecurityPoliciesOutput 

type ListSecurityPoliciesOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Details about the security policies in your account.
	SecurityPolicySummaries []*SecurityPolicySummary `locationName:"securityPolicySummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListSecurityPoliciesOutput) GoString 

func (s ListSecurityPoliciesOutput) GoString() string

GoString returns the string representation.

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

func (*ListSecurityPoliciesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSecurityPoliciesOutput) SetSecurityPolicySummaries 

func (s *ListSecurityPoliciesOutput) SetSecurityPolicySummaries(v []*SecurityPolicySummary) *ListSecurityPoliciesOutput

SetSecurityPolicySummaries sets the SecurityPolicySummaries field's value.

func (ListSecurityPoliciesOutput) String 

func (s ListSecurityPoliciesOutput) String() string

String returns the string representation.

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

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. The resource must be active
	// (not in the DELETING state), and must be owned by the account ID included
	// in the request.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

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

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags associated with the resource.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

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

type ListVpcEndpointsInput 

type ListVpcEndpointsInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results. The default is 20.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// If your initial ListVpcEndpoints operation returns a nextToken, you can include
	// the returned nextToken in subsequent ListVpcEndpoints operations, which returns
	// results in the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Filter the results according to the current status of the VPC endpoint. Possible
	// statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.
	VpcEndpointFilters *VpcEndpointFilters `locationName:"vpcEndpointFilters" type:"structure"`
	// contains filtered or unexported fields
}

func (ListVpcEndpointsInput) GoString 

func (s ListVpcEndpointsInput) GoString() string

GoString returns the string representation.

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

func (*ListVpcEndpointsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListVpcEndpointsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListVpcEndpointsInput) SetVpcEndpointFilters 

func (s *ListVpcEndpointsInput) SetVpcEndpointFilters(v *VpcEndpointFilters) *ListVpcEndpointsInput

SetVpcEndpointFilters sets the VpcEndpointFilters field's value.

func (ListVpcEndpointsInput) String 

func (s ListVpcEndpointsInput) String() string

String returns the string representation.

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

func (*ListVpcEndpointsInput) Validate 

func (s *ListVpcEndpointsInput) Validate() error

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

type ListVpcEndpointsOutput 

type ListVpcEndpointsOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Details about each VPC endpoint, including the name and current status.
	VpcEndpointSummaries []*VpcEndpointSummary `locationName:"vpcEndpointSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListVpcEndpointsOutput) GoString 

func (s ListVpcEndpointsOutput) GoString() string

GoString returns the string representation.

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

func (*ListVpcEndpointsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListVpcEndpointsOutput) SetVpcEndpointSummaries 

func (s *ListVpcEndpointsOutput) SetVpcEndpointSummaries(v []*VpcEndpointSummary) *ListVpcEndpointsOutput

SetVpcEndpointSummaries sets the VpcEndpointSummaries field's value.

func (ListVpcEndpointsOutput) String 

func (s ListVpcEndpointsOutput) String() string

String returns the string representation.

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

type OcuLimitExceededException added in v1.44.232 

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

	// Description of the error.
	Message_ *string `locationName:"message" type:"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) Code added in v1.44.232 

func (s *OcuLimitExceededException) Code() string

Code returns the exception type name.

func (*OcuLimitExceededException) Error added in v1.44.232 

func (s *OcuLimitExceededException) Error() string

func (OcuLimitExceededException) GoString added in v1.44.232 

func (s OcuLimitExceededException) GoString() string

GoString returns the string representation.

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

func (*OcuLimitExceededException) Message added in v1.44.232 

func (s *OcuLimitExceededException) Message() string

Message returns the exception's message.

func (*OcuLimitExceededException) OrigErr added in v1.44.232 

func (s *OcuLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OcuLimitExceededException) RequestID added in v1.44.232 

func (s *OcuLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OcuLimitExceededException) StatusCode added in v1.44.232 

func (s *OcuLimitExceededException) StatusCode() int

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

func (OcuLimitExceededException) String added in v1.44.232 

func (s OcuLimitExceededException) String() string

String returns the string representation.

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

type OpenSearchServerless 

type OpenSearchServerless struct {
	*client.Client
}

OpenSearchServerless provides the API operation methods for making requests to OpenSearch Service Serverless. See this package's package overview docs for details on the service.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *OpenSearchServerless

New creates a new instance of the OpenSearchServerless client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a OpenSearchServerless client from just a session.
svc := opensearchserverless.New(mySession)

// Create a OpenSearchServerless client with additional configuration
svc := opensearchserverless.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*OpenSearchServerless) BatchGetCollection 

func (c *OpenSearchServerless) BatchGetCollection(input *BatchGetCollectionInput) (*BatchGetCollectionOutput, error)

BatchGetCollection API operation for OpenSearch Service Serverless.

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation BatchGetCollection for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetCollection

func (*OpenSearchServerless) BatchGetCollectionRequest 

func (c *OpenSearchServerless) BatchGetCollectionRequest(input *BatchGetCollectionInput) (req *request.Request, output *BatchGetCollectionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetCollection

func (*OpenSearchServerless) BatchGetCollectionWithContext 

func (c *OpenSearchServerless) BatchGetCollectionWithContext(ctx aws.Context, input *BatchGetCollectionInput, opts ...request.Option) (*BatchGetCollectionOutput, error)

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

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

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

func (*OpenSearchServerless) BatchGetEffectiveLifecyclePolicy added in v1.46.3 

func (c *OpenSearchServerless) BatchGetEffectiveLifecyclePolicy(input *BatchGetEffectiveLifecyclePolicyInput) (*BatchGetEffectiveLifecyclePolicyOutput, error)

BatchGetEffectiveLifecyclePolicy API operation for OpenSearch Service Serverless.

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation BatchGetEffectiveLifecyclePolicy for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetEffectiveLifecyclePolicy

func (*OpenSearchServerless) BatchGetEffectiveLifecyclePolicyRequest added in v1.46.3 

func (c *OpenSearchServerless) BatchGetEffectiveLifecyclePolicyRequest(input *BatchGetEffectiveLifecyclePolicyInput) (req *request.Request, output *BatchGetEffectiveLifecyclePolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetEffectiveLifecyclePolicy

func (*OpenSearchServerless) BatchGetEffectiveLifecyclePolicyWithContext added in v1.46.3 

func (c *OpenSearchServerless) BatchGetEffectiveLifecyclePolicyWithContext(ctx aws.Context, input *BatchGetEffectiveLifecyclePolicyInput, opts ...request.Option) (*BatchGetEffectiveLifecyclePolicyOutput, error)

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

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

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

func (*OpenSearchServerless) BatchGetLifecyclePolicy added in v1.46.3 

func (c *OpenSearchServerless) BatchGetLifecyclePolicy(input *BatchGetLifecyclePolicyInput) (*BatchGetLifecyclePolicyOutput, error)

BatchGetLifecyclePolicy API operation for OpenSearch Service Serverless.

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation BatchGetLifecyclePolicy for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetLifecyclePolicy

func (*OpenSearchServerless) BatchGetLifecyclePolicyRequest added in v1.46.3 

func (c *OpenSearchServerless) BatchGetLifecyclePolicyRequest(input *BatchGetLifecyclePolicyInput) (req *request.Request, output *BatchGetLifecyclePolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetLifecyclePolicy

func (*OpenSearchServerless) BatchGetLifecyclePolicyWithContext added in v1.46.3 

func (c *OpenSearchServerless) BatchGetLifecyclePolicyWithContext(ctx aws.Context, input *BatchGetLifecyclePolicyInput, opts ...request.Option) (*BatchGetLifecyclePolicyOutput, error)

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

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

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

func (*OpenSearchServerless) BatchGetVpcEndpoint 

func (c *OpenSearchServerless) BatchGetVpcEndpoint(input *BatchGetVpcEndpointInput) (*BatchGetVpcEndpointOutput, error)

BatchGetVpcEndpoint API operation for OpenSearch Service Serverless.

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation BatchGetVpcEndpoint for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetVpcEndpoint

func (*OpenSearchServerless) BatchGetVpcEndpointRequest 

func (c *OpenSearchServerless) BatchGetVpcEndpointRequest(input *BatchGetVpcEndpointInput) (req *request.Request, output *BatchGetVpcEndpointOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetVpcEndpoint

func (*OpenSearchServerless) BatchGetVpcEndpointWithContext 

func (c *OpenSearchServerless) BatchGetVpcEndpointWithContext(ctx aws.Context, input *BatchGetVpcEndpointInput, opts ...request.Option) (*BatchGetVpcEndpointOutput, error)

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

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

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

func (*OpenSearchServerless) CreateAccessPolicy 

func (c *OpenSearchServerless) CreateAccessPolicy(input *CreateAccessPolicyInput) (*CreateAccessPolicyOutput, error)

CreateAccessPolicy API operation for OpenSearch Service Serverless.

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation CreateAccessPolicy for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateAccessPolicy

func (*OpenSearchServerless) CreateAccessPolicyRequest 

func (c *OpenSearchServerless) CreateAccessPolicyRequest(input *CreateAccessPolicyInput) (req *request.Request, output *CreateAccessPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateAccessPolicy

func (*OpenSearchServerless) CreateAccessPolicyWithContext 

func (c *OpenSearchServerless) CreateAccessPolicyWithContext(ctx aws.Context, input *CreateAccessPolicyInput, opts ...request.Option) (*CreateAccessPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) CreateCollection 

func (c *OpenSearchServerless) CreateCollection(input *CreateCollectionInput) (*CreateCollectionOutput, error)

CreateCollection API operation for OpenSearch Service Serverless.

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation CreateCollection for usage and error information.

Returned Error Types:

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

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

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollection

func (*OpenSearchServerless) CreateCollectionRequest 

func (c *OpenSearchServerless) CreateCollectionRequest(input *CreateCollectionInput) (req *request.Request, output *CreateCollectionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollection

func (*OpenSearchServerless) CreateCollectionWithContext 

func (c *OpenSearchServerless) CreateCollectionWithContext(ctx aws.Context, input *CreateCollectionInput, opts ...request.Option) (*CreateCollectionOutput, error)

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

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

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

func (*OpenSearchServerless) CreateLifecyclePolicy added in v1.46.3 

func (c *OpenSearchServerless) CreateLifecyclePolicy(input *CreateLifecyclePolicyInput) (*CreateLifecyclePolicyOutput, error)

CreateLifecyclePolicy API operation for OpenSearch Service Serverless.

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation CreateLifecyclePolicy for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateLifecyclePolicy

func (*OpenSearchServerless) CreateLifecyclePolicyRequest added in v1.46.3 

func (c *OpenSearchServerless) CreateLifecyclePolicyRequest(input *CreateLifecyclePolicyInput) (req *request.Request, output *CreateLifecyclePolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateLifecyclePolicy

func (*OpenSearchServerless) CreateLifecyclePolicyWithContext added in v1.46.3 

func (c *OpenSearchServerless) CreateLifecyclePolicyWithContext(ctx aws.Context, input *CreateLifecyclePolicyInput, opts ...request.Option) (*CreateLifecyclePolicyOutput, error)

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

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

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

func (*OpenSearchServerless) CreateSecurityConfig 

func (c *OpenSearchServerless) CreateSecurityConfig(input *CreateSecurityConfigInput) (*CreateSecurityConfigOutput, error)

CreateSecurityConfig API operation for OpenSearch Service Serverless.

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation CreateSecurityConfig for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityConfig

func (*OpenSearchServerless) CreateSecurityConfigRequest 

func (c *OpenSearchServerless) CreateSecurityConfigRequest(input *CreateSecurityConfigInput) (req *request.Request, output *CreateSecurityConfigOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityConfig

func (*OpenSearchServerless) CreateSecurityConfigWithContext 

func (c *OpenSearchServerless) CreateSecurityConfigWithContext(ctx aws.Context, input *CreateSecurityConfigInput, opts ...request.Option) (*CreateSecurityConfigOutput, error)

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

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

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

func (*OpenSearchServerless) CreateSecurityPolicy 

func (c *OpenSearchServerless) CreateSecurityPolicy(input *CreateSecurityPolicyInput) (*CreateSecurityPolicyOutput, error)

CreateSecurityPolicy API operation for OpenSearch Service Serverless.

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) and Encryption at rest for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation CreateSecurityPolicy for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityPolicy

func (*OpenSearchServerless) CreateSecurityPolicyRequest 

func (c *OpenSearchServerless) CreateSecurityPolicyRequest(input *CreateSecurityPolicyInput) (req *request.Request, output *CreateSecurityPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityPolicy

func (*OpenSearchServerless) CreateSecurityPolicyWithContext 

func (c *OpenSearchServerless) CreateSecurityPolicyWithContext(ctx aws.Context, input *CreateSecurityPolicyInput, opts ...request.Option) (*CreateSecurityPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) CreateVpcEndpoint 

func (c *OpenSearchServerless) CreateVpcEndpoint(input *CreateVpcEndpointInput) (*CreateVpcEndpointOutput, error)

CreateVpcEndpoint API operation for OpenSearch Service Serverless.

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation CreateVpcEndpoint for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateVpcEndpoint

func (*OpenSearchServerless) CreateVpcEndpointRequest 

func (c *OpenSearchServerless) CreateVpcEndpointRequest(input *CreateVpcEndpointInput) (req *request.Request, output *CreateVpcEndpointOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateVpcEndpoint

func (*OpenSearchServerless) CreateVpcEndpointWithContext 

func (c *OpenSearchServerless) CreateVpcEndpointWithContext(ctx aws.Context, input *CreateVpcEndpointInput, opts ...request.Option) (*CreateVpcEndpointOutput, error)

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

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

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

func (*OpenSearchServerless) DeleteAccessPolicy 

func (c *OpenSearchServerless) DeleteAccessPolicy(input *DeleteAccessPolicyInput) (*DeleteAccessPolicyOutput, error)

DeleteAccessPolicy API operation for OpenSearch Service Serverless.

Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation DeleteAccessPolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteAccessPolicy

func (*OpenSearchServerless) DeleteAccessPolicyRequest 

func (c *OpenSearchServerless) DeleteAccessPolicyRequest(input *DeleteAccessPolicyInput) (req *request.Request, output *DeleteAccessPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteAccessPolicy

func (*OpenSearchServerless) DeleteAccessPolicyWithContext 

func (c *OpenSearchServerless) DeleteAccessPolicyWithContext(ctx aws.Context, input *DeleteAccessPolicyInput, opts ...request.Option) (*DeleteAccessPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) DeleteCollection 

func (c *OpenSearchServerless) DeleteCollection(input *DeleteCollectionInput) (*DeleteCollectionOutput, error)

DeleteCollection API operation for OpenSearch Service Serverless.

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation DeleteCollection for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteCollection

func (*OpenSearchServerless) DeleteCollectionRequest 

func (c *OpenSearchServerless) DeleteCollectionRequest(input *DeleteCollectionInput) (req *request.Request, output *DeleteCollectionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteCollection

func (*OpenSearchServerless) DeleteCollectionWithContext 

func (c *OpenSearchServerless) DeleteCollectionWithContext(ctx aws.Context, input *DeleteCollectionInput, opts ...request.Option) (*DeleteCollectionOutput, error)

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

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

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

func (*OpenSearchServerless) DeleteLifecyclePolicy added in v1.46.3 

func (c *OpenSearchServerless) DeleteLifecyclePolicy(input *DeleteLifecyclePolicyInput) (*DeleteLifecyclePolicyOutput, error)

DeleteLifecyclePolicy API operation for OpenSearch Service Serverless.

Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-delete).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation DeleteLifecyclePolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteLifecyclePolicy

func (*OpenSearchServerless) DeleteLifecyclePolicyRequest added in v1.46.3 

func (c *OpenSearchServerless) DeleteLifecyclePolicyRequest(input *DeleteLifecyclePolicyInput) (req *request.Request, output *DeleteLifecyclePolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteLifecyclePolicy

func (*OpenSearchServerless) DeleteLifecyclePolicyWithContext added in v1.46.3 

func (c *OpenSearchServerless) DeleteLifecyclePolicyWithContext(ctx aws.Context, input *DeleteLifecyclePolicyInput, opts ...request.Option) (*DeleteLifecyclePolicyOutput, error)

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

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

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

func (*OpenSearchServerless) DeleteSecurityConfig 

func (c *OpenSearchServerless) DeleteSecurityConfig(input *DeleteSecurityConfigInput) (*DeleteSecurityConfigOutput, error)

DeleteSecurityConfig API operation for OpenSearch Service Serverless.

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation DeleteSecurityConfig for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityConfig

func (*OpenSearchServerless) DeleteSecurityConfigRequest 

func (c *OpenSearchServerless) DeleteSecurityConfigRequest(input *DeleteSecurityConfigInput) (req *request.Request, output *DeleteSecurityConfigOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityConfig

func (*OpenSearchServerless) DeleteSecurityConfigWithContext 

func (c *OpenSearchServerless) DeleteSecurityConfigWithContext(ctx aws.Context, input *DeleteSecurityConfigInput, opts ...request.Option) (*DeleteSecurityConfigOutput, error)

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

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

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

func (*OpenSearchServerless) DeleteSecurityPolicy 

func (c *OpenSearchServerless) DeleteSecurityPolicy(input *DeleteSecurityPolicyInput) (*DeleteSecurityPolicyOutput, error)

DeleteSecurityPolicy API operation for OpenSearch Service Serverless.

Deletes an OpenSearch Serverless security policy.

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation DeleteSecurityPolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityPolicy

func (*OpenSearchServerless) DeleteSecurityPolicyRequest 

func (c *OpenSearchServerless) DeleteSecurityPolicyRequest(input *DeleteSecurityPolicyInput) (req *request.Request, output *DeleteSecurityPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityPolicy

func (*OpenSearchServerless) DeleteSecurityPolicyWithContext 

func (c *OpenSearchServerless) DeleteSecurityPolicyWithContext(ctx aws.Context, input *DeleteSecurityPolicyInput, opts ...request.Option) (*DeleteSecurityPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) DeleteVpcEndpoint 

func (c *OpenSearchServerless) DeleteVpcEndpoint(input *DeleteVpcEndpointInput) (*DeleteVpcEndpointOutput, error)

DeleteVpcEndpoint API operation for OpenSearch Service Serverless.

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation DeleteVpcEndpoint for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteVpcEndpoint

func (*OpenSearchServerless) DeleteVpcEndpointRequest 

func (c *OpenSearchServerless) DeleteVpcEndpointRequest(input *DeleteVpcEndpointInput) (req *request.Request, output *DeleteVpcEndpointOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteVpcEndpoint

func (*OpenSearchServerless) DeleteVpcEndpointWithContext 

func (c *OpenSearchServerless) DeleteVpcEndpointWithContext(ctx aws.Context, input *DeleteVpcEndpointInput, opts ...request.Option) (*DeleteVpcEndpointOutput, error)

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

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

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

func (*OpenSearchServerless) GetAccessPolicy 

func (c *OpenSearchServerless) GetAccessPolicy(input *GetAccessPolicyInput) (*GetAccessPolicyOutput, error)

GetAccessPolicy API operation for OpenSearch Service Serverless.

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation GetAccessPolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccessPolicy

func (*OpenSearchServerless) GetAccessPolicyRequest 

func (c *OpenSearchServerless) GetAccessPolicyRequest(input *GetAccessPolicyInput) (req *request.Request, output *GetAccessPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccessPolicy

func (*OpenSearchServerless) GetAccessPolicyWithContext 

func (c *OpenSearchServerless) GetAccessPolicyWithContext(ctx aws.Context, input *GetAccessPolicyInput, opts ...request.Option) (*GetAccessPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) GetAccountSettings 

func (c *OpenSearchServerless) GetAccountSettings(input *GetAccountSettingsInput) (*GetAccountSettingsOutput, error)

GetAccountSettings API operation for OpenSearch Service Serverless.

Returns account-level settings related to OpenSearch Serverless.

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation GetAccountSettings for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccountSettings

func (*OpenSearchServerless) GetAccountSettingsRequest 

func (c *OpenSearchServerless) GetAccountSettingsRequest(input *GetAccountSettingsInput) (req *request.Request, output *GetAccountSettingsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccountSettings

func (*OpenSearchServerless) GetAccountSettingsWithContext 

func (c *OpenSearchServerless) GetAccountSettingsWithContext(ctx aws.Context, input *GetAccountSettingsInput, opts ...request.Option) (*GetAccountSettingsOutput, error)

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

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

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

func (*OpenSearchServerless) GetPoliciesStats 

func (c *OpenSearchServerless) GetPoliciesStats(input *GetPoliciesStatsInput) (*GetPoliciesStatsOutput, error)

GetPoliciesStats API operation for OpenSearch Service Serverless.

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation GetPoliciesStats for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetPoliciesStats

func (*OpenSearchServerless) GetPoliciesStatsRequest 

func (c *OpenSearchServerless) GetPoliciesStatsRequest(input *GetPoliciesStatsInput) (req *request.Request, output *GetPoliciesStatsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetPoliciesStats

func (*OpenSearchServerless) GetPoliciesStatsWithContext 

func (c *OpenSearchServerless) GetPoliciesStatsWithContext(ctx aws.Context, input *GetPoliciesStatsInput, opts ...request.Option) (*GetPoliciesStatsOutput, error)

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

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

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

func (*OpenSearchServerless) GetSecurityConfig 

func (c *OpenSearchServerless) GetSecurityConfig(input *GetSecurityConfigInput) (*GetSecurityConfigOutput, error)

GetSecurityConfig API operation for OpenSearch Service Serverless.

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation GetSecurityConfig for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityConfig

func (*OpenSearchServerless) GetSecurityConfigRequest 

func (c *OpenSearchServerless) GetSecurityConfigRequest(input *GetSecurityConfigInput) (req *request.Request, output *GetSecurityConfigOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityConfig

func (*OpenSearchServerless) GetSecurityConfigWithContext 

func (c *OpenSearchServerless) GetSecurityConfigWithContext(ctx aws.Context, input *GetSecurityConfigInput, opts ...request.Option) (*GetSecurityConfigOutput, error)

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

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

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

func (*OpenSearchServerless) GetSecurityPolicy 

func (c *OpenSearchServerless) GetSecurityPolicy(input *GetSecurityPolicyInput) (*GetSecurityPolicyOutput, error)

GetSecurityPolicy API operation for OpenSearch Service Serverless.

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) and Encryption at rest for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation GetSecurityPolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityPolicy

func (*OpenSearchServerless) GetSecurityPolicyRequest 

func (c *OpenSearchServerless) GetSecurityPolicyRequest(input *GetSecurityPolicyInput) (req *request.Request, output *GetSecurityPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityPolicy

func (*OpenSearchServerless) GetSecurityPolicyWithContext 

func (c *OpenSearchServerless) GetSecurityPolicyWithContext(ctx aws.Context, input *GetSecurityPolicyInput, opts ...request.Option) (*GetSecurityPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) ListAccessPolicies 

func (c *OpenSearchServerless) ListAccessPolicies(input *ListAccessPoliciesInput) (*ListAccessPoliciesOutput, error)

ListAccessPolicies API operation for OpenSearch Service Serverless.

Returns information about a list of OpenSearch Serverless access policies.

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation ListAccessPolicies for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListAccessPolicies

func (*OpenSearchServerless) ListAccessPoliciesPages 

func (c *OpenSearchServerless) ListAccessPoliciesPages(input *ListAccessPoliciesInput, fn func(*ListAccessPoliciesOutput, bool) bool) error

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

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

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

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

func (*OpenSearchServerless) ListAccessPoliciesPagesWithContext 

func (c *OpenSearchServerless) ListAccessPoliciesPagesWithContext(ctx aws.Context, input *ListAccessPoliciesInput, fn func(*ListAccessPoliciesOutput, bool) bool, opts ...request.Option) error

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

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

func (*OpenSearchServerless) ListAccessPoliciesRequest 

func (c *OpenSearchServerless) ListAccessPoliciesRequest(input *ListAccessPoliciesInput) (req *request.Request, output *ListAccessPoliciesOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListAccessPolicies

func (*OpenSearchServerless) ListAccessPoliciesWithContext 

func (c *OpenSearchServerless) ListAccessPoliciesWithContext(ctx aws.Context, input *ListAccessPoliciesInput, opts ...request.Option) (*ListAccessPoliciesOutput, error)

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

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

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

func (*OpenSearchServerless) ListCollections 

func (c *OpenSearchServerless) ListCollections(input *ListCollectionsInput) (*ListCollectionsOutput, error)

ListCollections API operation for OpenSearch Service Serverless.

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html).

Make sure to include an empty request body {} if you don't include any collection filters in the request.

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation ListCollections for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollections

func (*OpenSearchServerless) ListCollectionsPages 

func (c *OpenSearchServerless) ListCollectionsPages(input *ListCollectionsInput, fn func(*ListCollectionsOutput, bool) bool) error

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

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

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

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

func (*OpenSearchServerless) ListCollectionsPagesWithContext 

func (c *OpenSearchServerless) ListCollectionsPagesWithContext(ctx aws.Context, input *ListCollectionsInput, fn func(*ListCollectionsOutput, bool) bool, opts ...request.Option) error

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

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

func (*OpenSearchServerless) ListCollectionsRequest 

func (c *OpenSearchServerless) ListCollectionsRequest(input *ListCollectionsInput) (req *request.Request, output *ListCollectionsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollections

func (*OpenSearchServerless) ListCollectionsWithContext 

func (c *OpenSearchServerless) ListCollectionsWithContext(ctx aws.Context, input *ListCollectionsInput, opts ...request.Option) (*ListCollectionsOutput, error)

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

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

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

func (*OpenSearchServerless) ListLifecyclePolicies added in v1.46.3 

func (c *OpenSearchServerless) ListLifecyclePolicies(input *ListLifecyclePoliciesInput) (*ListLifecyclePoliciesOutput, error)

ListLifecyclePolicies API operation for OpenSearch Service Serverless.

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation ListLifecyclePolicies for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListLifecyclePolicies

func (*OpenSearchServerless) ListLifecyclePoliciesPages added in v1.46.3 

func (c *OpenSearchServerless) ListLifecyclePoliciesPages(input *ListLifecyclePoliciesInput, fn func(*ListLifecyclePoliciesOutput, bool) bool) error

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

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

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

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

func (*OpenSearchServerless) ListLifecyclePoliciesPagesWithContext added in v1.46.3 

func (c *OpenSearchServerless) ListLifecyclePoliciesPagesWithContext(ctx aws.Context, input *ListLifecyclePoliciesInput, fn func(*ListLifecyclePoliciesOutput, bool) bool, opts ...request.Option) error

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

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

func (*OpenSearchServerless) ListLifecyclePoliciesRequest added in v1.46.3 

func (c *OpenSearchServerless) ListLifecyclePoliciesRequest(input *ListLifecyclePoliciesInput) (req *request.Request, output *ListLifecyclePoliciesOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListLifecyclePolicies

func (*OpenSearchServerless) ListLifecyclePoliciesWithContext added in v1.46.3 

func (c *OpenSearchServerless) ListLifecyclePoliciesWithContext(ctx aws.Context, input *ListLifecyclePoliciesInput, opts ...request.Option) (*ListLifecyclePoliciesOutput, error)

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

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

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

func (*OpenSearchServerless) ListSecurityConfigs 

func (c *OpenSearchServerless) ListSecurityConfigs(input *ListSecurityConfigsInput) (*ListSecurityConfigsOutput, error)

ListSecurityConfigs API operation for OpenSearch Service Serverless.

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation ListSecurityConfigs for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityConfigs

func (*OpenSearchServerless) ListSecurityConfigsPages 

func (c *OpenSearchServerless) ListSecurityConfigsPages(input *ListSecurityConfigsInput, fn func(*ListSecurityConfigsOutput, bool) bool) error

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

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

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

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

func (*OpenSearchServerless) ListSecurityConfigsPagesWithContext 

func (c *OpenSearchServerless) ListSecurityConfigsPagesWithContext(ctx aws.Context, input *ListSecurityConfigsInput, fn func(*ListSecurityConfigsOutput, bool) bool, opts ...request.Option) error

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

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

func (*OpenSearchServerless) ListSecurityConfigsRequest 

func (c *OpenSearchServerless) ListSecurityConfigsRequest(input *ListSecurityConfigsInput) (req *request.Request, output *ListSecurityConfigsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityConfigs

func (*OpenSearchServerless) ListSecurityConfigsWithContext 

func (c *OpenSearchServerless) ListSecurityConfigsWithContext(ctx aws.Context, input *ListSecurityConfigsInput, opts ...request.Option) (*ListSecurityConfigsOutput, error)

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

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

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

func (*OpenSearchServerless) ListSecurityPolicies 

func (c *OpenSearchServerless) ListSecurityPolicies(input *ListSecurityPoliciesInput) (*ListSecurityPoliciesOutput, error)

ListSecurityPolicies API operation for OpenSearch Service Serverless.

Returns information about configured OpenSearch Serverless security policies.

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation ListSecurityPolicies for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityPolicies

func (*OpenSearchServerless) ListSecurityPoliciesPages 

func (c *OpenSearchServerless) ListSecurityPoliciesPages(input *ListSecurityPoliciesInput, fn func(*ListSecurityPoliciesOutput, bool) bool) error

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

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

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

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

func (*OpenSearchServerless) ListSecurityPoliciesPagesWithContext 

func (c *OpenSearchServerless) ListSecurityPoliciesPagesWithContext(ctx aws.Context, input *ListSecurityPoliciesInput, fn func(*ListSecurityPoliciesOutput, bool) bool, opts ...request.Option) error

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

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

func (*OpenSearchServerless) ListSecurityPoliciesRequest 

func (c *OpenSearchServerless) ListSecurityPoliciesRequest(input *ListSecurityPoliciesInput) (req *request.Request, output *ListSecurityPoliciesOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityPolicies

func (*OpenSearchServerless) ListSecurityPoliciesWithContext 

func (c *OpenSearchServerless) ListSecurityPoliciesWithContext(ctx aws.Context, input *ListSecurityPoliciesInput, opts ...request.Option) (*ListSecurityPoliciesOutput, error)

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

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

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

func (*OpenSearchServerless) ListTagsForResource 

func (c *OpenSearchServerless) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for OpenSearch Service Serverless.

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListTagsForResource

func (*OpenSearchServerless) ListTagsForResourceRequest 

func (c *OpenSearchServerless) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListTagsForResource

func (*OpenSearchServerless) ListTagsForResourceWithContext 

func (c *OpenSearchServerless) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

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

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

func (*OpenSearchServerless) ListVpcEndpoints 

func (c *OpenSearchServerless) ListVpcEndpoints(input *ListVpcEndpointsInput) (*ListVpcEndpointsOutput, error)

ListVpcEndpoints API operation for OpenSearch Service Serverless.

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation ListVpcEndpoints for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListVpcEndpoints

func (*OpenSearchServerless) ListVpcEndpointsPages 

func (c *OpenSearchServerless) ListVpcEndpointsPages(input *ListVpcEndpointsInput, fn func(*ListVpcEndpointsOutput, bool) bool) error

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

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

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

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

func (*OpenSearchServerless) ListVpcEndpointsPagesWithContext 

func (c *OpenSearchServerless) ListVpcEndpointsPagesWithContext(ctx aws.Context, input *ListVpcEndpointsInput, fn func(*ListVpcEndpointsOutput, bool) bool, opts ...request.Option) error

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

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

func (*OpenSearchServerless) ListVpcEndpointsRequest 

func (c *OpenSearchServerless) ListVpcEndpointsRequest(input *ListVpcEndpointsInput) (req *request.Request, output *ListVpcEndpointsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListVpcEndpoints

func (*OpenSearchServerless) ListVpcEndpointsWithContext 

func (c *OpenSearchServerless) ListVpcEndpointsWithContext(ctx aws.Context, input *ListVpcEndpointsInput, opts ...request.Option) (*ListVpcEndpointsOutput, error)

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

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

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

func (*OpenSearchServerless) TagResource 

func (c *OpenSearchServerless) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for OpenSearch Service Serverless.

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation TagResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/TagResource

func (*OpenSearchServerless) TagResourceRequest 

func (c *OpenSearchServerless) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/TagResource

func (*OpenSearchServerless) TagResourceWithContext 

func (c *OpenSearchServerless) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

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

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

func (*OpenSearchServerless) UntagResource 

func (c *OpenSearchServerless) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for OpenSearch Service Serverless.

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UntagResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UntagResource

func (*OpenSearchServerless) UntagResourceRequest 

func (c *OpenSearchServerless) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UntagResource

func (*OpenSearchServerless) UntagResourceWithContext 

func (c *OpenSearchServerless) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

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

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

func (*OpenSearchServerless) UpdateAccessPolicy 

func (c *OpenSearchServerless) UpdateAccessPolicy(input *UpdateAccessPolicyInput) (*UpdateAccessPolicyOutput, error)

UpdateAccessPolicy API operation for OpenSearch Service Serverless.

Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UpdateAccessPolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccessPolicy

func (*OpenSearchServerless) UpdateAccessPolicyRequest 

func (c *OpenSearchServerless) UpdateAccessPolicyRequest(input *UpdateAccessPolicyInput) (req *request.Request, output *UpdateAccessPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccessPolicy

func (*OpenSearchServerless) UpdateAccessPolicyWithContext 

func (c *OpenSearchServerless) UpdateAccessPolicyWithContext(ctx aws.Context, input *UpdateAccessPolicyInput, opts ...request.Option) (*UpdateAccessPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) UpdateAccountSettings 

func (c *OpenSearchServerless) UpdateAccountSettings(input *UpdateAccountSettingsInput) (*UpdateAccountSettingsOutput, error)

UpdateAccountSettings API operation for OpenSearch Service Serverless.

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UpdateAccountSettings for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccountSettings

func (*OpenSearchServerless) UpdateAccountSettingsRequest 

func (c *OpenSearchServerless) UpdateAccountSettingsRequest(input *UpdateAccountSettingsInput) (req *request.Request, output *UpdateAccountSettingsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccountSettings

func (*OpenSearchServerless) UpdateAccountSettingsWithContext 

func (c *OpenSearchServerless) UpdateAccountSettingsWithContext(ctx aws.Context, input *UpdateAccountSettingsInput, opts ...request.Option) (*UpdateAccountSettingsOutput, error)

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

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

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

func (*OpenSearchServerless) UpdateCollection 

func (c *OpenSearchServerless) UpdateCollection(input *UpdateCollectionInput) (*UpdateCollectionOutput, error)

UpdateCollection API operation for OpenSearch Service Serverless.

Updates an OpenSearch Serverless collection.

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UpdateCollection for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollection

func (*OpenSearchServerless) UpdateCollectionRequest 

func (c *OpenSearchServerless) UpdateCollectionRequest(input *UpdateCollectionInput) (req *request.Request, output *UpdateCollectionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollection

func (*OpenSearchServerless) UpdateCollectionWithContext 

func (c *OpenSearchServerless) UpdateCollectionWithContext(ctx aws.Context, input *UpdateCollectionInput, opts ...request.Option) (*UpdateCollectionOutput, error)

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

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

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

func (*OpenSearchServerless) UpdateLifecyclePolicy added in v1.46.3 

func (c *OpenSearchServerless) UpdateLifecyclePolicy(input *UpdateLifecyclePolicyInput) (*UpdateLifecyclePolicyOutput, error)

UpdateLifecyclePolicy API operation for OpenSearch Service Serverless.

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-update).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UpdateLifecyclePolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateLifecyclePolicy

func (*OpenSearchServerless) UpdateLifecyclePolicyRequest added in v1.46.3 

func (c *OpenSearchServerless) UpdateLifecyclePolicyRequest(input *UpdateLifecyclePolicyInput) (req *request.Request, output *UpdateLifecyclePolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateLifecyclePolicy

func (*OpenSearchServerless) UpdateLifecyclePolicyWithContext added in v1.46.3 

func (c *OpenSearchServerless) UpdateLifecyclePolicyWithContext(ctx aws.Context, input *UpdateLifecyclePolicyInput, opts ...request.Option) (*UpdateLifecyclePolicyOutput, error)

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

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

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

func (*OpenSearchServerless) UpdateSecurityConfig 

func (c *OpenSearchServerless) UpdateSecurityConfig(input *UpdateSecurityConfigInput) (*UpdateSecurityConfigOutput, error)

UpdateSecurityConfig API operation for OpenSearch Service Serverless.

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UpdateSecurityConfig for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityConfig

func (*OpenSearchServerless) UpdateSecurityConfigRequest 

func (c *OpenSearchServerless) UpdateSecurityConfigRequest(input *UpdateSecurityConfigInput) (req *request.Request, output *UpdateSecurityConfigOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityConfig

func (*OpenSearchServerless) UpdateSecurityConfigWithContext 

func (c *OpenSearchServerless) UpdateSecurityConfigWithContext(ctx aws.Context, input *UpdateSecurityConfigInput, opts ...request.Option) (*UpdateSecurityConfigOutput, error)

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

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

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

func (*OpenSearchServerless) UpdateSecurityPolicy 

func (c *OpenSearchServerless) UpdateSecurityPolicy(input *UpdateSecurityPolicyInput) (*UpdateSecurityPolicyOutput, error)

UpdateSecurityPolicy API operation for OpenSearch Service Serverless.

Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) and Encryption at rest for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UpdateSecurityPolicy for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.

  • ConflictException 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.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityPolicy

func (*OpenSearchServerless) UpdateSecurityPolicyRequest 

func (c *OpenSearchServerless) UpdateSecurityPolicyRequest(input *UpdateSecurityPolicyInput) (req *request.Request, output *UpdateSecurityPolicyOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityPolicy

func (*OpenSearchServerless) UpdateSecurityPolicyWithContext 

func (c *OpenSearchServerless) UpdateSecurityPolicyWithContext(ctx aws.Context, input *UpdateSecurityPolicyInput, opts ...request.Option) (*UpdateSecurityPolicyOutput, error)

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

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

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

func (*OpenSearchServerless) UpdateVpcEndpoint 

func (c *OpenSearchServerless) UpdateVpcEndpoint(input *UpdateVpcEndpointInput) (*UpdateVpcEndpointOutput, error)

UpdateVpcEndpoint API operation for OpenSearch Service Serverless.

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html).

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

See the AWS API reference guide for OpenSearch Service Serverless's API operation UpdateVpcEndpoint for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpoint

func (*OpenSearchServerless) UpdateVpcEndpointRequest 

func (c *OpenSearchServerless) UpdateVpcEndpointRequest(input *UpdateVpcEndpointInput) (req *request.Request, output *UpdateVpcEndpointOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpoint

func (*OpenSearchServerless) UpdateVpcEndpointWithContext 

func (c *OpenSearchServerless) UpdateVpcEndpointWithContext(ctx aws.Context, input *UpdateVpcEndpointInput, opts ...request.Option) (*UpdateVpcEndpointOutput, error)

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

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

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

type ResourceNotFoundException 

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

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

Thrown when accessing or deleting a resource that does not exist.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

type SamlConfigOptions 

type SamlConfigOptions struct {

	// The group attribute for this SAML integration.
	GroupAttribute *string `locationName:"groupAttribute" min:"1" type:"string"`

	// The XML IdP metadata file generated from your identity provider.
	//
	// Metadata is a required field
	Metadata *string `locationName:"metadata" min:"1" type:"string" required:"true"`

	// The session timeout, in minutes. Default is 60 minutes (12 hours).
	SessionTimeout *int64 `locationName:"sessionTimeout" min:"5" type:"integer"`

	// A user attribute for this SAML integration.
	UserAttribute *string `locationName:"userAttribute" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (SamlConfigOptions) GoString 

func (s SamlConfigOptions) GoString() string

GoString returns the string representation.

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

func (*SamlConfigOptions) SetGroupAttribute 

func (s *SamlConfigOptions) SetGroupAttribute(v string) *SamlConfigOptions

SetGroupAttribute sets the GroupAttribute field's value.

func (*SamlConfigOptions) SetMetadata 

func (s *SamlConfigOptions) SetMetadata(v string) *SamlConfigOptions

SetMetadata sets the Metadata field's value.

func (*SamlConfigOptions) SetSessionTimeout 

func (s *SamlConfigOptions) SetSessionTimeout(v int64) *SamlConfigOptions

SetSessionTimeout sets the SessionTimeout field's value.

func (*SamlConfigOptions) SetUserAttribute 

func (s *SamlConfigOptions) SetUserAttribute(v string) *SamlConfigOptions

SetUserAttribute sets the UserAttribute field's value.

func (SamlConfigOptions) String 

func (s SamlConfigOptions) String() string

String returns the string representation.

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

func (*SamlConfigOptions) Validate 

func (s *SamlConfigOptions) Validate() error

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

type SecurityConfigDetail 

type SecurityConfigDetail struct {

	// The version of the security configuration.
	ConfigVersion *string `locationName:"configVersion" min:"20" type:"string"`

	// The date the configuration was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the security configuration.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the security configuration.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The timestamp of when the configuration was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// SAML options for the security configuration in the form of a key-value map.
	SamlOptions *SamlConfigOptions `locationName:"samlOptions" type:"structure"`

	// The type of security configuration.
	Type *string `locationName:"type" type:"string" enum:"SecurityConfigType"`
	// contains filtered or unexported fields
}

Details about a security configuration for OpenSearch Serverless.

func (SecurityConfigDetail) GoString 

func (s SecurityConfigDetail) GoString() string

GoString returns the string representation.

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

func (*SecurityConfigDetail) SetConfigVersion 

func (s *SecurityConfigDetail) SetConfigVersion(v string) *SecurityConfigDetail

SetConfigVersion sets the ConfigVersion field's value.

func (*SecurityConfigDetail) SetCreatedDate 

func (s *SecurityConfigDetail) SetCreatedDate(v int64) *SecurityConfigDetail

SetCreatedDate sets the CreatedDate field's value.

func (*SecurityConfigDetail) SetDescription 

func (s *SecurityConfigDetail) SetDescription(v string) *SecurityConfigDetail

SetDescription sets the Description field's value.

func (*SecurityConfigDetail) SetId 

func (s *SecurityConfigDetail) SetId(v string) *SecurityConfigDetail

SetId sets the Id field's value.

func (*SecurityConfigDetail) SetLastModifiedDate 

func (s *SecurityConfigDetail) SetLastModifiedDate(v int64) *SecurityConfigDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SecurityConfigDetail) SetSamlOptions 

func (s *SecurityConfigDetail) SetSamlOptions(v *SamlConfigOptions) *SecurityConfigDetail

SetSamlOptions sets the SamlOptions field's value.

func (*SecurityConfigDetail) SetType 

func (s *SecurityConfigDetail) SetType(v string) *SecurityConfigDetail

SetType sets the Type field's value.

func (SecurityConfigDetail) String 

func (s SecurityConfigDetail) String() string

String returns the string representation.

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

type SecurityConfigStats 

type SecurityConfigStats struct {

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

Statistics for an OpenSearch Serverless security configuration.

func (SecurityConfigStats) GoString 

func (s SecurityConfigStats) GoString() string

GoString returns the string representation.

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

func (*SecurityConfigStats) SetSamlConfigCount 

func (s *SecurityConfigStats) SetSamlConfigCount(v int64) *SecurityConfigStats

SetSamlConfigCount sets the SamlConfigCount field's value.

func (SecurityConfigStats) String 

func (s SecurityConfigStats) String() string

String returns the string representation.

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

type SecurityConfigSummary 

type SecurityConfigSummary struct {

	// The version of the security configuration.
	ConfigVersion *string `locationName:"configVersion" min:"20" type:"string"`

	// The Epoch time when the security configuration was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the security configuration.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the security configuration.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The timestamp of when the configuration was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The type of security configuration.
	Type *string `locationName:"type" type:"string" enum:"SecurityConfigType"`
	// contains filtered or unexported fields
}

A summary of a security configuration for OpenSearch Serverless.

func (SecurityConfigSummary) GoString 

func (s SecurityConfigSummary) GoString() string

GoString returns the string representation.

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

func (*SecurityConfigSummary) SetConfigVersion 

func (s *SecurityConfigSummary) SetConfigVersion(v string) *SecurityConfigSummary

SetConfigVersion sets the ConfigVersion field's value.

func (*SecurityConfigSummary) SetCreatedDate 

func (s *SecurityConfigSummary) SetCreatedDate(v int64) *SecurityConfigSummary

SetCreatedDate sets the CreatedDate field's value.

func (*SecurityConfigSummary) SetDescription 

func (s *SecurityConfigSummary) SetDescription(v string) *SecurityConfigSummary

SetDescription sets the Description field's value.

func (*SecurityConfigSummary) SetId 

func (s *SecurityConfigSummary) SetId(v string) *SecurityConfigSummary

SetId sets the Id field's value.

func (*SecurityConfigSummary) SetLastModifiedDate 

func (s *SecurityConfigSummary) SetLastModifiedDate(v int64) *SecurityConfigSummary

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SecurityConfigSummary) SetType 

func (s *SecurityConfigSummary) SetType(v string) *SecurityConfigSummary

SetType sets the Type field's value.

func (SecurityConfigSummary) String 

func (s SecurityConfigSummary) String() string

String returns the string representation.

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

type SecurityPolicyDetail 

type SecurityPolicyDetail struct {

	// The date the policy was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the security policy.
	Description *string `locationName:"description" type:"string"`

	// The timestamp of when the policy was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the policy.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The version of the policy.
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string"`

	// The type of security policy.
	Type *string `locationName:"type" type:"string" enum:"SecurityPolicyType"`
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless security policy.

func (SecurityPolicyDetail) GoString 

func (s SecurityPolicyDetail) GoString() string

GoString returns the string representation.

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

func (*SecurityPolicyDetail) SetCreatedDate 

func (s *SecurityPolicyDetail) SetCreatedDate(v int64) *SecurityPolicyDetail

SetCreatedDate sets the CreatedDate field's value.

func (*SecurityPolicyDetail) SetDescription 

func (s *SecurityPolicyDetail) SetDescription(v string) *SecurityPolicyDetail

SetDescription sets the Description field's value.

func (*SecurityPolicyDetail) SetLastModifiedDate 

func (s *SecurityPolicyDetail) SetLastModifiedDate(v int64) *SecurityPolicyDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SecurityPolicyDetail) SetName 

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

SetName sets the Name field's value.

func (*SecurityPolicyDetail) SetPolicyVersion 

func (s *SecurityPolicyDetail) SetPolicyVersion(v string) *SecurityPolicyDetail

SetPolicyVersion sets the PolicyVersion field's value.

func (*SecurityPolicyDetail) SetType 

func (s *SecurityPolicyDetail) SetType(v string) *SecurityPolicyDetail

SetType sets the Type field's value.

func (SecurityPolicyDetail) String 

func (s SecurityPolicyDetail) String() string

String returns the string representation.

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

type SecurityPolicyStats 

type SecurityPolicyStats struct {

	// The number of encryption policies in the current account.
	EncryptionPolicyCount *int64 `type:"long"`

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

Statistics for an OpenSearch Serverless security policy.

func (SecurityPolicyStats) GoString 

func (s SecurityPolicyStats) GoString() string

GoString returns the string representation.

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

func (*SecurityPolicyStats) SetEncryptionPolicyCount 

func (s *SecurityPolicyStats) SetEncryptionPolicyCount(v int64) *SecurityPolicyStats

SetEncryptionPolicyCount sets the EncryptionPolicyCount field's value.

func (*SecurityPolicyStats) SetNetworkPolicyCount 

func (s *SecurityPolicyStats) SetNetworkPolicyCount(v int64) *SecurityPolicyStats

SetNetworkPolicyCount sets the NetworkPolicyCount field's value.

func (SecurityPolicyStats) String 

func (s SecurityPolicyStats) String() string

String returns the string representation.

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

type SecurityPolicySummary 

type SecurityPolicySummary struct {

	// The date the policy was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the security policy.
	Description *string `locationName:"description" type:"string"`

	// The timestamp of when the policy was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the policy.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The version of the policy.
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string"`

	// The type of security policy.
	Type *string `locationName:"type" type:"string" enum:"SecurityPolicyType"`
	// contains filtered or unexported fields
}

A summary of a security policy for OpenSearch Serverless.

func (SecurityPolicySummary) GoString 

func (s SecurityPolicySummary) GoString() string

GoString returns the string representation.

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

func (*SecurityPolicySummary) SetCreatedDate 

func (s *SecurityPolicySummary) SetCreatedDate(v int64) *SecurityPolicySummary

SetCreatedDate sets the CreatedDate field's value.

func (*SecurityPolicySummary) SetDescription 

func (s *SecurityPolicySummary) SetDescription(v string) *SecurityPolicySummary

SetDescription sets the Description field's value.

func (*SecurityPolicySummary) SetLastModifiedDate 

func (s *SecurityPolicySummary) SetLastModifiedDate(v int64) *SecurityPolicySummary

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SecurityPolicySummary) SetName 

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

SetName sets the Name field's value.

func (*SecurityPolicySummary) SetPolicyVersion 

func (s *SecurityPolicySummary) SetPolicyVersion(v string) *SecurityPolicySummary

SetPolicyVersion sets the PolicyVersion field's value.

func (*SecurityPolicySummary) SetType 

func (s *SecurityPolicySummary) SetType(v string) *SecurityPolicySummary

SetType sets the Type field's value.

func (SecurityPolicySummary) String 

func (s SecurityPolicySummary) String() string

String returns the string representation.

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

type ServiceQuotaExceededException added in v1.44.232 

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

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// Service Quotas requirement to identify originating quota.
	QuotaCode *string `locationName:"quotaCode" type:"string"`

	// Identifier of the resource affected.
	ResourceId *string `locationName:"resourceId" type:"string"`

	// Type of the resource affected.
	ResourceType *string `locationName:"resourceType" type:"string"`

	// Service Quotas requirement to identify originating service.
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (*ServiceQuotaExceededException) Code added in v1.44.232 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.44.232 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.44.232 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

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

func (*ServiceQuotaExceededException) Message added in v1.44.232 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.44.232 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.44.232 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.44.232 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String added in v1.44.232 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

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

type Tag 

type Tag struct {

	// The key to use in the tag.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The value of the tag.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

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

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

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

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. The resource must be active
	// (not in the DELETING state), and must be owned by the account ID included
	// in the request.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of tags (key-value pairs) to add to the resource. All tag keys in
	// the request must be unique.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

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

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

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

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

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

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to remove tags from. The resource
	// must be active (not in the DELETING state), and must be owned by the account
	// ID included in the request.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The tag or set of tags to remove from the resource. All tag keys in the request
	// must be unique.
	//
	// TagKeys is a required field
	TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

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

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

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

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

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

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

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

type UpdateAccessPolicyInput 

type UpdateAccessPolicyInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string `locationName:"description" type:"string"`

	// The name of the policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The JSON policy document to use as the content for the policy.
	Policy *string `locationName:"policy" min:"1" type:"string"`

	// The version of the policy being updated.
	//
	// PolicyVersion is a required field
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string" required:"true"`

	// The type of policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AccessPolicyType"`
	// contains filtered or unexported fields
}

func (UpdateAccessPolicyInput) GoString 

func (s UpdateAccessPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessPolicyInput) SetClientToken 

func (s *UpdateAccessPolicyInput) SetClientToken(v string) *UpdateAccessPolicyInput

SetClientToken sets the ClientToken field's value.

func (*UpdateAccessPolicyInput) SetDescription 

func (s *UpdateAccessPolicyInput) SetDescription(v string) *UpdateAccessPolicyInput

SetDescription sets the Description field's value.

func (*UpdateAccessPolicyInput) SetName 

func (s *UpdateAccessPolicyInput) SetName(v string) *UpdateAccessPolicyInput

SetName sets the Name field's value.

func (*UpdateAccessPolicyInput) SetPolicy 

func (s *UpdateAccessPolicyInput) SetPolicy(v string) *UpdateAccessPolicyInput

SetPolicy sets the Policy field's value.

func (*UpdateAccessPolicyInput) SetPolicyVersion 

func (s *UpdateAccessPolicyInput) SetPolicyVersion(v string) *UpdateAccessPolicyInput

SetPolicyVersion sets the PolicyVersion field's value.

func (*UpdateAccessPolicyInput) SetType 

func (s *UpdateAccessPolicyInput) SetType(v string) *UpdateAccessPolicyInput

SetType sets the Type field's value.

func (UpdateAccessPolicyInput) String 

func (s UpdateAccessPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessPolicyInput) Validate 

func (s *UpdateAccessPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAccessPolicyOutput 

type UpdateAccessPolicyOutput struct {

	// Details about the updated access policy.
	AccessPolicyDetail *AccessPolicyDetail `locationName:"accessPolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAccessPolicyOutput) GoString 

func (s UpdateAccessPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessPolicyOutput) SetAccessPolicyDetail 

func (s *UpdateAccessPolicyOutput) SetAccessPolicyDetail(v *AccessPolicyDetail) *UpdateAccessPolicyOutput

SetAccessPolicyDetail sets the AccessPolicyDetail field's value.

func (UpdateAccessPolicyOutput) String 

func (s UpdateAccessPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAccountSettingsInput 

type UpdateAccountSettingsInput 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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html).
	CapacityLimits *CapacityLimits `locationName:"capacityLimits" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAccountSettingsInput) GoString 

func (s UpdateAccountSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountSettingsInput) SetCapacityLimits 

func (s *UpdateAccountSettingsInput) SetCapacityLimits(v *CapacityLimits) *UpdateAccountSettingsInput

SetCapacityLimits sets the CapacityLimits field's value.

func (UpdateAccountSettingsInput) String 

func (s UpdateAccountSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountSettingsInput) Validate 

func (s *UpdateAccountSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAccountSettingsOutput 

type UpdateAccountSettingsOutput struct {

	// OpenSearch Serverless-related settings for the current Amazon Web Services
	// account.
	AccountSettingsDetail *AccountSettingsDetail `locationName:"accountSettingsDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAccountSettingsOutput) GoString 

func (s UpdateAccountSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountSettingsOutput) SetAccountSettingsDetail 

func (s *UpdateAccountSettingsOutput) SetAccountSettingsDetail(v *AccountSettingsDetail) *UpdateAccountSettingsOutput

SetAccountSettingsDetail sets the AccountSettingsDetail field's value.

func (UpdateAccountSettingsOutput) String 

func (s UpdateAccountSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateCollectionDetail 

type UpdateCollectionDetail struct {

	// The Amazon Resource Name (ARN) of the collection.
	Arn *string `locationName:"arn" type:"string"`

	// The date and time when the collection was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The description of the collection.
	Description *string `locationName:"description" type:"string"`

	// The unique identifier of the collection.
	Id *string `locationName:"id" min:"3" type:"string"`

	// The date and time when the collection was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the collection.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The current status of the collection.
	Status *string `locationName:"status" type:"string" enum:"CollectionStatus"`

	// The collection type.
	Type *string `locationName:"type" type:"string" enum:"CollectionType"`
	// contains filtered or unexported fields
}

Details about an updated OpenSearch Serverless collection.

func (UpdateCollectionDetail) GoString 

func (s UpdateCollectionDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCollectionDetail) SetArn 

func (s *UpdateCollectionDetail) SetArn(v string) *UpdateCollectionDetail

SetArn sets the Arn field's value.

func (*UpdateCollectionDetail) SetCreatedDate 

func (s *UpdateCollectionDetail) SetCreatedDate(v int64) *UpdateCollectionDetail

SetCreatedDate sets the CreatedDate field's value.

func (*UpdateCollectionDetail) SetDescription 

func (s *UpdateCollectionDetail) SetDescription(v string) *UpdateCollectionDetail

SetDescription sets the Description field's value.

func (*UpdateCollectionDetail) SetId 

func (s *UpdateCollectionDetail) SetId(v string) *UpdateCollectionDetail

SetId sets the Id field's value.

func (*UpdateCollectionDetail) SetLastModifiedDate 

func (s *UpdateCollectionDetail) SetLastModifiedDate(v int64) *UpdateCollectionDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*UpdateCollectionDetail) SetName 

func (s *UpdateCollectionDetail) SetName(v string) *UpdateCollectionDetail

SetName sets the Name field's value.

func (*UpdateCollectionDetail) SetStatus 

func (s *UpdateCollectionDetail) SetStatus(v string) *UpdateCollectionDetail

SetStatus sets the Status field's value.

func (*UpdateCollectionDetail) SetType 

func (s *UpdateCollectionDetail) SetType(v string) *UpdateCollectionDetail

SetType sets the Type field's value.

func (UpdateCollectionDetail) String 

func (s UpdateCollectionDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateCollectionInput 

type UpdateCollectionInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the collection.
	Description *string `locationName:"description" type:"string"`

	// The unique identifier of the collection.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCollectionInput) GoString 

func (s UpdateCollectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCollectionInput) SetClientToken 

func (s *UpdateCollectionInput) SetClientToken(v string) *UpdateCollectionInput

SetClientToken sets the ClientToken field's value.

func (*UpdateCollectionInput) SetDescription 

func (s *UpdateCollectionInput) SetDescription(v string) *UpdateCollectionInput

SetDescription sets the Description field's value.

func (*UpdateCollectionInput) SetId 

func (s *UpdateCollectionInput) SetId(v string) *UpdateCollectionInput

SetId sets the Id field's value.

func (UpdateCollectionInput) String 

func (s UpdateCollectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCollectionInput) Validate 

func (s *UpdateCollectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateCollectionOutput 

type UpdateCollectionOutput struct {

	// Details about the updated collection.
	UpdateCollectionDetail *UpdateCollectionDetail `locationName:"updateCollectionDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateCollectionOutput) GoString 

func (s UpdateCollectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCollectionOutput) SetUpdateCollectionDetail 

func (s *UpdateCollectionOutput) SetUpdateCollectionDetail(v *UpdateCollectionDetail) *UpdateCollectionOutput

SetUpdateCollectionDetail sets the UpdateCollectionDetail field's value.

func (UpdateCollectionOutput) String 

func (s UpdateCollectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLifecyclePolicyInput added in v1.46.3 

type UpdateLifecyclePolicyInput struct {

	// A unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the lifecycle policy.
	Description *string `locationName:"description" type:"string"`

	// The name of the policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The JSON policy document to use as the content for the lifecycle policy.
	Policy *string `locationName:"policy" min:"1" type:"string"`

	// The version of the policy being updated.
	//
	// PolicyVersion is a required field
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string" required:"true"`

	// The type of lifecycle policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"LifecyclePolicyType"`
	// contains filtered or unexported fields
}

func (UpdateLifecyclePolicyInput) GoString added in v1.46.3 

func (s UpdateLifecyclePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLifecyclePolicyInput) SetClientToken added in v1.46.3 

func (s *UpdateLifecyclePolicyInput) SetClientToken(v string) *UpdateLifecyclePolicyInput

SetClientToken sets the ClientToken field's value.

func (*UpdateLifecyclePolicyInput) SetDescription added in v1.46.3 

func (s *UpdateLifecyclePolicyInput) SetDescription(v string) *UpdateLifecyclePolicyInput

SetDescription sets the Description field's value.

func (*UpdateLifecyclePolicyInput) SetName added in v1.46.3 

func (s *UpdateLifecyclePolicyInput) SetName(v string) *UpdateLifecyclePolicyInput

SetName sets the Name field's value.

func (*UpdateLifecyclePolicyInput) SetPolicy added in v1.46.3 

func (s *UpdateLifecyclePolicyInput) SetPolicy(v string) *UpdateLifecyclePolicyInput

SetPolicy sets the Policy field's value.

func (*UpdateLifecyclePolicyInput) SetPolicyVersion added in v1.46.3 

func (s *UpdateLifecyclePolicyInput) SetPolicyVersion(v string) *UpdateLifecyclePolicyInput

SetPolicyVersion sets the PolicyVersion field's value.

func (*UpdateLifecyclePolicyInput) SetType added in v1.46.3 

func (s *UpdateLifecyclePolicyInput) SetType(v string) *UpdateLifecyclePolicyInput

SetType sets the Type field's value.

func (UpdateLifecyclePolicyInput) String added in v1.46.3 

func (s UpdateLifecyclePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLifecyclePolicyInput) Validate added in v1.46.3 

func (s *UpdateLifecyclePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLifecyclePolicyOutput added in v1.46.3 

type UpdateLifecyclePolicyOutput struct {

	// Details about the updated lifecycle policy.
	LifecyclePolicyDetail *LifecyclePolicyDetail `locationName:"lifecyclePolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateLifecyclePolicyOutput) GoString added in v1.46.3 

func (s UpdateLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLifecyclePolicyOutput) SetLifecyclePolicyDetail added in v1.46.3 

func (s *UpdateLifecyclePolicyOutput) SetLifecyclePolicyDetail(v *LifecyclePolicyDetail) *UpdateLifecyclePolicyOutput

SetLifecyclePolicyDetail sets the LifecyclePolicyDetail field's value.

func (UpdateLifecyclePolicyOutput) String added in v1.46.3 

func (s UpdateLifecyclePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSecurityConfigInput 

type UpdateSecurityConfigInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The version of the security configuration to be updated. You can find the
	// most recent version of a security configuration using the GetSecurityPolicy
	// command.
	//
	// ConfigVersion is a required field
	ConfigVersion *string `locationName:"configVersion" min:"20" type:"string" required:"true"`

	// A description of the security configuration.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>.
	// For example, saml/123456789123/OKTADev.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// SAML options in in the form of a key-value map.
	SamlOptions *SamlConfigOptions `locationName:"samlOptions" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSecurityConfigInput) GoString 

func (s UpdateSecurityConfigInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityConfigInput) SetClientToken 

func (s *UpdateSecurityConfigInput) SetClientToken(v string) *UpdateSecurityConfigInput

SetClientToken sets the ClientToken field's value.

func (*UpdateSecurityConfigInput) SetConfigVersion 

func (s *UpdateSecurityConfigInput) SetConfigVersion(v string) *UpdateSecurityConfigInput

SetConfigVersion sets the ConfigVersion field's value.

func (*UpdateSecurityConfigInput) SetDescription 

func (s *UpdateSecurityConfigInput) SetDescription(v string) *UpdateSecurityConfigInput

SetDescription sets the Description field's value.

func (*UpdateSecurityConfigInput) SetId 

func (s *UpdateSecurityConfigInput) SetId(v string) *UpdateSecurityConfigInput

SetId sets the Id field's value.

func (*UpdateSecurityConfigInput) SetSamlOptions 

func (s *UpdateSecurityConfigInput) SetSamlOptions(v *SamlConfigOptions) *UpdateSecurityConfigInput

SetSamlOptions sets the SamlOptions field's value.

func (UpdateSecurityConfigInput) String 

func (s UpdateSecurityConfigInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityConfigInput) Validate 

func (s *UpdateSecurityConfigInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSecurityConfigOutput 

type UpdateSecurityConfigOutput struct {

	// Details about the updated security configuration.
	SecurityConfigDetail *SecurityConfigDetail `locationName:"securityConfigDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSecurityConfigOutput) GoString 

func (s UpdateSecurityConfigOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityConfigOutput) SetSecurityConfigDetail 

func (s *UpdateSecurityConfigOutput) SetSecurityConfigDetail(v *SecurityConfigDetail) *UpdateSecurityConfigOutput

SetSecurityConfigDetail sets the SecurityConfigDetail field's value.

func (UpdateSecurityConfigOutput) String 

func (s UpdateSecurityConfigOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSecurityPolicyInput 

type UpdateSecurityPolicyInput struct {

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string `locationName:"description" type:"string"`

	// The name of the policy.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The JSON policy document to use as the content for the new policy.
	Policy *string `locationName:"policy" min:"1" type:"string"`

	// The version of the policy being updated.
	//
	// PolicyVersion is a required field
	PolicyVersion *string `locationName:"policyVersion" min:"20" type:"string" required:"true"`

	// The type of access policy.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SecurityPolicyType"`
	// contains filtered or unexported fields
}

func (UpdateSecurityPolicyInput) GoString 

func (s UpdateSecurityPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityPolicyInput) SetClientToken 

func (s *UpdateSecurityPolicyInput) SetClientToken(v string) *UpdateSecurityPolicyInput

SetClientToken sets the ClientToken field's value.

func (*UpdateSecurityPolicyInput) SetDescription 

func (s *UpdateSecurityPolicyInput) SetDescription(v string) *UpdateSecurityPolicyInput

SetDescription sets the Description field's value.

func (*UpdateSecurityPolicyInput) SetName 

func (s *UpdateSecurityPolicyInput) SetName(v string) *UpdateSecurityPolicyInput

SetName sets the Name field's value.

func (*UpdateSecurityPolicyInput) SetPolicy 

func (s *UpdateSecurityPolicyInput) SetPolicy(v string) *UpdateSecurityPolicyInput

SetPolicy sets the Policy field's value.

func (*UpdateSecurityPolicyInput) SetPolicyVersion 

func (s *UpdateSecurityPolicyInput) SetPolicyVersion(v string) *UpdateSecurityPolicyInput

SetPolicyVersion sets the PolicyVersion field's value.

func (*UpdateSecurityPolicyInput) SetType 

func (s *UpdateSecurityPolicyInput) SetType(v string) *UpdateSecurityPolicyInput

SetType sets the Type field's value.

func (UpdateSecurityPolicyInput) String 

func (s UpdateSecurityPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityPolicyInput) Validate 

func (s *UpdateSecurityPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSecurityPolicyOutput 

type UpdateSecurityPolicyOutput struct {

	// Details about the updated security policy.
	SecurityPolicyDetail *SecurityPolicyDetail `locationName:"securityPolicyDetail" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSecurityPolicyOutput) GoString 

func (s UpdateSecurityPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityPolicyOutput) SetSecurityPolicyDetail 

func (s *UpdateSecurityPolicyOutput) SetSecurityPolicyDetail(v *SecurityPolicyDetail) *UpdateSecurityPolicyOutput

SetSecurityPolicyDetail sets the SecurityPolicyDetail field's value.

func (UpdateSecurityPolicyOutput) String 

func (s UpdateSecurityPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateVpcEndpointDetail 

type UpdateVpcEndpointDetail struct {

	// The unique identifier of the endpoint.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The timestamp of when the endpoint was last modified.
	LastModifiedDate *int64 `locationName:"lastModifiedDate" type:"long"`

	// The name of the endpoint.
	Name *string `locationName:"name" min:"3" type:"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 `locationName:"securityGroupIds" min:"1" type:"list"`

	// The current status of the endpoint update process.
	Status *string `locationName:"status" type:"string" enum:"VpcEndpointStatus"`

	// The ID of the subnets from which you access OpenSearch Serverless.
	SubnetIds []*string `locationName:"subnetIds" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Update details for an OpenSearch Serverless-managed interface endpoint.

func (UpdateVpcEndpointDetail) GoString 

func (s UpdateVpcEndpointDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVpcEndpointDetail) SetId 

func (s *UpdateVpcEndpointDetail) SetId(v string) *UpdateVpcEndpointDetail

SetId sets the Id field's value.

func (*UpdateVpcEndpointDetail) SetLastModifiedDate 

func (s *UpdateVpcEndpointDetail) SetLastModifiedDate(v int64) *UpdateVpcEndpointDetail

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*UpdateVpcEndpointDetail) SetName 

func (s *UpdateVpcEndpointDetail) SetName(v string) *UpdateVpcEndpointDetail

SetName sets the Name field's value.

func (*UpdateVpcEndpointDetail) SetSecurityGroupIds 

func (s *UpdateVpcEndpointDetail) SetSecurityGroupIds(v []*string) *UpdateVpcEndpointDetail

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*UpdateVpcEndpointDetail) SetStatus 

func (s *UpdateVpcEndpointDetail) SetStatus(v string) *UpdateVpcEndpointDetail

SetStatus sets the Status field's value.

func (*UpdateVpcEndpointDetail) SetSubnetIds 

func (s *UpdateVpcEndpointDetail) SetSubnetIds(v []*string) *UpdateVpcEndpointDetail

SetSubnetIds sets the SubnetIds field's value.

func (UpdateVpcEndpointDetail) String 

func (s UpdateVpcEndpointDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateVpcEndpointInput 

type UpdateVpcEndpointInput struct {

	// The unique identifiers of the security groups to add to the endpoint. Security
	// groups define the ports, protocols, and sources for inbound traffic that
	// you are authorizing into your endpoint.
	AddSecurityGroupIds []*string `locationName:"addSecurityGroupIds" min:"1" type:"list"`

	// The ID of one or more subnets to add to the endpoint.
	AddSubnetIds []*string `locationName:"addSubnetIds" min:"1" type:"list"`

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The unique identifier of the interface endpoint to update.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// The unique identifiers of the security groups to remove from the endpoint.
	RemoveSecurityGroupIds []*string `locationName:"removeSecurityGroupIds" min:"1" type:"list"`

	// The unique identifiers of the subnets to remove from the endpoint.
	RemoveSubnetIds []*string `locationName:"removeSubnetIds" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateVpcEndpointInput) GoString 

func (s UpdateVpcEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVpcEndpointInput) SetAddSecurityGroupIds 

func (s *UpdateVpcEndpointInput) SetAddSecurityGroupIds(v []*string) *UpdateVpcEndpointInput

SetAddSecurityGroupIds sets the AddSecurityGroupIds field's value.

func (*UpdateVpcEndpointInput) SetAddSubnetIds 

func (s *UpdateVpcEndpointInput) SetAddSubnetIds(v []*string) *UpdateVpcEndpointInput

SetAddSubnetIds sets the AddSubnetIds field's value.

func (*UpdateVpcEndpointInput) SetClientToken 

func (s *UpdateVpcEndpointInput) SetClientToken(v string) *UpdateVpcEndpointInput

SetClientToken sets the ClientToken field's value.

func (*UpdateVpcEndpointInput) SetId 

func (s *UpdateVpcEndpointInput) SetId(v string) *UpdateVpcEndpointInput

SetId sets the Id field's value.

func (*UpdateVpcEndpointInput) SetRemoveSecurityGroupIds 

func (s *UpdateVpcEndpointInput) SetRemoveSecurityGroupIds(v []*string) *UpdateVpcEndpointInput

SetRemoveSecurityGroupIds sets the RemoveSecurityGroupIds field's value.

func (*UpdateVpcEndpointInput) SetRemoveSubnetIds 

func (s *UpdateVpcEndpointInput) SetRemoveSubnetIds(v []*string) *UpdateVpcEndpointInput

SetRemoveSubnetIds sets the RemoveSubnetIds field's value.

func (UpdateVpcEndpointInput) String 

func (s UpdateVpcEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVpcEndpointInput) Validate 

func (s *UpdateVpcEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateVpcEndpointOutput 

type UpdateVpcEndpointOutput struct {

	// Details about the updated VPC endpoint.
	UpdateVpcEndpointDetail *UpdateVpcEndpointDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateVpcEndpointOutput) GoString 

func (s UpdateVpcEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVpcEndpointOutput) SetUpdateVpcEndpointDetail 

func (s *UpdateVpcEndpointOutput) SetUpdateVpcEndpointDetail(v *UpdateVpcEndpointDetail) *UpdateVpcEndpointOutput

SetUpdateVpcEndpointDetail sets the UpdateVpcEndpointDetail field's value.

func (UpdateVpcEndpointOutput) String 

func (s UpdateVpcEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when the HTTP request contains invalid input or is missing required input.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcEndpointDetail 

type VpcEndpointDetail struct {

	// The date the endpoint was created.
	CreatedDate *int64 `locationName:"createdDate" type:"long"`

	// The unique identifier of the endpoint.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The name of the endpoint.
	Name *string `locationName:"name" min:"3" type:"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 `locationName:"securityGroupIds" min:"1" type:"list"`

	// The current status of the endpoint.
	Status *string `locationName:"status" type:"string" enum:"VpcEndpointStatus"`

	// The ID of the subnets from which you access OpenSearch Serverless.
	SubnetIds []*string `locationName:"subnetIds" min:"1" type:"list"`

	// The ID of the VPC from which you access OpenSearch Serverless.
	VpcId *string `locationName:"vpcId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Details about an OpenSearch Serverless-managed interface endpoint.

func (VpcEndpointDetail) GoString 

func (s VpcEndpointDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcEndpointDetail) SetCreatedDate 

func (s *VpcEndpointDetail) SetCreatedDate(v int64) *VpcEndpointDetail

SetCreatedDate sets the CreatedDate field's value.

func (*VpcEndpointDetail) SetId 

func (s *VpcEndpointDetail) SetId(v string) *VpcEndpointDetail

SetId sets the Id field's value.

func (*VpcEndpointDetail) SetName 

func (s *VpcEndpointDetail) SetName(v string) *VpcEndpointDetail

SetName sets the Name field's value.

func (*VpcEndpointDetail) SetSecurityGroupIds 

func (s *VpcEndpointDetail) SetSecurityGroupIds(v []*string) *VpcEndpointDetail

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcEndpointDetail) SetStatus 

func (s *VpcEndpointDetail) SetStatus(v string) *VpcEndpointDetail

SetStatus sets the Status field's value.

func (*VpcEndpointDetail) SetSubnetIds 

func (s *VpcEndpointDetail) SetSubnetIds(v []*string) *VpcEndpointDetail

SetSubnetIds sets the SubnetIds field's value.

func (*VpcEndpointDetail) SetVpcId 

func (s *VpcEndpointDetail) SetVpcId(v string) *VpcEndpointDetail

SetVpcId sets the VpcId field's value.

func (VpcEndpointDetail) String 

func (s VpcEndpointDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcEndpointErrorDetail 

type VpcEndpointErrorDetail struct {

	// The error code for the failed request.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// An error message describing the reason for the failure.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The unique identifier of the VPC endpoint.
	Id *string `locationName:"id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Error information for a failed BatchGetVpcEndpoint request.

func (VpcEndpointErrorDetail) GoString 

func (s VpcEndpointErrorDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcEndpointErrorDetail) SetErrorCode 

func (s *VpcEndpointErrorDetail) SetErrorCode(v string) *VpcEndpointErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*VpcEndpointErrorDetail) SetErrorMessage 

func (s *VpcEndpointErrorDetail) SetErrorMessage(v string) *VpcEndpointErrorDetail

SetErrorMessage sets the ErrorMessage field's value.

func (*VpcEndpointErrorDetail) SetId 

func (s *VpcEndpointErrorDetail) SetId(v string) *VpcEndpointErrorDetail

SetId sets the Id field's value.

func (VpcEndpointErrorDetail) String 

func (s VpcEndpointErrorDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcEndpointFilters 

type VpcEndpointFilters struct {

	// The current status of the endpoint.
	Status *string `locationName:"status" type:"string" enum:"VpcEndpointStatus"`
	// contains filtered or unexported fields
}

Filter the results of a ListVpcEndpoints request.

func (VpcEndpointFilters) GoString 

func (s VpcEndpointFilters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcEndpointFilters) SetStatus 

func (s *VpcEndpointFilters) SetStatus(v string) *VpcEndpointFilters

SetStatus sets the Status field's value.

func (VpcEndpointFilters) String 

func (s VpcEndpointFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcEndpointSummary 

type VpcEndpointSummary struct {

	// The unique identifier of the endpoint.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The name of the endpoint.
	Name *string `locationName:"name" min:"3" type:"string"`

	// The current status of the endpoint.
	Status *string `locationName:"status" type:"string" enum:"VpcEndpointStatus"`
	// contains filtered or unexported fields
}

The VPC endpoint object.

func (VpcEndpointSummary) GoString 

func (s VpcEndpointSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcEndpointSummary) SetId 

func (s *VpcEndpointSummary) SetId(v string) *VpcEndpointSummary

SetId sets the Id field's value.

func (*VpcEndpointSummary) SetName 

func (s *VpcEndpointSummary) SetName(v string) *VpcEndpointSummary

SetName sets the Name field's value.

func (*VpcEndpointSummary) SetStatus 

func (s *VpcEndpointSummary) SetStatus(v string) *VpcEndpointSummary

SetStatus sets the Status field's value.

func (VpcEndpointSummary) String 

func (s VpcEndpointSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package opensearchserverlessiface provides an interface to enable mocking the OpenSearch Service Serverless service client for testing your code.
 Package opensearchserverlessiface provides an interface to enable mocking the OpenSearch Service Serverless service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.