opensearchserverless

package module
v1.11.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 42 Imported by: 2

Documentation

Overview

Package opensearchserverless provides the API client, operations, and parameter types for 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)

Index

Constants

View Source 
const ServiceAPIVersion = "2021-11-01"
View Source 
const ServiceID = "OpenSearchServerless"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.4.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.8.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.8.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.8.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.8.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

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

	// A list of collection names. You can't provide names and IDs in the same request.
	Names []string
	// contains filtered or unexported fields
}

type BatchGetCollectionOutput 

type BatchGetCollectionOutput struct {

	// Details about each collection.
	CollectionDetails []types.CollectionDetail

	// Error information for the request.
	CollectionErrorDetails []types.CollectionErrorDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetEffectiveLifecyclePolicyInput added in v1.6.0 

type BatchGetEffectiveLifecyclePolicyInput struct {

	// The unique identifiers of policy types and resource names.
	//
	// This member is required.
	ResourceIdentifiers []types.LifecyclePolicyResourceIdentifier
	// contains filtered or unexported fields
}

type BatchGetEffectiveLifecyclePolicyOutput added in v1.6.0 

type BatchGetEffectiveLifecyclePolicyOutput struct {

	// A list of lifecycle policies applied to the OpenSearch Serverless indexes.
	EffectiveLifecyclePolicyDetails []types.EffectiveLifecyclePolicyDetail

	// A list of resources for which retrieval failed.
	EffectiveLifecyclePolicyErrorDetails []types.EffectiveLifecyclePolicyErrorDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetLifecyclePolicyInput added in v1.6.0 

type BatchGetLifecyclePolicyInput struct {

	// The unique identifiers of policy types and policy names.
	//
	// This member is required.
	Identifiers []types.LifecyclePolicyIdentifier
	// contains filtered or unexported fields
}

type BatchGetLifecyclePolicyOutput added in v1.6.0 

type BatchGetLifecyclePolicyOutput struct {

	// A list of lifecycle policies matched to the input policy name and policy type.
	LifecyclePolicyDetails []types.LifecyclePolicyDetail

	// A list of lifecycle policy names and policy types for which retrieval failed.
	LifecyclePolicyErrorDetails []types.LifecyclePolicyErrorDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetVpcEndpointInput 

type BatchGetVpcEndpointInput struct {

	// A list of VPC endpoint identifiers.
	//
	// This member is required.
	Ids []string
	// contains filtered or unexported fields
}

type BatchGetVpcEndpointOutput 

type BatchGetVpcEndpointOutput struct {

	// Details about the specified VPC endpoint.
	VpcEndpointDetails []types.VpcEndpointDetail

	// Error information for a failed request.
	VpcEndpointErrorDetails []types.VpcEndpointErrorDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

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

Client provides the API client to make operations call for OpenSearch Service Serverless.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetCollection 

func (c *Client) BatchGetCollection(ctx context.Context, params *BatchGetCollectionInput, optFns ...func(*Options)) (*BatchGetCollectionOutput, error)

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

func (*Client) BatchGetEffectiveLifecyclePolicy added in v1.6.0 

func (c *Client) BatchGetEffectiveLifecyclePolicy(ctx context.Context, params *BatchGetEffectiveLifecyclePolicyInput, optFns ...func(*Options)) (*BatchGetEffectiveLifecyclePolicyOutput, error)

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

func (*Client) BatchGetLifecyclePolicy added in v1.6.0 

func (c *Client) BatchGetLifecyclePolicy(ctx context.Context, params *BatchGetLifecyclePolicyInput, optFns ...func(*Options)) (*BatchGetLifecyclePolicyOutput, error)

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

func (*Client) BatchGetVpcEndpoint 

func (c *Client) BatchGetVpcEndpoint(ctx context.Context, params *BatchGetVpcEndpointInput, optFns ...func(*Options)) (*BatchGetVpcEndpointOutput, error)

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

func (*Client) CreateAccessPolicy 

func (c *Client) CreateAccessPolicy(ctx context.Context, params *CreateAccessPolicyInput, optFns ...func(*Options)) (*CreateAccessPolicyOutput, error)

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

func (*Client) CreateCollection 

func (c *Client) CreateCollection(ctx context.Context, params *CreateCollectionInput, optFns ...func(*Options)) (*CreateCollectionOutput, error)

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

func (*Client) CreateLifecyclePolicy added in v1.6.0 

func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecyclePolicyInput, optFns ...func(*Options)) (*CreateLifecyclePolicyOutput, error)

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

func (*Client) CreateSecurityConfig 

func (c *Client) CreateSecurityConfig(ctx context.Context, params *CreateSecurityConfigInput, optFns ...func(*Options)) (*CreateSecurityConfigOutput, error)

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

func (*Client) CreateSecurityPolicy 

func (c *Client) CreateSecurityPolicy(ctx context.Context, params *CreateSecurityPolicyInput, optFns ...func(*Options)) (*CreateSecurityPolicyOutput, error)

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

func (*Client) CreateVpcEndpoint 

func (c *Client) CreateVpcEndpoint(ctx context.Context, params *CreateVpcEndpointInput, optFns ...func(*Options)) (*CreateVpcEndpointOutput, error)

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

func (*Client) DeleteAccessPolicy 

func (c *Client) DeleteAccessPolicy(ctx context.Context, params *DeleteAccessPolicyInput, optFns ...func(*Options)) (*DeleteAccessPolicyOutput, error)

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

func (*Client) DeleteCollection 

func (c *Client) DeleteCollection(ctx context.Context, params *DeleteCollectionInput, optFns ...func(*Options)) (*DeleteCollectionOutput, error)

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

func (*Client) DeleteLifecyclePolicy added in v1.6.0 

func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecyclePolicyInput, optFns ...func(*Options)) (*DeleteLifecyclePolicyOutput, error)

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

func (*Client) DeleteSecurityConfig 

func (c *Client) DeleteSecurityConfig(ctx context.Context, params *DeleteSecurityConfigInput, optFns ...func(*Options)) (*DeleteSecurityConfigOutput, error)

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

func (*Client) DeleteSecurityPolicy 

func (c *Client) DeleteSecurityPolicy(ctx context.Context, params *DeleteSecurityPolicyInput, optFns ...func(*Options)) (*DeleteSecurityPolicyOutput, error)

Deletes an OpenSearch Serverless security policy.

func (*Client) DeleteVpcEndpoint 

func (c *Client) DeleteVpcEndpoint(ctx context.Context, params *DeleteVpcEndpointInput, optFns ...func(*Options)) (*DeleteVpcEndpointOutput, error)

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

func (*Client) GetAccessPolicy 

func (c *Client) GetAccessPolicy(ctx context.Context, params *GetAccessPolicyInput, optFns ...func(*Options)) (*GetAccessPolicyOutput, error)

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

func (*Client) GetAccountSettings 

func (c *Client) GetAccountSettings(ctx context.Context, params *GetAccountSettingsInput, optFns ...func(*Options)) (*GetAccountSettingsOutput, error)

Returns account-level settings related to OpenSearch Serverless.

func (*Client) GetPoliciesStats 

func (c *Client) GetPoliciesStats(ctx context.Context, params *GetPoliciesStatsInput, optFns ...func(*Options)) (*GetPoliciesStatsOutput, error)

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

func (*Client) GetSecurityConfig 

func (c *Client) GetSecurityConfig(ctx context.Context, params *GetSecurityConfigInput, optFns ...func(*Options)) (*GetSecurityConfigOutput, error)

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

func (*Client) GetSecurityPolicy 

func (c *Client) GetSecurityPolicy(ctx context.Context, params *GetSecurityPolicyInput, optFns ...func(*Options)) (*GetSecurityPolicyOutput, error)

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

func (*Client) ListAccessPolicies 

func (c *Client) ListAccessPolicies(ctx context.Context, params *ListAccessPoliciesInput, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)

Returns information about a list of OpenSearch Serverless access policies.

func (*Client) ListCollections 

func (c *Client) ListCollections(ctx context.Context, params *ListCollectionsInput, optFns ...func(*Options)) (*ListCollectionsOutput, error)

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.

func (*Client) ListLifecyclePolicies added in v1.6.0 

func (c *Client) ListLifecyclePolicies(ctx context.Context, params *ListLifecyclePoliciesInput, optFns ...func(*Options)) (*ListLifecyclePoliciesOutput, error)

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

func (*Client) ListSecurityConfigs 

func (c *Client) ListSecurityConfigs(ctx context.Context, params *ListSecurityConfigsInput, optFns ...func(*Options)) (*ListSecurityConfigsOutput, error)

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

func (*Client) ListSecurityPolicies 

func (c *Client) ListSecurityPolicies(ctx context.Context, params *ListSecurityPoliciesInput, optFns ...func(*Options)) (*ListSecurityPoliciesOutput, error)

Returns information about configured OpenSearch Serverless security policies.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

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

func (*Client) ListVpcEndpoints 

func (c *Client) ListVpcEndpoints(ctx context.Context, params *ListVpcEndpointsInput, optFns ...func(*Options)) (*ListVpcEndpointsOutput, error)

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

func (*Client) Options added in v1.9.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

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

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

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

func (*Client) UpdateAccessPolicy 

func (c *Client) UpdateAccessPolicy(ctx context.Context, params *UpdateAccessPolicyInput, optFns ...func(*Options)) (*UpdateAccessPolicyOutput, error)

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

func (*Client) UpdateAccountSettings 

func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error)

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

func (*Client) UpdateCollection 

func (c *Client) UpdateCollection(ctx context.Context, params *UpdateCollectionInput, optFns ...func(*Options)) (*UpdateCollectionOutput, error)

Updates an OpenSearch Serverless collection.

func (*Client) UpdateLifecyclePolicy added in v1.6.0 

func (c *Client) UpdateLifecyclePolicy(ctx context.Context, params *UpdateLifecyclePolicyInput, optFns ...func(*Options)) (*UpdateLifecyclePolicyOutput, error)

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

func (*Client) UpdateSecurityConfig 

func (c *Client) UpdateSecurityConfig(ctx context.Context, params *UpdateSecurityConfigInput, optFns ...func(*Options)) (*UpdateSecurityConfigOutput, error)

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

func (*Client) UpdateSecurityPolicy 

func (c *Client) UpdateSecurityPolicy(ctx context.Context, params *UpdateSecurityPolicyInput, optFns ...func(*Options)) (*UpdateSecurityPolicyOutput, error)

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

func (*Client) UpdateVpcEndpoint 

func (c *Client) UpdateVpcEndpoint(ctx context.Context, params *UpdateVpcEndpointInput, optFns ...func(*Options)) (*UpdateVpcEndpointOutput, error)

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

type CreateAccessPolicyInput 

type CreateAccessPolicyInput struct {

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

	// The JSON policy document to use as the content for the policy.
	//
	// This member is required.
	Policy *string

	// The type of policy.
	//
	// This member is required.
	Type types.AccessPolicyType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string
	// contains filtered or unexported fields
}

type CreateAccessPolicyOutput 

type CreateAccessPolicyOutput struct {

	// Details about the created access policy.
	AccessPolicyDetail *types.AccessPolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCollectionInput 

type CreateCollectionInput struct {

	// Name of the collection.
	//
	// This member is required.
	Name *string

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// Description of the collection.
	Description *string

	// Indicates whether standby replicas should be used for a collection.
	StandbyReplicas types.StandbyReplicas

	// An arbitrary set of tags (key–value pairs) to associate with the OpenSearch
	// Serverless collection.
	Tags []types.Tag

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

type CreateCollectionOutput 

type CreateCollectionOutput struct {

	// Details about the collection.
	CreateCollectionDetail *types.CreateCollectionDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLifecyclePolicyInput added in v1.6.0 

type CreateLifecyclePolicyInput struct {

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

	// The JSON policy document to use as the content for the lifecycle policy.
	//
	// This member is required.
	Policy *string

	// The type of lifecycle policy.
	//
	// This member is required.
	Type types.LifecyclePolicyType

	// A unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// A description of the lifecycle policy.
	Description *string
	// contains filtered or unexported fields
}

type CreateLifecyclePolicyOutput added in v1.6.0 

type CreateLifecyclePolicyOutput struct {

	// Details about the created lifecycle policy.
	LifecyclePolicyDetail *types.LifecyclePolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSecurityConfigInput 

type CreateSecurityConfigInput struct {

	// The name of the security configuration.
	//
	// This member is required.
	Name *string

	// The type of security configuration.
	//
	// This member is required.
	Type types.SecurityConfigType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

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

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

type CreateSecurityConfigOutput 

type CreateSecurityConfigOutput struct {

	// Details about the created security configuration.
	SecurityConfigDetail *types.SecurityConfigDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSecurityPolicyInput 

type CreateSecurityPolicyInput struct {

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

	// The JSON policy document to use as the content for the new policy.
	//
	// This member is required.
	Policy *string

	// The type of security policy.
	//
	// This member is required.
	Type types.SecurityPolicyType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string
	// contains filtered or unexported fields
}

type CreateSecurityPolicyOutput 

type CreateSecurityPolicyOutput struct {

	// Details about the created security policy.
	SecurityPolicyDetail *types.SecurityPolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVpcEndpointInput 

type CreateVpcEndpointInput struct {

	// The name of the interface endpoint.
	//
	// This member is required.
	Name *string

	// The ID of one or more subnets from which you'll access OpenSearch Serverless.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the VPC from which you'll access OpenSearch Serverless.
	//
	// This member is required.
	VpcId *string

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *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
	// contains filtered or unexported fields
}

type CreateVpcEndpointOutput 

type CreateVpcEndpointOutput struct {

	// Details about the created interface VPC endpoint.
	CreateVpcEndpointDetail *types.CreateVpcEndpointDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAccessPolicyInput 

type DeleteAccessPolicyInput struct {

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

	// The type of policy.
	//
	// This member is required.
	Type types.AccessPolicyType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteAccessPolicyOutput 

type DeleteAccessPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCollectionInput 

type DeleteCollectionInput struct {

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

	// A unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteCollectionOutput 

type DeleteCollectionOutput struct {

	// Details of the deleted collection.
	DeleteCollectionDetail *types.DeleteCollectionDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLifecyclePolicyInput added in v1.6.0 

type DeleteLifecyclePolicyInput struct {

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

	// The type of lifecycle policy.
	//
	// This member is required.
	Type types.LifecyclePolicyType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteLifecyclePolicyOutput added in v1.6.0 

type DeleteLifecyclePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSecurityConfigInput 

type DeleteSecurityConfigInput struct {

	// The security configuration identifier. For SAML the ID will be
	// saml/<accountId>/<idpProviderName> . For example, saml/123456789123/OKTADev .
	//
	// This member is required.
	Id *string

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteSecurityConfigOutput 

type DeleteSecurityConfigOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSecurityPolicyInput 

type DeleteSecurityPolicyInput struct {

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

	// The type of policy.
	//
	// This member is required.
	Type types.SecurityPolicyType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteSecurityPolicyOutput 

type DeleteSecurityPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVpcEndpointInput 

type DeleteVpcEndpointInput struct {

	// The VPC endpoint identifier.
	//
	// This member is required.
	Id *string

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteVpcEndpointOutput 

type DeleteVpcEndpointOutput struct {

	// Details about the deleted endpoint.
	DeleteVpcEndpointDetail *types.DeleteVpcEndpointDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.4.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.4.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.4.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.4.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.4.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccessPolicyInput 

type GetAccessPolicyInput struct {

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

	// Tye type of policy. Currently, the only supported value is data .
	//
	// This member is required.
	Type types.AccessPolicyType
	// contains filtered or unexported fields
}

type GetAccessPolicyOutput 

type GetAccessPolicyOutput struct {

	// Details about the requested access policy.
	AccessPolicyDetail *types.AccessPolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAccountSettingsInput 

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

type GetAccountSettingsOutput 

type GetAccountSettingsOutput struct {

	// OpenSearch Serverless-related details for the current account.
	AccountSettingsDetail *types.AccountSettingsDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPoliciesStatsInput 

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

type GetPoliciesStatsOutput 

type GetPoliciesStatsOutput struct {

	// Information about the data access policies in your account.
	AccessPolicyStats *types.AccessPolicyStats

	// Information about the lifecycle policies in your account.
	LifecyclePolicyStats *types.LifecyclePolicyStats

	// Information about the security configurations in your account.
	SecurityConfigStats *types.SecurityConfigStats

	// Information about the security policies in your account.
	SecurityPolicyStats *types.SecurityPolicyStats

	// The total number of OpenSearch Serverless security policies and configurations
	// in your account.
	TotalPolicyCount *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSecurityConfigInput 

type GetSecurityConfigInput struct {

	// The unique identifier of the security configuration.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetSecurityConfigOutput 

type GetSecurityConfigOutput struct {

	// Details of the requested security configuration.
	SecurityConfigDetail *types.SecurityConfigDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSecurityPolicyInput 

type GetSecurityPolicyInput struct {

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

	// The type of security policy.
	//
	// This member is required.
	Type types.SecurityPolicyType
	// contains filtered or unexported fields
}

type GetSecurityPolicyOutput 

type GetSecurityPolicyOutput struct {

	// Details about the requested security policy.
	SecurityPolicyDetail *types.SecurityPolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAccessPoliciesAPIClient 

type ListAccessPoliciesAPIClient interface {
	ListAccessPolicies(context.Context, *ListAccessPoliciesInput, ...func(*Options)) (*ListAccessPoliciesOutput, error)
}

ListAccessPoliciesAPIClient is a client that implements the ListAccessPolicies operation.

type ListAccessPoliciesInput 

type ListAccessPoliciesInput struct {

	// The type of access policy.
	//
	// This member is required.
	Type types.AccessPolicyType

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

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

	// Resource filters (can be collections or indexes) that policies can apply to.
	Resource []string
	// contains filtered or unexported fields
}

type ListAccessPoliciesOutput 

type ListAccessPoliciesOutput struct {

	// Details about the requested access policies.
	AccessPolicySummaries []types.AccessPolicySummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAccessPoliciesPaginator 

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

ListAccessPoliciesPaginator is a paginator for ListAccessPolicies

func NewListAccessPoliciesPaginator 

func NewListAccessPoliciesPaginator(client ListAccessPoliciesAPIClient, params *ListAccessPoliciesInput, optFns ...func(*ListAccessPoliciesPaginatorOptions)) *ListAccessPoliciesPaginator

NewListAccessPoliciesPaginator returns a new ListAccessPoliciesPaginator

func (*ListAccessPoliciesPaginator) HasMorePages 

func (p *ListAccessPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccessPoliciesPaginator) NextPage 

func (p *ListAccessPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)

NextPage retrieves the next ListAccessPolicies page.

type ListAccessPoliciesPaginatorOptions 

type ListAccessPoliciesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAccessPoliciesPaginatorOptions is the paginator options for ListAccessPolicies

type ListCollectionsAPIClient 

type ListCollectionsAPIClient interface {
	ListCollections(context.Context, *ListCollectionsInput, ...func(*Options)) (*ListCollectionsOutput, error)
}

ListCollectionsAPIClient is a client that implements the ListCollections operation.

type ListCollectionsInput 

type ListCollectionsInput struct {

	// A list of filter names and values that you can use for requests.
	CollectionFilters *types.CollectionFilters

	// The maximum number of results to return. Default is 20. You can use nextToken
	// to get the next page of results.
	MaxResults *int32

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

type ListCollectionsOutput 

type ListCollectionsOutput struct {

	// Details about each collection.
	CollectionSummaries []types.CollectionSummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCollectionsPaginator 

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

ListCollectionsPaginator is a paginator for ListCollections

func NewListCollectionsPaginator 

func NewListCollectionsPaginator(client ListCollectionsAPIClient, params *ListCollectionsInput, optFns ...func(*ListCollectionsPaginatorOptions)) *ListCollectionsPaginator

NewListCollectionsPaginator returns a new ListCollectionsPaginator

func (*ListCollectionsPaginator) HasMorePages 

func (p *ListCollectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCollectionsPaginator) NextPage 

func (p *ListCollectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCollectionsOutput, error)

NextPage retrieves the next ListCollections page.

type ListCollectionsPaginatorOptions 

type ListCollectionsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCollectionsPaginatorOptions is the paginator options for ListCollections

type ListLifecyclePoliciesAPIClient added in v1.6.0 

type ListLifecyclePoliciesAPIClient interface {
	ListLifecyclePolicies(context.Context, *ListLifecyclePoliciesInput, ...func(*Options)) (*ListLifecyclePoliciesOutput, error)
}

ListLifecyclePoliciesAPIClient is a client that implements the ListLifecyclePolicies operation.

type ListLifecyclePoliciesInput added in v1.6.0 

type ListLifecyclePoliciesInput struct {

	// The type of lifecycle policy.
	//
	// This member is required.
	Type types.LifecyclePolicyType

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

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

	// Resource filters that policies can apply to. Currently, the only supported
	// resource type is index .
	Resources []string
	// contains filtered or unexported fields
}

type ListLifecyclePoliciesOutput added in v1.6.0 

type ListLifecyclePoliciesOutput struct {

	// Details about the requested lifecycle policies.
	LifecyclePolicySummaries []types.LifecyclePolicySummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLifecyclePoliciesPaginator added in v1.6.0 

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

ListLifecyclePoliciesPaginator is a paginator for ListLifecyclePolicies

func NewListLifecyclePoliciesPaginator added in v1.6.0 

func NewListLifecyclePoliciesPaginator(client ListLifecyclePoliciesAPIClient, params *ListLifecyclePoliciesInput, optFns ...func(*ListLifecyclePoliciesPaginatorOptions)) *ListLifecyclePoliciesPaginator

NewListLifecyclePoliciesPaginator returns a new ListLifecyclePoliciesPaginator

func (*ListLifecyclePoliciesPaginator) HasMorePages added in v1.6.0 

func (p *ListLifecyclePoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLifecyclePoliciesPaginator) NextPage added in v1.6.0 

func (p *ListLifecyclePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLifecyclePoliciesOutput, error)

NextPage retrieves the next ListLifecyclePolicies page.

type ListLifecyclePoliciesPaginatorOptions added in v1.6.0 

type ListLifecyclePoliciesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLifecyclePoliciesPaginatorOptions is the paginator options for ListLifecyclePolicies

type ListSecurityConfigsAPIClient 

type ListSecurityConfigsAPIClient interface {
	ListSecurityConfigs(context.Context, *ListSecurityConfigsInput, ...func(*Options)) (*ListSecurityConfigsOutput, error)
}

ListSecurityConfigsAPIClient is a client that implements the ListSecurityConfigs operation.

type ListSecurityConfigsInput 

type ListSecurityConfigsInput struct {

	// The type of security configuration.
	//
	// This member is required.
	Type types.SecurityConfigType

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

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

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

	// Details about the security configurations in your account.
	SecurityConfigSummaries []types.SecurityConfigSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSecurityConfigsPaginator 

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

ListSecurityConfigsPaginator is a paginator for ListSecurityConfigs

func NewListSecurityConfigsPaginator 

func NewListSecurityConfigsPaginator(client ListSecurityConfigsAPIClient, params *ListSecurityConfigsInput, optFns ...func(*ListSecurityConfigsPaginatorOptions)) *ListSecurityConfigsPaginator

NewListSecurityConfigsPaginator returns a new ListSecurityConfigsPaginator

func (*ListSecurityConfigsPaginator) HasMorePages 

func (p *ListSecurityConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityConfigsPaginator) NextPage 

func (p *ListSecurityConfigsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityConfigsOutput, error)

NextPage retrieves the next ListSecurityConfigs page.

type ListSecurityConfigsPaginatorOptions 

type ListSecurityConfigsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSecurityConfigsPaginatorOptions is the paginator options for ListSecurityConfigs

type ListSecurityPoliciesAPIClient 

type ListSecurityPoliciesAPIClient interface {
	ListSecurityPolicies(context.Context, *ListSecurityPoliciesInput, ...func(*Options)) (*ListSecurityPoliciesOutput, error)
}

ListSecurityPoliciesAPIClient is a client that implements the ListSecurityPolicies operation.

type ListSecurityPoliciesInput 

type ListSecurityPoliciesInput struct {

	// The type of policy.
	//
	// This member is required.
	Type types.SecurityPolicyType

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

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

	// Resource filters (can be collection or indexes) that policies can apply to.
	Resource []string
	// contains filtered or unexported fields
}

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

	// Details about the security policies in your account.
	SecurityPolicySummaries []types.SecurityPolicySummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSecurityPoliciesPaginator 

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

ListSecurityPoliciesPaginator is a paginator for ListSecurityPolicies

func NewListSecurityPoliciesPaginator 

func NewListSecurityPoliciesPaginator(client ListSecurityPoliciesAPIClient, params *ListSecurityPoliciesInput, optFns ...func(*ListSecurityPoliciesPaginatorOptions)) *ListSecurityPoliciesPaginator

NewListSecurityPoliciesPaginator returns a new ListSecurityPoliciesPaginator

func (*ListSecurityPoliciesPaginator) HasMorePages 

func (p *ListSecurityPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityPoliciesPaginator) NextPage 

func (p *ListSecurityPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityPoliciesOutput, error)

NextPage retrieves the next ListSecurityPolicies page.

type ListSecurityPoliciesPaginatorOptions 

type ListSecurityPoliciesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSecurityPoliciesPaginatorOptions is the paginator options for ListSecurityPolicies

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags associated with the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVpcEndpointsAPIClient 

type ListVpcEndpointsAPIClient interface {
	ListVpcEndpoints(context.Context, *ListVpcEndpointsInput, ...func(*Options)) (*ListVpcEndpointsOutput, error)
}

ListVpcEndpointsAPIClient is a client that implements the ListVpcEndpoints operation.

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

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

	// Filter the results according to the current status of the VPC endpoint.
	// Possible statuses are CREATING , DELETING , UPDATING , ACTIVE , and FAILED .
	VpcEndpointFilters *types.VpcEndpointFilters
	// contains filtered or unexported fields
}

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

	// Details about each VPC endpoint, including the name and current status.
	VpcEndpointSummaries []types.VpcEndpointSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVpcEndpointsPaginator 

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

ListVpcEndpointsPaginator is a paginator for ListVpcEndpoints

func NewListVpcEndpointsPaginator 

func NewListVpcEndpointsPaginator(client ListVpcEndpointsAPIClient, params *ListVpcEndpointsInput, optFns ...func(*ListVpcEndpointsPaginatorOptions)) *ListVpcEndpointsPaginator

NewListVpcEndpointsPaginator returns a new ListVpcEndpointsPaginator

func (*ListVpcEndpointsPaginator) HasMorePages 

func (p *ListVpcEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVpcEndpointsPaginator) NextPage 

func (p *ListVpcEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVpcEndpointsOutput, error)

NextPage retrieves the next ListVpcEndpoints page.

type ListVpcEndpointsPaginatorOptions 

type ListVpcEndpointsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVpcEndpointsPaginatorOptions is the paginator options for ListVpcEndpoints

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.8.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

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

	// A list of tags (key-value pairs) to add to the resource. All tag keys in the
	// request must be unique.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// The tag or set of tags to remove from the resource. All tag keys in the request
	// must be unique.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAccessPolicyInput 

type UpdateAccessPolicyInput struct {

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

	// The version of the policy being updated.
	//
	// This member is required.
	PolicyVersion *string

	// The type of policy.
	//
	// This member is required.
	Type types.AccessPolicyType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string

	// The JSON policy document to use as the content for the policy.
	Policy *string
	// contains filtered or unexported fields
}

type UpdateAccessPolicyOutput 

type UpdateAccessPolicyOutput struct {

	// Details about the updated access policy.
	AccessPolicyDetail *types.AccessPolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type UpdateAccountSettingsOutput 

type UpdateAccountSettingsOutput struct {

	// OpenSearch Serverless-related settings for the current Amazon Web Services
	// account.
	AccountSettingsDetail *types.AccountSettingsDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCollectionInput 

type UpdateCollectionInput struct {

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

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// A description of the collection.
	Description *string
	// contains filtered or unexported fields
}

type UpdateCollectionOutput 

type UpdateCollectionOutput struct {

	// Details about the updated collection.
	UpdateCollectionDetail *types.UpdateCollectionDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLifecyclePolicyInput added in v1.6.0 

type UpdateLifecyclePolicyInput struct {

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

	// The version of the policy being updated.
	//
	// This member is required.
	PolicyVersion *string

	// The type of lifecycle policy.
	//
	// This member is required.
	Type types.LifecyclePolicyType

	// A unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

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

	// The JSON policy document to use as the content for the lifecycle policy.
	Policy *string
	// contains filtered or unexported fields
}

type UpdateLifecyclePolicyOutput added in v1.6.0 

type UpdateLifecyclePolicyOutput struct {

	// Details about the updated lifecycle policy.
	LifecyclePolicyDetail *types.LifecyclePolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSecurityConfigInput 

type UpdateSecurityConfigInput struct {

	// The version of the security configuration to be updated. You can find the most
	// recent version of a security configuration using the GetSecurityPolicy command.
	//
	// This member is required.
	ConfigVersion *string

	// The security configuration identifier. For SAML the ID will be
	// saml/<accountId>/<idpProviderName> . For example, saml/123456789123/OKTADev .
	//
	// This member is required.
	Id *string

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

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

	// SAML options in in the form of a key-value map.
	SamlOptions *types.SamlConfigOptions
	// contains filtered or unexported fields
}

type UpdateSecurityConfigOutput 

type UpdateSecurityConfigOutput struct {

	// Details about the updated security configuration.
	SecurityConfigDetail *types.SecurityConfigDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSecurityPolicyInput 

type UpdateSecurityPolicyInput struct {

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

	// The version of the policy being updated.
	//
	// This member is required.
	PolicyVersion *string

	// The type of access policy.
	//
	// This member is required.
	Type types.SecurityPolicyType

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// A description of the policy. Typically used to store information about the
	// permissions defined in the policy.
	Description *string

	// The JSON policy document to use as the content for the new policy.
	Policy *string
	// contains filtered or unexported fields
}

type UpdateSecurityPolicyOutput 

type UpdateSecurityPolicyOutput struct {

	// Details about the updated security policy.
	SecurityPolicyDetail *types.SecurityPolicyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateVpcEndpointInput 

type UpdateVpcEndpointInput struct {

	// The unique identifier of the interface endpoint to update.
	//
	// This member is required.
	Id *string

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

	// The ID of one or more subnets to add to the endpoint.
	AddSubnetIds []string

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string

	// The unique identifiers of the security groups to remove from the endpoint.
	RemoveSecurityGroupIds []string

	// The unique identifiers of the subnets to remove from the endpoint.
	RemoveSubnetIds []string
	// contains filtered or unexported fields
}

type UpdateVpcEndpointOutput 

type UpdateVpcEndpointOutput struct {

	// Details about the updated VPC endpoint.
	UpdateVpcEndpointDetail *types.UpdateVpcEndpointDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

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.