AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ConnectWisdomService::Types::SearchContentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb

Overview

Note:

When making an API call, you may pass SearchContentRequest data as a hash:

{
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
  search_expression: { # required
    filters: [ # required
      {
        field: "NAME", # required, accepts NAME
        operator: "EQUALS", # required, accepts EQUALS
        value: "NonEmptyString", # required
      },
    ],
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#knowledge_base_idString

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String)


2056
2057
2058
2059
2060
2061
2062
2063
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 2056

class SearchContentRequest < Struct.new(
  :knowledge_base_id,
  :max_results,
  :next_token,
  :search_expression)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return per page.

Returns:

  • (Integer)


2056
2057
2058
2059
2060
2061
2062
2063
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 2056

class SearchContentRequest < Struct.new(
  :knowledge_base_id,
  :max_results,
  :next_token,
  :search_expression)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

  • (String)


2056
2057
2058
2059
2060
2061
2062
2063
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 2056

class SearchContentRequest < Struct.new(
  :knowledge_base_id,
  :max_results,
  :next_token,
  :search_expression)
  SENSITIVE = []
  include Aws::Structure
end

#search_expressionTypes::SearchExpression

The search expression to filter results.



2056
2057
2058
2059
2060
2061
2062
2063
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 2056

class SearchContentRequest < Struct.new(
  :knowledge_base_id,
  :max_results,
  :next_token,
  :search_expression)
  SENSITIVE = []
  include Aws::Structure
end