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

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

This operation lists in-progress multipart uploads.

This operation returns paginated results.

Synopsis

# Creating a Request

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.

See: listMultipartUploads smart constructor.

Instances

# Request Lenses

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

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

Undocumented member.

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.

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.

Character you use to group keys.

Undocumented member.

# Destructuring the Response

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.

See: listMultipartUploadsResponse smart constructor.

Instances

# Response Lenses

The key at or after which the listing began.

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

Undocumented member.

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

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

Upload ID after which listing began.

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

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

Undocumented member.

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.

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.

Undocumented member.

• - | The response status code.