Documentation ¶
Overview ¶
Package kendraranking provides the API client, operations, and parameter types for Amazon Kendra Intelligent Ranking.
Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) CreateRescoreExecutionPlan(ctx context.Context, params *CreateRescoreExecutionPlanInput, ...) (*CreateRescoreExecutionPlanOutput, error)
- func (c *Client) DeleteRescoreExecutionPlan(ctx context.Context, params *DeleteRescoreExecutionPlanInput, ...) (*DeleteRescoreExecutionPlanOutput, error)
- func (c *Client) DescribeRescoreExecutionPlan(ctx context.Context, params *DescribeRescoreExecutionPlanInput, ...) (*DescribeRescoreExecutionPlanOutput, error)
- func (c *Client) ListRescoreExecutionPlans(ctx context.Context, params *ListRescoreExecutionPlansInput, ...) (*ListRescoreExecutionPlansOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) Rescore(ctx context.Context, params *RescoreInput, optFns ...func(*Options)) (*RescoreOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateRescoreExecutionPlan(ctx context.Context, params *UpdateRescoreExecutionPlanInput, ...) (*UpdateRescoreExecutionPlanOutput, error)
- type CreateRescoreExecutionPlanInput
- type CreateRescoreExecutionPlanOutput
- type DeleteRescoreExecutionPlanInput
- type DeleteRescoreExecutionPlanOutput
- type DescribeRescoreExecutionPlanInput
- type DescribeRescoreExecutionPlanOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListRescoreExecutionPlansAPIClient
- type ListRescoreExecutionPlansInput
- type ListRescoreExecutionPlansOutput
- type ListRescoreExecutionPlansPaginator
- type ListRescoreExecutionPlansPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type RescoreInput
- type RescoreOutput
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateRescoreExecutionPlanInput
- type UpdateRescoreExecutionPlanOutput
Constants ¶
const ServiceAPIVersion = "2022-10-19"
const ServiceID = "Kendra Ranking"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AuthResolverParameters ¶
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Kendra Intelligent Ranking.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateRescoreExecutionPlan ¶
func (c *Client) CreateRescoreExecutionPlan(ctx context.Context, params *CreateRescoreExecutionPlanInput, optFns ...func(*Options)) (*CreateRescoreExecutionPlanOutput, error)
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.
func (*Client) DeleteRescoreExecutionPlan ¶
func (c *Client) DeleteRescoreExecutionPlan(ctx context.Context, params *DeleteRescoreExecutionPlanInput, optFns ...func(*Options)) (*DeleteRescoreExecutionPlanOutput, error)
Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
func (*Client) DescribeRescoreExecutionPlan ¶
func (c *Client) DescribeRescoreExecutionPlan(ctx context.Context, params *DescribeRescoreExecutionPlanInput, optFns ...func(*Options)) (*DescribeRescoreExecutionPlanOutput, error)
Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
func (*Client) ListRescoreExecutionPlans ¶
func (c *Client) ListRescoreExecutionPlans(ctx context.Context, params *ListRescoreExecutionPlansInput, optFns ...func(*Options)) (*ListRescoreExecutionPlansOutput, error)
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
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.
func (*Client) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) Rescore ¶
func (c *Client) Rescore(ctx context.Context, params *RescoreInput, optFns ...func(*Options)) (*RescoreOutput, error)
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.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
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.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
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.
func (*Client) UpdateRescoreExecutionPlan ¶
func (c *Client) UpdateRescoreExecutionPlan(ctx context.Context, params *UpdateRescoreExecutionPlanInput, optFns ...func(*Options)) (*UpdateRescoreExecutionPlanOutput, error)
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.
type CreateRescoreExecutionPlanInput ¶
type CreateRescoreExecutionPlanInput struct { // A name for the rescore execution plan. // // This member is required. Name *string // 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]. // // [Adjusting capacity]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html CapacityUnits *types.CapacityUnitsConfiguration // 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 // A description for the rescore execution plan. Description *string // 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 []types.Tag // contains filtered or unexported fields }
type CreateRescoreExecutionPlanOutput ¶
type CreateRescoreExecutionPlanOutput struct { // The Amazon Resource Name (ARN) of the rescore execution plan. // // This member is required. Arn *string // The identifier of the rescore execution plan. // // This member is required. Id *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRescoreExecutionPlanInput ¶
type DeleteRescoreExecutionPlanInput struct { // The identifier of the rescore execution plan that you want to delete. // // This member is required. Id *string // contains filtered or unexported fields }
type DeleteRescoreExecutionPlanOutput ¶
type DeleteRescoreExecutionPlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeRescoreExecutionPlanInput ¶
type DescribeRescoreExecutionPlanInput struct { // The identifier of the rescore execution plan that you want to get information // on. // // This member is required. Id *string // contains filtered or unexported fields }
type DescribeRescoreExecutionPlanOutput ¶
type DescribeRescoreExecutionPlanOutput struct { // The Amazon Resource Name (ARN) of the rescore execution plan. Arn *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]. // // [Adjusting capacity]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html CapacityUnits *types.CapacityUnitsConfiguration // The Unix timestamp of when the rescore execution plan was created. CreatedAt *time.Time // The description for the rescore execution plan. Description *string // When the Status field value is FAILED , the ErrorMessage field contains a // message that explains why. ErrorMessage *string // The identifier of the rescore execution plan. Id *string // The name for the rescore execution plan. Name *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 types.RescoreExecutionPlanStatus // The Unix timestamp of when the rescore execution plan was last updated. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListRescoreExecutionPlansAPIClient ¶
type ListRescoreExecutionPlansAPIClient interface {
ListRescoreExecutionPlans(context.Context, *ListRescoreExecutionPlansInput, ...func(*Options)) (*ListRescoreExecutionPlansOutput, error)
}
ListRescoreExecutionPlansAPIClient is a client that implements the ListRescoreExecutionPlans operation.
type ListRescoreExecutionPlansInput ¶
type ListRescoreExecutionPlansInput struct { // The maximum number of rescore execution plans to return. MaxResults *int32 // 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 // contains filtered or unexported fields }
type ListRescoreExecutionPlansOutput ¶
type ListRescoreExecutionPlansOutput struct { // If the response is truncated, Amazon Kendra Intelligent Ranking returns a // pagination token in the response. NextToken *string // An array of summary information for one or more rescore execution plans. SummaryItems []types.RescoreExecutionPlanSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRescoreExecutionPlansPaginator ¶
type ListRescoreExecutionPlansPaginator struct {
// contains filtered or unexported fields
}
ListRescoreExecutionPlansPaginator is a paginator for ListRescoreExecutionPlans
func NewListRescoreExecutionPlansPaginator ¶
func NewListRescoreExecutionPlansPaginator(client ListRescoreExecutionPlansAPIClient, params *ListRescoreExecutionPlansInput, optFns ...func(*ListRescoreExecutionPlansPaginatorOptions)) *ListRescoreExecutionPlansPaginator
NewListRescoreExecutionPlansPaginator returns a new ListRescoreExecutionPlansPaginator
func (*ListRescoreExecutionPlansPaginator) HasMorePages ¶
func (p *ListRescoreExecutionPlansPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRescoreExecutionPlansPaginator) NextPage ¶
func (p *ListRescoreExecutionPlansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRescoreExecutionPlansOutput, error)
NextPage retrieves the next ListRescoreExecutionPlans page.
type ListRescoreExecutionPlansPaginatorOptions ¶
type ListRescoreExecutionPlansPaginatorOptions struct { // The maximum number of rescore execution plans to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRescoreExecutionPlansPaginatorOptions is the paginator options for ListRescoreExecutionPlans
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the rescore execution plan to get a list of // tags for. // // This member is required. ResourceARN *string // 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.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A list of tags associated with the rescore execution plan. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
If the action is successful, the service sends back an HTTP 200 response.
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type RescoreInput ¶
type RescoreInput struct { // The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank // on. // // This member is required. Documents []types.Document // The identifier of the rescore execution plan. A rescore execution plan is an // Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore // API. // // This member is required. RescoreExecutionPlanId *string // The input query from the search service. // // This member is required. SearchQuery *string // contains filtered or unexported fields }
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 // A list of result items for documents with new relevancy scores. The results are // in descending order. ResultItems []types.RescoreResultItem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the rescore execution plan to tag. // // This member is required. ResourceARN *string // 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. // // This member is required. Tags []types.Tag // 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.
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the rescore execution plan to remove the tag. // // This member is required. ResourceARN *string // 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. // // This member is required. TagKeys []string // 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.
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
type UpdateRescoreExecutionPlanInput ¶
type UpdateRescoreExecutionPlanInput struct { // The identifier of the rescore execution plan that you want to update. // // This member is required. Id *string // 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]. // // [Adjusting capacity]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html CapacityUnits *types.CapacityUnitsConfiguration // A new description for the rescore execution plan. Description *string // A new name for the rescore execution plan. Name *string // contains filtered or unexported fields }
type UpdateRescoreExecutionPlanOutput ¶
type UpdateRescoreExecutionPlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CreateRescoreExecutionPlan.go
- api_op_DeleteRescoreExecutionPlan.go
- api_op_DescribeRescoreExecutionPlan.go
- api_op_ListRescoreExecutionPlans.go
- api_op_ListTagsForResource.go
- api_op_Rescore.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateRescoreExecutionPlan.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go