osis

package
v0.0.0-...-93f74c0 Latest Latest
Warning

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

 Go to latest Published: Nov 11, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package osis provides the client and types for making API requests to Amazon OpenSearch Ingestion.

Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html).

See https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01 for more information on this service.

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

Using the Client

To contact Amazon OpenSearch Ingestion 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 Amazon OpenSearch Ingestion client OSIS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/osis/#New

Index

Constants

View Source 
const (
	// ChangeProgressStageStatusesPending is a ChangeProgressStageStatuses enum value
	ChangeProgressStageStatusesPending = "PENDING"

	// ChangeProgressStageStatusesInProgress is a ChangeProgressStageStatuses enum value
	ChangeProgressStageStatusesInProgress = "IN_PROGRESS"

	// ChangeProgressStageStatusesCompleted is a ChangeProgressStageStatuses enum value
	ChangeProgressStageStatusesCompleted = "COMPLETED"

	// ChangeProgressStageStatusesFailed is a ChangeProgressStageStatuses enum value
	ChangeProgressStageStatusesFailed = "FAILED"
)
View Source 
const (
	// ChangeProgressStatusesPending is a ChangeProgressStatuses enum value
	ChangeProgressStatusesPending = "PENDING"

	// ChangeProgressStatusesInProgress is a ChangeProgressStatuses enum value
	ChangeProgressStatusesInProgress = "IN_PROGRESS"

	// ChangeProgressStatusesCompleted is a ChangeProgressStatuses enum value
	ChangeProgressStatusesCompleted = "COMPLETED"

	// ChangeProgressStatusesFailed is a ChangeProgressStatuses enum value
	ChangeProgressStatusesFailed = "FAILED"
)
View Source 
const (
	// PipelineStatusCreating is a PipelineStatus enum value
	PipelineStatusCreating = "CREATING"

	// PipelineStatusActive is a PipelineStatus enum value
	PipelineStatusActive = "ACTIVE"

	// PipelineStatusUpdating is a PipelineStatus enum value
	PipelineStatusUpdating = "UPDATING"

	// PipelineStatusDeleting is a PipelineStatus enum value
	PipelineStatusDeleting = "DELETING"

	// PipelineStatusCreateFailed is a PipelineStatus enum value
	PipelineStatusCreateFailed = "CREATE_FAILED"

	// PipelineStatusUpdateFailed is a PipelineStatus enum value
	PipelineStatusUpdateFailed = "UPDATE_FAILED"

	// PipelineStatusStarting is a PipelineStatus enum value
	PipelineStatusStarting = "STARTING"

	// PipelineStatusStartFailed is a PipelineStatus enum value
	PipelineStatusStartFailed = "START_FAILED"

	// PipelineStatusStopping is a PipelineStatus enum value
	PipelineStatusStopping = "STOPPING"

	// PipelineStatusStopped is a PipelineStatus enum value
	PipelineStatusStopped = "STOPPED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have permissions to access the resource.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The client attempted to remove a resource that is currently in use.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// The request failed because of an unknown error, exception, or failure (the
	// failure is internal to the service).
	ErrCodeInternalException = "InternalException"

	// ErrCodeInvalidPaginationTokenException for service response error code
	// "InvalidPaginationTokenException".
	//
	// An invalid pagination token provided in the request.
	ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You attempted to create more than the allowed number of tags.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// You attempted to create a resource that already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// You attempted to access or delete a resource that does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// An exception for missing or invalid input fields.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "OSIS" // Name of service.
	EndpointsID = "osis" // ID to lookup a service endpoint with.
	ServiceID   = "OSIS" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// VpcEndpointServiceNameOpensearchServerless is a VpcEndpointServiceName enum value
	VpcEndpointServiceNameOpensearchServerless = "OPENSEARCH_SERVERLESS"
)

Variables

This section is empty.

Functions

func ChangeProgressStageStatuses_Values 

func ChangeProgressStageStatuses_Values() []string

ChangeProgressStageStatuses_Values returns all elements of the ChangeProgressStageStatuses enum

func ChangeProgressStatuses_Values 

func ChangeProgressStatuses_Values() []string

ChangeProgressStatuses_Values returns all elements of the ChangeProgressStatuses enum

func PipelineStatus_Values 

func PipelineStatus_Values() []string

PipelineStatus_Values returns all elements of the PipelineStatus enum

func VpcEndpointServiceName_Values 

func VpcEndpointServiceName_Values() []string

VpcEndpointServiceName_Values returns all elements of the VpcEndpointServiceName enum

Types

type AccessDeniedException 

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

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

You don't have permissions to access the resource.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) 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 (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) 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 BufferOptions 

type BufferOptions struct {

	// Whether persistent buffering should be enabled.
	//
	// PersistentBufferEnabled is a required field
	PersistentBufferEnabled *bool `type:"boolean" required:"true"`
	// 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.

func (BufferOptions) GoString 

func (s BufferOptions) 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 (*BufferOptions) SetPersistentBufferEnabled 

func (s *BufferOptions) SetPersistentBufferEnabled(v bool) *BufferOptions

SetPersistentBufferEnabled sets the PersistentBufferEnabled field's value.

func (BufferOptions) String 

func (s BufferOptions) 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 (*BufferOptions) Validate 

func (s *BufferOptions) Validate() error

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

type ChangeProgressStage 

type ChangeProgressStage struct {

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

	// The most recent updated timestamp of the stage.
	LastUpdatedAt *time.Time `type:"timestamp"`

	// The name of the stage.
	Name *string `type:"string"`

	// The current status of the stage that the change is in.
	Status *string `type:"string" enum:"ChangeProgressStageStatuses"`
	// contains filtered or unexported fields
}

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

func (ChangeProgressStage) GoString 

func (s ChangeProgressStage) 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 (*ChangeProgressStage) SetDescription 

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

SetDescription sets the Description field's value.

func (*ChangeProgressStage) SetLastUpdatedAt 

func (s *ChangeProgressStage) SetLastUpdatedAt(v time.Time) *ChangeProgressStage

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*ChangeProgressStage) SetName 

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

SetName sets the Name field's value.

func (*ChangeProgressStage) SetStatus 

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

SetStatus sets the Status field's value.

func (ChangeProgressStage) String 

func (s ChangeProgressStage) 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 ChangeProgressStatus 

