Class: Aws::QBusiness::Types::GetPluginResponse

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::GetPluginResponse

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The identifier of the application which contains the plugin.

• #auth_configuration ⇒ Types::PluginAuthConfiguration

  Authentication configuration information for an Amazon Q Business plugin.

• #build_status ⇒ String

  The current status of a plugin.

• #created_at ⇒ Time

  The timestamp for when the plugin was created.

• #custom_plugin_configuration ⇒ Types::CustomPluginConfiguration

  Configuration information required to create a custom plugin.

• #display_name ⇒ String

  The name of the plugin.

• #plugin_arn ⇒ String

  The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

• #plugin_id ⇒ String

  The identifier of the plugin.

• #server_url ⇒ String

  The source URL used for plugin configuration.

• #state ⇒ String

  The current state of the plugin.

• #type ⇒ String

  The type of the plugin.

• #updated_at ⇒ Time

  The timestamp for when the plugin was last updated.

Instance Attribute Details

#application_id ⇒ String

The identifier of the application which contains the plugin.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#auth_configuration ⇒ Types::PluginAuthConfiguration

Authentication configuration information for an Amazon Q Business plugin.

Returns:

• (Types::PluginAuthConfiguration)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#build_status ⇒ String

The current status of a plugin. A plugin is modified asynchronously.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp for when the plugin was created.

Returns:

• (Time)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#custom_plugin_configuration ⇒ Types::CustomPluginConfiguration

Configuration information required to create a custom plugin.

Returns:

• (Types::CustomPluginConfiguration)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of the plugin.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_arn ⇒ String

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_id ⇒ String

The identifier of the plugin.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#server_url ⇒ String

The source URL used for plugin configuration.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the plugin.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the plugin.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp for when the plugin was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3450

class GetPluginResponse < Struct.new(
  :application_id,
  :plugin_id,
  :display_name,
  :type,
  :server_url,
  :auth_configuration,
  :custom_plugin_configuration,
  :build_status,
  :plugin_arn,
  :state,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end