Skip to content

list_report_versions

list_report_versions(
    report_id: ReportId,
    *,
    config_overrides: Optional[ArtifactClientConfig] = None,
    max_results: Optional[MaxResultsAttribute] = None,
    next_token: Optional[NextTokenAttribute] = None,
) -> ListReportVersionsResponse

List available report versions for a given report.

Parameters:

  • report_id (ReportId) –

    Unique resource ID for the report resource.

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

    Maximum number of resources to return in the paginated response.

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

    Pagination token to request the next page of resources.

Raises:

Examples:

Invoke ListReportVersions operation The ListReportVersions operation returns a collection of report versions for a given resource.

>>> client.list_report_versions(report_id='report-abcdef0123456789')
Source code in docs_src/capo_artifact/_services/artifact.py
def list_report_versions(
    self,
    report_id: "capo_artifact.types.report_id.ReportId",
    *,
    config_overrides: Optional[ArtifactClientConfig] = None,
    max_results: Optional[
        "capo_artifact.types.max_results_attribute.MaxResultsAttribute"
    ] = None,
    next_token: Optional[
        "capo_artifact.types.next_token_attribute.NextTokenAttribute"
    ] = None,
) -> "capo_artifact.types.list_report_versions_response.ListReportVersionsResponse":
    """<p>List available report versions for a given report.</p>

    Args:
        report_id: <p>Unique resource ID for the report resource.</p>
        max_results: <p>Maximum number of resources to return in the paginated response.</p>
        next_token: <p>Pagination token to request the next page of resources.</p>

    Raises:
        capo_artifact.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_artifact.errors.internal_server_exception.InternalServerException: <p>An unknown server exception has occurred.</p>
        capo_artifact.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_artifact.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_artifact.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_artifact.errors.validation_exception.ValidationException: <p>Request fails to satisfy the constraints specified by an AWS service.</p>
        capo_artifact.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Invoke ListReportVersions operation
        The ListReportVersions operation returns a collection of report versions
                    for a given resource.

        >>> client.list_report_versions(report_id='report-abcdef0123456789')
    """

    def _handler(
        req: "OperationRequest[capo_artifact.types.list_report_versions_request.ListReportVersionsRequest]",
    ) -> OperationResponse[
        "capo_artifact.types.list_report_versions_response.ListReportVersionsResponse"
    ]:
        import capo_artifact._operations.artifact.list_report_versions

        output, http_response = (
            capo_artifact._operations.artifact.list_report_versions.list_report_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReportVersions")
    )
    input_: capo_artifact.types.list_report_versions_request.ListReportVersionsRequest = {
        "report_id": report_id
    }
    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