list_experiment_runs ¶

def list_experiment_runs(
    self,
    application_identifier: "capo_appconfig.types.identifier.Identifier",
    experiment_definition_identifier: "capo_appconfig.types.identifier.Identifier",
    *,
    config_overrides: Optional[AppConfigClientConfig] = None,
    max_results: Optional["capo_appconfig.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_appconfig.types.next_token.NextToken"] = None,
    status: Optional[
        "capo_appconfig.types.experiment_run_status.ExperimentRunStatus"
    ] = None,
) -> "capo_appconfig.types.experiment_runs.ExperimentRuns":
    """<p>Lists the experiment runs for a specified experiment definition. You can filter by status.</p>

    Args:
        application_identifier: <p>The application ID or name.</p>
        experiment_definition_identifier: <p>The experiment definition ID or name.</p>
        max_results: <p>The maximum number of items to return.</p>
        next_token: <p>A token to start the list from a previously truncated response.</p>
        status: <p>A filter for the experiment run status.</p>

    Raises:
        capo_appconfig.errors.bad_request_exception.BadRequestException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_appconfig.errors.internal_server_exception.InternalServerException: <p>There was an internal failure in the AppConfig service.</p>
        capo_appconfig.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_appconfig.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list experiment runs
        The following ListExperimentRuns example lists the experiment runs for an experiment definition.

        >>> client.list_experiment_runs(application_identifier='339ohji', experiment_definition_identifier='bsxyd7k')
    """

    def _handler(
        req: "OperationRequest[capo_appconfig.types.list_experiment_runs_request.ListExperimentRunsRequest]",
    ) -> OperationResponse["capo_appconfig.types.experiment_runs.ExperimentRuns"]:
        import capo_appconfig._operations.amazon_app_config.list_experiment_runs

        output, http_response = (
            capo_appconfig._operations.amazon_app_config.list_experiment_runs.list_experiment_runs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListExperimentRuns")
    )
    input_: capo_appconfig.types.list_experiment_runs_request.ListExperimentRunsRequest = {
        "application_identifier": application_identifier,
        "experiment_definition_identifier": experiment_definition_identifier,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if status is not None:
        input_["status"] = status

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