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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_arn ⇒ String

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

Returns:

  • (String) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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:



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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:



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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:



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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:



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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.

Returns:



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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:



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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:



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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) 


4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4418

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