Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Backup.ListBackupJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data ListBackupJobs = ListBackupJobs' {
- byAccountId :: Maybe Text
- byBackupVaultName :: Maybe Text
- byCompleteAfter :: Maybe POSIX
- byCompleteBefore :: Maybe POSIX
- byCreatedAfter :: Maybe POSIX
- byCreatedBefore :: Maybe POSIX
- byParentJobId :: Maybe Text
- byResourceArn :: Maybe Text
- byResourceType :: Maybe Text
- byState :: Maybe BackupJobState
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListBackupJobs :: ListBackupJobs
listBackupJobs_byAccountId :: Lens' ListBackupJobs (Maybe Text)
listBackupJobs_byBackupVaultName :: Lens' ListBackupJobs (Maybe Text)
listBackupJobs_byCompleteAfter :: Lens' ListBackupJobs (Maybe UTCTime)
listBackupJobs_byCompleteBefore :: Lens' ListBackupJobs (Maybe UTCTime)
listBackupJobs_byCreatedAfter :: Lens' ListBackupJobs (Maybe UTCTime)
listBackupJobs_byCreatedBefore :: Lens' ListBackupJobs (Maybe UTCTime)
listBackupJobs_byParentJobId :: Lens' ListBackupJobs (Maybe Text)
listBackupJobs_byResourceArn :: Lens' ListBackupJobs (Maybe Text)
listBackupJobs_byResourceType :: Lens' ListBackupJobs (Maybe Text)
listBackupJobs_byState :: Lens' ListBackupJobs (Maybe BackupJobState)
listBackupJobs_maxResults :: Lens' ListBackupJobs (Maybe Natural)
listBackupJobs_nextToken :: Lens' ListBackupJobs (Maybe Text)
data ListBackupJobsResponse = ListBackupJobsResponse' {
- backupJobs :: Maybe [BackupJob]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBackupJobsResponse :: Int -> ListBackupJobsResponse
listBackupJobsResponse_backupJobs :: Lens' ListBackupJobsResponse (Maybe [BackupJob])
listBackupJobsResponse_nextToken :: Lens' ListBackupJobsResponse (Maybe Text)
listBackupJobsResponse_httpStatus :: Lens' ListBackupJobsResponse Int

Creating a Request

data ListBackupJobs Source #

See: newListBackupJobs smart constructor.

Constructors

ListBackupJobs'

Fields

byAccountId :: Maybe Text
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 * returns all jobs across the organization.
byBackupVaultName :: Maybe Text
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 :: Maybe POSIX
Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
byCompleteBefore :: Maybe POSIX
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
byCreatedAfter :: Maybe POSIX
Returns only backup jobs that were created after the specified date.
byCreatedBefore :: Maybe POSIX
Returns only backup jobs that were created before the specified date.
byParentJobId :: Maybe Text
This is a filter to list child (nested) jobs based on parent job ID.
byResourceArn :: Maybe Text
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
byResourceType :: Maybe Text
Returns only backup jobs for the specified resources:
- Aurora for Amazon Aurora
- DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
- DynamoDB for Amazon DynamoDB
- EBS for Amazon Elastic Block Store
- EC2 for Amazon Elastic Compute Cloud
- EFS for Amazon Elastic File System
- FSx for Amazon FSx
- Neptune for Amazon Neptune
- RDS for Amazon Relational Database Service
- Storage Gateway for Storage Gateway
- S3 for Amazon S3
- VirtualMachine for virtual machines
byState :: Maybe BackupJobState
Returns only backup jobs that are in the specified state.
maxResults :: Maybe Natural
The maximum number of items to be returned.
nextToken :: Maybe Text
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Instances

Instances details

ToHeaders ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods toHeaders :: ListBackupJobs -> [Header] #
ToPath ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods toPath :: ListBackupJobs -> ByteString #
ToQuery ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods toQuery :: ListBackupJobs -> QueryString #
AWSPager ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods page :: ListBackupJobs -> AWSResponse ListBackupJobs -> Maybe ListBackupJobs #
AWSRequest ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Associated Types type AWSResponse ListBackupJobs # Methods request :: (Service -> Service) -> ListBackupJobs -> Request ListBackupJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBackupJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBackupJobs))) #
Generic ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Associated Types type Rep ListBackupJobs :: Type -> Type # Methods from :: ListBackupJobs -> Rep ListBackupJobs x # to :: Rep ListBackupJobs x -> ListBackupJobs #
Read ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods readsPrec :: Int -> ReadS ListBackupJobs # readList :: ReadS [ListBackupJobs] # readPrec :: ReadPrec ListBackupJobs # readListPrec :: ReadPrec [ListBackupJobs] #
Show ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods showsPrec :: Int -> ListBackupJobs -> ShowS # show :: ListBackupJobs -> String # showList :: [ListBackupJobs] -> ShowS #
NFData ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods rnf :: ListBackupJobs -> () #
Eq ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods (==) :: ListBackupJobs -> ListBackupJobs -> Bool # (/=) :: ListBackupJobs -> ListBackupJobs -> Bool #
Hashable ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods hashWithSalt :: Int -> ListBackupJobs -> Int # hash :: ListBackupJobs -> Int #
type AWSResponse ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs type AWSResponse ListBackupJobs = ListBackupJobsResponse
type Rep ListBackupJobs Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs type Rep ListBackupJobs = D1 ('MetaData "ListBackupJobs" "Amazonka.Backup.ListBackupJobs" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupJobs'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "byAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "byBackupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "byCompleteAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "byCompleteBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "byCreatedAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "byCreatedBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "byParentJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "byResourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "byResourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "byState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupJobState)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newListBackupJobs :: ListBackupJobs Source #

