Class: Aws::QBusiness::Types::GetApplicationResponse

Inherits:

Struct

Object
Struct
Aws::QBusiness::Types::GetApplicationResponse

show all

Includes:: Structure

Defined in:: lib/aws-sdk-qbusiness/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#application_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Q Business application.
#application_id ⇒ String

The identifier of the Amazon Q Business application.
#attachments_configuration ⇒ Types::AppliedAttachmentsConfiguration

Settings for whether end users can upload files directly during chat.
#auto_subscription_configuration ⇒ Types::AutoSubscriptionConfiguration

Settings for auto-subscription behavior for this application.
#client_ids_for_oidc ⇒ Array<String>

The OIDC client ID for a Amazon Q Business application.
#created_at ⇒ Time

The Unix timestamp when the Amazon Q Business application was last updated.
#description ⇒ String

A description for the Amazon Q Business application.
#display_name ⇒ String

The name of the Amazon Q Business application.
#encryption_configuration ⇒ Types::EncryptionConfiguration

The identifier of the Amazon Web Services KMS key that is used to encrypt your data.
#error ⇒ Types::ErrorDetail

If the ‘Status` field is set to `ERROR`, the `ErrorMessage` field contains a description of the error that caused the synchronization to fail.
#iam_identity_provider_arn ⇒ String

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
#identity_center_application_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
#identity_type ⇒ String

The authentication type being used by a Amazon Q Business application.
#personalization_configuration ⇒ Types::PersonalizationConfiguration

Configuration information about chat response personalization.
#q_apps_configuration ⇒ Types::QAppsConfiguration

Settings for whether end users can create and use Amazon Q Apps in the web experience.
#quick_sight_configuration ⇒ Types::QuickSightConfiguration

The Amazon QuickSight authentication configuration for the Amazon Q Business application.
#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
#status ⇒ String

The status of the Amazon Q Business application.
#updated_at ⇒ Time

The Unix timestamp when the Amazon Q Business application was last updated.

Instance Attribute Details

#application_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#application_id ⇒ `String`

The identifier of the Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#attachments_configuration ⇒ `Types::AppliedAttachmentsConfiguration`

Settings for whether end users can upload files directly during chat.

Returns:

(Types::AppliedAttachmentsConfiguration)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#auto_subscription_configuration ⇒ `Types::AutoSubscriptionConfiguration`

Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

Returns:

(Types::AutoSubscriptionConfiguration)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_ids_for_oidc ⇒ `Array<String>`

The OIDC client ID for a Amazon Q Business application.

Returns:

(Array<String>)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

(Time)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description for the Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ `String`

The name of the Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ `Types::EncryptionConfiguration`

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn’t support asymmetric keys.

Returns:

(Types::EncryptionConfiguration)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ `Types::ErrorDetail`

If the ‘Status` field is set to `ERROR`, the `ErrorMessage` field contains a description of the error that caused the synchronization to fail.

Returns:

(Types::ErrorDetail)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#iam_identity_provider_arn ⇒ `String`

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_application_arn ⇒ `String`

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_type ⇒ `String`

The authentication type being used by a Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#personalization_configuration ⇒ `Types::PersonalizationConfiguration`

Configuration information about chat response personalization. For more information, see [Personalizing chat responses].

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html

Returns:

(Types::PersonalizationConfiguration)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#q_apps_configuration ⇒ `Types::QAppsConfiguration`

Settings for whether end users can create and use Amazon Q Apps in the web experience.

Returns:

(Types::QAppsConfiguration)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#quick_sight_configuration ⇒ `Types::QuickSightConfiguration`

The Amazon QuickSight authentication configuration for the Amazon Q Business application.

Returns:

(Types::QuickSightConfiguration)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the Amazon Q Business application.

Returns:

(String)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ `Time`

The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

(Time)

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

class GetApplicationResponse < Struct.new(
  :display_name,
  :application_id,
  :application_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_application_arn,
  :role_arn,
  :status,
  :description,
  :encryption_configuration,
  :created_at,
  :updated_at,
  :error,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :auto_subscription_configuration,
  :client_ids_for_oidc,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::QBusiness::Types::GetApplicationResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#application_arn ⇒ String

#application_id ⇒ String

#attachments_configuration ⇒ Types::AppliedAttachmentsConfiguration

#auto_subscription_configuration ⇒ Types::AutoSubscriptionConfiguration

#client_ids_for_oidc ⇒ Array<String>

#created_at ⇒ Time

#description ⇒ String

#display_name ⇒ String

#encryption_configuration ⇒ Types::EncryptionConfiguration

#error ⇒ Types::ErrorDetail

#iam_identity_provider_arn ⇒ String

#identity_center_application_arn ⇒ String

#identity_type ⇒ String

#personalization_configuration ⇒ Types::PersonalizationConfiguration

#q_apps_configuration ⇒ Types::QAppsConfiguration

#quick_sight_configuration ⇒ Types::QuickSightConfiguration

#role_arn ⇒ String

#status ⇒ String

#updated_at ⇒ Time

#application_arn ⇒ `String`

#application_id ⇒ `String`

#attachments_configuration ⇒ `Types::AppliedAttachmentsConfiguration`

#auto_subscription_configuration ⇒ `Types::AutoSubscriptionConfiguration`

#client_ids_for_oidc ⇒ `Array<String>`

#created_at ⇒ `Time`

#description ⇒ `String`

#display_name ⇒ `String`

#encryption_configuration ⇒ `Types::EncryptionConfiguration`

#error ⇒ `Types::ErrorDetail`

#iam_identity_provider_arn ⇒ `String`

#identity_center_application_arn ⇒ `String`

#identity_type ⇒ `String`

#personalization_configuration ⇒ `Types::PersonalizationConfiguration`

#q_apps_configuration ⇒ `Types::QAppsConfiguration`

#quick_sight_configuration ⇒ `Types::QuickSightConfiguration`

#role_arn ⇒ `String`

#status ⇒ `String`

#updated_at ⇒ `Time`