AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListRestoreJobSummaries operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Backup.AmazonBackupRequest
      Amazon.Backup.Model.ListRestoreJobSummariesRequest

Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z

Syntax

C#
public class ListRestoreJobSummariesRequest : AmazonBackupRequest
         IAmazonWebServiceRequest

The ListRestoreJobSummariesRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AccountId System.String

Gets and sets the property AccountId.

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.

Public Property AggregationPeriod Amazon.Backup.AggregationPeriod

Gets and sets the property AggregationPeriod.

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.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

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.

Public Property NextToken System.String

Gets and sets the property NextToken.

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.

Public Property ResourceType System.String

Gets and sets the property ResourceType.

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.

Public Property State Amazon.Backup.RestoreJobState

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5