/AWS1/CL_QQBGETAPPLICATIONRSP¶
GetApplicationResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_DISPLAYNAME TYPE /AWS1/QQBAPPLICATIONNAME /AWS1/QQBAPPLICATIONNAME¶
The name of the Amazon Q Business application.
IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID¶
The identifier of the Amazon Q Business application.
IV_APPLICATIONARN TYPE /AWS1/QQBAPPLICATIONARN /AWS1/QQBAPPLICATIONARN¶
The Amazon Resource Name (ARN) of the Amazon Q Business application.
IV_IDENTITYTYPE TYPE /AWS1/QQBIDENTITYTYPE /AWS1/QQBIDENTITYTYPE¶
The authentication type being used by a Amazon Q Business application.
IV_IAMIDENTITYPROVIDERARN TYPE /AWS1/QQBIAMIDENTITYPVDRARN /AWS1/QQBIAMIDENTITYPVDRARN¶
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
IV_IDCENTERAPPLICATIONARN TYPE /AWS1/QQBIDCAPPLICATIONARN /AWS1/QQBIDCAPPLICATIONARN¶
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
IV_ROLEARN TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN¶
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
IV_STATUS TYPE /AWS1/QQBAPPLICATIONSTATUS /AWS1/QQBAPPLICATIONSTATUS¶
The status of the Amazon Q Business application.
IV_DESCRIPTION TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION¶
A description for the Amazon Q Business application.
IO_ENCRYPTIONCONFIGURATION TYPE REF TO /AWS1/CL_QQBENCRYPTIONCONF /AWS1/CL_QQBENCRYPTIONCONF¶
The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
IV_CREATEDAT TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP¶
The Unix timestamp when the Amazon Q Business application was last updated.
IV_UPDATEDAT TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP¶
The Unix timestamp when the Amazon Q Business application was last updated.
IO_ERROR TYPE REF TO /AWS1/CL_QQBERRORDETAIL /AWS1/CL_QQBERRORDETAIL¶
If the
Statusfield is set toERROR, theErrorMessagefield contains a description of the error that caused the synchronization to fail.
IO_ATTACHMENTSCONFIGURATION TYPE REF TO /AWS1/CL_QQBAPPLIEDATTACHMEN00 /AWS1/CL_QQBAPPLIEDATTACHMEN00¶
Settings for whether end users can upload files directly during chat.
IO_QAPPSCONFIGURATION TYPE REF TO /AWS1/CL_QQBQAPPSCONFIGURATION /AWS1/CL_QQBQAPPSCONFIGURATION¶
Settings for whether end users can create and use Amazon Q Apps in the web experience.
IO_PERSONALIZATIONCONF TYPE REF TO /AWS1/CL_QQBPERSONALIZATIONC00 /AWS1/CL_QQBPERSONALIZATIONC00¶
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
IO_AUTOSUBSCRIPTIONCONF TYPE REF TO /AWS1/CL_QQBAUTOSUBSCRIPTION00 /AWS1/CL_QQBAUTOSUBSCRIPTION00¶
Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
IT_CLIENTIDSFOROIDC TYPE /AWS1/CL_QQBCLIENTIDSFOROIDC_W=>TT_CLIENTIDSFOROIDC TT_CLIENTIDSFOROIDC¶
The OIDC client ID for a Amazon Q Business application.
IO_QUICKSIGHTCONFIGURATION TYPE REF TO /AWS1/CL_QQBQUICKSIGHTCONF /AWS1/CL_QQBQUICKSIGHTCONF¶
The Amazon QuickSight authentication configuration for the Amazon Q Business application.
Queryable Attributes¶
displayName¶
The name of the Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISPLAYNAME() |
Getter for DISPLAYNAME, with configurable default |
ASK_DISPLAYNAME() |
Getter for DISPLAYNAME w/ exceptions if field has no value |
HAS_DISPLAYNAME() |
Determine if DISPLAYNAME has a value |
applicationId¶
The identifier of the Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONID() |
Getter for APPLICATIONID, with configurable default |
ASK_APPLICATIONID() |
Getter for APPLICATIONID w/ exceptions if field has no value |
HAS_APPLICATIONID() |
Determine if APPLICATIONID has a value |
applicationArn¶
The Amazon Resource Name (ARN) of the Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONARN() |
Getter for APPLICATIONARN, with configurable default |
ASK_APPLICATIONARN() |
Getter for APPLICATIONARN w/ exceptions if field has no valu |
HAS_APPLICATIONARN() |
Determine if APPLICATIONARN has a value |
identityType¶
The authentication type being used by a Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDENTITYTYPE() |
Getter for IDENTITYTYPE, with configurable default |
ASK_IDENTITYTYPE() |
Getter for IDENTITYTYPE w/ exceptions if field has no value |
HAS_IDENTITYTYPE() |
Determine if IDENTITYTYPE has a value |
iamIdentityProviderArn¶
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IAMIDENTITYPROVIDERARN() |
Getter for IAMIDENTITYPROVIDERARN, with configurable default |
ASK_IAMIDENTITYPROVIDERARN() |
Getter for IAMIDENTITYPROVIDERARN w/ exceptions if field has |
HAS_IAMIDENTITYPROVIDERARN() |
Determine if IAMIDENTITYPROVIDERARN has a value |
identityCenterApplicationArn¶
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDCENTERAPPLICATIONARN() |
Getter for IDENTITYCENTERAPPLICATIONARN, with configurable d |
ASK_IDCENTERAPPLICATIONARN() |
Getter for IDENTITYCENTERAPPLICATIONARN w/ exceptions if fie |
HAS_IDCENTERAPPLICATIONARN() |
Determine if IDENTITYCENTERAPPLICATIONARN has a value |
roleArn¶
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
status¶
The status of the Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
description¶
A description for the Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONCONFIGURATION() |
Getter for ENCRYPTIONCONFIGURATION |
createdAt¶
The Unix timestamp when the Amazon Q Business application was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
updatedAt¶
The Unix timestamp when the Amazon Q Business application was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
error¶
If the
Statusfield is set toERROR, theErrorMessagefield contains a description of the error that caused the synchronization to fail.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERROR() |
Getter for ERROR |
attachmentsConfiguration¶
Settings for whether end users can upload files directly during chat.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTACHMENTSCONFIGURATION() |
Getter for ATTACHMENTSCONFIGURATION |
qAppsConfiguration¶
Settings for whether end users can create and use Amazon Q Apps in the web experience.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QAPPSCONFIGURATION() |
Getter for QAPPSCONFIGURATION |
personalizationConfiguration¶
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERSONALIZATIONCONF() |
Getter for PERSONALIZATIONCONFIGURATION |
autoSubscriptionConfiguration¶
Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTOSUBSCRIPTIONCONF() |
Getter for AUTOSUBSCRIPTIONCONF |
clientIdsForOIDC¶
The OIDC client ID for a Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTIDSFOROIDC() |
Getter for CLIENTIDSFOROIDC, with configurable default |
ASK_CLIENTIDSFOROIDC() |
Getter for CLIENTIDSFOROIDC w/ exceptions if field has no va |
HAS_CLIENTIDSFOROIDC() |
Determine if CLIENTIDSFOROIDC has a value |
quickSightConfiguration¶
The Amazon QuickSight authentication configuration for the Amazon Q Business application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUICKSIGHTCONFIGURATION() |
Getter for QUICKSIGHTCONFIGURATION |