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 ListBackupJobs operation. 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.
Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z
public class ListBackupJobsRequest : AmazonBackupRequest IAmazonWebServiceRequest
The ListBackupJobsRequest type exposes the following members
Name | Description | |
---|---|---|
ListBackupJobsRequest() |
Name | Type | Description | |
---|---|---|---|
ByAccountId | System.String |
Gets and sets the property ByAccountId. The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an Organizations management account, passing |
|
ByBackupVaultName | System.String |
Gets and sets the property ByBackupVaultName. Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens. |
|
ByCompleteAfter | System.DateTime |
Gets and sets the property ByCompleteAfter. Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC). |
|
ByCompleteBefore | System.DateTime |
Gets and sets the property ByCompleteBefore. Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC). |
|
ByCreatedAfter | System.DateTime |
Gets and sets the property ByCreatedAfter. Returns only backup jobs that were created after the specified date. |
|
ByCreatedBefore | System.DateTime |
Gets and sets the property ByCreatedBefore. Returns only backup jobs that were created before the specified date. |
|
ByMessageCategory | System.String |
Gets and sets the property ByMessageCategory. This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include View Monitoring The wildcard () returns count of all message categories.
|
|
ByParentJobId | System.String |
Gets and sets the property ByParentJobId. This is a filter to list child (nested) jobs based on parent job ID. |
|
ByResourceArn | System.String |
Gets and sets the property ByResourceArn. Returns only backup jobs that match the specified resource Amazon Resource Name (ARN). |
|
ByResourceType | System.String |
Gets and sets the property ByResourceType. Returns only backup jobs for the specified resources:
|
|
ByState | Amazon.Backup.BackupJobState |
Gets and sets the property ByState. Returns only backup jobs that are in the specified state.
To obtain the job count for GET /backup-jobs/?state=COMPLETED GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED |
|
MaxResults | System.Int32 |
Gets and sets the property MaxResults. The maximum number of items to be returned. |
|
NextToken | System.String |
Gets and sets the property NextToken.
The next item following a partial list of returned items. For example, if a request
is made to return |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5