ListApplicationsCommand

Suggest an Edit

Lists Amazon Q Business applications.

Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, ListApplicationsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, ListApplicationsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // ListApplicationsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListApplicationsCommand(input);
const response = await client.send(command);
// { // ListApplicationsResponse
//   nextToken: "STRING_VALUE",
//   applications: [ // Applications
//     { // Application
//       displayName: "STRING_VALUE",
//       applicationId: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//       status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
//       identityType: "AWS_IAM_IDP_SAML" || "AWS_IAM_IDP_OIDC" || "AWS_IAM_IDC" || "AWS_QUICKSIGHT_IDP",
//       quickSightConfiguration: { // QuickSightConfiguration
//         clientNamespace: "STRING_VALUE", // required
//       },
//     },
//   ],
// };

ListApplicationsCommand Input

See ListApplicationsCommandInput for more details

Parameter
Type
Description
maxResults
number | undefined

The maximum number of Amazon Q Business applications to return.

nextToken
string | undefined

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.

ListApplicationsCommand Output

See ListApplicationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
applications
Application[] | undefined

An array of summary information on the configuration of one or more Amazon Q Business applications.

nextToken
string | undefined

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.