kendraranking

package
v0.0.0-...-3080b95 Latest Latest
Warning

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

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

Documentation

Overview

Package kendraranking provides the client and types for making API requests to Amazon Kendra Intelligent Ranking.

Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.

See https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19 for more information on this service.

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

Using the Client

To contact Amazon Kendra Intelligent Ranking 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 Kendra Intelligent Ranking client KendraRanking for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kendraranking/#New

Index

Constants

View Source 
const (
	// RescoreExecutionPlanStatusCreating is a RescoreExecutionPlanStatus enum value
	RescoreExecutionPlanStatusCreating = "CREATING"

	// RescoreExecutionPlanStatusUpdating is a RescoreExecutionPlanStatus enum value
	RescoreExecutionPlanStatusUpdating = "UPDATING"

	// RescoreExecutionPlanStatusActive is a RescoreExecutionPlanStatus enum value
	RescoreExecutionPlanStatusActive = "ACTIVE"

	// RescoreExecutionPlanStatusDeleting is a RescoreExecutionPlanStatus enum value
	RescoreExecutionPlanStatusDeleting = "DELETING"

	// RescoreExecutionPlanStatusFailed is a RescoreExecutionPlanStatus enum value
	RescoreExecutionPlanStatusFailed = "FAILED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don’t have sufficient access to perform this action. Please ensure
	// you have the required permission policies and user accounts and try again.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A conflict occurred with the request. Please fix any inconsistencies with
	// your resources and try again.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An issue occurred with the internal server used for your Amazon Kendra Intelligent
	// Ranking service. Please wait a few minutes and try again, or contact Support
	// (http://aws.amazon.com/contact-us/) for help.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource you want to use doesn't exist. Please check you have provided
	// the correct resource and try again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceUnavailableException for service response error code
	// "ResourceUnavailableException".
	//
	// The resource you want to use is unavailable. Please check you have provided
	// the correct resource information and try again.
	ErrCodeResourceUnavailableException = "ResourceUnavailableException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You have exceeded the set limits for your Amazon Kendra Intelligent Ranking
	// service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html)
	// for more information, or contact Support (http://aws.amazon.com/contact-us/)
	// to inquire about an increase of limits.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling. Please reduce the number
	// of requests and try again.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints set by the Amazon Kendra Intelligent
	// Ranking service. Please provide the correct input and try again.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Kendra Ranking" // Name of service.
	EndpointsID = "kendra-ranking" // ID to lookup a service endpoint with.
	ServiceID   = "Kendra Ranking" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func RescoreExecutionPlanStatus_Values 

func RescoreExecutionPlanStatus_Values() []string

RescoreExecutionPlanStatus_Values returns all elements of the RescoreExecutionPlanStatus enum

Types

type AccessDeniedException 

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

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

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 CapacityUnitsConfiguration 

type CapacityUnitsConfiguration struct {

	// The amount of extra capacity for your rescore execution plan.
	//
	// A single extra capacity unit for a rescore execution plan provides 0.01 rescore
	// requests per second. You can add up to 1000 extra capacity units.
	//
	// RescoreCapacityUnits is a required field
	RescoreCapacityUnits *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Sets additional capacity units configured for your rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can add and remove capacity units to fit your usage requirements.

func (CapacityUnitsConfiguration) GoString 

func (s CapacityUnitsConfiguration) 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 (*CapacityUnitsConfiguration) SetRescoreCapacityUnits 

func (s *CapacityUnitsConfiguration) SetRescoreCapacityUnits(v int64) *CapacityUnitsConfiguration

SetRescoreCapacityUnits sets the RescoreCapacityUnits field's value.

func (CapacityUnitsConfiguration) String 

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

func (s *CapacityUnitsConfiguration) 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" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

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 CreateRescoreExecutionPlanInput 

type CreateRescoreExecutionPlanInput struct {

	// You can set additional capacity units to meet the needs of your rescore execution
	// plan. You are given a single capacity unit by default. If you want to use
	// the default capacity, you don't set additional capacity units. For more information
	// on the default capacity and additional capacity units, see Adjusting capacity
	// (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
	CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

	// A token that you provide to identify the request to create a rescore execution
	// plan. Multiple calls to the CreateRescoreExecutionPlanRequest API with the
	// same client token will create only one rescore execution plan.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description for the rescore execution plan.
	Description *string `type:"string"`

	// A name for the rescore execution plan.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// A list of key-value pairs that identify or categorize your rescore execution
	// plan. You can also use tags to help control access to the rescore execution
	// plan. Tag keys and values can consist of Unicode letters, digits, white space,
	// and any of the following symbols: _ . : / = + - @.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateRescoreExecutionPlanInput) GoString 

func (s CreateRescoreExecutionPlanInput) 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 (*CreateRescoreExecutionPlanInput) SetCapacityUnits 

func (s *CreateRescoreExecutionPlanInput) SetCapacityUnits(v *CapacityUnitsConfiguration) *CreateRescoreExecutionPlanInput

SetCapacityUnits sets the CapacityUnits field's value.

func (*CreateRescoreExecutionPlanInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateRescoreExecutionPlanInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateRescoreExecutionPlanInput) SetName 

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

SetName sets the Name field's value.

func (*CreateRescoreExecutionPlanInput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateRescoreExecutionPlanInput) String 

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

func (s *CreateRescoreExecutionPlanInput) Validate() error

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

type CreateRescoreExecutionPlanOutput 

type CreateRescoreExecutionPlanOutput struct {

	// The Amazon Resource Name (ARN) of the rescore execution plan.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The identifier of the rescore execution plan.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRescoreExecutionPlanOutput) GoString 

func (s CreateRescoreExecutionPlanOutput) 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 (*CreateRescoreExecutionPlanOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*CreateRescoreExecutionPlanOutput) SetId 

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

SetId sets the Id field's value.

func (CreateRescoreExecutionPlanOutput) String 

func (s CreateRescoreExecutionPlanOutput) 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 DeleteRescoreExecutionPlanInput 

type DeleteRescoreExecutionPlanInput struct {

	// The identifier of the rescore execution plan that you want to delete.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRescoreExecutionPlanInput) GoString 

func (s DeleteRescoreExecutionPlanInput) 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 (*DeleteRescoreExecutionPlanInput) SetId 

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

SetId sets the Id field's value.

func (DeleteRescoreExecutionPlanInput) String 

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

func (s *DeleteRescoreExecutionPlanInput) Validate() error

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

type DeleteRescoreExecutionPlanOutput 

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

func (DeleteRescoreExecutionPlanOutput) GoString 

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

func (s DeleteRescoreExecutionPlanOutput) 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 DescribeRescoreExecutionPlanInput 

type DescribeRescoreExecutionPlanInput struct {

	// The identifier of the rescore execution plan that you want to get information
	// on.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRescoreExecutionPlanInput) GoString 

func (s DescribeRescoreExecutionPlanInput) 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 (*DescribeRescoreExecutionPlanInput) SetId 

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

SetId sets the Id field's value.

func (DescribeRescoreExecutionPlanInput) String 

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

func (s *DescribeRescoreExecutionPlanInput) Validate() error

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

type DescribeRescoreExecutionPlanOutput 

type DescribeRescoreExecutionPlanOutput struct {

	// The Amazon Resource Name (ARN) of the rescore execution plan.
	Arn *string `type:"string"`

	// The capacity units set for the rescore execution plan. A capacity of zero
	// indicates that the rescore execution plan is using the default capacity.
	// For more information on the default capacity and additional capacity units,
	// see Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
	CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

	// The Unix timestamp of when the rescore execution plan was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The description for the rescore execution plan.
	Description *string `type:"string"`

	// When the Status field value is FAILED, the ErrorMessage field contains a
	// message that explains why.
	ErrorMessage *string `min:"1" type:"string"`

	// The identifier of the rescore execution plan.
	Id *string `min:"36" type:"string"`

	// The name for the rescore execution plan.
	Name *string `min:"1" type:"string"`

	// The current status of the rescore execution plan. When the value is ACTIVE,
	// the rescore execution plan is ready for use. If the Status field value is
	// FAILED, the ErrorMessage field contains a message that explains why.
	Status *string `type:"string" enum:"RescoreExecutionPlanStatus"`

	// The Unix timestamp of when the rescore execution plan was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeRescoreExecutionPlanOutput) GoString 

func (s DescribeRescoreExecutionPlanOutput) 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 (*DescribeRescoreExecutionPlanOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*DescribeRescoreExecutionPlanOutput) SetCapacityUnits 

func (s *DescribeRescoreExecutionPlanOutput) SetCapacityUnits(v *CapacityUnitsConfiguration) *DescribeRescoreExecutionPlanOutput

SetCapacityUnits sets the CapacityUnits field's value.

func (*DescribeRescoreExecutionPlanOutput) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeRescoreExecutionPlanOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*DescribeRescoreExecutionPlanOutput) SetErrorMessage 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeRescoreExecutionPlanOutput) SetId 

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

SetId sets the Id field's value.

func (*DescribeRescoreExecutionPlanOutput) SetName 

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

SetName sets the Name field's value.

func (*DescribeRescoreExecutionPlanOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*DescribeRescoreExecutionPlanOutput) SetUpdatedAt 

func (s *DescribeRescoreExecutionPlanOutput) SetUpdatedAt(v time.Time) *DescribeRescoreExecutionPlanOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeRescoreExecutionPlanOutput) String 

func (s DescribeRescoreExecutionPlanOutput) 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 Document 

type Document struct {

	// The body text of the search service's document.
	Body *string `min:"1" type:"string"`

	// The optional group identifier of the document from the search service. Documents
	// with the same group identifier are grouped together and processed as one
	// document within the service.
	GroupId *string `min:"1" type:"string"`

	// The identifier of the document from the search service.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The original document score or rank from the search service. Amazon Kendra
	// Intelligent Ranking gives the document a new score or rank based on its intelligent
	// search algorithms.
	//
	// OriginalScore is a required field
	OriginalScore *float64 `type:"float" required:"true"`

	// The title of the search service's document.
	Title *string `min:"1" type:"string"`

	// The body text of the search service's document represented as a list of tokens
	// or words. You must choose to provide Body or TokenizedBody. You cannot provide
	// both.
	TokenizedBody []*string `min:"1" type:"list"`

	// The title of the search service's document represented as a list of tokens
	// or words. You must choose to provide Title or TokenizedTitle. You cannot
	// provide both.
	TokenizedTitle []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.

func (Document) GoString 

func (s Document) 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 (*Document) SetBody 

func (s *Document) SetBody(v string) *Document

SetBody sets the Body field's value.

func (*Document) SetGroupId 

func (s *Document) SetGroupId(v string) *Document

SetGroupId sets the GroupId field's value.

func (*Document) SetId 

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

SetId sets the Id field's value.

func (*Document) SetOriginalScore 

func (s *Document) SetOriginalScore(v float64) *Document

SetOriginalScore sets the OriginalScore field's value.

func (*Document) SetTitle 

func (s *Document) SetTitle(v string) *Document

SetTitle sets the Title field's value.

func (*Document) SetTokenizedBody 

func (s *Document) SetTokenizedBody(v []*string) *Document

SetTokenizedBody sets the TokenizedBody field's value.

func (*Document) SetTokenizedTitle 

func (s *Document) SetTokenizedTitle(v []*string) *Document

SetTokenizedTitle sets the TokenizedTitle field's value.

func (Document) String 

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

func (s *Document) Validate() error

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

type InternalServerException 

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

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

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

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

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

type KendraRanking 

type KendraRanking struct {
	*client.Client
}

KendraRanking provides the API operation methods for making requests to Amazon Kendra Intelligent Ranking. See this package's package overview docs for details on the service.

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

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

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

func (*KendraRanking) CreateRescoreExecutionPlan 

func (c *KendraRanking) CreateRescoreExecutionPlan(input *CreateRescoreExecutionPlanInput) (*CreateRescoreExecutionPlanOutput, error)

CreateRescoreExecutionPlan API operation for Amazon Kendra Intelligent Ranking.

Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.

For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results (https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.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 Kendra Intelligent Ranking's API operation CreateRescoreExecutionPlan for usage and error information.

Returned Error Types:

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan

func (*KendraRanking) CreateRescoreExecutionPlanRequest 

func (c *KendraRanking) CreateRescoreExecutionPlanRequest(input *CreateRescoreExecutionPlanInput) (req *request.Request, output *CreateRescoreExecutionPlanOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan

func (*KendraRanking) CreateRescoreExecutionPlanWithContext 

func (c *KendraRanking) CreateRescoreExecutionPlanWithContext(ctx aws.Context, input *CreateRescoreExecutionPlanInput, opts ...request.Option) (*CreateRescoreExecutionPlanOutput, error)

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

See CreateRescoreExecutionPlan 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 (*KendraRanking) DeleteRescoreExecutionPlan 

func (c *KendraRanking) DeleteRescoreExecutionPlan(input *DeleteRescoreExecutionPlanInput) (*DeleteRescoreExecutionPlanOutput, error)

DeleteRescoreExecutionPlan API operation for Amazon Kendra Intelligent Ranking.

Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

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 Kendra Intelligent Ranking's API operation DeleteRescoreExecutionPlan for usage and error information.

Returned Error Types:

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan

func (*KendraRanking) DeleteRescoreExecutionPlanRequest 

func (c *KendraRanking) DeleteRescoreExecutionPlanRequest(input *DeleteRescoreExecutionPlanInput) (req *request.Request, output *DeleteRescoreExecutionPlanOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan

func (*KendraRanking) DeleteRescoreExecutionPlanWithContext 

func (c *KendraRanking) DeleteRescoreExecutionPlanWithContext(ctx aws.Context, input *DeleteRescoreExecutionPlanInput, opts ...request.Option) (*DeleteRescoreExecutionPlanOutput, error)

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

See DeleteRescoreExecutionPlan 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 (*KendraRanking) DescribeRescoreExecutionPlan 

func (c *KendraRanking) DescribeRescoreExecutionPlan(input *DescribeRescoreExecutionPlanInput) (*DescribeRescoreExecutionPlanOutput, error)

DescribeRescoreExecutionPlan API operation for Amazon Kendra Intelligent Ranking.

Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

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 Kendra Intelligent Ranking's API operation DescribeRescoreExecutionPlan for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan

func (*KendraRanking) DescribeRescoreExecutionPlanRequest 

func (c *KendraRanking) DescribeRescoreExecutionPlanRequest(input *DescribeRescoreExecutionPlanInput) (req *request.Request, output *DescribeRescoreExecutionPlanOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan

func (*KendraRanking) DescribeRescoreExecutionPlanWithContext 

func (c *KendraRanking) DescribeRescoreExecutionPlanWithContext(ctx aws.Context, input *DescribeRescoreExecutionPlanInput, opts ...request.Option) (*DescribeRescoreExecutionPlanOutput, error)

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

See DescribeRescoreExecutionPlan 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 (*KendraRanking) ListRescoreExecutionPlans 

func (c *KendraRanking) ListRescoreExecutionPlans(input *ListRescoreExecutionPlansInput) (*ListRescoreExecutionPlansOutput, error)

ListRescoreExecutionPlans API operation for Amazon Kendra Intelligent Ranking.

Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

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 Kendra Intelligent Ranking's API operation ListRescoreExecutionPlans for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ListRescoreExecutionPlans

func (*KendraRanking) ListRescoreExecutionPlansPages 

func (c *KendraRanking) ListRescoreExecutionPlansPages(input *ListRescoreExecutionPlansInput, fn func(*ListRescoreExecutionPlansOutput, bool) bool) error

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

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

func (*KendraRanking) ListRescoreExecutionPlansPagesWithContext 

func (c *KendraRanking) ListRescoreExecutionPlansPagesWithContext(ctx aws.Context, input *ListRescoreExecutionPlansInput, fn func(*ListRescoreExecutionPlansOutput, bool) bool, opts ...request.Option) error

ListRescoreExecutionPlansPagesWithContext same as ListRescoreExecutionPlansPages 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 (*KendraRanking) ListRescoreExecutionPlansRequest 

func (c *KendraRanking) ListRescoreExecutionPlansRequest(input *ListRescoreExecutionPlansInput) (req *request.Request, output *ListRescoreExecutionPlansOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ListRescoreExecutionPlans

func (*KendraRanking) ListRescoreExecutionPlansWithContext 

func (c *KendraRanking) ListRescoreExecutionPlansWithContext(ctx aws.Context, input *ListRescoreExecutionPlansInput, opts ...request.Option) (*ListRescoreExecutionPlansOutput, error)

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

See ListRescoreExecutionPlans 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 (*KendraRanking) ListTagsForResource 

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

ListTagsForResource API operation for Amazon Kendra Intelligent Ranking.

Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.

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 Kendra Intelligent Ranking's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ListTagsForResource

func (*KendraRanking) ListTagsForResourceRequest 

func (c *KendraRanking) 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/kendra-ranking-2022-10-19/ListTagsForResource

func (*KendraRanking) ListTagsForResourceWithContext 

func (c *KendraRanking) 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 (*KendraRanking) Rescore 

func (c *KendraRanking) Rescore(input *RescoreInput) (*RescoreOutput, error)

Rescore API operation for Amazon Kendra Intelligent Ranking.

Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.

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 Kendra Intelligent Ranking's API operation Rescore for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ResourceNotFoundException The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/Rescore

func (*KendraRanking) RescoreRequest 

func (c *KendraRanking) RescoreRequest(input *RescoreInput) (req *request.Request, output *RescoreOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/Rescore

func (*KendraRanking) RescoreWithContext 

func (c *KendraRanking) RescoreWithContext(ctx aws.Context, input *RescoreInput, opts ...request.Option) (*RescoreOutput, error)

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

See Rescore 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 (*KendraRanking) TagResource 

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

TagResource API operation for Amazon Kendra Intelligent Ranking.

Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the existing value is replaced with the new value.

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 Kendra Intelligent Ranking's API operation TagResource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/TagResource

func (*KendraRanking) TagResourceRequest 

func (c *KendraRanking) 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/kendra-ranking-2022-10-19/TagResource

func (*KendraRanking) TagResourceWithContext 

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

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

UntagResource API operation for Amazon Kendra Intelligent Ranking.

Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore operation.

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 Kendra Intelligent Ranking's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/UntagResource

func (*KendraRanking) UntagResourceRequest 

func (c *KendraRanking) 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/kendra-ranking-2022-10-19/UntagResource

func (*KendraRanking) UntagResourceWithContext 

func (c *KendraRanking) 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 (*KendraRanking) UpdateRescoreExecutionPlan 

func (c *KendraRanking) UpdateRescoreExecutionPlan(input *UpdateRescoreExecutionPlanInput) (*UpdateRescoreExecutionPlanOutput, error)

UpdateRescoreExecutionPlan API operation for Amazon Kendra Intelligent Ranking.

Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.

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 Kendra Intelligent Ranking's API operation UpdateRescoreExecutionPlan for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ConflictException A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan

func (*KendraRanking) UpdateRescoreExecutionPlanRequest 

func (c *KendraRanking) UpdateRescoreExecutionPlanRequest(input *UpdateRescoreExecutionPlanInput) (req *request.Request, output *UpdateRescoreExecutionPlanOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan

func (*KendraRanking) UpdateRescoreExecutionPlanWithContext 

func (c *KendraRanking) UpdateRescoreExecutionPlanWithContext(ctx aws.Context, input *UpdateRescoreExecutionPlanInput, opts ...request.Option) (*UpdateRescoreExecutionPlanOutput, error)

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

See UpdateRescoreExecutionPlan 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 ListRescoreExecutionPlansInput 

type ListRescoreExecutionPlansInput struct {

	// The maximum number of rescore execution plans to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the response is truncated, Amazon Kendra Intelligent Ranking returns a
	// pagination token in the response. You can use this pagination token to retrieve
	// the next set of rescore execution plans.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRescoreExecutionPlansInput) GoString 

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

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

SetMaxResults sets the MaxResults field's value.

func (*ListRescoreExecutionPlansInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListRescoreExecutionPlansInput) String 

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

func (s *ListRescoreExecutionPlansInput) Validate() error

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

type ListRescoreExecutionPlansOutput 

type ListRescoreExecutionPlansOutput struct {

	// If the response is truncated, Amazon Kendra Intelligent Ranking returns a
	// pagination token in the response.
	NextToken *string `min:"1" type:"string"`

	// An array of summary information for one or more rescore execution plans.
	SummaryItems []*RescoreExecutionPlanSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListRescoreExecutionPlansOutput) GoString 

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

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

SetNextToken sets the NextToken field's value.

func (*ListRescoreExecutionPlansOutput) SetSummaryItems 

func (s *ListRescoreExecutionPlansOutput) SetSummaryItems(v []*RescoreExecutionPlanSummary) *ListRescoreExecutionPlansOutput

SetSummaryItems sets the SummaryItems field's value.

func (ListRescoreExecutionPlansOutput) String 

func (s ListRescoreExecutionPlansOutput) 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 rescore execution plan to get a list
	// of tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request information for listing tags associated with a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceInput) SetResourceARN 

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

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

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

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

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

If the action is successful, the service sends back an HTTP 200 response.

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 RescoreExecutionPlanSummary 

type RescoreExecutionPlanSummary struct {

	// The Unix timestamp when the rescore execution plan was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of the rescore execution plan.
	Id *string `min:"36" type:"string"`

	// The name of the rescore execution plan.
	Name *string `min:"1" type:"string"`

	// The current status of the rescore execution plan. When the value is ACTIVE,
	// the rescore execution plan is ready for use.
	Status *string `type:"string" enum:"RescoreExecutionPlanStatus"`

	// The Unix timestamp when the rescore execution plan was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

func (RescoreExecutionPlanSummary) GoString 

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

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

SetCreatedAt sets the CreatedAt field's value.

func (*RescoreExecutionPlanSummary) SetId 

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

SetId sets the Id field's value.

func (*RescoreExecutionPlanSummary) SetName 

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

SetName sets the Name field's value.

func (*RescoreExecutionPlanSummary) SetStatus 

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

SetStatus sets the Status field's value.

func (*RescoreExecutionPlanSummary) SetUpdatedAt 

func (s *RescoreExecutionPlanSummary) SetUpdatedAt(v time.Time) *RescoreExecutionPlanSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (RescoreExecutionPlanSummary) String 

func (s RescoreExecutionPlanSummary) 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 RescoreInput 

type RescoreInput struct {

	// The list of documents for Amazon Kendra Intelligent Ranking to rescore or
	// rank on.
	//
	// Documents is a required field
	Documents []*Document `min:"1" type:"list" required:"true"`

	// The identifier of the rescore execution plan. A rescore execution plan is
	// an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore
	// API.
	//
	// RescoreExecutionPlanId is a required field
	RescoreExecutionPlanId *string `min:"36" type:"string" required:"true"`

	// The input query from the search service.
	//
	// SearchQuery is a required field
	SearchQuery *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RescoreInput) GoString 

func (s RescoreInput) 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 (*RescoreInput) SetDocuments 

func (s *RescoreInput) SetDocuments(v []*Document) *RescoreInput

SetDocuments sets the Documents field's value.

func (*RescoreInput) SetRescoreExecutionPlanId 

func (s *RescoreInput) SetRescoreExecutionPlanId(v string) *RescoreInput

SetRescoreExecutionPlanId sets the RescoreExecutionPlanId field's value.

func (*RescoreInput) SetSearchQuery 

func (s *RescoreInput) SetSearchQuery(v string) *RescoreInput

SetSearchQuery sets the SearchQuery field's value.

func (RescoreInput) String 

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

func (s *RescoreInput) Validate() error

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

type RescoreOutput 

type RescoreOutput struct {

	// The identifier associated with the scores that Amazon Kendra Intelligent
	// Ranking gives to the results. Amazon Kendra Intelligent Ranking rescores
	// or re-ranks the results for the search service.
	RescoreId *string `min:"1" type:"string"`

	// A list of result items for documents with new relevancy scores. The results
	// are in descending order.
	ResultItems []*RescoreResultItem `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (RescoreOutput) GoString 

func (s RescoreOutput) 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 (*RescoreOutput) SetRescoreId 

func (s *RescoreOutput) SetRescoreId(v string) *RescoreOutput

SetRescoreId sets the RescoreId field's value.

func (*RescoreOutput) SetResultItems 

func (s *RescoreOutput) SetResultItems(v []*RescoreResultItem) *RescoreOutput

SetResultItems sets the ResultItems field's value.

func (RescoreOutput) String 

func (s RescoreOutput) 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 RescoreResultItem 

type RescoreResultItem struct {

	// The identifier of the document from the search service.
	DocumentId *string `min:"1" type:"string"`

	// The relevancy score or rank that Amazon Kendra Intelligent Ranking gives
	// to the result.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

A result item for a document with a new relevancy score.

func (RescoreResultItem) GoString 

func (s RescoreResultItem) 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 (*RescoreResultItem) SetDocumentId 

func (s *RescoreResultItem) SetDocumentId(v string) *RescoreResultItem

SetDocumentId sets the DocumentId field's value.

func (*RescoreResultItem) SetScore 

func (s *RescoreResultItem) SetScore(v float64) *RescoreResultItem

SetScore sets the Score field's value.

func (RescoreResultItem) String 

func (s RescoreResultItem) 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" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

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 ResourceUnavailableException 

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

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.

func (*ResourceUnavailableException) Code 

func (s *ResourceUnavailableException) Code() string

Code returns the exception type name.

func (*ResourceUnavailableException) Error 

func (s *ResourceUnavailableException) Error() string

func (ResourceUnavailableException) GoString 

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

func (s *ResourceUnavailableException) Message() string

Message returns the exception's message.

func (*ResourceUnavailableException) OrigErr 

func (s *ResourceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceUnavailableException) RequestID 

func (s *ResourceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceUnavailableException) StatusCode 

func (s *ResourceUnavailableException) StatusCode() int

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

func (ResourceUnavailableException) String 

func (s ResourceUnavailableException) String() string

String returns the string representation.

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

type ServiceQuotaExceededException 

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

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

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

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

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

type Tag 

type Tag struct {

	// The key for the tag. Keys are not case sensitive and must be unique.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value associated with the tag. The value can be an empty string but it
	// can't be null.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A key-value pair that identifies or categorizes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can also use a tag to help control access to a rescore execution plan. A tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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 rescore execution plan to tag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of tag keys to add to a rescore execution plan. If a tag already exists,
	// the existing value is replaced with the new value.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

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

func (*TagResourceInput) SetResourceARN 

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

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

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

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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 ThrottlingException 

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

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling. Please reduce the number of requests and try again.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

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

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) 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 rescore execution plan to remove the
	// tag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of tag keys to remove from the rescore execution plan. If a tag key
	// does not exist on the resource, it is ignored.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request information to remove a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

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

func (*UntagResourceInput) SetResourceARN 

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

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

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

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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 UpdateRescoreExecutionPlanInput 

type UpdateRescoreExecutionPlanInput struct {

	// You can set additional capacity units to meet the needs of your rescore execution
	// plan. You are given a single capacity unit by default. If you want to use
	// the default capacity, you don't set additional capacity units. For more information
	// on the default capacity and additional capacity units, see Adjusting capacity
	// (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
	CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

	// A new description for the rescore execution plan.
	Description *string `type:"string"`

	// The identifier of the rescore execution plan that you want to update.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`

	// A new name for the rescore execution plan.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateRescoreExecutionPlanInput) GoString 

func (s UpdateRescoreExecutionPlanInput) 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 (*UpdateRescoreExecutionPlanInput) SetCapacityUnits 

func (s *UpdateRescoreExecutionPlanInput) SetCapacityUnits(v *CapacityUnitsConfiguration) *UpdateRescoreExecutionPlanInput

SetCapacityUnits sets the CapacityUnits field's value.

func (*UpdateRescoreExecutionPlanInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateRescoreExecutionPlanInput) SetId 

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

SetId sets the Id field's value.

func (*UpdateRescoreExecutionPlanInput) SetName 

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

SetName sets the Name field's value.

func (UpdateRescoreExecutionPlanInput) String 

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

func (s *UpdateRescoreExecutionPlanInput) Validate() error

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

type UpdateRescoreExecutionPlanOutput 

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

func (UpdateRescoreExecutionPlanOutput) GoString 

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

func (s UpdateRescoreExecutionPlanOutput) 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" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

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

Source Files

View all Source files

Directories

Path Synopsis
Package kendrarankingiface provides an interface to enable mocking the Amazon Kendra Intelligent Ranking service client for testing your code.
 Package kendrarankingiface provides an interface to enable mocking the Amazon Kendra Intelligent Ranking 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.