aws-sdk-backup 1.59.0 → 1.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7adfd167b34bc7abec7ba5ed89505e49b8952fedb25e2841027d8208860e1090
-  data.tar.gz: c4559690ae97c5e3f0ccc3595d395f2c84932d5405bd49623c26c7eae58daaf3
+  metadata.gz: e98045c0456ddce0531fc02b79a256b4d485284acf4bd4a9cb82b89811f4697a
+  data.tar.gz: 6071b8ac2e21abee8f281d7210be0bb11c700a004e9661182634021567ff10c5
 SHA512:
-  metadata.gz: 75f14e15adb9f49964365a9b61b7563fdde0f4086ecc2865f985cf982f8dc8ba8eb1f29d5e31fd44365c0aa66eb4b733c3fa90f616d1ec230e842c45a209a8e2
-  data.tar.gz: 2975a49b7d5ae35a5cd8bd934c10d69cc2331c29674c5297484fab0976bc259b6ca679b7f48c3581990b9fe2db6429bc980f434084dd50aa0b4094c7c4698ac6
+  metadata.gz: 5856225aa494cb39f6b7f3276a373da7bd0c2e874b8ae79c941c9b1713caee6197e35d34a9fbe51325100e7e49006b8efe79146a42dff220351f4c50e3670c8e
+  data.tar.gz: 6f96784bbc839203afba65087a5b01686833912033f30d044edb4f0cb71b3e49f88844832549dbbb7c26f69df8064f89d9bc13420d61a36ea38b6ec19fed62f8

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.60.0 (2023-11-14)
+------------------
+
+* Feature - AWS Backup - Features: Provide Job Summary for your backup activity.
+
 1.59.0 (2023-09-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.59.0
+1.60.0

data/lib/aws-sdk-backup/client.rb

@@ -1309,6 +1309,7 @@ module Aws::Backup
     #   * {Types::DescribeBackupJobOutput#number_of_child_jobs #number_of_child_jobs} => Integer
     #   * {Types::DescribeBackupJobOutput#child_jobs_in_state #child_jobs_in_state} => Hash<String,Integer>
     #   * {Types::DescribeBackupJobOutput#resource_name #resource_name} => String
+    #   * {Types::DescribeBackupJobOutput#message_category #message_category} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -1348,6 +1349,7 @@ module Aws::Backup
     #   resp.child_jobs_in_state #=> Hash
     #   resp.child_jobs_in_state["BackupJobState"] #=> Integer
     #   resp.resource_name #=> String
+    #   resp.message_category #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJob AWS API Documentation
     #
@@ -1455,6 +1457,7 @@ module Aws::Backup
     #   resp.copy_job.child_jobs_in_state #=> Hash
     #   resp.copy_job.child_jobs_in_state["CopyJobState"] #=> Integer
     #   resp.copy_job.resource_name #=> String
+    #   resp.copy_job.message_category #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeCopyJob AWS API Documentation
     #
@@ -2365,6 +2368,133 @@ module Aws::Backup
       req.send_request(options)
     end
 
+    # This is a request for a summary of backup jobs created or running
+    # within 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,
+    # ResourceType, MessageCategory, StartTime, EndTime, and Count of
+    # included jobs.
+    #
+    # @option params [String] :account_id
+    #   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.
+    #
+    # @option params [String] :state
+    #   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.
+    #
+    # @option params [String] :resource_type
+    #   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.
+    #
+    # @option params [String] :message_category
+    #   This parameter returns the job count for the specified message
+    #   category.
+    #
+    #   Example accepted strings include `AccessDenied`, `Success`, and
+    #   `InvalidParameters`. See [Monitoring][1] 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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
+    #
+    # @option params [String] :aggregation_period
+    #   This is the period that sets the boundaries for returned results.
+    #
+    #   Acceptable values include
+    #
+    #   * `ONE_DAY` for daily job count for the prior 14 days.
+    #
+    #   * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
+    #
+    #   * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
+    #
+    # @option params [Integer] :max_results
+    #   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.
+    #
+    # @option params [String] :next_token
+    #   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.
+    #
+    # @return [Types::ListBackupJobSummariesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListBackupJobSummariesOutput#backup_job_summaries #backup_job_summaries} => Array<Types::BackupJobSummary>
+    #   * {Types::ListBackupJobSummariesOutput#aggregation_period #aggregation_period} => String
+    #   * {Types::ListBackupJobSummariesOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_backup_job_summaries({
+    #     account_id: "AccountId",
+    #     state: "CREATED", # accepts CREATED, PENDING, RUNNING, ABORTING, ABORTED, COMPLETED, FAILED, EXPIRED, PARTIAL, AGGREGATE_ALL, ANY
+    #     resource_type: "ResourceType",
+    #     message_category: "MessageCategory",
+    #     aggregation_period: "ONE_DAY", # accepts ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS
+    #     max_results: 1,
+    #     next_token: "string",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.backup_job_summaries #=> Array
+    #   resp.backup_job_summaries[0].region #=> String
+    #   resp.backup_job_summaries[0].account_id #=> String
+    #   resp.backup_job_summaries[0].state #=> String, one of "CREATED", "PENDING", "RUNNING", "ABORTING", "ABORTED", "COMPLETED", "FAILED", "EXPIRED", "PARTIAL", "AGGREGATE_ALL", "ANY"
+    #   resp.backup_job_summaries[0].resource_type #=> String
+    #   resp.backup_job_summaries[0].message_category #=> String
+    #   resp.backup_job_summaries[0].count #=> Integer
+    #   resp.backup_job_summaries[0].start_time #=> Time
+    #   resp.backup_job_summaries[0].end_time #=> Time
+    #   resp.aggregation_period #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobSummaries AWS API Documentation
+    #
+    # @overload list_backup_job_summaries(params = {})
+    # @param [Hash] params ({})
+    def list_backup_job_summaries(params = {}, options = {})
+      req = build_request(:list_backup_job_summaries, params)
+      req.send_request(options)
+    end
+
     # Returns a list of existing backup jobs for an authenticated account
     # for the last 30 days. For a longer period of time, consider using
     # these [monitoring tools][1].
@@ -2447,6 +2577,17 @@ module Aws::Backup
     # @option params [String] :by_parent_job_id
     #   This is a filter to list child (nested) jobs based on parent job ID.
     #
+    # @option params [String] :by_message_category
+    #   This returns a list of backup jobs for the specified message category.
+    #
+    #   Example strings may include `AccessDenied`, `Success`, and
+    #   `InvalidParameters`. See [Monitoring][1] for a list of MessageCategory
+    #   strings.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
+    #
     # @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array<Types::BackupJob>
@@ -2469,6 +2610,7 @@ module Aws::Backup
     #     by_complete_after: Time.now,
     #     by_complete_before: Time.now,
     #     by_parent_job_id: "string",
+    #     by_message_category: "string",
     #   })
     #
     # @example Response structure
@@ -2501,6 +2643,7 @@ module Aws::Backup
     #   resp.backup_jobs[0].parent_job_id #=> String
     #   resp.backup_jobs[0].is_parent #=> Boolean
     #   resp.backup_jobs[0].resource_name #=> String
+    #   resp.backup_jobs[0].message_category #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobs AWS API Documentation
@@ -2778,6 +2921,131 @@ module Aws::Backup
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [String] :account_id
+    #   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.
+    #
+    # @option params [String] :state
+    #   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.
+    #
+    # @option params [String] :resource_type
+    #   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.
+    #
+    # @option params [String] :message_category
+    #   This parameter returns the job count for the specified message
+    #   category.
+    #
+    #   Example accepted strings include `AccessDenied`, `Success`, and
+    #   `InvalidParameters`. See [Monitoring][1] 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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
+    #
+    # @option params [String] :aggregation_period
+    #   This is the period that sets the boundaries for returned results.
+    #
+    #   * `ONE_DAY` for daily job count for the prior 14 days.
+    #
+    #   * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
+    #
+    #   * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
+    #
+    # @option params [Integer] :max_results
+    #   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.
+    #
+    # @option params [String] :next_token
+    #   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.
+    #
+    # @return [Types::ListCopyJobSummariesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListCopyJobSummariesOutput#copy_job_summaries #copy_job_summaries} => Array<Types::CopyJobSummary>
+    #   * {Types::ListCopyJobSummariesOutput#aggregation_period #aggregation_period} => String
+    #   * {Types::ListCopyJobSummariesOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_copy_job_summaries({
+    #     account_id: "AccountId",
+    #     state: "CREATED", # accepts CREATED, RUNNING, ABORTING, ABORTED, COMPLETING, COMPLETED, FAILING, FAILED, PARTIAL, AGGREGATE_ALL, ANY
+    #     resource_type: "ResourceType",
+    #     message_category: "MessageCategory",
+    #     aggregation_period: "ONE_DAY", # accepts ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS
+    #     max_results: 1,
+    #     next_token: "string",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.copy_job_summaries #=> Array
+    #   resp.copy_job_summaries[0].region #=> String
+    #   resp.copy_job_summaries[0].account_id #=> String
+    #   resp.copy_job_summaries[0].state #=> String, one of "CREATED", "RUNNING", "ABORTING", "ABORTED", "COMPLETING", "COMPLETED", "FAILING", "FAILED", "PARTIAL", "AGGREGATE_ALL", "ANY"
+    #   resp.copy_job_summaries[0].resource_type #=> String
+    #   resp.copy_job_summaries[0].message_category #=> String
+    #   resp.copy_job_summaries[0].count #=> Integer
+    #   resp.copy_job_summaries[0].start_time #=> Time
+    #   resp.copy_job_summaries[0].end_time #=> Time
+    #   resp.aggregation_period #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobSummaries AWS API Documentation
+    #
+    # @overload list_copy_job_summaries(params = {})
+    # @param [Hash] params ({})
+    def list_copy_job_summaries(params = {}, options = {})
+      req = build_request(:list_copy_job_summaries, params)
+      req.send_request(options)
+    end
+
     # Returns metadata about your copy jobs.
     #
     # @option params [String] :next_token
@@ -2849,6 +3117,23 @@ module Aws::Backup
     # @option params [String] :by_parent_job_id
     #   This is a filter to list child (nested) jobs based on parent job ID.
     #
+    # @option params [String] :by_message_category
+    #   This parameter returns the job count for the specified message
+    #   category.
+    #
+    #   Example accepted strings include `AccessDenied`, `Success`, and
+    #   `InvalidParameters`. See [Monitoring][1] 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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
+    #
     # @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
@@ -2871,6 +3156,7 @@ module Aws::Backup
     #     by_complete_before: Time.now,
     #     by_complete_after: Time.now,
     #     by_parent_job_id: "string",
+    #     by_message_category: "string",
     #   })
     #
     # @example Response structure
@@ -2901,6 +3187,7 @@ module Aws::Backup
     #   resp.copy_jobs[0].child_jobs_in_state #=> Hash
     #   resp.copy_jobs[0].child_jobs_in_state["CopyJobState"] #=> Integer
     #   resp.copy_jobs[0].resource_name #=> String
+    #   resp.copy_jobs[0].message_category #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobs AWS API Documentation
@@ -3461,6 +3748,114 @@ module Aws::Backup
       req.send_request(options)
     end
 
+    # This request obtains a summary of restore jobs created or running
+    # within the the most recent 30 days. You can include parameters
+    # AccountID, State, ResourceType, 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.
+    #
+    # @option params [String] :account_id
+    #   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.
+    #
+    # @option params [String] :state
+    #   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.
+    #
+    # @option params [String] :resource_type
+    #   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.
+    #
+    # @option params [String] :aggregation_period
+    #   This is the period that sets the boundaries for returned results.
+    #
+    #   Acceptable values include
+    #
+    #   * `ONE_DAY` for daily job count for the prior 14 days.
+    #
+    #   * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
+    #
+    #   * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
+    #
+    # @option params [Integer] :max_results
+    #   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.
+    #
+    # @option params [String] :next_token
+    #   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.
+    #
+    # @return [Types::ListRestoreJobSummariesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListRestoreJobSummariesOutput#restore_job_summaries #restore_job_summaries} => Array<Types::RestoreJobSummary>
+    #   * {Types::ListRestoreJobSummariesOutput#aggregation_period #aggregation_period} => String
+    #   * {Types::ListRestoreJobSummariesOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_restore_job_summaries({
+    #     account_id: "AccountId",
+    #     state: "CREATED", # accepts CREATED, PENDING, RUNNING, ABORTED, COMPLETED, FAILED, AGGREGATE_ALL, ANY
+    #     resource_type: "ResourceType",
+    #     aggregation_period: "ONE_DAY", # accepts ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS
+    #     max_results: 1,
+    #     next_token: "string",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.restore_job_summaries #=> Array
+    #   resp.restore_job_summaries[0].region #=> String
+    #   resp.restore_job_summaries[0].account_id #=> String
+    #   resp.restore_job_summaries[0].state #=> String, one of "CREATED", "PENDING", "RUNNING", "ABORTED", "COMPLETED", "FAILED", "AGGREGATE_ALL", "ANY"
+    #   resp.restore_job_summaries[0].resource_type #=> String
+    #   resp.restore_job_summaries[0].count #=> Integer
+    #   resp.restore_job_summaries[0].start_time #=> Time
+    #   resp.restore_job_summaries[0].end_time #=> Time
+    #   resp.aggregation_period #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobSummaries AWS API Documentation
+    #
+    # @overload list_restore_job_summaries(params = {})
+    # @param [Hash] params ({})
+    def list_restore_job_summaries(params = {}, options = {})
+      req = build_request(:list_restore_job_summaries, params)
+      req.send_request(options)
+    end
+
     # Returns a list of jobs that Backup initiated to restore a saved
     # resource, including details about the recovery process.
     #
@@ -4661,7 +5056,7 @@ module Aws::Backup
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-backup'
-      context[:gem_version] = '1.59.0'
+      context[:gem_version] = '1.60.0'
       Seahorse::Client::Request.new(handlers, context)
     end