/aws-sdk-net

Official mirror of the AWS SDK for .NET. For more information on the AWS SDK for .NET, see our web site:

Primary LanguageC#Apache License 2.0Apache-2.0

AWS SDK for .NET Build Status

The AWS SDK for .NET enables .NET developers to easily work with Amazon Web Services and build scalable solutions with Amazon S3, Amazon DynamoDB, Amazon Glacier, and more. You can get started in minutes using NuGet or by getting the source code.

Features

  • Provides easy-to-use HTTP clients for all supported AWS services, regions, and authentication protocols.
  • Amazon DynamoDB Object Persistence Framework - Uses Plain Old C# Objects (POCOs) to store and retrieve Amazon DynamoDB data.
  • Amazon S3 Transfer Utility - With a simple API, achieves enhanced throughput, performance, and reliability by using multi-threaded Amazon S3 multi-part calls.
  • Amazon Glacier ArchiveTransferManager - Eases transferring data to and from Amazon Glacier by automatically dividing large files into parts and by computing check sums.
  • Automatically uses IAM Instance Profile Credentials on configured Amazon EC2 instances.
  • Support for Windows Store and Windows Phone apps.
  • And more!

Getting Started

  1. Sign up for AWS - Before you begin, you need an AWS account. Please see the AWS Account and Credentials section of the developer guide for information about how to create an AWS account and retrieve your AWS credentials.
  2. Minimum requirements - To run the SDK you need the Microsoft .NET Framework 3.5 or later. For more information about the requirements and optimum settings for the SDK, please see the .NET Development Environment section of the developer guide.
  3. Install the SDK - Using NuGet is the easiest way to add the AWS SDK for .NET to a Visual Studio project. Simply type the following in the Package Manager Console: 'Install-Package AWSSDK'
  4. Using the SDK - The best way to become familiar with how to use the SDK is to read the Developer Guide.

Source Layout

Solutions

There are 2 main solutions used for the development of the SDK. AWSSDK_DotNet.Core.sln is used to develop the .NET 3.5 and .NET 4.5 version of the SDK. The AWSSDK_DotNet.Mobile.sln is used for windows store and windows phone versions of the SDK. Windows 8.1 or Windows Server 2012 R2 is required to build this solution.

Tests

Important: Do not run the integration tests on a production account.

Integration tests can be found in the AWSSDK_DotNet.IntegrationTests project. These test assume that a default profile has been configured for credentials. For information about setting up a default profile read the Developer Guide.

The tests are designed to create and delete the resources needed for testing but it is important to keep your data safe. Do not run these tests on accounts that contain production data or resources. Since AWS resources are created and deleted during the running of these tests, charges can occur. To reduce charges occurred by running the tests the test focus on AWS resources that have minimal cost.

Unit tests can be found in the AWSSDK_DotNet.UnitTests project.

Code Generator

All low-level service clients are created using the code generator found in the ServiceClientGenerator folder. The code generator uses the service models defined in the ServiceModels folder. The easiest way to run the code generator is to set the ServiceClientGenerator as the startup project in the AWSSDK_DotNet.Core.sln solution.