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::CreateContentRequest

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 CreateContentRequest data as a hash:

{
  client_token: "NonEmptyString",
  knowledge_base_id: "UuidOrArn", # required
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  name: "Name", # required
  override_link_out_uri: "Uri",
  tags: {
    "TagKey" => "TagValue",
  },
  title: "ContentTitle",
  upload_id: "NonEmptyString", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end

#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)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end

#metadataHash<String,String>

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

Returns:

  • (Hash<String,String>)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

Returns:

  • (String)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end

The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

Returns:

  • (String)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash<String,String>)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end

#titleString

The title of the content. If not set, the title is equal to the name.

Returns:

  • (String)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end

#upload_idString

A pointer to the uploaded asset. This value is returned by StartContentUpload.

Returns:

  • (String)


713
714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 713

class CreateContentRequest < Struct.new(
  :client_token,
  :knowledge_base_id,
  :metadata,
  :name,
  :override_link_out_uri,
  :tags,
  :title,
  :upload_id)
  SENSITIVE = []
  include Aws::Structure
end