Skip to content

Commit

Permalink
Release v0.9.0 (2019-05-28)
Browse files Browse the repository at this point in the history
Services
---
* Synced the V2 SDK with latests AWS service API definitions.
* Fixes [aws#304](aws#304)
* Fixes [aws#295](aws#295)

SDK Breaking changes
---
This update includes multiple breaking changes to the SDK. These updates improve the SDK's usability, consistency.

Client type name
---
The API client type is renamed to `Client` for consistency, and remove stutter between package and client type name. Using Amazon S3 API client as an example, the `s3.S3` type is renamed to `s3.Client`.

New API operation response type
---
API operations' `Request.Send` method now returns a Response type for the specific operation. The Response type wraps the operation's Output parameter, and includes a method for the response's metadata such as RequestID. The Output type is an annonymous embedded field within the Output type. If your application was passing the Output value around you'll need to extract it directly, or pass the Response type instead.

New API operation paginator utility
---
This change removes the `Paginate` method from API operation Request types, (e.g. ListObjectsRequest). A new Paginator constructor is added that can be used to page these operations. To update your application to use the new pattern, where `Paginate` was being called, replace this with the Paginator type's constructor. The usage of the returned Paginator type is unchanged.

```go
req := svc.ListObjectsRequest(params)
p := req.Paginate()
```

Is updated to to use the Paginator constructor instead of Paginate method.

```go
req := svc.ListObjectsRequest(params)
p := s3.NewListObjectsPaginator(req)
```

Other changes
---
  * Standardizes API client package name to be based on the API model's `ServiceID`.
  * Standardizes API client operation input and output type names.
  * Removes `endpoints` package's service identifier constants. These values were unstable. Each API client package contains an `EndpointsID` constant that can be used for service specific endpoint lookup.
  * Fix API endpoint lookups to use the API's modeled `EndpointsID` (aka `enpdointPrefix`). Searching for API endpoints in the `endpoints` package should use the API client package's, `EndpointsID`.

SDK Enhancements
---
*  Update CI tests to ensure all codegen changes are accounted for in PR ([aws#183](aws#183))
  * Updates the CI tests to ensure that any code generation changes are accounted for in the PR, and that there were no mistaken changes made without also running code generation. This change should also help ensure that code generation order is stable, and there are no ordering issues with the SDK's codegen.
  * Related [aws/aws-sdk-go#1966](aws/aws-sdk-go#1966)

* `service/dynamodb/expression`: Fix Builder with KeyCondition example ([aws#306](aws#306))
  * Fixes the ExampleBuilder_WithKeyCondition example to include the ExpressionAttributeNames member being set.
  * Fixes [aws#285](aws#285)
* `aws/defaults`: Fix UserAgent execution environment key ([aws#307](aws#307))
  * Fixes the SDK's UserAgent key for the execution environment.
  * Fixes [aws#276](aws#276)
* `private/model/api`: Improve SDK API reference doc generation ([aws#309](aws#309))
  * Improves the SDK's generated documentation for API client, operation, and types. This fixes several bugs in the doc generation causing poor formatting, an difficult to read reference documentation.
  * Fix [aws#308](aws#308)
  * Related [aws/aws-sdk-go#2617](aws/aws-sdk-go#2617)
  • Loading branch information
jasdel committed May 28, 2019
1 parent 95160f5 commit 5da7dc0
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 1 deletion.
55 changes: 55 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,58 @@
Release v0.9.0 (2019-05-28)
===

### Services
* Synced the V2 SDK with latests AWS service API definitions.
* Fixes [#304](https://github.com/aws/aws-sdk-go-v2/issues/304)
* Fixes [#295](https://github.com/aws/aws-sdk-go-v2/issues/295)

### SDK Breaking changes
This update includes multiple breaking changes to the SDK. These updates improve the SDK's usability, consistency.

#### Client type name
The API client type is renamed to `Client` for consistency, and remove stutter between package and client type name. Using Amazon S3 API client as an example, the `s3.S3` type is renamed to `s3.Client`.

#### New API operation response type
API operations' `Request.Send` method now returns a Response type for the specific operation. The Response type wraps the operation's Output parameter, and includes a method for the response's metadata such as RequestID. The Output type is an annonymous embedded field within the Output type. If your application was passing the Output value around you'll need to extract it directly, or pass the Response type instead.

#### New API operation paginator utility
This change removes the `Paginate` method from API operation Request types, (e.g. ListObjectsRequest). A new Paginator constructor is added that can be used to page these operations. To update your application to use the new pattern, where `Paginate` was being called, replace this with the Paginator type's constructor. The usage of the returned Paginator type is unchanged.

```go
req := svc.ListObjectsRequest(params)
p := req.Paginate()
```

Is updated to to use the Paginator constructor instead of Paginate method.

```go
req := svc.ListObjectsRequest(params)
p := s3.NewListObjectsPaginator(req)
```

#### Other changes
* Standardizes API client package name to be based on the API model's `ServiceID`.
* Standardizes API client operation input and output type names.
* Removes `endpoints` package's service identifier constants. These values were unstable. Each API client package contains an `EndpointsID` constant that can be used for service specific endpoint lookup.
* Fix API endpoint lookups to use the API's modeled `EndpointsID` (aka `enpdointPrefix`). Searching for API endpoints in the `endpoints` package should use the API client package's, `EndpointsID`.

### SDK Enhancements
* Update CI tests to ensure all codegen changes are accounted for in PR ([#183](https://github.com/aws/aws-sdk-go-v2/issues/183))
* Updates the CI tests to ensure that any code generation changes are accounted for in the PR, and that there were no mistaken changes made without also running code generation. This change should also help ensure that code generation order is stable, and there are no ordering issues with the SDK's codegen.
* Related [aws/aws-sdk-go#1966](https://github.com/aws/aws-sdk-go/issues/1966)

### SDK Bugs
* `service/dynamodb/expression`: Fix Builder with KeyCondition example ([#306](https://github.com/aws/aws-sdk-go-v2/issues/306))
* Fixes the ExampleBuilder_WithKeyCondition example to include the ExpressionAttributeNames member being set.
* Fixes [#285](https://github.com/aws/aws-sdk-go-v2/issues/285)
* `aws/defaults`: Fix UserAgent execution environment key ([#307](https://github.com/aws/aws-sdk-go-v2/issues/307))
* Fixes the SDK's UserAgent key for the execution environment.
* Fixes [#276](https://github.com/aws/aws-sdk-go-v2/issues/276)
* `private/model/api`: Improve SDK API reference doc generation ([#309](https://github.com/aws/aws-sdk-go-v2/issues/309))
* Improves the SDK's generated documentation for API client, operation, and types. This fixes several bugs in the doc generation causing poor formatting, an difficult to read reference documentation.
* Fix [#308](https://github.com/aws/aws-sdk-go-v2/issues/308)
* Related [aws/aws-sdk-go#2617](https://github.com/aws/aws-sdk-go/issues/2617)

Release v0.8.0 (2019-04-25)
===

Expand Down
2 changes: 1 addition & 1 deletion aws/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ package aws
const SDKName = "aws-sdk-go"

// SDKVersion is the version of this SDK
const SDKVersion = "0.8.0"
const SDKVersion = "0.9.0"

0 comments on commit 5da7dc0

Please sign in to comment.