types

package
v1.13.3 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have permissions to access the resource.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

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

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type BufferOptions added in v1.5.0 

type BufferOptions struct {

	// Whether persistent buffering should be enabled.
	//
	// This member is required.
	PersistentBufferEnabled *bool
	// contains filtered or unexported fields
}

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering.

type ChangeProgressStage 

type ChangeProgressStage struct {

	// A description of the stage.
	Description *string

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

	// The name of the stage.
	Name *string

	// The current status of the stage that the change is in.
	Status ChangeProgressStageStatuses
	// contains filtered or unexported fields
}

Progress details for a specific stage of a pipeline configuration change.

type ChangeProgressStageStatuses 

type ChangeProgressStageStatuses string
const (
	ChangeProgressStageStatusesPending    ChangeProgressStageStatuses = "PENDING"
	ChangeProgressStageStatusesInProgress ChangeProgressStageStatuses = "IN_PROGRESS"
	ChangeProgressStageStatusesCompleted  ChangeProgressStageStatuses = "COMPLETED"
	ChangeProgressStageStatusesFailed     ChangeProgressStageStatuses = "FAILED"
)

Enum values for ChangeProgressStageStatuses

func (ChangeProgressStageStatuses) Values 

func (ChangeProgressStageStatuses) Values() []ChangeProgressStageStatuses

Values returns all known values for ChangeProgressStageStatuses. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeProgressStatus 

