Class: Aws::QConnect::Types::CreateContentRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::CreateContentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #knowledge_base_id ⇒ String

  The identifier of the knowledge base.

• #metadata ⇒ Hash<String,String>

  A key/value map to store attributes without affecting tagging or recommendations.

• #name ⇒ String

  The name of the content.

• #override_link_out_uri ⇒ String

  The URI you want to use for the article.

• #tags ⇒ Hash<String,String>

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

• #title ⇒ String

  The title of the content.

• #upload_id ⇒ String

  A pointer to the uploaded asset.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

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

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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

#knowledge_base_id ⇒ String

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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

#metadata ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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

#name ⇒ String

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.

[1]: docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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

#override_link_out_uri ⇒ String

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)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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

#title ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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

#upload_id ⇒ String

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

[1]: docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 2864

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