copy_job_summaries

Creates, updates, deletes, gets or lists a copy_job_summaries resource.

Overview

Name	copy_job_summaries
Type	Resource
Id	aws.backup.copy_job_summaries

Fields

The following fields are returned by SELECT queries:

list_copy_job_summaries

Name	Datatype	Description
aggregation_period	string	The period for the returned results. ONE_DAY - The daily job count for the prior 14 days. SEVEN_DAYS - The aggregated job count for the prior 7 days. FOURTEEN_DAYS - The aggregated job count for prior 14 days.
copy_job_summaries	array	This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
next_token	string	The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_copy_job_summaries	select	region	AccountId, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, NextToken	This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
AccountId	string	Returns the job count for the specified account. 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. Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization. AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.
AggregationPeriod	string	The period for the returned results. ONE_DAY - The daily job count for the prior 14 days. SEVEN_DAYS - The aggregated job count for the prior 7 days. FOURTEEN_DAYS - The aggregated job count for prior 14 days.
MaxResults	integer	This parameter sets the maximum number of items to be returned. The value is an integer. Range of accepted values is from 1 to 500.
MessageCategory	string	This parameter returns the job count for the specified message category. Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted 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.
NextToken	string	The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
ResourceType	string	Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types. The the value ANY returns count of all resource types. AGGREGATE_ALL aggregates job counts for all resource types and returns the sum. 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.
State	string	This parameter returns the job count for jobs with the specified state. The the value ANY returns count of all states. AGGREGATE_ALL aggregates job counts for all states and returns the sum.

SELECT examples

list_copy_job_summaries

This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

SELECT
aggregation_period,
copy_job_summaries,
next_token
FROM aws.backup.copy_job_summaries
WHERE region = '{{ region }}' -- required
AND AccountId = '{{ AccountId }}'
AND State = '{{ State }}'
AND ResourceType = '{{ ResourceType }}'
AND MessageCategory = '{{ MessageCategory }}'
AND AggregationPeriod = '{{ AggregationPeriod }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;