type ChangeProgressStatus struct {

	// Information about the stages that the pipeline is going through to perform the
	// configuration change.
	ChangeProgressStages []ChangeProgressStage

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

	// The overall status of the pipeline configuration change.
	Status ChangeProgressStatuses

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

The progress details of a pipeline configuration change.

type ChangeProgressStatuses 

type ChangeProgressStatuses string
const (
	ChangeProgressStatusesPending    ChangeProgressStatuses = "PENDING"
	ChangeProgressStatusesInProgress ChangeProgressStatuses = "IN_PROGRESS"
	ChangeProgressStatusesCompleted  ChangeProgressStatuses = "COMPLETED"
	ChangeProgressStatusesFailed     ChangeProgressStatuses = "FAILED"
)

Enum values for ChangeProgressStatuses

func (ChangeProgressStatuses) Values 

func (ChangeProgressStatuses) Values() []ChangeProgressStatuses

Values returns all known values for ChangeProgressStatuses. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CloudWatchLogDestination 

type CloudWatchLogDestination struct {

	// The name of the CloudWatch Logs group to send pipeline logs to. You can specify
	// an existing log group or create a new one. For example,
	// /aws/vendedlogs/OpenSearchService/pipelines .
	//
	// This member is required.
	LogGroup *string
	// contains filtered or unexported fields
}

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The client attempted to remove a resource that is currently in use.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DisabledOperationException added in v1.9.0 

type DisabledOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception is thrown when an operation has been disabled.

func (*DisabledOperationException) Error added in v1.9.0 

func (e *DisabledOperationException) Error() string

func (*DisabledOperationException) ErrorCode added in v1.9.0 

func (e *DisabledOperationException) ErrorCode() string

func (*DisabledOperationException) ErrorFault added in v1.9.0 

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

func (*DisabledOperationException) ErrorMessage added in v1.9.0 

func (e *DisabledOperationException) ErrorMessage() string

type EncryptionAtRestOptions added in v1.5.0 

type EncryptionAtRestOptions struct {

	// The ARN of the KMS key used to encrypt buffer data. By default, data is
	// encrypted using an Amazon Web Services owned key.
	//
	// This member is required.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Options to control how OpenSearch encrypts buffer data.

type InternalException 

type InternalException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

func (*InternalException) Error 

func (e *InternalException) Error() string

func (*InternalException) ErrorCode 

func (e *InternalException) ErrorCode() string

func (*InternalException) ErrorFault 

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

func (*InternalException) ErrorMessage 

func (e *InternalException) ErrorMessage() string

type InvalidPaginationTokenException 

type InvalidPaginationTokenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An invalid pagination token provided in the request.

func (*InvalidPaginationTokenException) Error 

func (e *InvalidPaginationTokenException) Error() string

func (*InvalidPaginationTokenException) ErrorCode 

func (e *InvalidPaginationTokenException) ErrorCode() string

func (*InvalidPaginationTokenException) ErrorFault 

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

func (*InvalidPaginationTokenException) ErrorMessage 

func (e *InvalidPaginationTokenException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You attempted to create more than the allowed number of tags.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

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

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type LogPublishingOptions 

type LogPublishingOptions struct {

	// The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs.
	// This parameter is required if IsLoggingEnabled is set to true .
	CloudWatchLogDestination *CloudWatchLogDestination

	// Whether logs should be published.
	IsLoggingEnabled *bool
	// contains filtered or unexported fields
}

Container for the values required to configure logging for the pipeline. If you don't specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.

type Pipeline 

type Pipeline struct {

	// Options that specify the configuration of a persistent buffer. To configure how
	// OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For
	// more information, see [Persistent buffering].
	//
	// [Persistent buffering]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/osis-features-overview.html#persistent-buffering
	BufferOptions *BufferOptions

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

	// Destinations to which the pipeline writes data.
	Destinations []PipelineDestination

	// Options to control how OpenSearch encrypts buffer data.
	EncryptionAtRestOptions *EncryptionAtRestOptions

	// The ingestion endpoints for the pipeline, which you can send data to.
	IngestEndpointUrls []string

	// The date and time when the pipeline was last updated.
	LastUpdatedAt *time.Time

	// Key-value pairs that represent log publishing settings.
	LogPublishingOptions *LogPublishingOptions

	// The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
	MaxUnits int32

	// The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
	MinUnits int32

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string

	// The Data Prepper pipeline configuration in YAML format.
	PipelineConfigurationBody *string

	// The name of the pipeline.
	PipelineName *string

	// A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon
	// Web Services services.
	ServiceVpcEndpoints []ServiceVpcEndpoint

	// The current status of the pipeline.
	Status PipelineStatus

	// The reason for the current status of the pipeline.
	StatusReason *PipelineStatusReason

	// A list of tags associated with the given pipeline.
	Tags []Tag

	// The VPC endpoint service name for the pipeline.
	VpcEndpointService *string

	// The VPC interface endpoints that have access to the pipeline.
	VpcEndpoints []VpcEndpoint
	// contains filtered or unexported fields
}

Information about an existing OpenSearch Ingestion pipeline.

type PipelineBlueprint 

type PipelineBlueprint struct {

	// The name of the blueprint.
	BlueprintName *string

	// A description of the blueprint.
	DisplayDescription *string

	// The display name of the blueprint.
	DisplayName *string

	// The YAML configuration of the blueprint.
	PipelineConfigurationBody *string

	// The name of the service that the blueprint is associated with.
	Service *string

	// The use case that the blueprint relates to.
	UseCase *string
	// contains filtered or unexported fields
}

Container for information about an OpenSearch Ingestion blueprint.

type PipelineBlueprintSummary 

type PipelineBlueprintSummary struct {

	// The name of the blueprint.
	BlueprintName *string

	// A description of the blueprint.
	DisplayDescription *string

	// The display name of the blueprint.
	DisplayName *string

	// The name of the service that the blueprint is associated with.
	Service *string

	// The use case that the blueprint relates to.
	UseCase *string
	// contains filtered or unexported fields
}

A summary of an OpenSearch Ingestion blueprint.

type PipelineDestination added in v1.9.0 

type PipelineDestination struct {

	// The endpoint receiving data from the pipeline.
	Endpoint *string

	// The name of the service receiving data from the pipeline.
	ServiceName *string
	// contains filtered or unexported fields
}

An object representing the destination of a pipeline.

type PipelineStatus 

type PipelineStatus string
const (
	PipelineStatusCreating     PipelineStatus = "CREATING"
	PipelineStatusActive       PipelineStatus = "ACTIVE"
	PipelineStatusUpdating     PipelineStatus = "UPDATING"
	PipelineStatusDeleting     PipelineStatus = "DELETING"
	PipelineStatusCreateFailed PipelineStatus = "CREATE_FAILED"
	PipelineStatusUpdateFailed PipelineStatus = "UPDATE_FAILED"
	PipelineStatusStarting     PipelineStatus = "STARTING"
	PipelineStatusStartFailed  PipelineStatus = "START_FAILED"
	PipelineStatusStopping     PipelineStatus = "STOPPING"
	PipelineStatusStopped      PipelineStatus = "STOPPED"
)

Enum values for PipelineStatus

func (PipelineStatus) Values 

func (PipelineStatus) Values() []PipelineStatus

Values returns all known values for PipelineStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PipelineStatusReason 

type PipelineStatusReason struct {

	// A description of why a pipeline has a certain status.
	Description *string
	// contains filtered or unexported fields
}

Information about a pipeline's current status.

type PipelineSummary 

type PipelineSummary struct {

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

	// A list of destinations to which the pipeline writes data.
	Destinations []PipelineDestination

	// The date and time when the pipeline was last updated.
	LastUpdatedAt *time.Time

	// The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
	MaxUnits *int32

	// The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
	MinUnits *int32

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string

	// The name of the pipeline.
	PipelineName *string

	// The current status of the pipeline.
	Status PipelineStatus

	// Information about a pipeline's current status.
	StatusReason *PipelineStatusReason

	// A list of tags associated with the given pipeline.
	Tags []Tag
	// contains filtered or unexported fields
}

Summary information for an OpenSearch Ingestion pipeline.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You attempted to create a resource that already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

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

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You attempted to access or delete a resource that does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

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

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceVpcEndpoint added in v1.5.0 

type ServiceVpcEndpoint struct {

	// The name of the service for which a VPC endpoint was created.
	ServiceName VpcEndpointServiceName

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

A container for information about VPC endpoints that were created to other services

type Tag 

type Tag struct {

	// The tag key. Tag keys must be unique for the pipeline to which they are
	// attached.
	//
	// This member is required.
	Key *string

	// The value assigned to the corresponding tag key. Tag values can be null and
	// don't have to be unique in a tag set. For example, you can have a key value pair
	// in a tag set of project : Trinity and cost-center : Trinity
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A tag (key-value pair) for an OpenSearch Ingestion pipeline.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An exception for missing or invalid input fields.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

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

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationMessage 

type ValidationMessage struct {

	// The validation message.
	Message *string
	// contains filtered or unexported fields
}

A validation message associated with a ValidatePipeline request in OpenSearch Ingestion.

type VpcAttachmentOptions added in v1.9.0 

type VpcAttachmentOptions struct {

	// Whether a VPC is attached to the pipeline.
	//
	// This member is required.
	AttachToVpc *bool

	// The CIDR block to be reserved for OpenSearch Ingestion to create elastic
	// network interfaces (ENIs).
	CidrBlock *string
	// contains filtered or unexported fields
}

Options for attaching a VPC to pipeline.

type VpcEndpoint 

type VpcEndpoint struct {

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

	// The ID for your VPC. Amazon Web Services PrivateLink generates this value when
	// you create a VPC.
	VpcId *string

	// Information about the VPC, including associated subnets and security groups.
	VpcOptions *VpcOptions
	// contains filtered or unexported fields
}

An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.

type VpcEndpointManagement added in v1.10.0 

type VpcEndpointManagement string
const (
	VpcEndpointManagementCustomer VpcEndpointManagement = "CUSTOMER"
	VpcEndpointManagementService  VpcEndpointManagement = "SERVICE"
)

Enum values for VpcEndpointManagement

func (VpcEndpointManagement) Values added in v1.10.0 

func (VpcEndpointManagement) Values() []VpcEndpointManagement

Values returns all known values for VpcEndpointManagement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcEndpointServiceName added in v1.5.0 

type VpcEndpointServiceName string
const (
	VpcEndpointServiceNameOpensearchServerless VpcEndpointServiceName = "OPENSEARCH_SERVERLESS"
)

Enum values for VpcEndpointServiceName

func (VpcEndpointServiceName) Values added in v1.5.0 

func (VpcEndpointServiceName) Values() []VpcEndpointServiceName

Values returns all known values for VpcEndpointServiceName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcOptions 

type VpcOptions struct {

	// A list of subnet IDs associated with the VPC endpoint.
	//
	// This member is required.
	SubnetIds []string

	// A list of security groups associated with the VPC endpoint.
	SecurityGroupIds []string

	// Options for attaching a VPC to a pipeline.
	VpcAttachmentOptions *VpcAttachmentOptions

	// Defines whether you or Amazon OpenSearch Ingestion service create and manage
	// the VPC endpoint configured for the pipeline.
	VpcEndpointManagement VpcEndpointManagement
	// contains filtered or unexported fields
}

Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.