Skip to content

Commit

Permalink
Improve names of SoS tags
Browse files Browse the repository at this point in the history
  • Loading branch information
shepazon authored and DavidSouther committed Nov 25, 2024
1 parent 836db03 commit 6f9f438
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions swift/example_code/s3/multipart-upload/Sources/entry.swift
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
/// An example demonstrating how to perform multi-part uploads to Amazon S3
/// using the AWS SDK for Swift.

// snippet-start:[swift.s3.multipart-upload-upload.imports]
// snippet-start:[swift.s3.multipart-upload.imports]
import ArgumentParser
import AsyncHTTPClient
import AWSClientRuntime
import AWSS3
import Foundation
import Smithy
// snippet-end:[swift.s3.multipart-upload-upload.imports]
// snippet-end:[swift.s3.multipart-upload.imports]

// -MARK: - Async command line tool

Expand Down Expand Up @@ -113,7 +113,7 @@ struct ExampleCommand: ParsableCommand {
print("Done. Uploaded as \(fileName) in bucket \(bucket).")
}

// snippet-start:[swift.s3.multipart-upload.create]
// snippet-start:[swift.s3.multipart-upload.CreateMultipartUpload]
/// Start a multi-part upload to Amazon S3.
/// - Parameters:
/// - bucket: The name of the bucket to upload into.
Expand Down Expand Up @@ -147,9 +147,9 @@ struct ExampleCommand: ParsableCommand {

return uploadID
}
// snippet-end:[swift.s3.multipart-upload.create]
// snippet-end:[swift.s3.multipart-upload.CreateMultipartUpload]

// snippet-start:[swift.s3.multipart-upload.upload-part]
// snippet-start:[swift.s3.multipart-upload.UploadPart]
/// Upload the specified data as part of an Amazon S3 multi-part upload.
///
/// - Parameters:
Expand All @@ -160,7 +160,7 @@ struct ExampleCommand: ParsableCommand {
/// - partNumber: The part number within the file that the specified data represents.
/// - data: The data to send as the specified object part number in the object.
///
/// - Throws: `TransferError.signingError`, `TransferError.uploadError`
/// - Throws: `TransferError.uploadError`
///
/// - Returns: A `CompletedPart` object describing the part that was uploaded.
/// contains the part number as well as the ETag returned by Amazon S3.
Expand All @@ -186,13 +186,11 @@ struct ExampleCommand: ParsableCommand {
throw TransferError.uploadError(error.localizedDescription)
}
}
// snippet-end:[swift.s3.multipart-upload.upload-part]
// snippet-end:[swift.s3.multipart-upload.UploadPart]

// snippet-start:[swift.s3.multipart-upload.upload-complete]
/// Complete a multi-part upload by creating a `CompletedMultipartUpload`
/// with the array of completed part descriptions. This is used as the
/// value of the `multipartUpload` property when calling
/// `completeMultipartUpload(input:)`.
// snippet-start:[swift.s3.multipart-upload.CompleteMultipartUpload]
/// Complete a multi-part upload using an array of `CompletedMultipartUpload`
/// objects describing the completed parts.
///
/// - Parameters:
/// - client: The S3Client to finish uploading with.
Expand All @@ -219,7 +217,7 @@ struct ExampleCommand: ParsableCommand {
throw TransferError.multipartFinishError(error.localizedDescription)
}
}
// snippet-end:[swift.s3.multipart-upload.upload-complete]
// snippet-end:[swift.s3.multipart-upload.CompleteMultipartUpload]

// -MARK: - File access

Expand Down

0 comments on commit 6f9f438

Please sign in to comment.