Skip to content

list_bot_versions

list_bot_versions(
    bot_id: Id,
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
    sort_by: Optional[BotVersionSortBy] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListBotVersionsResponse

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

Parameters:

  • bot_id (Id) –

    The identifier of the bot to list versions for.

  • sort_by (Optional[BotVersionSortBy], default: None ) –

    Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.

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

    The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

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

    If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Raises:

Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py
def list_bot_versions(
    self,
    bot_id: "capo_lex_models_v2.types.id.Id",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
    sort_by: Optional[
        "capo_lex_models_v2.types.bot_version_sort_by.BotVersionSortBy"
    ] = None,
    max_results: Optional["capo_lex_models_v2.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_lex_models_v2.types.next_token.NextToken"] = None,
) -> "capo_lex_models_v2.types.list_bot_versions_response.ListBotVersionsResponse":
    """<p>Gets information about all of the versions of a bot.</p> <p>The <code>ListBotVersions</code> operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the <code>ListBotVersions</code> operation returns for summaries, one for each numbered version and one for the <code>DRAFT</code> version.</p> <p>The <code>ListBotVersions</code> operation always returns at least one version, the <code>DRAFT</code> version.</p>

    Args:
        bot_id: <p>The identifier of the bot to list versions for.</p>
        sort_by: <p>Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.</p>
        max_results: <p>The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.</p>
        next_token: <p>If the response to the <code>ListBotVersion</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.</p>

    Raises:
        capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
        capo_lex_models_v2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have reached a quota for your bot. </p>
        capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
        capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
        capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lex_models_v2.types.list_bot_versions_request.ListBotVersionsRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.list_bot_versions_response.ListBotVersionsResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.list_bot_versions

        output, http_response = (
            capo_lex_models_v2._operations.lex_model_building_service_v2.list_bot_versions.list_bot_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBotVersions")
    )
    input_: capo_lex_models_v2.types.list_bot_versions_request.ListBotVersionsRequest = {
        "bot_id": bot_id
    }
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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