type ChangeProgressStatus struct {

	// Information about the stages that the pipeline is going through to perform
	// the configuration change.
	ChangeProgressStages []*ChangeProgressStage `type:"list"`

	// The time at which the configuration change is made on the pipeline.
	StartTime *time.Time `type:"timestamp"`

	// The overall status of the pipeline configuration change.
	Status *string `type:"string" enum:"ChangeProgressStatuses"`

	// The total number of stages required for the pipeline configuration change.
	TotalNumberOfStages *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The progress details of a pipeline configuration change.

func (ChangeProgressStatus) GoString 

func (s ChangeProgressStatus) 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 (*ChangeProgressStatus) SetChangeProgressStages 

func (s *ChangeProgressStatus) SetChangeProgressStages(v []*ChangeProgressStage) *ChangeProgressStatus

SetChangeProgressStages sets the ChangeProgressStages field's value.

func (*ChangeProgressStatus) SetStartTime 

func (s *ChangeProgressStatus) SetStartTime(v time.Time) *ChangeProgressStatus

SetStartTime sets the StartTime field's value.

func (*ChangeProgressStatus) SetStatus 

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

SetStatus sets the Status field's value.

func (*ChangeProgressStatus) SetTotalNumberOfStages 

func (s *ChangeProgressStatus) SetTotalNumberOfStages(v int64) *ChangeProgressStatus

SetTotalNumberOfStages sets the TotalNumberOfStages field's value.

func (ChangeProgressStatus) String 

func (s ChangeProgressStatus) 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 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/OpenSearchService/IngestionService/my-pipeline.
	//
	// LogGroup is a required field
	LogGroup *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.

func (CloudWatchLogDestination) GoString 

func (s CloudWatchLogDestination) 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 (*CloudWatchLogDestination) SetLogGroup 

func (s *CloudWatchLogDestination) SetLogGroup(v string) *CloudWatchLogDestination

SetLogGroup sets the LogGroup field's value.

func (CloudWatchLogDestination) String 

func (s CloudWatchLogDestination) 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 (*CloudWatchLogDestination) Validate 

func (s *CloudWatchLogDestination) Validate() error

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

type ConflictException 

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

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

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

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 CreatePipelineInput 

type CreatePipelineInput struct {

	// Key-value pairs to configure persistent buffering for the pipeline.
	BufferOptions *BufferOptions `type:"structure"`

	// Key-value pairs to configure encryption for data that is written to a persistent
	// buffer.
	EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

	// Key-value pairs to configure log publishing.
	LogPublishingOptions *LogPublishingOptions `type:"structure"`

	// The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
	//
	// MaxUnits is a required field
	MaxUnits *int64 `min:"1" type:"integer" required:"true"`

	// The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
	//
	// MinUnits is a required field
	MinUnits *int64 `min:"1" type:"integer" required:"true"`

	// The pipeline configuration in YAML format. The command accepts the pipeline
	// configuration as a string or within a .yaml file. If you provide the configuration
	// as a string, each new line must be escaped with \n.
	//
	// PipelineConfigurationBody is a required field
	PipelineConfigurationBody *string `min:"1" type:"string" required:"true"`

	// The name of the OpenSearch Ingestion pipeline to create. Pipeline names are
	// unique across the pipelines owned by an account within an Amazon Web Services
	// Region.
	//
	// PipelineName is a required field
	PipelineName *string `min:"3" type:"string" required:"true"`

	// List of tags to add to the pipeline upon creation.
	Tags []*Tag `type:"list"`

	// Container for the values required to configure VPC access for the pipeline.
	// If you don't specify these values, OpenSearch Ingestion creates the pipeline
	// with a public endpoint.
	VpcOptions *VpcOptions `type:"structure"`
	// contains filtered or unexported fields
}

func (CreatePipelineInput) GoString 

func (s CreatePipelineInput) 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 (*CreatePipelineInput) SetBufferOptions 

func (s *CreatePipelineInput) SetBufferOptions(v *BufferOptions) *CreatePipelineInput

SetBufferOptions sets the BufferOptions field's value.

func (*CreatePipelineInput) SetEncryptionAtRestOptions 

func (s *CreatePipelineInput) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *CreatePipelineInput

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*CreatePipelineInput) SetLogPublishingOptions 

func (s *CreatePipelineInput) SetLogPublishingOptions(v *LogPublishingOptions) *CreatePipelineInput

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*CreatePipelineInput) SetMaxUnits 

func (s *CreatePipelineInput) SetMaxUnits(v int64) *CreatePipelineInput

SetMaxUnits sets the MaxUnits field's value.

func (*CreatePipelineInput) SetMinUnits 

func (s *CreatePipelineInput) SetMinUnits(v int64) *CreatePipelineInput

SetMinUnits sets the MinUnits field's value.

func (*CreatePipelineInput) SetPipelineConfigurationBody 

func (s *CreatePipelineInput) SetPipelineConfigurationBody(v string) *CreatePipelineInput

SetPipelineConfigurationBody sets the PipelineConfigurationBody field's value.

func (*CreatePipelineInput) SetPipelineName 

func (s *CreatePipelineInput) SetPipelineName(v string) *CreatePipelineInput

SetPipelineName sets the PipelineName field's value.

func (*CreatePipelineInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreatePipelineInput) SetVpcOptions 

func (s *CreatePipelineInput) SetVpcOptions(v *VpcOptions) *CreatePipelineInput

SetVpcOptions sets the VpcOptions field's value.

func (CreatePipelineInput) String 

func (s CreatePipelineInput) 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 (*CreatePipelineInput) Validate 

func (s *CreatePipelineInput) Validate() error

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

type CreatePipelineOutput 

type CreatePipelineOutput struct {

	// Container for information about the created pipeline.
	Pipeline *Pipeline `type:"structure"`
	// contains filtered or unexported fields
}

func (CreatePipelineOutput) GoString 

func (s CreatePipelineOutput) 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 (*CreatePipelineOutput) SetPipeline 

func (s *CreatePipelineOutput) SetPipeline(v *Pipeline) *CreatePipelineOutput

SetPipeline sets the Pipeline field's value.

func (CreatePipelineOutput) String 

func (s CreatePipelineOutput) 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 DeletePipelineInput 

