libZSservicesZSamazonka-glacierZSamazonka-glacier
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.Glacier.ListParts

Description

This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.

The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Parts in the Amazon Glacier Developer Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data ListParts Source #

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

See: newListParts smart constructor.

Constructors

ListParts' 

Fields

  • marker :: Maybe Text

    An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

  • limit :: Maybe Text

    The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.

  • accountId :: Text

    The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

  • vaultName :: Text

    The name of the vault.

  • uploadId :: Text

    The upload ID of the multipart upload.

Instances

Instances details
Eq ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

(==) :: ListParts -> ListParts -> Bool #

(/=) :: ListParts -> ListParts -> Bool #

Read ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

readsPrec :: Int -> ReadS ListParts #

readList :: ReadS [ListParts] #

readPrec :: ReadPrec ListParts #

readListPrec :: ReadPrec [ListParts] #

Show ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

showsPrec :: Int -> ListParts -> ShowS #

show :: ListParts -> String #

showList :: [ListParts] -> ShowS #

Generic ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Associated Types

type Rep ListParts :: Type -> Type #

Methods

from :: ListParts -> Rep ListParts x #

to :: Rep ListParts x -> ListParts #

NFData ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

rnf :: ListParts -> () #

Hashable ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

hashWithSalt :: Int -> ListParts -> Int #

hash :: ListParts -> Int #

AWSPager ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

page :: ListParts -> AWSResponse ListParts -> Maybe ListParts #

AWSRequest ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Associated Types

type AWSResponse ListParts #

Methods

request :: ListParts -> Request ListParts #

response :: MonadResource m => Logger -> Service -> Proxy ListParts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListParts))) #

ToHeaders ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

toHeaders :: ListParts -> [Header] #

ToPath ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

toPath :: ListParts -> ByteString #

ToQuery ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

toQuery :: ListParts -> QueryString #

type Rep ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

type Rep ListParts = D1 ('MetaData "ListParts" "Amazonka.Glacier.ListParts" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "ListParts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "uploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListParts Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

type AWSResponse ListParts = ListPartsResponse

newListParts Source #

Arguments

:: Text

$sel:accountId:ListParts'

-> Text

$sel:vaultName:ListParts'

-> Text

$sel:uploadId:ListParts'

-> ListParts 

Create a value of ListParts 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:marker:ListParts', listParts_marker - An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

$sel:limit:ListParts', listParts_limit - The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.

$sel:accountId:ListParts', listParts_accountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

$sel:vaultName:ListParts', listParts_vaultName - The name of the vault.

$sel:uploadId:ListParts', listParts_uploadId - The upload ID of the multipart upload.

Request Lenses

listParts_marker :: Lens' ListParts (Maybe Text) Source #

An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

listParts_limit :: Lens' ListParts (Maybe Text) Source #

The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.

listParts_accountId :: Lens' ListParts Text Source #

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

listParts_vaultName :: Lens' ListParts Text Source #

The name of the vault.

listParts_uploadId :: Lens' ListParts Text Source #

The upload ID of the multipart upload.

Destructuring the Response

data ListPartsResponse Source #

Contains the Amazon S3 Glacier response to your request.

See: newListPartsResponse smart constructor.

Constructors

ListPartsResponse' 

Fields

  • parts :: Maybe [PartListElement]

    A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

  • multipartUploadId :: Maybe Text

    The ID of the upload to which the parts are associated.

  • partSizeInBytes :: Maybe Integer

    The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

  • archiveDescription :: Maybe Text

    The description of the archive that was specified in the Initiate Multipart Upload request.

  • vaultARN :: Maybe Text

    The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

  • marker :: Maybe Text

    An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.

  • creationDate :: Maybe Text

    The UTC time at which the multipart upload was initiated.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListPartsResponse Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

(==) :: ListPartsResponse -> ListPartsResponse -> Bool #

(/=) :: ListPartsResponse -> ListPartsResponse -> Bool #

Read ListPartsResponse Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

readsPrec :: Int -> ReadS ListPartsResponse #

readList :: ReadS [ListPartsResponse] #

readPrec :: ReadPrec ListPartsResponse #

readListPrec :: ReadPrec [ListPartsResponse] #

Show ListPartsResponse Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

showsPrec :: Int -> ListPartsResponse -> ShowS #

show :: ListPartsResponse -> String #

showList :: [ListPartsResponse] -> ShowS #

Generic ListPartsResponse Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Associated Types

type Rep ListPartsResponse :: Type -> Type #

Methods

from :: ListPartsResponse -> Rep ListPartsResponse x #

to :: Rep ListPartsResponse x -> ListPartsResponse #

NFData ListPartsResponse Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

Methods

rnf :: ListPartsResponse -> () #

type Rep ListPartsResponse Source # 
Instance details

Defined in Amazonka.Glacier.ListParts

type Rep ListPartsResponse = D1 ('MetaData "ListPartsResponse" "Amazonka.Glacier.ListParts" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "ListPartsResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "parts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PartListElement])) :*: S1 ('MetaSel ('Just "multipartUploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "partSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "archiveDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "vaultARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListPartsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListPartsResponse'

-> ListPartsResponse 

Create a value of ListPartsResponse 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:parts:ListPartsResponse', listPartsResponse_parts - A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

$sel:multipartUploadId:ListPartsResponse', listPartsResponse_multipartUploadId - The ID of the upload to which the parts are associated.

$sel:partSizeInBytes:ListPartsResponse', listPartsResponse_partSizeInBytes - The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

$sel:archiveDescription:ListPartsResponse', listPartsResponse_archiveDescription - The description of the archive that was specified in the Initiate Multipart Upload request.

$sel:vaultARN:ListPartsResponse', listPartsResponse_vaultARN - The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

$sel:marker:ListParts', listPartsResponse_marker - An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.

$sel:creationDate:ListPartsResponse', listPartsResponse_creationDate - The UTC time at which the multipart upload was initiated.

$sel:httpStatus:ListPartsResponse', listPartsResponse_httpStatus - The response's http status code.

Response Lenses

listPartsResponse_parts :: Lens' ListPartsResponse (Maybe [PartListElement]) Source #

A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

listPartsResponse_multipartUploadId :: Lens' ListPartsResponse (Maybe Text) Source #

The ID of the upload to which the parts are associated.

listPartsResponse_partSizeInBytes :: Lens' ListPartsResponse (Maybe Integer) Source #

The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

listPartsResponse_archiveDescription :: Lens' ListPartsResponse (Maybe Text) Source #

The description of the archive that was specified in the Initiate Multipart Upload request.

listPartsResponse_vaultARN :: Lens' ListPartsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

listPartsResponse_marker :: Lens' ListPartsResponse (Maybe Text) Source #

An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.

listPartsResponse_creationDate :: Lens' ListPartsResponse (Maybe Text) Source #

The UTC time at which the multipart upload was initiated.

listPartsResponse_httpStatus :: Lens' ListPartsResponse Int Source #

The response's http status code.