amazonka-s3-1.5.0: Amazon Simple Storage Service SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.S3.ListMultipartUploads

Contents

Description

This operation lists in-progress multipart uploads.

This operation returns paginated results.

Synopsis

Creating a Request

listMultipartUploads Source #

Arguments

:: BucketName

lmuBucket

-> ListMultipartUploads 

Creates a value of ListMultipartUploads with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lmuKeyMarker - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
  • lmuPrefix - Lists in-progress uploads only for those keys that begin with the specified prefix.
  • lmuEncodingType - Undocumented member.
  • lmuUploadIdMarker - Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.
  • lmuMaxUploads - Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
  • lmuDelimiter - Character you use to group keys.
  • lmuBucket - Undocumented member.

data ListMultipartUploads Source #

See: listMultipartUploads smart constructor.

Instances

Eq ListMultipartUploads Source # 
Data ListMultipartUploads Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMultipartUploads -> c ListMultipartUploads #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMultipartUploads #

toConstr :: ListMultipartUploads -> Constr #

dataTypeOf :: ListMultipartUploads -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListMultipartUploads) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMultipartUploads) #

gmapT :: (forall b. Data b => b -> b) -> ListMultipartUploads -> ListMultipartUploads #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMultipartUploads -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMultipartUploads -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListMultipartUploads -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMultipartUploads -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMultipartUploads -> m ListMultipartUploads #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMultipartUploads -> m ListMultipartUploads #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMultipartUploads -> m ListMultipartUploads #

Read ListMultipartUploads Source # 
Show ListMultipartUploads Source # 
Generic ListMultipartUploads Source # 
Hashable ListMultipartUploads Source # 
NFData ListMultipartUploads Source # 

Methods

rnf :: ListMultipartUploads -> () #

AWSPager ListMultipartUploads Source # 
AWSRequest ListMultipartUploads Source # 
ToQuery ListMultipartUploads Source # 
ToPath ListMultipartUploads Source # 
ToHeaders ListMultipartUploads Source # 
type Rep ListMultipartUploads Source # 
type Rs ListMultipartUploads Source # 

Request Lenses

lmuKeyMarker :: Lens' ListMultipartUploads (Maybe Text) Source #

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

lmuPrefix :: Lens' ListMultipartUploads (Maybe Text) Source #

Lists in-progress uploads only for those keys that begin with the specified prefix.

lmuEncodingType :: Lens' ListMultipartUploads (Maybe EncodingType) Source #

Undocumented member.

lmuUploadIdMarker :: Lens' ListMultipartUploads (Maybe Text) Source #

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.

lmuMaxUploads :: Lens' ListMultipartUploads (Maybe Int) Source #

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

lmuDelimiter :: Lens' ListMultipartUploads (Maybe Delimiter) Source #

Character you use to group keys.

lmuBucket :: Lens' ListMultipartUploads BucketName Source #

Undocumented member.

Destructuring the Response

listMultipartUploadsResponse Source #

Arguments

:: Int

lmursResponseStatus

-> ListMultipartUploadsResponse 

Creates a value of ListMultipartUploadsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lmursKeyMarker - The key at or after which the listing began.
  • lmursPrefix - When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
  • lmursCommonPrefixes - Undocumented member.
  • lmursEncodingType - Encoding type used by Amazon S3 to encode object keys in the response.
  • lmursBucket - Name of the bucket to which the multipart upload was initiated.
  • lmursUploadIdMarker - Upload ID after which listing began.
  • lmursMaxUploads - Maximum number of multipart uploads that could have been included in the response.
  • lmursNextKeyMarker - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
  • lmursUploads - Undocumented member.
  • lmursIsTruncated - Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
  • lmursNextUploadIdMarker - When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
  • lmursDelimiter - Undocumented member.
  • lmursResponseStatus - -- | The response status code.

data ListMultipartUploadsResponse Source #

See: listMultipartUploadsResponse smart constructor.

Instances

Eq ListMultipartUploadsResponse Source # 
Data ListMultipartUploadsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMultipartUploadsResponse -> c ListMultipartUploadsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMultipartUploadsResponse #

toConstr :: ListMultipartUploadsResponse -> Constr #

dataTypeOf :: ListMultipartUploadsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListMultipartUploadsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMultipartUploadsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListMultipartUploadsResponse -> ListMultipartUploadsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMultipartUploadsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMultipartUploadsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListMultipartUploadsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMultipartUploadsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMultipartUploadsResponse -> m ListMultipartUploadsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMultipartUploadsResponse -> m ListMultipartUploadsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMultipartUploadsResponse -> m ListMultipartUploadsResponse #

Read ListMultipartUploadsResponse Source # 
Show ListMultipartUploadsResponse Source # 
Generic ListMultipartUploadsResponse Source # 
NFData ListMultipartUploadsResponse Source # 
type Rep ListMultipartUploadsResponse Source # 
type Rep ListMultipartUploadsResponse = D1 (MetaData "ListMultipartUploadsResponse" "Network.AWS.S3.ListMultipartUploads" "amazonka-s3-1.5.0-4i2REsRgyXL98WvgynC9is" False) (C1 (MetaCons "ListMultipartUploadsResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lmursKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lmursPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lmursCommonPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CommonPrefix]))))) ((:*:) (S1 (MetaSel (Just Symbol "_lmursEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType))) ((:*:) (S1 (MetaSel (Just Symbol "_lmursBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BucketName))) (S1 (MetaSel (Just Symbol "_lmursUploadIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lmursMaxUploads") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_lmursNextKeyMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lmursUploads") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MultipartUpload]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lmursIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_lmursNextUploadIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lmursDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter))) (S1 (MetaSel (Just Symbol "_lmursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

Response Lenses

lmursKeyMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

The key at or after which the listing began.

lmursPrefix :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

lmursCommonPrefixes :: Lens' ListMultipartUploadsResponse [CommonPrefix] Source #

Undocumented member.

lmursEncodingType :: Lens' ListMultipartUploadsResponse (Maybe EncodingType) Source #

Encoding type used by Amazon S3 to encode object keys in the response.

lmursBucket :: Lens' ListMultipartUploadsResponse (Maybe BucketName) Source #

Name of the bucket to which the multipart upload was initiated.

lmursUploadIdMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

Upload ID after which listing began.

lmursMaxUploads :: Lens' ListMultipartUploadsResponse (Maybe Int) Source #

Maximum number of multipart uploads that could have been included in the response.

lmursNextKeyMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

lmursUploads :: Lens' ListMultipartUploadsResponse [MultipartUpload] Source #

Undocumented member.

lmursIsTruncated :: Lens' ListMultipartUploadsResponse (Maybe Bool) Source #

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

lmursNextUploadIdMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) Source #

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

lmursDelimiter :: Lens' ListMultipartUploadsResponse (Maybe Delimiter) Source #

Undocumented member.

lmursResponseStatus :: Lens' ListMultipartUploadsResponse Int Source #

  • - | The response status code.