1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. qbusiness
  5. getApplication

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.qbusiness.getApplication

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Definition of AWS::QBusiness::Application Resource Type

Using getApplication

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApplication(args: GetApplicationArgs, opts?: InvokeOptions): Promise<GetApplicationResult>
function getApplicationOutput(args: GetApplicationOutputArgs, opts?: InvokeOptions): Output<GetApplicationResult>
Copy
def get_application(application_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApplicationResult
def get_application_output(application_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApplicationResult]
Copy
func LookupApplication(ctx *Context, args *LookupApplicationArgs, opts ...InvokeOption) (*LookupApplicationResult, error)
func LookupApplicationOutput(ctx *Context, args *LookupApplicationOutputArgs, opts ...InvokeOption) LookupApplicationResultOutput
Copy

> Note: This function is named LookupApplication in the Go SDK.

public static class GetApplication 
{
    public static Task<GetApplicationResult> InvokeAsync(GetApplicationArgs args, InvokeOptions? opts = null)
    public static Output<GetApplicationResult> Invoke(GetApplicationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApplicationResult> getApplication(GetApplicationArgs args, InvokeOptions options)
public static Output<GetApplicationResult> getApplication(GetApplicationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:qbusiness:getApplication
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApplicationId This property is required. string
The identifier for the Amazon Q Business application.
ApplicationId This property is required. string
The identifier for the Amazon Q Business application.
applicationId This property is required. String
The identifier for the Amazon Q Business application.
applicationId This property is required. string
The identifier for the Amazon Q Business application.
application_id This property is required. str
The identifier for the Amazon Q Business application.
applicationId This property is required. String
The identifier for the Amazon Q Business application.

getApplication Result

The following output properties are available:

ApplicationArn string
The Amazon Resource Name (ARN) of the Amazon Q Business application.
ApplicationId string
The identifier for the Amazon Q Business application.
AttachmentsConfiguration Pulumi.AwsNative.QBusiness.Outputs.ApplicationAttachmentsConfiguration
Configuration information for the file upload during chat feature.
AutoSubscriptionConfiguration Pulumi.AwsNative.QBusiness.Outputs.ApplicationAutoSubscriptionConfiguration
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
CreatedAt string
The Unix timestamp when the Amazon Q Business application was created.
Description string
A description for the Amazon Q Business application.
DisplayName string
The name of the Amazon Q Business application.
IdentityCenterApplicationArn string
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
PersonalizationConfiguration Pulumi.AwsNative.QBusiness.Outputs.ApplicationPersonalizationConfiguration
Configuration information about chat response personalization. For more information, see Personalizing chat responses .
QAppsConfiguration Pulumi.AwsNative.QBusiness.Outputs.ApplicationQAppsConfiguration
Configuration information about Amazon Q Apps.
RoleArn string
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
Status Pulumi.AwsNative.QBusiness.ApplicationStatus
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
Tags List<Pulumi.AwsNative.Outputs.Tag>
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
UpdatedAt string
The Unix timestamp when the Amazon Q Business application was last updated.
ApplicationArn string
The Amazon Resource Name (ARN) of the Amazon Q Business application.
ApplicationId string
The identifier for the Amazon Q Business application.
AttachmentsConfiguration ApplicationAttachmentsConfiguration
Configuration information for the file upload during chat feature.
AutoSubscriptionConfiguration ApplicationAutoSubscriptionConfiguration
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
CreatedAt string
The Unix timestamp when the Amazon Q Business application was created.
Description string
A description for the Amazon Q Business application.
DisplayName string
The name of the Amazon Q Business application.
IdentityCenterApplicationArn string
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
PersonalizationConfiguration ApplicationPersonalizationConfiguration
Configuration information about chat response personalization. For more information, see Personalizing chat responses .
QAppsConfiguration ApplicationQAppsConfiguration
Configuration information about Amazon Q Apps.
RoleArn string
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
Status ApplicationStatus
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
Tags Tag
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
UpdatedAt string
The Unix timestamp when the Amazon Q Business application was last updated.
applicationArn String
The Amazon Resource Name (ARN) of the Amazon Q Business application.
applicationId String
The identifier for the Amazon Q Business application.
attachmentsConfiguration ApplicationAttachmentsConfiguration
Configuration information for the file upload during chat feature.
autoSubscriptionConfiguration ApplicationAutoSubscriptionConfiguration
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
createdAt String
The Unix timestamp when the Amazon Q Business application was created.
description String
A description for the Amazon Q Business application.
displayName String
The name of the Amazon Q Business application.
identityCenterApplicationArn String
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
personalizationConfiguration ApplicationPersonalizationConfiguration
Configuration information about chat response personalization. For more information, see Personalizing chat responses .
qAppsConfiguration ApplicationQAppsConfiguration
Configuration information about Amazon Q Apps.
roleArn String
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
status ApplicationStatus
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
tags List<Tag>
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updatedAt String
The Unix timestamp when the Amazon Q Business application was last updated.
applicationArn string
The Amazon Resource Name (ARN) of the Amazon Q Business application.
applicationId string
The identifier for the Amazon Q Business application.
attachmentsConfiguration ApplicationAttachmentsConfiguration
Configuration information for the file upload during chat feature.
autoSubscriptionConfiguration ApplicationAutoSubscriptionConfiguration
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
createdAt string
The Unix timestamp when the Amazon Q Business application was created.
description string
A description for the Amazon Q Business application.
displayName string
The name of the Amazon Q Business application.
identityCenterApplicationArn string
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
personalizationConfiguration ApplicationPersonalizationConfiguration
Configuration information about chat response personalization. For more information, see Personalizing chat responses .
qAppsConfiguration ApplicationQAppsConfiguration
Configuration information about Amazon Q Apps.
roleArn string
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
status ApplicationStatus
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
tags Tag[]
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updatedAt string
The Unix timestamp when the Amazon Q Business application was last updated.
application_arn str
The Amazon Resource Name (ARN) of the Amazon Q Business application.
application_id str
The identifier for the Amazon Q Business application.
attachments_configuration ApplicationAttachmentsConfiguration
Configuration information for the file upload during chat feature.
auto_subscription_configuration ApplicationAutoSubscriptionConfiguration
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
created_at str
The Unix timestamp when the Amazon Q Business application was created.
description str
A description for the Amazon Q Business application.
display_name str
The name of the Amazon Q Business application.
identity_center_application_arn str
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
personalization_configuration ApplicationPersonalizationConfiguration
Configuration information about chat response personalization. For more information, see Personalizing chat responses .
q_apps_configuration ApplicationQAppsConfiguration
Configuration information about Amazon Q Apps.
role_arn str
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
status ApplicationStatus
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
tags Sequence[root_Tag]
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updated_at str
The Unix timestamp when the Amazon Q Business application was last updated.
applicationArn String
The Amazon Resource Name (ARN) of the Amazon Q Business application.
applicationId String
The identifier for the Amazon Q Business application.
attachmentsConfiguration Property Map
Configuration information for the file upload during chat feature.
autoSubscriptionConfiguration Property Map
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
createdAt String
The Unix timestamp when the Amazon Q Business application was created.
description String
A description for the Amazon Q Business application.
displayName String
The name of the Amazon Q Business application.
identityCenterApplicationArn String
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
personalizationConfiguration Property Map
Configuration information about chat response personalization. For more information, see Personalizing chat responses .
qAppsConfiguration Property Map
Configuration information about Amazon Q Apps.
roleArn String
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
status "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING"
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE .
tags List<Property Map>
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
updatedAt String
The Unix timestamp when the Amazon Q Business application was last updated.

Supporting Types

ApplicationAttachmentsConfiguration

AttachmentsControlMode This property is required. Pulumi.AwsNative.QBusiness.ApplicationAttachmentsControlMode
Status information about whether file upload functionality is activated or deactivated for your end user.
AttachmentsControlMode This property is required. ApplicationAttachmentsControlMode
Status information about whether file upload functionality is activated or deactivated for your end user.
attachmentsControlMode This property is required. ApplicationAttachmentsControlMode
Status information about whether file upload functionality is activated or deactivated for your end user.
attachmentsControlMode This property is required. ApplicationAttachmentsControlMode
Status information about whether file upload functionality is activated or deactivated for your end user.
attachments_control_mode This property is required. ApplicationAttachmentsControlMode
Status information about whether file upload functionality is activated or deactivated for your end user.
attachmentsControlMode This property is required. "ENABLED" | "DISABLED"
Status information about whether file upload functionality is activated or deactivated for your end user.

ApplicationAttachmentsControlMode

ApplicationAutoSubscriptionConfiguration

AutoSubscribe This property is required. Pulumi.AwsNative.QBusiness.ApplicationAutoSubscriptionStatus
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
DefaultSubscriptionType Pulumi.AwsNative.QBusiness.ApplicationSubscriptionType
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
AutoSubscribe This property is required. ApplicationAutoSubscriptionStatus
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
DefaultSubscriptionType ApplicationSubscriptionType
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
autoSubscribe This property is required. ApplicationAutoSubscriptionStatus
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
defaultSubscriptionType ApplicationSubscriptionType
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
autoSubscribe This property is required. ApplicationAutoSubscriptionStatus
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
defaultSubscriptionType ApplicationSubscriptionType
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
auto_subscribe This property is required. ApplicationAutoSubscriptionStatus
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
default_subscription_type ApplicationSubscriptionType
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
autoSubscribe This property is required. "ENABLED" | "DISABLED"
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
defaultSubscriptionType "Q_LITE" | "Q_BUSINESS"
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.

ApplicationAutoSubscriptionStatus

ApplicationPersonalizationConfiguration

PersonalizationControlMode This property is required. Pulumi.AwsNative.QBusiness.ApplicationPersonalizationControlMode
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
PersonalizationControlMode This property is required. ApplicationPersonalizationControlMode
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
personalizationControlMode This property is required. ApplicationPersonalizationControlMode
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
personalizationControlMode This property is required. ApplicationPersonalizationControlMode
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
personalization_control_mode This property is required. ApplicationPersonalizationControlMode
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
personalizationControlMode This property is required. "ENABLED" | "DISABLED"
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.

ApplicationPersonalizationControlMode

ApplicationQAppsConfiguration

QAppsControlMode This property is required. Pulumi.AwsNative.QBusiness.ApplicationQAppsControlMode
Status information about whether end users can create and use Amazon Q Apps in the web experience.
QAppsControlMode This property is required. ApplicationQAppsControlMode
Status information about whether end users can create and use Amazon Q Apps in the web experience.
qAppsControlMode This property is required. ApplicationQAppsControlMode
Status information about whether end users can create and use Amazon Q Apps in the web experience.
qAppsControlMode This property is required. ApplicationQAppsControlMode
Status information about whether end users can create and use Amazon Q Apps in the web experience.
q_apps_control_mode This property is required. ApplicationQAppsControlMode
Status information about whether end users can create and use Amazon Q Apps in the web experience.
qAppsControlMode This property is required. "ENABLED" | "DISABLED"
Status information about whether end users can create and use Amazon Q Apps in the web experience.

ApplicationQAppsControlMode

ApplicationStatus

ApplicationSubscriptionType

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi