Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Backup.ListCopyJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata about your copy jobs.

Synopsis

data ListCopyJobs = ListCopyJobs' {
- byResourceArn :: Maybe Text
- byCreatedAfter :: Maybe POSIX
- byAccountId :: Maybe Text
- byCreatedBefore :: Maybe POSIX
- byDestinationVaultArn :: Maybe Text
- byResourceType :: Maybe Text
- nextToken :: Maybe Text
- byState :: Maybe CopyJobState
- maxResults :: Maybe Natural
}
newListCopyJobs :: ListCopyJobs
listCopyJobs_byResourceArn :: Lens' ListCopyJobs (Maybe Text)
listCopyJobs_byCreatedAfter :: Lens' ListCopyJobs (Maybe UTCTime)
listCopyJobs_byAccountId :: Lens' ListCopyJobs (Maybe Text)
listCopyJobs_byCreatedBefore :: Lens' ListCopyJobs (Maybe UTCTime)
listCopyJobs_byDestinationVaultArn :: Lens' ListCopyJobs (Maybe Text)
listCopyJobs_byResourceType :: Lens' ListCopyJobs (Maybe Text)
listCopyJobs_nextToken :: Lens' ListCopyJobs (Maybe Text)
listCopyJobs_byState :: Lens' ListCopyJobs (Maybe CopyJobState)
listCopyJobs_maxResults :: Lens' ListCopyJobs (Maybe Natural)
data ListCopyJobsResponse = ListCopyJobsResponse' {
- nextToken :: Maybe Text
- copyJobs :: Maybe [CopyJob]
- httpStatus :: Int
}
newListCopyJobsResponse :: Int -> ListCopyJobsResponse
listCopyJobsResponse_nextToken :: Lens' ListCopyJobsResponse (Maybe Text)
listCopyJobsResponse_copyJobs :: Lens' ListCopyJobsResponse (Maybe [CopyJob])
listCopyJobsResponse_httpStatus :: Lens' ListCopyJobsResponse Int

Creating a Request

data ListCopyJobs Source #

See: newListCopyJobs smart constructor.

Constructors

ListCopyJobs'

Fields

byResourceArn :: Maybe Text
Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
byCreatedAfter :: Maybe POSIX
Returns only copy jobs that were created after the specified date.
byAccountId :: Maybe Text
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
byCreatedBefore :: Maybe POSIX
Returns only copy jobs that were created before the specified date.
byDestinationVaultArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
byResourceType :: Maybe Text
Returns only backup jobs for the specified resources:
- DynamoDB for Amazon DynamoDB
- EBS for Amazon Elastic Block Store
- EC2 for Amazon Elastic Compute Cloud
- EFS for Amazon Elastic File System
- RDS for Amazon Relational Database Service
- Aurora for Amazon Aurora
- Storage Gateway for Storage Gateway
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.
byState :: Maybe CopyJobState
Returns only copy jobs that are in the specified state.
maxResults :: Maybe Natural
The maximum number of items to be returned.

Instances

Instances details

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

newListCopyJobs :: ListCopyJobs Source #

Create a value of ListCopyJobs 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:byResourceArn:ListCopyJobs', listCopyJobs_byResourceArn - Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

$sel:byCreatedAfter:ListCopyJobs', listCopyJobs_byCreatedAfter - Returns only copy jobs that were created after the specified date.

$sel:byAccountId:ListCopyJobs', listCopyJobs_byAccountId - The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

$sel:byCreatedBefore:ListCopyJobs', listCopyJobs_byCreatedBefore - Returns only copy jobs that were created before the specified date.

$sel:byDestinationVaultArn:ListCopyJobs', listCopyJobs_byDestinationVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

$sel:byResourceType:ListCopyJobs', listCopyJobs_byResourceType - Returns only backup jobs for the specified resources:

DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for Storage Gateway

$sel:nextToken:ListCopyJobs', listCopyJobs_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:byState:ListCopyJobs', listCopyJobs_byState - Returns only copy jobs that are in the specified state.

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

Request Lenses

listCopyJobs_byResourceArn :: Lens' ListCopyJobs (Maybe Text) Source #

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

listCopyJobs_byCreatedAfter :: Lens' ListCopyJobs (Maybe UTCTime) Source #

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

listCopyJobs_byAccountId :: Lens' ListCopyJobs (Maybe Text) Source #

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

listCopyJobs_byCreatedBefore :: Lens' ListCopyJobs (Maybe UTCTime) Source #

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

listCopyJobs_byDestinationVaultArn :: Lens' ListCopyJobs (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

listCopyJobs_byResourceType :: Lens' ListCopyJobs (Maybe Text) Source #

Returns only backup jobs for the specified resources:

DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for Storage Gateway

listCopyJobs_nextToken :: Lens' ListCopyJobs (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.

listCopyJobs_byState :: Lens' ListCopyJobs (Maybe CopyJobState) Source #

Returns only copy jobs that are in the specified state.

listCopyJobs_maxResults :: Lens' ListCopyJobs (Maybe Natural) Source #

The maximum number of items to be returned.

Destructuring the Response

data ListCopyJobsResponse Source #

See: newListCopyJobsResponse smart constructor.

Constructors

ListCopyJobsResponse'

Fields

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.
copyJobs :: Maybe [CopyJob]
An array of structures containing metadata about your copy jobs returned in JSON format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListCopyJobsResponse Source #

Arguments

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

Create a value of ListCopyJobsResponse 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:nextToken:ListCopyJobs', listCopyJobsResponse_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:copyJobs:ListCopyJobsResponse', listCopyJobsResponse_copyJobs - An array of structures containing metadata about your copy jobs returned in JSON format.

$sel:httpStatus:ListCopyJobsResponse', listCopyJobsResponse_httpStatus - The response's http status code.

Response Lenses

listCopyJobsResponse_nextToken :: Lens' ListCopyJobsResponse (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.

listCopyJobsResponse_copyJobs :: Lens' ListCopyJobsResponse (Maybe [CopyJob]) Source #

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

listCopyJobsResponse_httpStatus :: Lens' ListCopyJobsResponse Int Source #

The response's http status code.