list_backup_job_summaries async ¶

async def list_backup_job_summaries(
    self,
    *,
    config_overrides: Optional[AsyncBackupClientConfig] = None,
    account_id: Optional["capo_backup.types.account_id.AccountId"] = None,
    state: Optional["capo_backup.types.backup_job_status.BackupJobStatus"] = None,
    resource_type: Optional["capo_backup.types.resource_type.ResourceType"] = None,
    message_category: Optional[
        "capo_backup.types.message_category.MessageCategory"
    ] = None,
    aggregation_period: Optional[
        "capo_backup.types.aggregation_period.AggregationPeriod"
    ] = None,
    max_results: Optional["capo_backup.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_backup.types.string.string"] = None,
) -> "capo_backup.types.list_backup_job_summaries_output.ListBackupJobSummariesOutput":
    """<p>This is a request for a summary of backup jobs created or running within the most recent 14 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.</p> <p>This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.</p>

    Args:
        account_id: <p>Returns the job count for the specified account.</p> <p>If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.</p> <p>Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.</p> <p> <code>AGGREGATE_ALL</code> aggregates job counts from all accounts within the authenticated organization, then returns the sum.</p>
        state: <p>This parameter returns the job count for jobs with the specified state.</p> <p>The the value ANY returns count of all states.</p> <p> <code>AGGREGATE_ALL</code> aggregates job counts for all states and returns the sum.</p> <p> <code>Completed with issues</code> is a status found only in the Backup console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the status is completed but comes with a status message. To obtain the job count for <code>Completed with issues</code>, run two GET requests, and subtract the second, smaller number:</p> <p>GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED</p> <p>GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED</p>
        resource_type: <p>Returns the job count for the specified resource type. Use request <code>GetSupportedResourceTypes</code> to obtain strings for supported resource types.</p> <p>The the value ANY returns count of all resource types.</p> <p> <code>AGGREGATE_ALL</code> aggregates job counts for all resource types and returns the sum.</p> <p>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>
        message_category: <p>This parameter returns the job count for the specified message category.</p> <p>Example accepted strings include <code>AccessDenied</code>, <code>Success</code>, and <code>InvalidParameters</code>. See <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of accepted MessageCategory strings.</p> <p>The the value ANY returns count of all message categories.</p> <p> <code>AGGREGATE_ALL</code> aggregates job counts for all message categories and returns the sum.</p>
        aggregation_period: <p>The period for the returned results.</p> <ul> <li> <p> <code>ONE_DAY</code> - The daily job count for the prior 14 days.</p> </li> <li> <p> <code>SEVEN_DAYS</code> - The aggregated job count for the prior 7 days.</p> </li> <li> <p> <code>FOURTEEN_DAYS</code> - The aggregated job count for prior 14 days.</p> </li> </ul>
        max_results: <p>The maximum number of items to be returned.</p> <p>The value is an integer. Range of accepted values is from 1 to 500.</p>
        next_token: <p>The next item following a partial list of returned resources. For example, if a request is made to return <code>MaxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_backup.types.list_backup_job_summaries_input.ListBackupJobSummariesInput]",
    ) -> AsyncOperationResponse[
        "capo_backup.types.list_backup_job_summaries_output.ListBackupJobSummariesOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.list_backup_job_summaries

        (
            output,
            http_response,
        ) = await capo_backup._operations.cryo_controller_user_manager.list_backup_job_summaries.async_list_backup_job_summaries(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBackupJobSummaries")
    )
    input_: capo_backup.types.list_backup_job_summaries_input.ListBackupJobSummariesInput = {}
    if account_id is not None:
        input_["account_id"] = account_id
    if state is not None:
        input_["state"] = state
    if resource_type is not None:
        input_["resource_type"] = resource_type
    if message_category is not None:
        input_["message_category"] = message_category
    if aggregation_period is not None:
        input_["aggregation_period"] = aggregation_period
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output