list_resource_snapshot_jobs ¶

def list_resource_snapshot_jobs(
    self,
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
    *,
    config_overrides: Optional[PartnerCentralSellingClientConfig] = None,
    max_results: Optional[
        "capo_partnercentral_selling.types.page_size.PageSize"
    ] = None,
    next_token: Optional[str] = None,
    engagement_identifier: Optional[
        "capo_partnercentral_selling.types.engagement_identifier.EngagementIdentifier"
    ] = None,
    status: Optional[
        "capo_partnercentral_selling.types.resource_snapshot_job_status.ResourceSnapshotJobStatus"
    ] = None,
    sort: Optional[
        "capo_partnercentral_selling.types.sort_object.SortObject"
    ] = None,
) -> "capo_partnercentral_selling.types.list_resource_snapshot_jobs_response.ListResourceSnapshotJobsResponse":
    """<p> Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters. </p>

    Args:
        catalog: <p> Specifies the catalog related to the request. </p>
        max_results: <p> The maximum number of results to return in a single call. If omitted, defaults to 50. </p>
        next_token: <p> The token for the next set of results. </p>
        engagement_identifier: <p> The identifier of the engagement to filter the response. </p>
        status: <p> The status of the jobs to filter the response. </p>
        sort: <p> Configures the sorting of the response. If omitted, results are sorted by <code>CreatedDate</code> in descending order. </p>

    Raises:
        capo_partnercentral_selling.errors.access_denied_exception.AccessDeniedException: <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
        capo_partnercentral_selling.errors.internal_server_exception.InternalServerException: <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
        capo_partnercentral_selling.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.</p>
        capo_partnercentral_selling.errors.throttling_exception.ThrottlingException: <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
        capo_partnercentral_selling.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
        capo_partnercentral_selling.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_selling.types.list_resource_snapshot_jobs_request.ListResourceSnapshotJobsRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_selling.types.list_resource_snapshot_jobs_response.ListResourceSnapshotJobsResponse"
    ]:
        import capo_partnercentral_selling._operations.aws_partner_central_selling.list_resource_snapshot_jobs

        output, http_response = (
            capo_partnercentral_selling._operations.aws_partner_central_selling.list_resource_snapshot_jobs.list_resource_snapshot_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListResourceSnapshotJobs")
    )
    input_: capo_partnercentral_selling.types.list_resource_snapshot_jobs_request.ListResourceSnapshotJobsRequest = {
        "catalog": catalog
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if engagement_identifier is not None:
        input_["engagement_identifier"] = engagement_identifier
    if status is not None:
        input_["status"] = status
    if sort is not None:
        input_["sort"] = sort

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