Skip to content

list_plugin_actions

list_plugin_actions(
    application_id: ApplicationId,
    plugin_id: PluginId,
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResultsIntegerForListPluginActions] = None,
) -> ListPluginActionsResponse

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

Parameters:

  • application_id (ApplicationId) –

    The identifier of the Amazon Q Business application the plugin is attached to.

  • plugin_id (PluginId) –

    The identifier of the Amazon Q Business plugin.

  • next_token (Optional[NextToken], default: None ) –

    If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.

  • max_results (Optional[MaxResultsIntegerForListPluginActions], default: None ) –

    The maximum number of plugin actions to return.

Raises:

  • AccessDeniedException –

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

  • InternalServerException –

    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.

  • ResourceNotFoundException –

    The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • ThrottlingException –

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

  • ValidationException –

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

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_qbusiness/_services/q_business.py
def list_plugin_actions(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    plugin_id: "capo_qbusiness.types.plugin_id.PluginId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    next_token: Optional["capo_qbusiness.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_qbusiness.types.max_results_integer_for_list_plugin_actions.MaxResultsIntegerForListPluginActions"
    ] = None,
) -> "capo_qbusiness.types.list_plugin_actions_response.ListPluginActionsResponse":
    """<p>Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.</p>

    Args:
        application_id: <p>The identifier of the Amazon Q Business application the plugin is attached to.</p>
        plugin_id: <p>The identifier of the Amazon Q Business plugin.</p>
        next_token: <p>If the number of plugin actions returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.</p>
        max_results: <p>The maximum number of plugin actions to return.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qbusiness.types.list_plugin_actions_request.ListPluginActionsRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.list_plugin_actions_response.ListPluginActionsResponse"
    ]:
        import capo_qbusiness._operations.expert_q.list_plugin_actions

        output, http_response = (
            capo_qbusiness._operations.expert_q.list_plugin_actions.list_plugin_actions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPluginActions")
    )
    input_: capo_qbusiness.types.list_plugin_actions_request.ListPluginActionsRequest = {
        "application_id": application_id,
        "plugin_id": plugin_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output