Skip to content

get_application

Operation

get_application

get_application(request: GetApplicationInput | GetApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetApplicationInputDict]) -> GetApplicationOutput

Gets information about an existing Amazon Q Business application.

Parameters:

Name Type Description Default
request GetApplicationInput | GetApplicationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetApplicationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetApplicationOutput

An instance of GetApplicationOutput.

get_application async

get_application(request: GetApplicationInput | GetApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetApplicationInputDict]) -> GetApplicationOutput

Gets information about an existing Amazon Q Business application.

Parameters:

Name Type Description Default
request GetApplicationInput | GetApplicationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetApplicationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetApplicationOutput

An instance of GetApplicationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetApplicationInputDict

Bases: TypedDict

Dictionary form of GetApplicationInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application.

GetApplicationInput dataclass

Bases: _SerdeShape

Dataclass for GetApplicationInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application.

Output

GetApplicationOutput dataclass

Bases: _SerdeShape

Dataclass for GetApplicationOutput structure.

Attributes

application_arn class-attribute instance-attribute
application_arn: str | None = ...

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

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application.

attachments_configuration class-attribute instance-attribute
attachments_configuration: AppliedAttachmentsConfiguration | None = ...

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

auto_subscription_configuration class-attribute instance-attribute
auto_subscription_configuration: AutoSubscriptionConfiguration | None = ...

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

client_ids_for_oidc class-attribute instance-attribute
client_ids_for_oidc: list[str] | None = ...

The OIDC client ID for a Amazon Q Business application.

created_at class-attribute instance-attribute
created_at: datetime | None = ...

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

description class-attribute instance-attribute
description: str | None = ...

A description for the Amazon Q Business application.

display_name class-attribute instance-attribute
display_name: str | None = ...

The name of the Amazon Q Business application.

encryption_configuration class-attribute instance-attribute
encryption_configuration: EncryptionConfiguration | None = ...

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 class-attribute instance-attribute
error: ErrorDetail | None = ...

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 class-attribute instance-attribute
iam_identity_provider_arn: str | None = ...

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

identity_center_application_arn class-attribute instance-attribute
identity_center_application_arn: str | None = ...

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

identity_type class-attribute instance-attribute
identity_type: str | None = ...

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

personalization_configuration class-attribute instance-attribute
personalization_configuration: PersonalizationConfiguration | None = ...

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

q_apps_configuration class-attribute instance-attribute
q_apps_configuration: QAppsConfiguration | None = ...

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

quick_sight_configuration class-attribute instance-attribute
quick_sight_configuration: QuickSightConfiguration | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

role_arn class-attribute instance-attribute
role_arn: str | None = ...

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

status class-attribute instance-attribute
status: str | None = ...

The status of the Amazon Q Business application.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

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