Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # を使用した Amazon Glacier の例 SDK for .NET 次のコード例は、Amazon Glacier AWS SDK for .NET で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。 **Topics** + [はじめに](#get_started) + [アクション](#actions) ## はじめに ### Hello Amazon Glacier 次のコード例は、Amazon Glacier の使用を開始する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/EventBridge#code-examples)での設定と実行の方法を確認してください。 ``` using Amazon.Glacier; using Amazon.Glacier.Model; namespace GlacierActions; public static class HelloGlacier { static async Task Main() { var glacierService = new AmazonGlacierClient(); Console.WriteLine("Hello Amazon Glacier!"); Console.WriteLine("Let's list your Glacier vaults:"); // You can use await and any of the async methods to get a response. // Let's get the vaults using a paginator. var glacierVaultPaginator = glacierService.Paginators.ListVaults( new ListVaultsRequest { AccountId = "-" }); await foreach (var vault in glacierVaultPaginator.VaultList) { Console.WriteLine($"{vault.CreationDate}:{vault.VaultName}, ARN:{vault.VaultARN}"); } } } ``` + API の詳細については、**「AWS SDK for .NET API リファレンス」の「[ListVaults](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/ListVaults)」を参照してください。 ## アクション ### `AddTagsToVault` 次のコード例は、`AddTagsToVault` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ``` /// /// Add tags to the items in an Amazon S3 Glacier vault. /// /// The name of the vault to add tags to. /// The name of the object to tag. /// The tag value to add. /// A Boolean value indicating the success of the action. public async Task AddTagsToVaultAsync(string vaultName, string key, string value) { var request = new AddTagsToVaultRequest { Tags = new Dictionary { { key, value }, }, AccountId = "-", VaultName = vaultName, }; var response = await _glacierService.AddTagsToVaultAsync(request); return response.HttpStatusCode == HttpStatusCode.NoContent; } ``` + API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[AddTagsToVault](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/AddTagsToVault)」を参照してください。 ### `CreateVault` 次のコード例は、`CreateVault` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ``` /// /// Create an Amazon S3 Glacier vault. /// /// The name of the vault to create. /// A Boolean value indicating the success of the action. public async Task CreateVaultAsync(string vaultName) { var request = new CreateVaultRequest { // Setting the AccountId to "-" means that // the account associated with the current // account will be used. AccountId = "-", VaultName = vaultName, }; var response = await _glacierService.CreateVaultAsync(request); Console.WriteLine($"Created {vaultName} at: {response.Location}"); return response.HttpStatusCode == HttpStatusCode.Created; } ``` + API の詳細については、*AWS SDK for .NET API リファレンス*の「[CreateVault](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/CreateVault)」を参照してください。 ### `DescribeVault` 次のコード例は、`DescribeVault` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ``` /// /// Describe an Amazon S3 Glacier vault. /// /// The name of the vault to describe. /// The Amazon Resource Name (ARN) of the vault. public async Task DescribeVaultAsync(string vaultName) { var request = new DescribeVaultRequest { AccountId = "-", VaultName = vaultName, }; var response = await _glacierService.DescribeVaultAsync(request); // Display the information about the vault. Console.WriteLine($"{response.VaultName}\tARN: {response.VaultARN}"); Console.WriteLine($"Created on: {response.CreationDate}\tNumber of Archives: {response.NumberOfArchives}\tSize (in bytes): {response.SizeInBytes}"); if (response.LastInventoryDate != DateTime.MinValue) { Console.WriteLine($"Last inventory: {response.LastInventoryDate}"); } return response.VaultARN; } ``` + API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[DescribeVault](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/DescribeVault)」を参照してください。 ### `InitiateJob` 次のコード例は、`InitiateJob` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ボールトからアーカイブを取得します。この例では ArchiveTransferManager クラスを使用しています。API の詳細については、「[ArchiveTransferManager](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Glacier/TArchiveTransferManager)」を参照してください。 ``` /// /// Download an archive from an Amazon S3 Glacier vault using the Archive /// Transfer Manager. /// /// The name of the vault containing the object. /// The Id of the archive to download. /// The local directory where the file will /// be stored after download. /// Async Task. public async Task DownloadArchiveWithArchiveManagerAsync(string vaultName, string archiveId, string localFilePath) { try { var manager = new ArchiveTransferManager(_glacierService); var options = new DownloadOptions { StreamTransferProgress = Progress!, }; // Download an archive. Console.WriteLine("Initiating the archive retrieval job and then polling SQS queue for the archive to be available."); Console.WriteLine("When the archive is available, downloading will begin."); await manager.DownloadAsync(vaultName, archiveId, localFilePath, options); return true; } catch (AmazonGlacierException ex) { Console.WriteLine(ex.Message); return false; } } /// /// Event handler to track the progress of the Archive Transfer Manager. /// /// The object that raised the event. /// The argument values from the object that raised the /// event. static void Progress(object sender, StreamTransferProgressArgs args) { if (args.PercentDone != _currentPercentage) { _currentPercentage = args.PercentDone; Console.WriteLine($"Downloaded {_currentPercentage}%"); } } ``` + API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[InitiateJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/InitiateJob)」を参照してください。 ### `ListJobs` 次のコード例は、`ListJobs` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ``` /// /// List Amazon S3 Glacier jobs. /// /// The name of the vault to list jobs for. /// A list of Amazon S3 Glacier jobs. public async Task> ListJobsAsync(string vaultName) { var request = new ListJobsRequest { // Using a hyphen "-" for the Account Id will // cause the SDK to use the Account Id associated // with the current account. AccountId = "-", VaultName = vaultName, }; var response = await _glacierService.ListJobsAsync(request); return response.JobList; } ``` + API の詳細については、AWS SDK for .NET API リファレンスの**「[ListJobs](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/ListJobs)」を参照してください。 ### `ListTagsForVault` 次のコード例は、`ListTagsForVault` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ``` /// /// List tags for an Amazon S3 Glacier vault. /// /// The name of the vault to list tags for. /// A dictionary listing the tags attached to each object in the /// vault and its tags. public async Task> ListTagsForVaultAsync(string vaultName) { var request = new ListTagsForVaultRequest { // Using a hyphen "-" for the Account Id will // cause the SDK to use the Account Id associated // with the default user. AccountId = "-", VaultName = vaultName, }; var response = await _glacierService.ListTagsForVaultAsync(request); return response.Tags; } ``` + API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[ListTagsForVault](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/ListTagsForVault)」を参照してください。 ### `ListVaults` 次のコード例は、`ListVaults` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ``` /// /// List the Amazon S3 Glacier vaults associated with the current account. /// /// A list containing information about each vault. public async Task> ListVaultsAsync() { var glacierVaultPaginator = _glacierService.Paginators.ListVaults( new ListVaultsRequest { AccountId = "-" }); var vaultList = new List(); await foreach (var vault in glacierVaultPaginator.VaultList) { vaultList.Add(vault); } return vaultList; } ``` + API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[ListVaults](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/ListVaults)」を参照してください。 ### `UploadArchive` 次のコード例は、`UploadArchive` を使用する方法を示しています。 **SDK for .NET** GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Glacier#code-examples)での設定と実行の方法を確認してください。 ``` /// /// Upload an object to an Amazon S3 Glacier vault. /// /// The name of the Amazon S3 Glacier vault to upload /// the archive to. /// The file path of the archive to upload to the vault. /// A Boolean value indicating the success of the action. public async Task UploadArchiveWithArchiveManager(string vaultName, string archiveFilePath) { try { var manager = new ArchiveTransferManager(_glacierService); // Upload an archive. var response = await manager.UploadAsync(vaultName, "upload archive test", archiveFilePath); return response.ArchiveId; } catch (AmazonGlacierException ex) { Console.WriteLine(ex.Message); return string.Empty; } } ``` + API の詳細については、**AWS SDK for .NET API リファレンスの「[UploadArchive](https://docs.aws.amazon.com/goto/DotNetSDKV3/glacier-2012-06-01/UploadArchive)」を参照してください。