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.FSx.DescribeBackups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of the NextToken value from the last response.

This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the backups returned across the responses of a multi-call iteration is unspecified.

This operation returns paginated results.

Synopsis

data DescribeBackups = DescribeBackups' {
- backupIds :: Maybe [Text]
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeBackups :: DescribeBackups
describeBackups_backupIds :: Lens' DescribeBackups (Maybe [Text])
describeBackups_filters :: Lens' DescribeBackups (Maybe [Filter])
describeBackups_maxResults :: Lens' DescribeBackups (Maybe Natural)
describeBackups_nextToken :: Lens' DescribeBackups (Maybe Text)
data DescribeBackupsResponse = DescribeBackupsResponse' {
- backups :: Maybe [Backup]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeBackupsResponse :: Int -> DescribeBackupsResponse
describeBackupsResponse_backups :: Lens' DescribeBackupsResponse (Maybe [Backup])
describeBackupsResponse_nextToken :: Lens' DescribeBackupsResponse (Maybe Text)
describeBackupsResponse_httpStatus :: Lens' DescribeBackupsResponse Int

Creating a Request

data DescribeBackups Source #

The request object for the DescribeBackups operation.

See: newDescribeBackups smart constructor.

Constructors

DescribeBackups'

Fields

backupIds :: Maybe [Text]
The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.
filters :: Maybe [Filter]
The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.
maxResults :: Maybe Natural
Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
nextToken :: Maybe Text
An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Instances

Instances details

ToJSON DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods toJSON :: DescribeBackups -> Value # toEncoding :: DescribeBackups -> Encoding # toJSONList :: [DescribeBackups] -> Value # toEncodingList :: [DescribeBackups] -> Encoding #
ToHeaders DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods toHeaders :: DescribeBackups -> [Header] #
ToPath DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods toPath :: DescribeBackups -> ByteString #
ToQuery DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods toQuery :: DescribeBackups -> QueryString #
AWSPager DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods page :: DescribeBackups -> AWSResponse DescribeBackups -> Maybe DescribeBackups #
AWSRequest DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Associated Types type AWSResponse DescribeBackups # Methods request :: (Service -> Service) -> DescribeBackups -> Request DescribeBackups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBackups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBackups))) #
Generic DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Associated Types type Rep DescribeBackups :: Type -> Type # Methods from :: DescribeBackups -> Rep DescribeBackups x # to :: Rep DescribeBackups x -> DescribeBackups #
Read DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods readsPrec :: Int -> ReadS DescribeBackups # readList :: ReadS [DescribeBackups] # readPrec :: ReadPrec DescribeBackups # readListPrec :: ReadPrec [DescribeBackups] #
Show DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods showsPrec :: Int -> DescribeBackups -> ShowS # show :: DescribeBackups -> String # showList :: [DescribeBackups] -> ShowS #
NFData DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods rnf :: DescribeBackups -> () #
Eq DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods (==) :: DescribeBackups -> DescribeBackups -> Bool # (/=) :: DescribeBackups -> DescribeBackups -> Bool #
Hashable DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups Methods hashWithSalt :: Int -> DescribeBackups -> Int # hash :: DescribeBackups -> Int #
type AWSResponse DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups type AWSResponse DescribeBackups = DescribeBackupsResponse
type Rep DescribeBackups Source #
Instance details Defined in Amazonka.FSx.DescribeBackups type Rep DescribeBackups = D1 ('MetaData "DescribeBackups" "Amazonka.FSx.DescribeBackups" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeBackups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeBackups :: DescribeBackups Source #

Create a value of DescribeBackups 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:backupIds:DescribeBackups', describeBackups_backupIds - The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

$sel:filters:DescribeBackups', describeBackups_filters - The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

$sel:maxResults:DescribeBackups', describeBackups_maxResults - Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

DescribeBackups, describeBackups_nextToken - An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Request Lenses

describeBackups_backupIds :: Lens' DescribeBackups (Maybe [Text]) Source #

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

describeBackups_filters :: Lens' DescribeBackups (Maybe [Filter]) Source #

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

describeBackups_maxResults :: Lens' DescribeBackups (Maybe Natural) Source #

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

describeBackups_nextToken :: Lens' DescribeBackups (Maybe Text) Source #

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Destructuring the Response

data DescribeBackupsResponse Source #

Response object for the DescribeBackups operation.

See: newDescribeBackupsResponse smart constructor.

Constructors

DescribeBackupsResponse'
Fields backups :: Maybe [Backup] An array of backups. nextToken :: Maybe Text A `NextToken` value is present if there are more backups than returned in the response. You can use the `NextToken` value in the subsequent request to fetch the backups. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeBackupsResponse Source #

Arguments

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

Create a value of DescribeBackupsResponse 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:backups:DescribeBackupsResponse', describeBackupsResponse_backups - An array of backups.

DescribeBackups, describeBackupsResponse_nextToken - A NextToken value is present if there are more backups than returned in the response. You can use the NextToken value in the subsequent request to fetch the backups.

$sel:httpStatus:DescribeBackupsResponse', describeBackupsResponse_httpStatus - The response's http status code.

Response Lenses

describeBackupsResponse_backups :: Lens' DescribeBackupsResponse (Maybe [Backup]) Source #

An array of backups.

describeBackupsResponse_nextToken :: Lens' DescribeBackupsResponse (Maybe Text) Source #

A NextToken value is present if there are more backups than returned in the response. You can use the NextToken value in the subsequent request to fetch the backups.

describeBackupsResponse_httpStatus :: Lens' DescribeBackupsResponse Int Source #

The response's http status code.