Amazonka.BackupStorage.ListObjects

List all Objects in a given Backup.

Creating a Request

data ListObjects

See: newListObjects smart constructor.

Constructors

ListObjects'

Fields

• createdAfter :: Maybe POSIX

  (Optional) Created after filter

• createdBefore :: Maybe POSIX

  (Optional) Created before filter

• maxResults :: Maybe Natural

  Maximum objects count

• nextToken :: Maybe Text

  Pagination token

• startingObjectName :: Maybe Text

  Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL

• startingObjectPrefix :: Maybe Text

  Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL

• storageJobId :: Text

  Storage job id

Instances

ToHeaders ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

toHeaders :: ListObjects -> [Header]

ToPath ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

toPath :: ListObjects -> ByteString

ToQuery ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

toQuery :: ListObjects -> QueryString

AWSRequest ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Associated Types

type AWSResponse ListObjects

Methods

request :: (Service -> Service) -> ListObjects -> Request ListObjects

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListObjects -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListObjects)))

Generic ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Associated Types

type Rep ListObjects :: Type -> Type

Methods

from :: ListObjects -> Rep ListObjects x

to :: Rep ListObjects x -> ListObjects

Read ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

readsPrec :: Int -> ReadS ListObjects

readList :: ReadS [ListObjects]

readPrec :: ReadPrec ListObjects

readListPrec :: ReadPrec [ListObjects]

Show ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

showsPrec :: Int -> ListObjects -> ShowS

show :: ListObjects -> String

showList :: [ListObjects] -> ShowS

NFData ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

rnf :: ListObjects -> ()

Eq ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

(==) :: ListObjects -> ListObjects -> Bool

(/=) :: ListObjects -> ListObjects -> Bool

Hashable ListObjects

Defined in Amazonka.BackupStorage.ListObjects

Methods

hashWithSalt :: Int -> ListObjects -> Int

hash :: ListObjects -> Int

type AWSResponse ListObjects

Defined in Amazonka.BackupStorage.ListObjects

type AWSResponse ListObjects = ListObjectsResponse

type Rep ListObjects

Defined in Amazonka.BackupStorage.ListObjects

type Rep ListObjects = D1 ('MetaData "ListObjects" "Amazonka.BackupStorage.ListObjects" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'False) (C1 ('MetaCons "ListObjects'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "createdBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startingObjectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "startingObjectPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "storageJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListObjects

Arguments

:: Text

$sel:storageJobId:ListObjects'

-> ListObjects

Create a value of ListObjects 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:createdAfter:ListObjects', listObjects_createdAfter - (Optional) Created after filter

$sel:createdBefore:ListObjects', listObjects_createdBefore - (Optional) Created before filter

$sel:maxResults:ListObjects', listObjects_maxResults - Maximum objects count

ListObjects, listObjects_nextToken - Pagination token

$sel:startingObjectName:ListObjects', listObjects_startingObjectName - Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL

$sel:startingObjectPrefix:ListObjects', listObjects_startingObjectPrefix - Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL

$sel:storageJobId:ListObjects', listObjects_storageJobId - Storage job id

Request Lenses

listObjects_createdAfter :: Lens' ListObjects (Maybe UTCTime)

(Optional) Created after filter

listObjects_createdBefore :: Lens' ListObjects (Maybe UTCTime)

(Optional) Created before filter

listObjects_maxResults :: Lens' ListObjects (Maybe Natural)

Maximum objects count

listObjects_nextToken :: Lens' ListObjects (Maybe Text)

Pagination token

listObjects_startingObjectName :: Lens' ListObjects (Maybe Text)

Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL

listObjects_startingObjectPrefix :: Lens' ListObjects (Maybe Text)

Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL

listObjects_storageJobId :: Lens' ListObjects Text

Storage job id

Destructuring the Response

data ListObjectsResponse

See: newListObjectsResponse smart constructor.

Constructors

ListObjectsResponse'

Fields

• nextToken :: Maybe Text

  Pagination token

• httpStatus :: Int

  The response's http status code.

• objectList :: [BackupObject]

  Object list

Instances

Generic ListObjectsResponse

Defined in Amazonka.BackupStorage.ListObjects

Associated Types

type Rep ListObjectsResponse :: Type -> Type

Methods

from :: ListObjectsResponse -> Rep ListObjectsResponse x

to :: Rep ListObjectsResponse x -> ListObjectsResponse

Read ListObjectsResponse

Defined in Amazonka.BackupStorage.ListObjects

Methods

readsPrec :: Int -> ReadS ListObjectsResponse

readList :: ReadS [ListObjectsResponse]

readPrec :: ReadPrec ListObjectsResponse

readListPrec :: ReadPrec [ListObjectsResponse]

Show ListObjectsResponse

Defined in Amazonka.BackupStorage.ListObjects

Methods

showsPrec :: Int -> ListObjectsResponse -> ShowS

show :: ListObjectsResponse -> String

showList :: [ListObjectsResponse] -> ShowS

NFData ListObjectsResponse

Defined in Amazonka.BackupStorage.ListObjects

Methods

rnf :: ListObjectsResponse -> ()

Eq ListObjectsResponse

Defined in Amazonka.BackupStorage.ListObjects

Methods

(==) :: ListObjectsResponse -> ListObjectsResponse -> Bool

(/=) :: ListObjectsResponse -> ListObjectsResponse -> Bool

type Rep ListObjectsResponse

Defined in Amazonka.BackupStorage.ListObjects

type Rep ListObjectsResponse = D1 ('MetaData "ListObjectsResponse" "Amazonka.BackupStorage.ListObjects" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'False) (C1 ('MetaCons "ListObjectsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "objectList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BackupObject]))))

newListObjectsResponse

Arguments

:: Int

$sel:httpStatus:ListObjectsResponse'

-> ListObjectsResponse

Create a value of ListObjectsResponse 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:

ListObjects, listObjectsResponse_nextToken - Pagination token

$sel:httpStatus:ListObjectsResponse', listObjectsResponse_httpStatus - The response's http status code.

$sel:objectList:ListObjectsResponse', listObjectsResponse_objectList - Object list

Response Lenses

listObjectsResponse_nextToken :: Lens' ListObjectsResponse (Maybe Text)

Pagination token

listObjectsResponse_httpStatus :: Lens' ListObjectsResponse Int

The response's http status code.

listObjectsResponse_objectList :: Lens' ListObjectsResponse [BackupObject]

Object list