func RescoreExecutionPlanStatus_Values() []string
RescoreExecutionPlanStatus_Values returns all elements of the RescoreExecutionPlanStatus enum
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 (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
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 (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *CapacityUnitsConfiguration) SetRescoreCapacityUnits(v int64) *CapacityUnitsConfiguration
SetRescoreCapacityUnits sets the RescoreCapacityUnits field's value.
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 (s *CapacityUnitsConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
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 (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *CreateRescoreExecutionPlanInput) SetCapacityUnits(v *CapacityUnitsConfiguration) *CreateRescoreExecutionPlanInput
SetCapacityUnits sets the CapacityUnits field's value.
func (s *CreateRescoreExecutionPlanInput) SetClientToken(v string) *CreateRescoreExecutionPlanInput
SetClientToken sets the ClientToken field's value.
func (s *CreateRescoreExecutionPlanInput) SetDescription(v string) *CreateRescoreExecutionPlanInput
SetDescription sets the Description field's value.
func (s *CreateRescoreExecutionPlanInput) SetName(v string) *CreateRescoreExecutionPlanInput
SetName sets the Name field's value.
func (s *CreateRescoreExecutionPlanInput) SetTags(v []*Tag) *CreateRescoreExecutionPlanInput
SetTags sets the Tags field's value.
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 (s *CreateRescoreExecutionPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateRescoreExecutionPlanOutput) SetArn(v string) *CreateRescoreExecutionPlanOutput
SetArn sets the Arn field's value.
func (s *CreateRescoreExecutionPlanOutput) SetId(v string) *CreateRescoreExecutionPlanOutput
SetId sets the Id field's value.
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 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 (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 (s *DeleteRescoreExecutionPlanInput) SetId(v string) *DeleteRescoreExecutionPlanInput
SetId sets the Id field's value.
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 (s *DeleteRescoreExecutionPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteRescoreExecutionPlanOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *DescribeRescoreExecutionPlanInput) SetId(v string) *DescribeRescoreExecutionPlanInput
SetId sets the Id field's value.
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 (s *DescribeRescoreExecutionPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeRescoreExecutionPlanOutput) SetArn(v string) *DescribeRescoreExecutionPlanOutput
SetArn sets the Arn field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetCapacityUnits(v *CapacityUnitsConfiguration) *DescribeRescoreExecutionPlanOutput
SetCapacityUnits sets the CapacityUnits field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetCreatedAt(v time.Time) *DescribeRescoreExecutionPlanOutput
SetCreatedAt sets the CreatedAt field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetDescription(v string) *DescribeRescoreExecutionPlanOutput
SetDescription sets the Description field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetErrorMessage(v string) *DescribeRescoreExecutionPlanOutput
SetErrorMessage sets the ErrorMessage field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetId(v string) *DescribeRescoreExecutionPlanOutput
SetId sets the Id field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetName(v string) *DescribeRescoreExecutionPlanOutput
SetName sets the Name field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetStatus(v string) *DescribeRescoreExecutionPlanOutput
SetStatus sets the Status field's value.
func (s *DescribeRescoreExecutionPlanOutput) SetUpdatedAt(v time.Time) *DescribeRescoreExecutionPlanOutput
SetUpdatedAt sets the UpdatedAt field's value.
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 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 (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 (s *Document) SetBody(v string) *Document
SetBody sets the Body field's value.
func (s *Document) SetGroupId(v string) *Document
SetGroupId sets the GroupId field's value.
func (s *Document) SetId(v string) *Document
SetId sets the Id field's value.
func (s *Document) SetOriginalScore(v float64) *Document
SetOriginalScore sets the OriginalScore field's value.
func (s *Document) SetTitle(v string) *Document
SetTitle sets the Title field's value.
func (s *Document) SetTokenizedBody(v []*string) *Document
SetTokenizedBody sets the TokenizedBody field's value.
func (s *Document) SetTokenizedTitle(v []*string) *Document
SetTokenizedTitle sets the TokenizedTitle field's value.
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 (s *Document) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
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 (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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(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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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 (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 (s *ListRescoreExecutionPlansInput) SetMaxResults(v int64) *ListRescoreExecutionPlansInput
SetMaxResults sets the MaxResults field's value.
func (s *ListRescoreExecutionPlansInput) SetNextToken(v string) *ListRescoreExecutionPlansInput
SetNextToken sets the NextToken field's value.
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 (s *ListRescoreExecutionPlansInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListRescoreExecutionPlansOutput) SetNextToken(v string) *ListRescoreExecutionPlansOutput
SetNextToken sets the NextToken field's value.
func (s *ListRescoreExecutionPlansOutput) SetSummaryItems(v []*RescoreExecutionPlanSummary) *ListRescoreExecutionPlansOutput
SetSummaryItems sets the SummaryItems field's value.
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 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 (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 (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput
SetResourceARN sets the ResourceARN field's value.
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 (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
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 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 (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 (s *RescoreExecutionPlanSummary) SetCreatedAt(v time.Time) *RescoreExecutionPlanSummary
SetCreatedAt sets the CreatedAt field's value.
func (s *RescoreExecutionPlanSummary) SetId(v string) *RescoreExecutionPlanSummary
SetId sets the Id field's value.
func (s *RescoreExecutionPlanSummary) SetName(v string) *RescoreExecutionPlanSummary
SetName sets the Name field's value.
func (s *RescoreExecutionPlanSummary) SetStatus(v string) *RescoreExecutionPlanSummary
SetStatus sets the Status field's value.
func (s *RescoreExecutionPlanSummary) SetUpdatedAt(v time.Time) *RescoreExecutionPlanSummary
SetUpdatedAt sets the UpdatedAt field's value.
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 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 (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 (s *RescoreInput) SetDocuments(v []*Document) *RescoreInput
SetDocuments sets the Documents field's value.
func (s *RescoreInput) SetRescoreExecutionPlanId(v string) *RescoreInput
SetRescoreExecutionPlanId sets the RescoreExecutionPlanId field's value.
func (s *RescoreInput) SetSearchQuery(v string) *RescoreInput
SetSearchQuery sets the SearchQuery field's value.
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 (s *RescoreInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *RescoreOutput) SetRescoreId(v string) *RescoreOutput
SetRescoreId sets the RescoreId field's value.
func (s *RescoreOutput) SetResultItems(v []*RescoreResultItem) *RescoreOutput
SetResultItems sets the ResultItems field's value.
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 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 (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 (s *RescoreResultItem) SetDocumentId(v string) *RescoreResultItem
SetDocumentId sets the DocumentId field's value.
func (s *RescoreResultItem) SetScore(v float64) *RescoreResultItem
SetScore sets the Score field's value.
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 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 (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ResourceUnavailableException) Code() string
Code returns the exception type name.
func (s *ResourceUnavailableException) Error() string
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 (s *ResourceUnavailableException) Message() string
Message returns the exception's message.
func (s *ResourceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (s *ServiceQuotaExceededException) Error() string
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 (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *Tag) SetKey(v string) *Tag
SetKey sets the Key field's value.
func (s *Tag) SetValue(v string) *Tag
SetValue sets the Value field's value.
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 (s *Tag) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput
SetResourceARN sets the ResourceARN field's value.
func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput
SetTags sets the Tags field's value.
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 (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (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 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 (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput
SetResourceARN sets the ResourceARN field's value.
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
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 (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (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 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 (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 (s *UpdateRescoreExecutionPlanInput) SetCapacityUnits(v *CapacityUnitsConfiguration) *UpdateRescoreExecutionPlanInput
SetCapacityUnits sets the CapacityUnits field's value.
func (s *UpdateRescoreExecutionPlanInput) SetDescription(v string) *UpdateRescoreExecutionPlanInput
SetDescription sets the Description field's value.
func (s *UpdateRescoreExecutionPlanInput) SetId(v string) *UpdateRescoreExecutionPlanInput
SetId sets the Id field's value.
func (s *UpdateRescoreExecutionPlanInput) SetName(v string) *UpdateRescoreExecutionPlanInput
SetName sets the Name field's value.
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 (s *UpdateRescoreExecutionPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRescoreExecutionPlanOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
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 (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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".