type DeletePipelineInput struct {

	// The name of the pipeline to delete.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"PipelineName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePipelineInput) GoString 

func (s DeletePipelineInput) 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 (*DeletePipelineInput) SetPipelineName 

func (s *DeletePipelineInput) SetPipelineName(v string) *DeletePipelineInput

SetPipelineName sets the PipelineName field's value.

func (DeletePipelineInput) String 

func (s DeletePipelineInput) 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 (*DeletePipelineInput) Validate 

func (s *DeletePipelineInput) Validate() error

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

type DeletePipelineOutput 

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

func (DeletePipelineOutput) GoString 

func (s DeletePipelineOutput) 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 (DeletePipelineOutput) String 

func (s DeletePipelineOutput) 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 EncryptionAtRestOptions 

type EncryptionAtRestOptions struct {

	// The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion.
	// By default, data is encrypted using an AWS owned key.
	//
	// KmsKeyArn is a required field
	KmsKeyArn *string `min:"7" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Options to control how OpenSearch encrypts all data-at-rest.

func (EncryptionAtRestOptions) GoString 

func (s EncryptionAtRestOptions) 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 (*EncryptionAtRestOptions) SetKmsKeyArn 

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

SetKmsKeyArn sets the KmsKeyArn field's value.

func (EncryptionAtRestOptions) String 

func (s EncryptionAtRestOptions) 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 (*EncryptionAtRestOptions) Validate 

func (s *EncryptionAtRestOptions) Validate() error

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

type GetPipelineBlueprintInput 

type GetPipelineBlueprintInput struct {

	// The name of the blueprint to retrieve.
	//
	// BlueprintName is a required field
	BlueprintName *string `location:"uri" locationName:"BlueprintName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPipelineBlueprintInput) GoString 

func (s GetPipelineBlueprintInput) 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 (*GetPipelineBlueprintInput) SetBlueprintName 

func (s *GetPipelineBlueprintInput) SetBlueprintName(v string) *GetPipelineBlueprintInput

SetBlueprintName sets the BlueprintName field's value.

func (GetPipelineBlueprintInput) String 

func (s GetPipelineBlueprintInput) 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 (*GetPipelineBlueprintInput) Validate 

func (s *GetPipelineBlueprintInput) Validate() error

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

type GetPipelineBlueprintOutput 

type GetPipelineBlueprintOutput struct {

	// The requested blueprint in YAML format.
	Blueprint *PipelineBlueprint `type:"structure"`
	// contains filtered or unexported fields
}

func (GetPipelineBlueprintOutput) GoString 

func (s GetPipelineBlueprintOutput) 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 (*GetPipelineBlueprintOutput) SetBlueprint 

func (s *GetPipelineBlueprintOutput) SetBlueprint(v *PipelineBlueprint) *GetPipelineBlueprintOutput

SetBlueprint sets the Blueprint field's value.

func (GetPipelineBlueprintOutput) String 

func (s GetPipelineBlueprintOutput) 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 GetPipelineChangeProgressInput 

type GetPipelineChangeProgressInput struct {

	// The name of the pipeline.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"PipelineName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPipelineChangeProgressInput) GoString 

func (s GetPipelineChangeProgressInput) 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 (*GetPipelineChangeProgressInput) SetPipelineName 

func (s *GetPipelineChangeProgressInput) SetPipelineName(v string) *GetPipelineChangeProgressInput

SetPipelineName sets the PipelineName field's value.

func (GetPipelineChangeProgressInput) String 

func (s GetPipelineChangeProgressInput) 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 (*GetPipelineChangeProgressInput) Validate 

func (s *GetPipelineChangeProgressInput) Validate() error

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

type GetPipelineChangeProgressOutput 

type GetPipelineChangeProgressOutput struct {

	// The current status of the change happening on the pipeline.
	ChangeProgressStatuses []*ChangeProgressStatus `type:"list"`
	// contains filtered or unexported fields
}

func (GetPipelineChangeProgressOutput) GoString 

func (s GetPipelineChangeProgressOutput) 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 (*GetPipelineChangeProgressOutput) SetChangeProgressStatuses 

func (s *GetPipelineChangeProgressOutput) SetChangeProgressStatuses(v []*ChangeProgressStatus) *GetPipelineChangeProgressOutput

SetChangeProgressStatuses sets the ChangeProgressStatuses field's value.

func (GetPipelineChangeProgressOutput) String 

func (s GetPipelineChangeProgressOutput) 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 GetPipelineInput 

type GetPipelineInput struct {

	// The name of the pipeline to get information about.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"PipelineName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPipelineInput) GoString 

func (s GetPipelineInput) 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 (*GetPipelineInput) SetPipelineName 

func (s *GetPipelineInput) SetPipelineName(v string) *GetPipelineInput

SetPipelineName sets the PipelineName field's value.

func (GetPipelineInput) String 

func (s GetPipelineInput) 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 (*GetPipelineInput) Validate 

func (s *GetPipelineInput) Validate() error

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

type GetPipelineOutput 

type GetPipelineOutput struct {

	// Detailed information about the requested pipeline.
	Pipeline *Pipeline `type:"structure"`
	// contains filtered or unexported fields
}

func (GetPipelineOutput) GoString 

func (s GetPipelineOutput) 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 (*GetPipelineOutput) SetPipeline 

func (s *GetPipelineOutput) SetPipeline(v *Pipeline) *GetPipelineOutput

SetPipeline sets the Pipeline field's value.

func (GetPipelineOutput) String 

func (s GetPipelineOutput) 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 InternalException 

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

	Message_ *string `locationName:"message" type:"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) Code 

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error 

func (s *InternalException) Error() string

func (InternalException) GoString 

func (s InternalException) 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 (*InternalException) Message 

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr 

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID 

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode 

func (s *InternalException) StatusCode() int

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

func (InternalException) String 

func (s InternalException) 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 InvalidPaginationTokenException 

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

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

An invalid pagination token provided in the request.

func (*InvalidPaginationTokenException) Code 

func (s *InvalidPaginationTokenException) Code() string

Code returns the exception type name.

func (*InvalidPaginationTokenException) Error 

func (s *InvalidPaginationTokenException) Error() string

func (InvalidPaginationTokenException) GoString 

func (s InvalidPaginationTokenException) 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 (*InvalidPaginationTokenException) Message 

func (s *InvalidPaginationTokenException) Message() string

Message returns the exception's message.

func (*InvalidPaginationTokenException) OrigErr 

func (s *InvalidPaginationTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPaginationTokenException) RequestID 

func (s *InvalidPaginationTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPaginationTokenException) StatusCode 

func (s *InvalidPaginationTokenException) StatusCode() int

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

func (InvalidPaginationTokenException) String 

func (s InvalidPaginationTokenException) 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 LimitExceededException 

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

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

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

func (*LimitExceededException) Code 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

func (s LimitExceededException) 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 (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String 

func (s LimitExceededException) 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 ListPipelineBlueprintsInput 

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

func (ListPipelineBlueprintsInput) GoString 

func (s ListPipelineBlueprintsInput) 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 (ListPipelineBlueprintsInput) String 

func (s ListPipelineBlueprintsInput) 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 ListPipelineBlueprintsOutput 

type ListPipelineBlueprintsOutput struct {

	// A list of available blueprints for Data Prepper.
	Blueprints []*PipelineBlueprintSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListPipelineBlueprintsOutput) GoString 

func (s ListPipelineBlueprintsOutput) 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 (*ListPipelineBlueprintsOutput) SetBlueprints 

func (s *ListPipelineBlueprintsOutput) SetBlueprints(v []*PipelineBlueprintSummary) *ListPipelineBlueprintsOutput

SetBlueprints sets the Blueprints field's value.

func (ListPipelineBlueprintsOutput) String 

func (s ListPipelineBlueprintsOutput) 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 ListPipelinesInput 

type ListPipelinesInput struct {

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

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

func (ListPipelinesInput) GoString 

func (s ListPipelinesInput) 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 (*ListPipelinesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListPipelinesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListPipelinesInput) String 

func (s ListPipelinesInput) 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 (*ListPipelinesInput) Validate 

func (s *ListPipelinesInput) Validate() error

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

type ListPipelinesOutput 

type ListPipelinesOutput 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 `type:"string"`

	// A list of all existing Data Prepper pipelines.
	Pipelines []*PipelineSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListPipelinesOutput) GoString 

func (s ListPipelinesOutput) 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 (*ListPipelinesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListPipelinesOutput) SetPipelines 

func (s *ListPipelinesOutput) SetPipelines(v []*PipelineSummary) *ListPipelinesOutput

SetPipelines sets the Pipelines field's value.

func (ListPipelinesOutput) String 

func (s ListPipelinesOutput) 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 pipeline to retrieve tags for.
	//
	// Arn is a required field
	Arn *string `location:"querystring" locationName:"arn" min:"46" 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) SetArn 

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

SetArn sets the Arn 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 {

	// A list of tags associated with the given pipeline.
	Tags []*Tag `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 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 `type:"structure"`

	// Whether logs should be published.
	IsLoggingEnabled *bool `type:"boolean"`
	// 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.

func (LogPublishingOptions) GoString 

func (s LogPublishingOptions) 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 (*LogPublishingOptions) SetCloudWatchLogDestination 

func (s *LogPublishingOptions) SetCloudWatchLogDestination(v *CloudWatchLogDestination) *LogPublishingOptions

SetCloudWatchLogDestination sets the CloudWatchLogDestination field's value.

func (*LogPublishingOptions) SetIsLoggingEnabled 

func (s *LogPublishingOptions) SetIsLoggingEnabled(v bool) *LogPublishingOptions

SetIsLoggingEnabled sets the IsLoggingEnabled field's value.

func (LogPublishingOptions) String 

func (s LogPublishingOptions) 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 (*LogPublishingOptions) Validate 

func (s *LogPublishingOptions) Validate() error

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

type OSIS 

type OSIS struct {
	*client.Client
}

OSIS provides the API operation methods for making requests to Amazon OpenSearch Ingestion. See this package's package overview docs for details on the service.

OSIS 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) *OSIS

New creates a new instance of the OSIS 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 OSIS client from just a session.
svc := osis.New(mySession)

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

func (*OSIS) CreatePipeline 

func (c *OSIS) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error)

CreatePipeline API operation for Amazon OpenSearch Ingestion.

Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.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 Amazon OpenSearch Ingestion's API operation CreatePipeline for usage and error information.

Returned Error Types:

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

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

  • ResourceAlreadyExistsException You attempted to create a resource that already exists.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/CreatePipeline

func (*OSIS) CreatePipelineRequest 

func (c *OSIS) CreatePipelineRequest(input *CreatePipelineInput) (req *request.Request, output *CreatePipelineOutput)

CreatePipelineRequest generates a "aws/request.Request" representing the client's request for the CreatePipeline 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 CreatePipeline for more information on using the CreatePipeline 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 CreatePipelineRequest method.
req, resp := client.CreatePipelineRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/CreatePipeline

func (*OSIS) CreatePipelineWithContext 

func (c *OSIS) CreatePipelineWithContext(ctx aws.Context, input *CreatePipelineInput, opts ...request.Option) (*CreatePipelineOutput, error)

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

See CreatePipeline 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 (*OSIS) DeletePipeline 

func (c *OSIS) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error)

DeletePipeline API operation for Amazon OpenSearch Ingestion.

Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/delete-pipeline.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 Amazon OpenSearch Ingestion's API operation DeletePipeline for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/DeletePipeline

func (*OSIS) DeletePipelineRequest 

func (c *OSIS) DeletePipelineRequest(input *DeletePipelineInput) (req *request.Request, output *DeletePipelineOutput)

DeletePipelineRequest generates a "aws/request.Request" representing the client's request for the DeletePipeline 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 DeletePipeline for more information on using the DeletePipeline 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 DeletePipelineRequest method.
req, resp := client.DeletePipelineRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/DeletePipeline

func (*OSIS) DeletePipelineWithContext 

func (c *OSIS) DeletePipelineWithContext(ctx aws.Context, input *DeletePipelineInput, opts ...request.Option) (*DeletePipelineOutput, error)

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

See DeletePipeline 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 (*OSIS) GetPipeline 

func (c *OSIS) GetPipeline(input *GetPipelineInput) (*GetPipelineOutput, error)

GetPipeline API operation for Amazon OpenSearch Ingestion.

Retrieves information about an OpenSearch Ingestion pipeline.

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 Amazon OpenSearch Ingestion's API operation GetPipeline for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipeline

func (*OSIS) GetPipelineBlueprint 

func (c *OSIS) GetPipelineBlueprint(input *GetPipelineBlueprintInput) (*GetPipelineBlueprintOutput, error)

GetPipelineBlueprint API operation for Amazon OpenSearch Ingestion.

Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint).

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 Amazon OpenSearch Ingestion's API operation GetPipelineBlueprint for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have permissions to access the resource.

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

  • ValidationException An exception for missing or invalid input fields.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineBlueprint

func (*OSIS) GetPipelineBlueprintRequest 

func (c *OSIS) GetPipelineBlueprintRequest(input *GetPipelineBlueprintInput) (req *request.Request, output *GetPipelineBlueprintOutput)

GetPipelineBlueprintRequest generates a "aws/request.Request" representing the client's request for the GetPipelineBlueprint 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 GetPipelineBlueprint for more information on using the GetPipelineBlueprint 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 GetPipelineBlueprintRequest method.
req, resp := client.GetPipelineBlueprintRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineBlueprint

func (*OSIS) GetPipelineBlueprintWithContext 

func (c *OSIS) GetPipelineBlueprintWithContext(ctx aws.Context, input *GetPipelineBlueprintInput, opts ...request.Option) (*GetPipelineBlueprintOutput, error)

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

See GetPipelineBlueprint 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 (*OSIS) GetPipelineChangeProgress 

func (c *OSIS) GetPipelineChangeProgress(input *GetPipelineChangeProgressInput) (*GetPipelineChangeProgressOutput, error)

GetPipelineChangeProgress API operation for Amazon OpenSearch Ingestion.

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.

For more information, see Tracking the status of pipeline creation (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#get-pipeline-progress).

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 Amazon OpenSearch Ingestion's API operation GetPipelineChangeProgress for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineChangeProgress

func (*OSIS) GetPipelineChangeProgressRequest 

func (c *OSIS) GetPipelineChangeProgressRequest(input *GetPipelineChangeProgressInput) (req *request.Request, output *GetPipelineChangeProgressOutput)

GetPipelineChangeProgressRequest generates a "aws/request.Request" representing the client's request for the GetPipelineChangeProgress 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 GetPipelineChangeProgress for more information on using the GetPipelineChangeProgress 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 GetPipelineChangeProgressRequest method.
req, resp := client.GetPipelineChangeProgressRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipelineChangeProgress

func (*OSIS) GetPipelineChangeProgressWithContext 

func (c *OSIS) GetPipelineChangeProgressWithContext(ctx aws.Context, input *GetPipelineChangeProgressInput, opts ...request.Option) (*GetPipelineChangeProgressOutput, error)

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

See GetPipelineChangeProgress 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 (*OSIS) GetPipelineRequest 

func (c *OSIS) GetPipelineRequest(input *GetPipelineInput) (req *request.Request, output *GetPipelineOutput)

GetPipelineRequest generates a "aws/request.Request" representing the client's request for the GetPipeline 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 GetPipeline for more information on using the GetPipeline 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 GetPipelineRequest method.
req, resp := client.GetPipelineRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/GetPipeline

func (*OSIS) GetPipelineWithContext 

func (c *OSIS) GetPipelineWithContext(ctx aws.Context, input *GetPipelineInput, opts ...request.Option) (*GetPipelineOutput, error)

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

See GetPipeline 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 (*OSIS) ListPipelineBlueprints 

func (c *OSIS) ListPipelineBlueprints(input *ListPipelineBlueprintsInput) (*ListPipelineBlueprintsOutput, error)

ListPipelineBlueprints API operation for Amazon OpenSearch Ingestion.

Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint).

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 Amazon OpenSearch Ingestion's API operation ListPipelineBlueprints for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

  • InvalidPaginationTokenException An invalid pagination token provided in the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelineBlueprints

func (*OSIS) ListPipelineBlueprintsRequest 

func (c *OSIS) ListPipelineBlueprintsRequest(input *ListPipelineBlueprintsInput) (req *request.Request, output *ListPipelineBlueprintsOutput)

ListPipelineBlueprintsRequest generates a "aws/request.Request" representing the client's request for the ListPipelineBlueprints 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 ListPipelineBlueprints for more information on using the ListPipelineBlueprints 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 ListPipelineBlueprintsRequest method.
req, resp := client.ListPipelineBlueprintsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelineBlueprints

func (*OSIS) ListPipelineBlueprintsWithContext 

func (c *OSIS) ListPipelineBlueprintsWithContext(ctx aws.Context, input *ListPipelineBlueprintsInput, opts ...request.Option) (*ListPipelineBlueprintsOutput, error)

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

See ListPipelineBlueprints 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 (*OSIS) ListPipelines 

func (c *OSIS) ListPipelines(input *ListPipelinesInput) (*ListPipelinesOutput, error)

ListPipelines API operation for Amazon OpenSearch Ingestion.

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.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 Amazon OpenSearch Ingestion's API operation ListPipelines for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

  • InvalidPaginationTokenException An invalid pagination token provided in the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelines

func (*OSIS) ListPipelinesPages 

func (c *OSIS) ListPipelinesPages(input *ListPipelinesInput, fn func(*ListPipelinesOutput, bool) bool) error

ListPipelinesPages iterates over the pages of a ListPipelines operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPipelines 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 ListPipelines operation.
pageNum := 0
err := client.ListPipelinesPages(params,
    func(page *osis.ListPipelinesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OSIS) ListPipelinesPagesWithContext 

func (c *OSIS) ListPipelinesPagesWithContext(ctx aws.Context, input *ListPipelinesInput, fn func(*ListPipelinesOutput, bool) bool, opts ...request.Option) error

ListPipelinesPagesWithContext same as ListPipelinesPages 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 (*OSIS) ListPipelinesRequest 

func (c *OSIS) ListPipelinesRequest(input *ListPipelinesInput) (req *request.Request, output *ListPipelinesOutput)

ListPipelinesRequest generates a "aws/request.Request" representing the client's request for the ListPipelines 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 ListPipelines for more information on using the ListPipelines 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 ListPipelinesRequest method.
req, resp := client.ListPipelinesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelines

func (*OSIS) ListPipelinesWithContext 

func (c *OSIS) ListPipelinesWithContext(ctx aws.Context, input *ListPipelinesInput, opts ...request.Option) (*ListPipelinesOutput, error)

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

See ListPipelines 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 (*OSIS) ListTagsForResource 

func (c *OSIS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon OpenSearch Ingestion.

Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.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 Amazon OpenSearch Ingestion's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

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

  • AccessDeniedException You don't have permissions to access the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListTagsForResource

func (*OSIS) ListTagsForResourceRequest 

func (c *OSIS) 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/osis-2022-01-01/ListTagsForResource

func (*OSIS) ListTagsForResourceWithContext 

func (c *OSIS) 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 (*OSIS) StartPipeline 

func (c *OSIS) StartPipeline(input *StartPipelineInput) (*StartPipelineOutput, error)

StartPipeline API operation for Amazon OpenSearch Ingestion.

Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--start).

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 Amazon OpenSearch Ingestion's API operation StartPipeline for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have permissions to access the resource.

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

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

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

  • ValidationException An exception for missing or invalid input fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StartPipeline

func (*OSIS) StartPipelineRequest 

func (c *OSIS) StartPipelineRequest(input *StartPipelineInput) (req *request.Request, output *StartPipelineOutput)

StartPipelineRequest generates a "aws/request.Request" representing the client's request for the StartPipeline 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 StartPipeline for more information on using the StartPipeline 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 StartPipelineRequest method.
req, resp := client.StartPipelineRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StartPipeline

func (*OSIS) StartPipelineWithContext 

func (c *OSIS) StartPipelineWithContext(ctx aws.Context, input *StartPipelineInput, opts ...request.Option) (*StartPipelineOutput, error)

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

See StartPipeline 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 (*OSIS) StopPipeline 

func (c *OSIS) StopPipeline(input *StopPipelineInput) (*StopPipelineOutput, error)

StopPipeline API operation for Amazon OpenSearch Ingestion.

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--stop).

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 Amazon OpenSearch Ingestion's API operation StopPipeline for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have permissions to access the resource.

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

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

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

  • ValidationException An exception for missing or invalid input fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StopPipeline

func (*OSIS) StopPipelineRequest 

func (c *OSIS) StopPipelineRequest(input *StopPipelineInput) (req *request.Request, output *StopPipelineOutput)

StopPipelineRequest generates a "aws/request.Request" representing the client's request for the StopPipeline 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 StopPipeline for more information on using the StopPipeline 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 StopPipelineRequest method.
req, resp := client.StopPipelineRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/StopPipeline

func (*OSIS) StopPipelineWithContext 

func (c *OSIS) StopPipelineWithContext(ctx aws.Context, input *StopPipelineInput, opts ...request.Option) (*StopPipelineOutput, error)

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

See StopPipeline 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 (*OSIS) TagResource 

func (c *OSIS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon OpenSearch Ingestion.

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.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 Amazon OpenSearch Ingestion's API operation TagResource for usage and error information.

Returned Error Types:

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

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/TagResource

func (*OSIS) TagResourceRequest 

func (c *OSIS) 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/osis-2022-01-01/TagResource

func (*OSIS) TagResourceWithContext 

func (c *OSIS) 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 (*OSIS) UntagResource 

func (c *OSIS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon OpenSearch Ingestion.

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.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 Amazon OpenSearch Ingestion's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

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

  • AccessDeniedException You don't have permissions to access the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/UntagResource

func (*OSIS) UntagResourceRequest 

func (c *OSIS) 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/osis-2022-01-01/UntagResource

func (*OSIS) UntagResourceWithContext 

func (c *OSIS) 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 (*OSIS) UpdatePipeline 

func (c *OSIS) UpdatePipeline(input *UpdatePipelineInput) (*UpdatePipelineOutput, error)

UpdatePipeline API operation for Amazon OpenSearch Ingestion.

Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/update-pipeline.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 Amazon OpenSearch Ingestion's API operation UpdatePipeline for usage and error information.

Returned Error Types:

  • ValidationException An exception for missing or invalid input fields.

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

  • AccessDeniedException You don't have permissions to access the resource.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/UpdatePipeline

func (*OSIS) UpdatePipelineRequest 

func (c *OSIS) UpdatePipelineRequest(input *UpdatePipelineInput) (req *request.Request, output *UpdatePipelineOutput)

UpdatePipelineRequest generates a "aws/request.Request" representing the client's request for the UpdatePipeline 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 UpdatePipeline for more information on using the UpdatePipeline 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 UpdatePipelineRequest method.
req, resp := client.UpdatePipelineRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/UpdatePipeline

func (*OSIS) UpdatePipelineWithContext 

func (c *OSIS) UpdatePipelineWithContext(ctx aws.Context, input *UpdatePipelineInput, opts ...request.Option) (*UpdatePipelineOutput, error)

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

See UpdatePipeline 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 (*OSIS) ValidatePipeline 

func (c *OSIS) ValidatePipeline(input *ValidatePipelineInput) (*ValidatePipelineOutput, error)

ValidatePipeline API operation for Amazon OpenSearch Ingestion.

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.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 Amazon OpenSearch Ingestion's API operation ValidatePipeline for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have permissions to access the resource.

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

  • ValidationException An exception for missing or invalid input fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ValidatePipeline

func (*OSIS) ValidatePipelineRequest 

func (c *OSIS) ValidatePipelineRequest(input *ValidatePipelineInput) (req *request.Request, output *ValidatePipelineOutput)

ValidatePipelineRequest generates a "aws/request.Request" representing the client's request for the ValidatePipeline 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 ValidatePipeline for more information on using the ValidatePipeline 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 ValidatePipelineRequest method.
req, resp := client.ValidatePipelineRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ValidatePipeline

func (*OSIS) ValidatePipelineWithContext 

func (c *OSIS) ValidatePipelineWithContext(ctx aws.Context, input *ValidatePipelineInput, opts ...request.Option) (*ValidatePipelineOutput, error)

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

See ValidatePipeline 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 Pipeline 

type Pipeline struct {

	// Options that specify the configuration of a persistent buffer. To configure
	// how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.
	BufferOptions *BufferOptions `type:"structure"`

	// The date and time when the pipeline was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Options to control how OpenSearch encrypts all data-at-rest.
	EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

	// The ingestion endpoints for the pipeline, which you can send data to.
	IngestEndpointUrls []*string `type:"list"`

	// The date and time when the pipeline was last updated.
	LastUpdatedAt *time.Time `type:"timestamp"`

	// Key-value pairs that represent log publishing settings.
	LogPublishingOptions *LogPublishingOptions `type:"structure"`

	// The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
	MaxUnits *int64 `type:"integer"`

	// The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
	MinUnits *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string `type:"string"`

	// The Data Prepper pipeline configuration in YAML format.
	PipelineConfigurationBody *string `type:"string"`

	// The name of the pipeline.
	PipelineName *string `type:"string"`

	// A list of VPC endpoints that OpenSearch Ingestion has created to other AWS
	// services.
	ServiceVpcEndpoints []*ServiceVpcEndpoint `type:"list"`

	// The current status of the pipeline.
	Status *string `type:"string" enum:"PipelineStatus"`

	// The reason for the current status of the pipeline.
	StatusReason *PipelineStatusReason `type:"structure"`

	// A list of tags associated with the given pipeline.
	Tags []*Tag `type:"list"`

	// The VPC interface endpoints that have access to the pipeline.
	VpcEndpoints []*VpcEndpoint `type:"list"`
	// contains filtered or unexported fields
}

Information about an existing OpenSearch Ingestion pipeline.

func (Pipeline) GoString 

func (s Pipeline) 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 (*Pipeline) SetBufferOptions 

func (s *Pipeline) SetBufferOptions(v *BufferOptions) *Pipeline

SetBufferOptions sets the BufferOptions field's value.

func (*Pipeline) SetCreatedAt 

func (s *Pipeline) SetCreatedAt(v time.Time) *Pipeline

SetCreatedAt sets the CreatedAt field's value.

func (*Pipeline) SetEncryptionAtRestOptions 

func (s *Pipeline) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *Pipeline

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*Pipeline) SetIngestEndpointUrls 

func (s *Pipeline) SetIngestEndpointUrls(v []*string) *Pipeline

SetIngestEndpointUrls sets the IngestEndpointUrls field's value.

func (*Pipeline) SetLastUpdatedAt 

func (s *Pipeline) SetLastUpdatedAt(v time.Time) *Pipeline

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*Pipeline) SetLogPublishingOptions 

func (s *Pipeline) SetLogPublishingOptions(v *LogPublishingOptions) *Pipeline

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*Pipeline) SetMaxUnits 

func (s *Pipeline) SetMaxUnits(v int64) *Pipeline

SetMaxUnits sets the MaxUnits field's value.

func (*Pipeline) SetMinUnits 

func (s *Pipeline) SetMinUnits(v int64) *Pipeline

SetMinUnits sets the MinUnits field's value.

func (*Pipeline) SetPipelineArn 

func (s *Pipeline) SetPipelineArn(v string) *Pipeline

SetPipelineArn sets the PipelineArn field's value.

func (*Pipeline) SetPipelineConfigurationBody 

func (s *Pipeline) SetPipelineConfigurationBody(v string) *Pipeline

SetPipelineConfigurationBody sets the PipelineConfigurationBody field's value.

func (*Pipeline) SetPipelineName 

func (s *Pipeline) SetPipelineName(v string) *Pipeline

SetPipelineName sets the PipelineName field's value.

func (*Pipeline) SetServiceVpcEndpoints 

func (s *Pipeline) SetServiceVpcEndpoints(v []*ServiceVpcEndpoint) *Pipeline

SetServiceVpcEndpoints sets the ServiceVpcEndpoints field's value.

func (*Pipeline) SetStatus 

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

SetStatus sets the Status field's value.

func (*Pipeline) SetStatusReason 

func (s *Pipeline) SetStatusReason(v *PipelineStatusReason) *Pipeline

SetStatusReason sets the StatusReason field's value.

func (*Pipeline) SetTags 

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

SetTags sets the Tags field's value.

func (*Pipeline) SetVpcEndpoints 

func (s *Pipeline) SetVpcEndpoints(v []*VpcEndpoint) *Pipeline

SetVpcEndpoints sets the VpcEndpoints field's value.

func (Pipeline) String 

func (s Pipeline) 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 PipelineBlueprint 

type PipelineBlueprint struct {

	// The name of the blueprint.
	BlueprintName *string `type:"string"`

	// The YAML configuration of the blueprint.
	PipelineConfigurationBody *string `type:"string"`
	// contains filtered or unexported fields
}

Container for information about an OpenSearch Ingestion blueprint.

func (PipelineBlueprint) GoString 

func (s PipelineBlueprint) 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 (*PipelineBlueprint) SetBlueprintName 

func (s *PipelineBlueprint) SetBlueprintName(v string) *PipelineBlueprint

SetBlueprintName sets the BlueprintName field's value.

func (*PipelineBlueprint) SetPipelineConfigurationBody 

func (s *PipelineBlueprint) SetPipelineConfigurationBody(v string) *PipelineBlueprint

SetPipelineConfigurationBody sets the PipelineConfigurationBody field's value.

func (PipelineBlueprint) String 

func (s PipelineBlueprint) 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 PipelineBlueprintSummary 

type PipelineBlueprintSummary struct {

	// The name of the blueprint.
	BlueprintName *string `type:"string"`
	// contains filtered or unexported fields
}

A summary of an OpenSearch Ingestion blueprint.

func (PipelineBlueprintSummary) GoString 

func (s PipelineBlueprintSummary) 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 (*PipelineBlueprintSummary) SetBlueprintName 

func (s *PipelineBlueprintSummary) SetBlueprintName(v string) *PipelineBlueprintSummary

SetBlueprintName sets the BlueprintName field's value.

func (PipelineBlueprintSummary) String 

func (s PipelineBlueprintSummary) 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 PipelineStatusReason 

type PipelineStatusReason struct {

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

Information about a pipeline's current status.

func (PipelineStatusReason) GoString 

func (s PipelineStatusReason) 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 (*PipelineStatusReason) SetDescription 

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

SetDescription sets the Description field's value.

func (PipelineStatusReason) String 

func (s PipelineStatusReason) 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 PipelineSummary 

type PipelineSummary struct {

	// The date and time when the pipeline was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The date and time when the pipeline was last updated.
	LastUpdatedAt *time.Time `type:"timestamp"`

	// The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
	MaxUnits *int64 `min:"1" type:"integer"`

	// The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
	MinUnits *int64 `min:"1" type:"integer"`

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string `min:"46" type:"string"`

	// The name of the pipeline.
	PipelineName *string `min:"3" type:"string"`

	// The current status of the pipeline.
	Status *string `type:"string" enum:"PipelineStatus"`

	// Information about a pipeline's current status.
	StatusReason *PipelineStatusReason `type:"structure"`

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

Summary information for an OpenSearch Ingestion pipeline.

func (PipelineSummary) GoString 

func (s PipelineSummary) 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 (*PipelineSummary) SetCreatedAt 

func (s *PipelineSummary) SetCreatedAt(v time.Time) *PipelineSummary

SetCreatedAt sets the CreatedAt field's value.

func (*PipelineSummary) SetLastUpdatedAt 

func (s *PipelineSummary) SetLastUpdatedAt(v time.Time) *PipelineSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*PipelineSummary) SetMaxUnits 

func (s *PipelineSummary) SetMaxUnits(v int64) *PipelineSummary

SetMaxUnits sets the MaxUnits field's value.

func (*PipelineSummary) SetMinUnits 

func (s *PipelineSummary) SetMinUnits(v int64) *PipelineSummary

SetMinUnits sets the MinUnits field's value.

func (*PipelineSummary) SetPipelineArn 

func (s *PipelineSummary) SetPipelineArn(v string) *PipelineSummary

SetPipelineArn sets the PipelineArn field's value.

func (*PipelineSummary) SetPipelineName 

func (s *PipelineSummary) SetPipelineName(v string) *PipelineSummary

SetPipelineName sets the PipelineName field's value.

func (*PipelineSummary) SetStatus 

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

SetStatus sets the Status field's value.

func (*PipelineSummary) SetStatusReason 

func (s *PipelineSummary) SetStatusReason(v *PipelineStatusReason) *PipelineSummary

SetStatusReason sets the StatusReason field's value.

func (*PipelineSummary) SetTags 

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

SetTags sets the Tags field's value.

func (PipelineSummary) String 

func (s PipelineSummary) 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 ResourceAlreadyExistsException 

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

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

You attempted to create a resource that already exists.

func (*ResourceAlreadyExistsException) Code 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString 

func (s ResourceAlreadyExistsException) 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 (*ResourceAlreadyExistsException) Message 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode 

func (s *ResourceAlreadyExistsException) StatusCode() int

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

func (ResourceAlreadyExistsException) String 

func (s ResourceAlreadyExistsException) 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 ResourceNotFoundException 

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

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

You attempted to access or delete 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 ServiceVpcEndpoint 

type ServiceVpcEndpoint struct {

	// The name of the service for which a VPC endpoint was created.
	ServiceName *string `type:"string" enum:"VpcEndpointServiceName"`

	// The ID of the VPC endpoint that was created.
	VpcEndpointId *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (ServiceVpcEndpoint) GoString 

func (s ServiceVpcEndpoint) 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 (*ServiceVpcEndpoint) SetServiceName 

func (s *ServiceVpcEndpoint) SetServiceName(v string) *ServiceVpcEndpoint

SetServiceName sets the ServiceName field's value.

func (*ServiceVpcEndpoint) SetVpcEndpointId 

func (s *ServiceVpcEndpoint) SetVpcEndpointId(v string) *ServiceVpcEndpoint

SetVpcEndpointId sets the VpcEndpointId field's value.

func (ServiceVpcEndpoint) String 

func (s ServiceVpcEndpoint) 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 StartPipelineInput 

type StartPipelineInput struct {

	// The name of the pipeline to start.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"PipelineName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartPipelineInput) GoString 

func (s StartPipelineInput) 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 (*StartPipelineInput) SetPipelineName 

func (s *StartPipelineInput) SetPipelineName(v string) *StartPipelineInput

SetPipelineName sets the PipelineName field's value.

func (StartPipelineInput) String 

func (s StartPipelineInput) 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 (*StartPipelineInput) Validate 

func (s *StartPipelineInput) Validate() error

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

type StartPipelineOutput 

type StartPipelineOutput struct {

	// Information about an existing OpenSearch Ingestion pipeline.
	Pipeline *Pipeline `type:"structure"`
	// contains filtered or unexported fields
}

func (StartPipelineOutput) GoString 

func (s StartPipelineOutput) 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 (*StartPipelineOutput) SetPipeline 

func (s *StartPipelineOutput) SetPipeline(v *Pipeline) *StartPipelineOutput

SetPipeline sets the Pipeline field's value.

func (StartPipelineOutput) String 

func (s StartPipelineOutput) 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 StopPipelineInput 

type StopPipelineInput struct {

	// The name of the pipeline to stop.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"PipelineName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopPipelineInput) GoString 

func (s StopPipelineInput) 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 (*StopPipelineInput) SetPipelineName 

func (s *StopPipelineInput) SetPipelineName(v string) *StopPipelineInput

SetPipelineName sets the PipelineName field's value.

func (StopPipelineInput) String 

func (s StopPipelineInput) 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 (*StopPipelineInput) Validate 

func (s *StopPipelineInput) Validate() error

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

type StopPipelineOutput 

type StopPipelineOutput struct {

	// Information about an existing OpenSearch Ingestion pipeline.
	Pipeline *Pipeline `type:"structure"`
	// contains filtered or unexported fields
}

func (StopPipelineOutput) GoString 

func (s StopPipelineOutput) 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 (*StopPipelineOutput) SetPipeline 

func (s *StopPipelineOutput) SetPipeline(v *Pipeline) *StopPipelineOutput

SetPipeline sets the Pipeline field's value.

func (StopPipelineOutput) String 

func (s StopPipelineOutput) 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 tag key. Tag keys must be unique for the pipeline to which they are attached.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// 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
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

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 pipeline to tag.
	//
	// Arn is a required field
	Arn *string `location:"querystring" locationName:"arn" min:"46" type:"string" required:"true"`

	// The list of key-value tags to add to the pipeline.
	//
	// Tags is a required field
	Tags []*Tag `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) SetArn 

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

SetArn sets the Arn 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 pipeline to remove tags from.
	//
	// Arn is a required field
	Arn *string `location:"querystring" locationName:"arn" min:"46" type:"string" required:"true"`

	// The tag keys to remove.
	//
	// TagKeys is a required field
	TagKeys []*string `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) SetArn 

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

SetArn sets the Arn 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 UpdatePipelineInput 

type UpdatePipelineInput struct {

	// Key-value pairs to configure persistent buffering for the pipeline.
	BufferOptions *BufferOptions `type:"structure"`

	// Key-value pairs to configure encryption for data that is written to a persistent
	// buffer.
	EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

	// Key-value pairs to configure log publishing.
	LogPublishingOptions *LogPublishingOptions `type:"structure"`

	// The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
	MaxUnits *int64 `min:"1" type:"integer"`

	// The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
	MinUnits *int64 `min:"1" type:"integer"`

	// The pipeline configuration in YAML format. The command accepts the pipeline
	// configuration as a string or within a .yaml file. If you provide the configuration
	// as a string, each new line must be escaped with \n.
	PipelineConfigurationBody *string `min:"1" type:"string"`

	// The name of the pipeline to update.
	//
	// PipelineName is a required field
	PipelineName *string `location:"uri" locationName:"PipelineName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePipelineInput) GoString 

func (s UpdatePipelineInput) 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 (*UpdatePipelineInput) SetBufferOptions 

func (s *UpdatePipelineInput) SetBufferOptions(v *BufferOptions) *UpdatePipelineInput

SetBufferOptions sets the BufferOptions field's value.

func (*UpdatePipelineInput) SetEncryptionAtRestOptions 

func (s *UpdatePipelineInput) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *UpdatePipelineInput

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*UpdatePipelineInput) SetLogPublishingOptions 

func (s *UpdatePipelineInput) SetLogPublishingOptions(v *LogPublishingOptions) *UpdatePipelineInput

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*UpdatePipelineInput) SetMaxUnits 

func (s *UpdatePipelineInput) SetMaxUnits(v int64) *UpdatePipelineInput

SetMaxUnits sets the MaxUnits field's value.

func (*UpdatePipelineInput) SetMinUnits 

func (s *UpdatePipelineInput) SetMinUnits(v int64) *UpdatePipelineInput

SetMinUnits sets the MinUnits field's value.

func (*UpdatePipelineInput) SetPipelineConfigurationBody 

func (s *UpdatePipelineInput) SetPipelineConfigurationBody(v string) *UpdatePipelineInput

SetPipelineConfigurationBody sets the PipelineConfigurationBody field's value.

func (*UpdatePipelineInput) SetPipelineName 

func (s *UpdatePipelineInput) SetPipelineName(v string) *UpdatePipelineInput

SetPipelineName sets the PipelineName field's value.

func (UpdatePipelineInput) String 

func (s UpdatePipelineInput) 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 (*UpdatePipelineInput) Validate 

func (s *UpdatePipelineInput) Validate() error

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

type UpdatePipelineOutput 

type UpdatePipelineOutput struct {

	// Container for information about the updated pipeline.
	Pipeline *Pipeline `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdatePipelineOutput) GoString 

func (s UpdatePipelineOutput) 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 (*UpdatePipelineOutput) SetPipeline 

func (s *UpdatePipelineOutput) SetPipeline(v *Pipeline) *UpdatePipelineOutput

SetPipeline sets the Pipeline field's value.

func (UpdatePipelineOutput) String 

func (s UpdatePipelineOutput) 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 ValidatePipelineInput 

type ValidatePipelineInput struct {

	// The pipeline configuration in YAML format. The command accepts the pipeline
	// configuration as a string or within a .yaml file. If you provide the configuration
	// as a string, each new line must be escaped with \n.
	//
	// PipelineConfigurationBody is a required field
	PipelineConfigurationBody *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ValidatePipelineInput) GoString 

func (s ValidatePipelineInput) 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 (*ValidatePipelineInput) SetPipelineConfigurationBody 

func (s *ValidatePipelineInput) SetPipelineConfigurationBody(v string) *ValidatePipelineInput

SetPipelineConfigurationBody sets the PipelineConfigurationBody field's value.

func (ValidatePipelineInput) String 

func (s ValidatePipelineInput) 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 (*ValidatePipelineInput) Validate 

func (s *ValidatePipelineInput) Validate() error

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

type ValidatePipelineOutput 

type ValidatePipelineOutput struct {

	// A list of errors if the configuration is invalid.
	Errors []*ValidationMessage `type:"list"`

	// A boolean indicating whether or not the pipeline configuration is valid.
	IsValid *bool `locationName:"isValid" type:"boolean"`
	// contains filtered or unexported fields
}

func (ValidatePipelineOutput) GoString 

func (s ValidatePipelineOutput) 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 (*ValidatePipelineOutput) SetErrors 

func (s *ValidatePipelineOutput) SetErrors(v []*ValidationMessage) *ValidatePipelineOutput

SetErrors sets the Errors field's value.

func (*ValidatePipelineOutput) SetIsValid 

func (s *ValidatePipelineOutput) SetIsValid(v bool) *ValidatePipelineOutput

SetIsValid sets the IsValid field's value.

func (ValidatePipelineOutput) String 

func (s ValidatePipelineOutput) 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
}

An exception for missing or invalid input fields.

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 ValidationMessage 

type ValidationMessage struct {

	// The validation message.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (ValidationMessage) GoString 

func (s ValidationMessage) 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 (*ValidationMessage) SetMessage 

func (s *ValidationMessage) SetMessage(v string) *ValidationMessage

SetMessage sets the Message field's value.

func (ValidationMessage) String 

func (s ValidationMessage) 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 VpcEndpoint 

type VpcEndpoint struct {

	// The unique identifier of the endpoint.
	VpcEndpointId *string `type:"string"`

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

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

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

func (VpcEndpoint) GoString 

func (s VpcEndpoint) 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 (*VpcEndpoint) SetVpcEndpointId 

func (s *VpcEndpoint) SetVpcEndpointId(v string) *VpcEndpoint

SetVpcEndpointId sets the VpcEndpointId field's value.

func (*VpcEndpoint) SetVpcId 

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

SetVpcId sets the VpcId field's value.

func (*VpcEndpoint) SetVpcOptions 

func (s *VpcEndpoint) SetVpcOptions(v *VpcOptions) *VpcEndpoint

SetVpcOptions sets the VpcOptions field's value.

func (VpcEndpoint) String 

func (s VpcEndpoint) 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 VpcOptions 

type VpcOptions struct {

	// A list of security groups associated with the VPC endpoint.
	SecurityGroupIds []*string `min:"1" type:"list"`

	// A list of subnet IDs associated with the VPC endpoint.
	//
	// SubnetIds is a required field
	SubnetIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (VpcOptions) GoString 

func (s VpcOptions) 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 (*VpcOptions) SetSecurityGroupIds 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcOptions) SetSubnetIds 

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

SetSubnetIds sets the SubnetIds field's value.

func (VpcOptions) String 

func (s VpcOptions) 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 (*VpcOptions) Validate 

func (s *VpcOptions) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package osisiface provides an interface to enable mocking the Amazon OpenSearch Ingestion service client for testing your code.
 Package osisiface provides an interface to enable mocking the Amazon OpenSearch Ingestion 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.