Network.AWS.Glacier.ListParts

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 1,000 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 Glacier and List Parts in the Amazon Glacier Developer Guide .

This operation returns paginated results.

Creating a Request

listParts

Arguments

:: Text

lpAccountId

-> Text

lpVaultName

-> Text

lpUploadId

-> ListParts

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

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

• lpMarker - 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.
• lpLimit - The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.
• lpAccountId - 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 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.
• lpVaultName - The name of the vault.
• lpUploadId - The upload ID of the multipart upload.

data ListParts

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

See: listParts smart constructor.

Instances

Eq ListParts

Methods

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

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

Data ListParts

Methods

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

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

toConstr :: ListParts -> Constr

dataTypeOf :: ListParts -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ListParts -> ListParts

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

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

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

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

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

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

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

Read ListParts

Methods

readsPrec :: Int -> ReadS ListParts

readList :: ReadS [ListParts]

readPrec :: ReadPrec ListParts

readListPrec :: ReadPrec [ListParts]

Show ListParts

Methods

showsPrec :: Int -> ListParts -> ShowS

show :: ListParts -> String

showList :: [ListParts] -> ShowS

Generic ListParts

Associated Types

type Rep ListParts :: * -> *

Methods

from :: ListParts -> Rep ListParts x

to :: Rep ListParts x -> ListParts

Hashable ListParts

Methods

hashWithSalt :: Int -> ListParts -> Int

hash :: ListParts -> Int

NFData ListParts

Methods

rnf :: ListParts -> ()

AWSPager ListParts

Methods

page :: ListParts -> Rs ListParts -> Maybe ListParts

AWSRequest ListParts

Associated Types

type Rs ListParts :: *

Methods

request :: ListParts -> Request ListParts

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListParts -> ClientResponse -> m (Response ListParts)

ToHeaders ListParts

Methods

toHeaders :: ListParts -> [Header]

ToPath ListParts

Methods

toPath :: ListParts -> ByteString

ToQuery ListParts

Methods

toQuery :: ListParts -> QueryString

type Rep ListParts

type Rep ListParts = D1 * (MetaData "ListParts" "Network.AWS.Glacier.ListParts" "amazonka-glacier-1.6.0-KFcSJp5ylrGJYtfh8aD2JF" False) (C1 * (MetaCons "ListParts'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lpLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lpAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_lpVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_lpUploadId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs ListParts

type Rs ListParts = ListPartsResponse

Request Lenses

lpMarker :: Lens' ListParts (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.

lpLimit :: Lens' ListParts (Maybe Text)

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

lpAccountId :: Lens' ListParts 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 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.

lpVaultName :: Lens' ListParts Text

The name of the vault.

lpUploadId :: Lens' ListParts Text

The upload ID of the multipart upload.

Destructuring the Response

listPartsResponse

Arguments

:: Int

lprsResponseStatus

-> ListPartsResponse

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

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

• lprsParts - 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.
• lprsMultipartUploadId - The ID of the upload to which the parts are associated.
• lprsPartSizeInBytes - The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.
• lprsArchiveDescription - The description of the archive that was specified in the Initiate Multipart Upload request.
• lprsVaultARN - The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.
• lprsMarker - 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 .
• lprsCreationDate - The UTC time at which the multipart upload was initiated.
• lprsResponseStatus - -- | The response status code.

data ListPartsResponse

Contains the Amazon Glacier response to your request.

See: listPartsResponse smart constructor.

Instances

Eq ListPartsResponse

Methods

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

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

Data ListPartsResponse

Methods

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

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

toConstr :: ListPartsResponse -> Constr

dataTypeOf :: ListPartsResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ListPartsResponse -> ListPartsResponse

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

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

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

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

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

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

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

Read ListPartsResponse

Methods

readsPrec :: Int -> ReadS ListPartsResponse

readList :: ReadS [ListPartsResponse]

readPrec :: ReadPrec ListPartsResponse

readListPrec :: ReadPrec [ListPartsResponse]

Show ListPartsResponse

Methods

showsPrec :: Int -> ListPartsResponse -> ShowS

show :: ListPartsResponse -> String

showList :: [ListPartsResponse] -> ShowS

Generic ListPartsResponse

Associated Types

type Rep ListPartsResponse :: * -> *

Methods

from :: ListPartsResponse -> Rep ListPartsResponse x

to :: Rep ListPartsResponse x -> ListPartsResponse

NFData ListPartsResponse

Methods

rnf :: ListPartsResponse -> ()

type Rep ListPartsResponse

type Rep ListPartsResponse = D1 * (MetaData "ListPartsResponse" "Network.AWS.Glacier.ListParts" "amazonka-glacier-1.6.0-KFcSJp5ylrGJYtfh8aD2JF" False) (C1 * (MetaCons "ListPartsResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lprsParts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PartListElement]))) (S1 * (MetaSel (Just Symbol "_lprsMultipartUploadId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lprsPartSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) (S1 * (MetaSel (Just Symbol "_lprsArchiveDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lprsVaultARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lprsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lprsCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

lprsParts :: Lens' ListPartsResponse [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.

lprsMultipartUploadId :: Lens' ListPartsResponse (Maybe Text)

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

lprsPartSizeInBytes :: Lens' ListPartsResponse (Maybe Integer)

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

lprsArchiveDescription :: Lens' ListPartsResponse (Maybe Text)

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

lprsVaultARN :: Lens' ListPartsResponse (Maybe Text)

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

lprsMarker :: Lens' ListPartsResponse (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 .

lprsCreationDate :: Lens' ListPartsResponse (Maybe Text)

The UTC time at which the multipart upload was initiated.

lprsResponseStatus :: Lens' ListPartsResponse Int

• - | The response status code.