Skip to content

CopyJobSummary

Source code in docs_src/capo_backup/types/copy_job_summary.py
class CopyJobSummary(TypedDict, closed=True):
    region: NotRequired["capo_backup.types.region.Region"]
    """<p>The Amazon Web Services Regions within the job summary.</p>"""
    account_id: NotRequired["capo_backup.types.account_id.AccountId"]
    """<p>The account ID that owns the jobs within the summary.</p>"""
    state: NotRequired["capo_backup.types.copy_job_status.CopyJobStatus"]
    """<p>This value is job count for jobs with the specified state.</p>"""
    resource_type: NotRequired["capo_backup.types.resource_type.ResourceType"]
    """<p>This value is the job count for the specified resource type. The request <code>GetSupportedResourceTypes</code> returns strings for supported resource types</p>"""
    message_category: NotRequired["capo_backup.types.message_category.MessageCategory"]
    """<p>This parameter is the job count for the specified message category.</p> <p>Example 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 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>"""
    count: "capo_backup.types.integer.integer"
    """<p>The value as a number of jobs in a job summary.</p>"""
    start_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The value of time in number format of a job start time.</p> <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    end_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The value of time in number format of a job end time.</p> <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""

account_id instance-attribute

account_id: NotRequired[AccountId]

The account ID that owns the jobs within the summary.

count instance-attribute

count: integer

The value as a number of jobs in a job summary.

end_time instance-attribute

end_time: NotRequired[timestamp]

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

message_category instance-attribute

message_category: NotRequired[MessageCategory]

This parameter is the job count for the specified message category.

Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

region instance-attribute

region: NotRequired[Region]

The Amazon Web Services Regions within the job summary.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types

start_time instance-attribute

start_time: NotRequired[timestamp]

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

state instance-attribute

state: NotRequired[CopyJobStatus]

This value is job count for jobs with the specified state.