Permalink
d52522b Sep 28, 2018
1 contributor

Users who have contributed to this file

212 lines (158 sloc) 13 KB

Release v2.0.0-preview.5 (2018-09-19)

Services

  • Synced the V2 SDK with latests AWS service API definitions.

SDK Bugs

  • Fix SDK Go 1.11 connection reset handling (#207)
    • Fixes how the SDK checks for connection reset errors when making API calls to be compatiable with Go 1.11.
  • aws/signer/v4: Fix X-Amz-Content-Sha256 being in to query for presign (#188)
    • Fixes the bug which would allow the X-Amz-Content-Sha256 header to be promoted to the query string when presigning a S3 request. This bug also was preventing users from setting their own sha256 value for a presigned URL. Presigned requests generated with the custom sha256 would of always failed with invalid signature.
    • Related to aws/aws-sdk-go#1974

SDK Enhancements

  • Cleanup SDK README and example documenation.
  • service/s3/s3manager: Add doc for sequential download (#201) Adds documentation for downloading object sequentially with the S3 download manager.
  • aws/credentials: Update Credentials cache to have less overhead (#184)
    • Updates the Credentials type's cache of the CredentialsValue to be synchronized with an atomic value in addition to the Mutex. This reduces the overhead applications will encounter when many concurrent API requests are being made.
    • Related to: aws/aws-sdk-go#1973
  • service/dynamodb/dynamodbattribute: Add support for custom struct tag keys (#203)
    • Adds support for (un)marshaling Go types using custom struct tag keys. The new MarshalOptions.TagKey allows the user to specify the tag key to use when (un)marshaling struct fields. Adds support for struct tags such as yaml, toml, etc. Support for these keys are in name only, and require the tag value format and values to be supported by the package's Marshalers.
  • internal/ini: Add custom INI parser for shared config/credentials file (#209)
    • Related to: aws/aws-sdk-go#2024

Release v2.0.0-preview.4 (2018-05-25)

Services

  • Synced the V2 SDK with latests AWS service API definitions.

SDK Bugs

  • private/protocol/xml/xmlutil: Fix XML unmarshaler not correctly unmarshaling list of timestamp values (#166)
    • Fixes a bug in the XML unmarshaler that would incorrectly try to unmarshal "time.Time" parameters that did not have the struct tag type on them.
    • Related to aws/aws-sdk-go#1894
  • service/s3: Fix typos for migrated S3 specific config options (#173)
    • Updates the S3 specific config error messages to the correct fields.
  • aws/endpoints: Fix SDK endpoint signing name resolution (#181)
    • Fixes how the SDK derives service signing names. If the signing name is not modeled in the endpoints package the service will fallback to the signing name modeled in the service model.
    • Fix #163
    • Fix #153
    • Related to aws/aws-sdk-go#1854
  • service/s3: remove SelectContent until EventStream supported (#175
    • S3's SelectContent API is not functional in the SDK yet, and was not supposed to be generated until EventStream support is available.
    • Related to aws/aws-sdk-go#1941

SDK Enhancements

  • service/s3/s3manager/s3manageriface: Add WithIterator to mock interface (#156)
    • Updates the DownloaderAPI and UploaderAPI mocking interfaces to have parity with the concrete types.
    • Fixes #155

Release v2.0.0-preview.3 (2018-03-08)

Services

  • Synced the V2 SDK with latests AWS service API definitions.

Breaking Changes

  • private/mode/api: Refactor service paginator helpers to iterator pattern (#119)
    • Refactors the generated service client paginators to be an iterator pattern. This pattern improves usability while removing the need for callbacks.
    • See the linked PR for an example.
  • private/model/api: Removes setter helpers from service API types (#101)
  • aws: Rename CanceledErrorCode to ErrCodeRequestCanceled (#131)
    • Renames CanceledErrorCode to correct naming scheme.

SDK Bugs

  • internal/awsutil: Fix DeepEqual to consider string alias type equal to string (#102)
    • Fixes SDK waiters not detecting the correct condition is met. #92
  • aws/external: Fix EnvConfig misspelled container endpoint path getter (#106)
    • This caused the type to not satisfy the ContainerCredentialsEndpointPathProvider interface.
    • Fixes #105
  • service/s3/s3crypto: Fix S3Crypto's handling of TagLen (#107)
    • Fixes the S3Crypto's handling of TagLen to only be set if present.
    • V2 Fix for aws/aws-sdk-go#1742
  • private/model/api: Update SDK service client initialization documentation (#141)
    • Updates the SDK's service initialization doc template to reflect the v2 SDK's configuration update change from v1.
    • Related to #136

SDK Enhancements

  • aws: Improve pagination unit tests (#97)
  • aws/external: Add example for shared config and static credential helper (#109)
    • Adds examples for the config helpers; WithSharedConfigProfile, WithCredentialsValue, WithMFATokenFunc.
  • private/model/api: Add validation to prevent collision of api defintions (#112)
  • aws/ec2metadata: Add support for AWS_EC2_METADATA_DISABLED env var (#128)
    • When this environment variable is set. The SDK's EC2 Metadata Client will not attempt to make requests. All requests made with the EC2 Metadata Client will fail.
    • V2 port of aws/aws-sdk-go#1799
  • Add code of conduct (#138)
  • Update SDK README dep usage (#140)

Release v2.0.0-preview.2 (2018-01-15)

Services

  • Synced the V2 SDK with latests AWS service API definitions.

SDK Bugs

  • service/s3/s3manager: Fix Upload Manger's UploadInput fields (#89)
  • aws: Fix Pagination handling of empty string NextToken (#94)

Release v2.0.0-preview.1 (2017-12-21)

What has changed?

Our focus for the 2.0 SDK is to improve the SDK’s development experience and performance, make the SDK easy to extend, and add new features. The changes made in the Developer Preview target the major pain points of configuring the SDK and using AWS service API calls. Check out the SDK for details on pending changes that are in development and designs we’re discussing.

The following are some of the larger changes included in the AWS SDK for Go 2.0 Developer Preview.

SDK configuration

The 2.0 SDK simplifies how you configure the SDK's service clients by using a single Config type. This simplifies the Session and Config type interaction from the 1.x SDK. In addition, we’ve moved the service-specific configuration flags to the individual service client types. This reduces confusion about where service clients will use configuration members.

We added the external package to provide the utilities for you to use external configuration sources to populate the SDK's Config type. External sources include environmental variables, shared credentials file (~/.aws/credentials), and shared config file (~/.aws/config). By default, the 2.0 SDK will now automatically load configuration values from the shared config file. The external package also provides you with the tools to customize how the external sources are loaded and used to populate the Config type.

You can even customize external configuration sources to include your own custom sources, for example, JSON files or a custom file format.

Use LoadDefaultAWSConfig in the external package to create the default Config value, and load configuration values from the external configuration sources.

cfg, err := external.LoadDefaultAWSConfig()

To specify the shared configuration profile load used in code, use the WithSharedConfigProfile helper passed into LoadDefaultAWSConfig with the profile name to use.

cfg, err := external.LoadDefaultAWSConfig(
	external.WithSharedConfigProfile("gopher")
)

Once a Config value is returned by LoadDefaultAWSConfig, you can set or override configuration values by setting the fields on the Config struct, such as Region.

cfg.Region = endpoints.UsWest2RegionID

Use the cfg value to provide the loaded configuration to new AWS service clients.

svc := dynamodb.New(cfg)

API request methods

The 2.0 SDK consolidates several ways to make an API call, providing a single request constructor for each API call. This means that your application will create an API request from input parameters, then send it. This enables you to optionally modify and configure how the request will be sent. This includes, but isn’t limited to, modifications such as setting the Context per request, adding request handlers, and enabling logging.

Each API request method is suffixed with Request and returns a typed value for the specific API request.

As an example, to use the Amazon Simple Storage Service GetObject API, the signature of the method is:

func (c *S3) GetObjectRequest(*s3.GetObjectInput) *s3.GetObjectRequest

To use the GetObject API, we pass in the input parameters to the method, just like we would with the 1.x SDK. The 2.0 SDK's method will initialize a GetObjectRequest value that we can then use to send our request to Amazon S3.

req := svc.GetObjectRequest(params)

// Optionally, set the context or other configuration for the request to use
req.SetContext(ctx)

// Send the request and get the response
resp, err := req.Send()

API enumerations

The 2.0 SDK uses typed enumeration values for all API enumeration fields. This change provides you with the type safety that you and your IDE can leverage to discover which enumeration values are valid for particular fields. Typed enumeration values also provide a stronger type safety story for your application than using string literals directly. The 2.0 SDK uses string aliases for each enumeration type. The SDK also generates typed constants for each enumeration value. This change removes the need for enumeration API fields to be pointers, as a zero-value enumeration always means the field isn’t set.

For example, the Amazon Simple Storage Service PutObject API has a field, ACL ObjectCannedACL. An ObjectCannedACL string alias is defined within the s3 package, and each enumeration value is also defined as a typed constant. In this example, we want to use the typed enumeration values to set an uploaded object to have an ACL of public-read. The constant that the SDK provides for this enumeration value is ObjectCannedACLPublicRead.

svc.PutObjectRequest(&s3.PutObjectInput{
	Bucket: aws.String("myBucket"),
	Key:    aws.String("myKey"),
	ACL:    s3.ObjectCannedACLPublicRead,
	Body:   body,
})

API slice and map elements

The 2.0 SDK removes the need to convert slice and map elements from values to pointers for API calls. This will reduce the overhead of needing to use fields with a type, such as []string, in API calls. The 1.x SDK's pattern of using pointer types for all slice and map elements was a significant pain point for users, requiring them to convert between the types. The 2.0 SDK does away with the pointer types for slices and maps, using value types instead.

The following example shows how value types for the Amazon Simple Queue Service AddPermission API's AWSAccountIds and Actions member slices are set.

svc := sqs.New(cfg)

svc.AddPermission(&sqs.AddPermissionInput{
	AWSAcountIds: []string{
		"123456789",
	},
	Actions: []string{
		"SendMessage",
	},

	Label:    aws.String("MessageSender"),
	QueueUrl: aws.String(queueURL)
})