Create a value of ListBackupJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:byAccountId:ListBackupJobs', listBackupJobs_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 * returns all jobs across the organization.

$sel:byBackupVaultName:ListBackupJobs', listBackupJobs_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.

$sel:byCompleteAfter:ListBackupJobs', listBackupJobs_byCompleteAfter - Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

$sel:byCompleteBefore:ListBackupJobs', listBackupJobs_byCompleteBefore - Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

$sel:byCreatedAfter:ListBackupJobs', listBackupJobs_byCreatedAfter - Returns only backup jobs that were created after the specified date.

$sel:byCreatedBefore:ListBackupJobs', listBackupJobs_byCreatedBefore - Returns only backup jobs that were created before the specified date.

$sel:byParentJobId:ListBackupJobs', listBackupJobs_byParentJobId - This is a filter to list child (nested) jobs based on parent job ID.

$sel:byResourceArn:ListBackupJobs', listBackupJobs_byResourceArn - Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

$sel:byResourceType:ListBackupJobs', listBackupJobs_byResourceType - Returns only backup jobs for the specified resources:

Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Storage Gateway for Storage Gateway
S3 for Amazon S3
VirtualMachine for virtual machines

$sel:byState:ListBackupJobs', listBackupJobs_byState - Returns only backup jobs that are in the specified state.

$sel:maxResults:ListBackupJobs', listBackupJobs_maxResults - The maximum number of items to be returned.

ListBackupJobs, listBackupJobs_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Request Lenses

listBackupJobs_byAccountId :: Lens' ListBackupJobs (Maybe Text) Source #

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 * returns all jobs across the organization.

listBackupJobs_byBackupVaultName :: Lens' ListBackupJobs (Maybe Text) Source #

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.

listBackupJobs_byCompleteAfter :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

listBackupJobs_byCompleteBefore :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

listBackupJobs_byCreatedAfter :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs that were created after the specified date.

listBackupJobs_byCreatedBefore :: Lens' ListBackupJobs (Maybe UTCTime) Source #

Returns only backup jobs that were created before the specified date.

listBackupJobs_byParentJobId :: Lens' ListBackupJobs (Maybe Text) Source #

This is a filter to list child (nested) jobs based on parent job ID.

listBackupJobs_byResourceArn :: Lens' ListBackupJobs (Maybe Text) Source #

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

listBackupJobs_byResourceType :: Lens' ListBackupJobs (Maybe Text) Source #

Returns only backup jobs for the specified resources:

Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Storage Gateway for Storage Gateway
S3 for Amazon S3
VirtualMachine for virtual machines

listBackupJobs_byState :: Lens' ListBackupJobs (Maybe BackupJobState) Source #

Returns only backup jobs that are in the specified state.

listBackupJobs_maxResults :: Lens' ListBackupJobs (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupJobs_nextToken :: Lens' ListBackupJobs (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Destructuring the Response

data ListBackupJobsResponse Source #

See: newListBackupJobsResponse smart constructor.

Constructors

ListBackupJobsResponse'

Fields

backupJobs :: Maybe [BackupJob]
An array of structures containing metadata about your backup jobs returned in JSON format.
nextToken :: Maybe Text
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListBackupJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Associated Types type Rep ListBackupJobsResponse :: Type -> Type # Methods from :: ListBackupJobsResponse -> Rep ListBackupJobsResponse x # to :: Rep ListBackupJobsResponse x -> ListBackupJobsResponse #
Read ListBackupJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods readsPrec :: Int -> ReadS ListBackupJobsResponse # readList :: ReadS [ListBackupJobsResponse] # readPrec :: ReadPrec ListBackupJobsResponse # readListPrec :: ReadPrec [ListBackupJobsResponse] #
Show ListBackupJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods showsPrec :: Int -> ListBackupJobsResponse -> ShowS # show :: ListBackupJobsResponse -> String # showList :: [ListBackupJobsResponse] -> ShowS #
NFData ListBackupJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods rnf :: ListBackupJobsResponse -> () #
Eq ListBackupJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs Methods (==) :: ListBackupJobsResponse -> ListBackupJobsResponse -> Bool # (/=) :: ListBackupJobsResponse -> ListBackupJobsResponse -> Bool #
type Rep ListBackupJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupJobs type Rep ListBackupJobsResponse = D1 ('MetaData "ListBackupJobsResponse" "Amazonka.Backup.ListBackupJobs" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackupJob])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBackupJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListBackupJobsResponse'`
-> ListBackupJobsResponse

Create a value of ListBackupJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:backupJobs:ListBackupJobsResponse', listBackupJobsResponse_backupJobs - An array of structures containing metadata about your backup jobs returned in JSON format.

ListBackupJobs, listBackupJobsResponse_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

$sel:httpStatus:ListBackupJobsResponse', listBackupJobsResponse_httpStatus - The response's http status code.

Response Lenses

listBackupJobsResponse_backupJobs :: Lens' ListBackupJobsResponse (Maybe [BackupJob]) Source #

An array of structures containing metadata about your backup jobs returned in JSON format.

listBackupJobsResponse_nextToken :: Lens' ListBackupJobsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupJobsResponse_httpStatus :: Lens' ListBackupJobsResponse Int Source #

The response's http status code.