Skip to content

list_applications

Operation

list_applications

list_applications(request: ListApplicationsInput | ListApplicationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListApplicationsInputDict]) -> ListApplicationsOutput

Lists Amazon Q Business applications.

Note

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.

Parameters:

Name Type Description Default
request ListApplicationsInput | ListApplicationsInputDict | 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[ListApplicationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListApplicationsOutput

An instance of ListApplicationsOutput.

list_applications async

list_applications(request: ListApplicationsInput | ListApplicationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListApplicationsInputDict]) -> ListApplicationsOutput

Lists Amazon Q Business applications.

Note

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.

Parameters:

Name Type Description Default
request ListApplicationsInput | ListApplicationsInputDict | 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[ListApplicationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListApplicationsOutput

An instance of ListApplicationsOutput.

Input

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

ListApplicationsInputDict

Bases: TypedDict

Dictionary form of ListApplicationsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of Amazon Q Business applications to return.

next_token instance-attribute
next_token: str | None

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.

ListApplicationsInput dataclass

Bases: _SerdeShape

Dataclass for ListApplicationsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of Amazon Q Business applications to return.

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

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.

Output

ListApplicationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListApplicationsOutput structure.

Attributes

applications class-attribute instance-attribute
applications: list[Application] | None = ...

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

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

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.

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.