Skip to content

GetApplicationResponse

Source code in docs_src/capo_qbusiness/types/get_application_response.py
class GetApplicationResponse(TypedDict, closed=True):
    display_name: NotRequired["capo_qbusiness.types.application_name.ApplicationName"]
    """<p>The name of the Amazon Q Business application.</p>"""
    application_id: NotRequired["capo_qbusiness.types.application_id.ApplicationId"]
    """<p>The identifier of the Amazon Q Business application.</p>"""
    application_arn: NotRequired["capo_qbusiness.types.application_arn.ApplicationArn"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Q Business application.</p>"""
    identity_type: NotRequired["capo_qbusiness.types.identity_type.IdentityType"]
    """<p>The authentication type being used by a Amazon Q Business application.</p>"""
    iam_identity_provider_arn: NotRequired[
        "capo_qbusiness.types.iam_identity_provider_arn.IAMIdentityProviderArn"
    ]
    """<p>The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.</p>"""
    identity_center_application_arn: NotRequired[
        "capo_qbusiness.types.idc_application_arn.IdcApplicationArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.</p>"""
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.</p>"""
    status: NotRequired["capo_qbusiness.types.application_status.ApplicationStatus"]
    """<p>The status of the Amazon Q Business application.</p>"""
    description: NotRequired["capo_qbusiness.types.description.Description"]
    """<p>A description for the Amazon Q Business application.</p>"""
    encryption_configuration: NotRequired[
        "capo_qbusiness.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.</p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the Amazon Q Business application was last updated.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the Amazon Q Business application was last updated.</p>"""
    error: NotRequired["capo_qbusiness.types.error_detail.ErrorDetail"]
    """<p>If the <code>Status</code> field is set to <code>ERROR</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the synchronization to fail.</p>"""
    attachments_configuration: NotRequired[
        "capo_qbusiness.types.applied_attachments_configuration.AppliedAttachmentsConfiguration"
    ]
    """<p>Settings for whether end users can upload files directly during chat.</p>"""
    q_apps_configuration: NotRequired[
        "capo_qbusiness.types.q_apps_configuration.QAppsConfiguration"
    ]
    """<p>Settings for whether end users can create and use Amazon Q Apps in the web experience.</p>"""
    personalization_configuration: NotRequired[
        "capo_qbusiness.types.personalization_configuration.PersonalizationConfiguration"
    ]
    """<p>Configuration information about chat response personalization. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>"""
    auto_subscription_configuration: NotRequired[
        "capo_qbusiness.types.auto_subscription_configuration.AutoSubscriptionConfiguration"
    ]
    """<p>Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.</p>"""
    client_ids_for_oidc: NotRequired[
        "capo_qbusiness.types.client_ids_for_oidc.ClientIdsForOIDC"
    ]
    """<p>The OIDC client ID for a Amazon Q Business application.</p>"""
    quick_sight_configuration: NotRequired[
        "capo_qbusiness.types.quick_sight_configuration.QuickSightConfiguration"
    ]
    """<p>The Amazon Quick Suite authentication configuration for the Amazon Q Business application.</p>"""

application_arn instance-attribute

application_arn: NotRequired[ApplicationArn]

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

application_id instance-attribute

application_id: NotRequired[ApplicationId]

The identifier of the Amazon Q Business application.

attachments_configuration instance-attribute

attachments_configuration: NotRequired[AppliedAttachmentsConfiguration]

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

auto_subscription_configuration instance-attribute

auto_subscription_configuration: NotRequired[AutoSubscriptionConfiguration]

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

client_ids_for_oidc instance-attribute

client_ids_for_oidc: NotRequired[ClientIdsForOIDC]

The OIDC client ID for a Amazon Q Business application.

created_at instance-attribute

created_at: NotRequired[Timestamp]

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

description instance-attribute

description: NotRequired[Description]

A description for the Amazon Q Business application.

display_name instance-attribute

display_name: NotRequired[ApplicationName]

The name of the Amazon Q Business application.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[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.

error instance-attribute

error: NotRequired[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 instance-attribute

iam_identity_provider_arn: NotRequired[IAMIdentityProviderArn]

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

identity_center_application_arn instance-attribute

identity_center_application_arn: NotRequired[IdcApplicationArn]

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

identity_type instance-attribute

identity_type: NotRequired[IdentityType]

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

personalization_configuration instance-attribute

personalization_configuration: NotRequired[PersonalizationConfiguration]

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

q_apps_configuration instance-attribute

q_apps_configuration: NotRequired[QAppsConfiguration]

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

quick_sight_configuration instance-attribute

quick_sight_configuration: NotRequired[QuickSightConfiguration]

The Amazon Quick Suite authentication configuration for the Amazon Q Business application.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

status instance-attribute

status: NotRequired[ApplicationStatus]

The status of the Amazon Q Business application.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

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