Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Gets information about an existing Amazon Q Business application.

get/applications/{applicationId}

Path parameters

applicationIdstring required

The identifier of the Amazon Q Business application.

Response

Success

displayNamestring

The name of the Amazon Q Business application.

applicationIdstring

The identifier of the Amazon Q Business application.

applicationArnstring

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

identityType'AWS_IAM_IDP_SAML' | 'AWS_IAM_IDP_OIDC' | 'AWS_IAM_IDC' | 'AWS_QUICKSIGHT_IDP' | 'ANONYMOUS'

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

iamIdentityProviderArnstring

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

identityCenterApplicationArnstring

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

roleArnstring

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

status'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'UPDATING'

The status of the Amazon Q Business application.

descriptionstring

A description for the Amazon Q Business application.

createdAtstring date-time

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

updatedAtstring date-time

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

clientIdsForOIDCClientIdForOIDC[]

The OIDC client ID for a Amazon Q Business application.