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

Amazonka.S3.ListMultipartUploads

Description

This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListMultipartUploads:

This operation returns paginated results.

Synopsis

Creating a Request

data ListMultipartUploads Source #

See: newListMultipartUploads smart constructor.

Constructors

ListMultipartUploads' 

Fields

  • keyMarker :: Maybe Text

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

    If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

    If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

  • prefix :: Maybe Text

    Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

  • encodingType :: Maybe EncodingType
     
  • uploadIdMarker :: Maybe Text

    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. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

  • maxUploads :: Maybe Int

    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.

  • delimiter :: Maybe Delimiter

    Character you use to group keys.

    All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

  • expectedBucketOwner :: Maybe Text

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

  • bucket :: BucketName

    The name of the bucket to which the multipart upload was initiated.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Instances

Instances details
Eq ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Read ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Show ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Generic ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Associated Types

type Rep ListMultipartUploads :: Type -> Type #

NFData ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Methods

rnf :: ListMultipartUploads -> () #

Hashable ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

AWSPager ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

AWSRequest ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Associated Types

type AWSResponse ListMultipartUploads #

ToHeaders ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

ToPath ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

ToQuery ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

type Rep ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

type AWSResponse ListMultipartUploads Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

newListMultipartUploads Source #

Create a value of ListMultipartUploads 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:keyMarker:ListMultipartUploads', listMultipartUploads_keyMarker - Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

$sel:prefix:ListMultipartUploads', listMultipartUploads_prefix - Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

$sel:encodingType:ListMultipartUploads', listMultipartUploads_encodingType - Undocumented member.

$sel:uploadIdMarker:ListMultipartUploads', listMultipartUploads_uploadIdMarker - 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. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

$sel:maxUploads:ListMultipartUploads', listMultipartUploads_maxUploads - 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.

$sel:delimiter:ListMultipartUploads', listMultipartUploads_delimiter - Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

$sel:expectedBucketOwner:ListMultipartUploads', listMultipartUploads_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

$sel:bucket:ListMultipartUploads', listMultipartUploads_bucket - The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Request Lenses

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

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

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

listMultipartUploads_uploadIdMarker :: 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. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

listMultipartUploads_maxUploads :: 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.

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

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

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

listMultipartUploads_bucket :: Lens' ListMultipartUploads BucketName Source #

The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Destructuring the Response

data ListMultipartUploadsResponse Source #

See: newListMultipartUploadsResponse smart constructor.

Constructors

ListMultipartUploadsResponse' 

Fields

  • keyMarker :: Maybe Text

    The key at or after which the listing began.

  • prefix :: Maybe Text

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

  • commonPrefixes :: Maybe [CommonPrefix]

    If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

  • encodingType :: Maybe EncodingType

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

    If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

    Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

  • bucket :: Maybe BucketName

    The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

  • uploadIdMarker :: Maybe Text

    Upload ID after which listing began.

  • maxUploads :: Maybe Int

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

  • nextKeyMarker :: Maybe Text

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

  • uploads :: Maybe [MultipartUpload]

    Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

  • isTruncated :: Maybe Bool

    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.

  • nextUploadIdMarker :: Maybe Text

    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.

  • delimiter :: Maybe Delimiter

    Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListMultipartUploadsResponse Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Read ListMultipartUploadsResponse Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Show ListMultipartUploadsResponse Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Generic ListMultipartUploadsResponse Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

Associated Types

type Rep ListMultipartUploadsResponse :: Type -> Type #

NFData ListMultipartUploadsResponse Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

type Rep ListMultipartUploadsResponse Source # 
Instance details

Defined in Amazonka.S3.ListMultipartUploads

type Rep ListMultipartUploadsResponse = D1 ('MetaData "ListMultipartUploadsResponse" "Amazonka.S3.ListMultipartUploads" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "ListMultipartUploadsResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "keyMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "commonPrefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CommonPrefix])))) :*: (S1 ('MetaSel ('Just "encodingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncodingType)) :*: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketName)) :*: S1 ('MetaSel ('Just "uploadIdMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "maxUploads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextKeyMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MultipartUpload])))) :*: ((S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "nextUploadIdMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "delimiter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Delimiter)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newListMultipartUploadsResponse Source #

Create a value of ListMultipartUploadsResponse 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:keyMarker:ListMultipartUploads', listMultipartUploadsResponse_keyMarker - The key at or after which the listing began.

$sel:prefix:ListMultipartUploads', listMultipartUploadsResponse_prefix - When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

$sel:commonPrefixes:ListMultipartUploadsResponse', listMultipartUploadsResponse_commonPrefixes - If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

$sel:encodingType:ListMultipartUploads', listMultipartUploadsResponse_encodingType - Encoding type used by Amazon S3 to encode object keys in the response.

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

$sel:bucket:ListMultipartUploads', listMultipartUploadsResponse_bucket - The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

$sel:uploadIdMarker:ListMultipartUploads', listMultipartUploadsResponse_uploadIdMarker - Upload ID after which listing began.

$sel:maxUploads:ListMultipartUploads', listMultipartUploadsResponse_maxUploads - Maximum number of multipart uploads that could have been included in the response.

$sel:nextKeyMarker:ListMultipartUploadsResponse', listMultipartUploadsResponse_nextKeyMarker - When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

$sel:uploads:ListMultipartUploadsResponse', listMultipartUploadsResponse_uploads - Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

$sel:isTruncated:ListMultipartUploadsResponse', listMultipartUploadsResponse_isTruncated - 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.

$sel:nextUploadIdMarker:ListMultipartUploadsResponse', listMultipartUploadsResponse_nextUploadIdMarker - 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.

$sel:delimiter:ListMultipartUploads', listMultipartUploadsResponse_delimiter - Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

$sel:httpStatus:ListMultipartUploadsResponse', listMultipartUploadsResponse_httpStatus - The response's http status code.

Response Lenses

listMultipartUploadsResponse_prefix :: 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.

listMultipartUploadsResponse_commonPrefixes :: Lens' ListMultipartUploadsResponse (Maybe [CommonPrefix]) Source #

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

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

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

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

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

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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

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

listMultipartUploadsResponse_nextKeyMarker :: 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.

listMultipartUploadsResponse_uploads :: Lens' ListMultipartUploadsResponse (Maybe [MultipartUpload]) Source #

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

listMultipartUploadsResponse_isTruncated :: 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.

listMultipartUploadsResponse_nextUploadIdMarker :: 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.

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

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.