list_exports ¶

def list_exports(
    self,
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
    bot_id: Optional["capo_lex_models_v2.types.id.Id"] = None,
    bot_version: Optional["capo_lex_models_v2.types.bot_version.BotVersion"] = None,
    sort_by: Optional[
        "capo_lex_models_v2.types.export_sort_by.ExportSortBy"
    ] = None,
    filters: Optional[
        "capo_lex_models_v2.types.export_filters.ExportFilters"
    ] = 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,
    locale_id: Optional["capo_lex_models_v2.types.locale_id.LocaleId"] = None,
) -> "capo_lex_models_v2.types.list_exports_response.ListExportsResponse":
    """<p>Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.</p>

    Args:
        bot_id: <p>The unique identifier that Amazon Lex assigned to the bot.</p>
        bot_version: <p>The version of the bot to list exports for. </p>
        sort_by: <p>Determines the field that the list of exports is sorted by. You can sort by the <code>LastUpdatedDateTime</code> field in ascending or descending order.</p>
        filters: <p>Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.</p>
        max_results: <p>The maximum number of exports 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 from the <code>ListExports</code> operation contains more results that specified in the <code>maxResults</code> parameter, a token is returned in the response. </p> <p>Use the returned token in the <code>nextToken</code> parameter of a <code>ListExports</code> request to return the next page of results. For a complete set of results, call the <code>ListExports</code> operation until the <code>nextToken</code> returned in the response is null.</p>
        locale_id: <p>Specifies the resources that should be exported. If you don't specify a resource type in the <code>filters</code> parameter, both bot locales and custom vocabularies are exported.</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.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_exports_request.ListExportsRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.list_exports_response.ListExportsResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.list_exports

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListExports")
    )
    input_: capo_lex_models_v2.types.list_exports_request.ListExportsRequest = {}
    if bot_id is not None:
        input_["bot_id"] = bot_id
    if bot_version is not None:
        input_["bot_version"] = bot_version
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if locale_id is not None:
        input_["locale_id"] = locale_id

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