Skip to content
This repository was archived by the owner on Jul 31, 2025. It is now read-only.

Commit 7ce44f3

Browse files
committed
aws
1 parent 239002f commit 7ce44f3

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

aws/doc.go

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Package aws provides the core SDK's utilities and shared types. Use this package's
22
// utilities to simplify setting and reading API operations parameters.
33
//
4-
// Value and Pointer Conversion Utilities
4+
// # Value and Pointer Conversion Utilities
55
//
66
// This package includes a helper conversion utility for each scalar type the SDK's
77
// API use. These utilities make getting a pointer of the scalar, and dereferencing
@@ -16,33 +16,33 @@
1616
// to get pointer of a literal string value, because getting the address of a
1717
// literal requires assigning the value to a variable first.
1818
//
19-
// var strPtr *string
19+
// var strPtr *string
2020
//
21-
// // Without the SDK's conversion functions
22-
// str := "my string"
23-
// strPtr = &str
21+
// // Without the SDK's conversion functions
22+
// str := "my string"
23+
// strPtr = &str
2424
//
25-
// // With the SDK's conversion functions
26-
// strPtr = aws.String("my string")
25+
// // With the SDK's conversion functions
26+
// strPtr = aws.String("my string")
2727
//
28-
// // Convert *string to string value
29-
// str = aws.StringValue(strPtr)
28+
// // Convert *string to string value
29+
// str = aws.StringValue(strPtr)
3030
//
3131
// In addition to scalars the aws package also includes conversion utilities for
3232
// map and slice for commonly types used in API parameters. The map and slice
3333
// conversion functions use similar naming pattern as the scalar conversion
3434
// functions.
3535
//
36-
// var strPtrs []*string
37-
// var strs []string = []string{"Go", "Gophers", "Go"}
36+
// var strPtrs []*string
37+
// var strs []string = []string{"Go", "Gophers", "Go"}
3838
//
39-
// // Convert []string to []*string
40-
// strPtrs = aws.StringSlice(strs)
39+
// // Convert []string to []*string
40+
// strPtrs = aws.StringSlice(strs)
4141
//
42-
// // Convert []*string to []string
43-
// strs = aws.StringValueSlice(strPtrs)
42+
// // Convert []*string to []string
43+
// strs = aws.StringValueSlice(strPtrs)
4444
//
45-
// SDK Default HTTP Client
45+
// # SDK Default HTTP Client
4646
//
4747
// The SDK will use the http.DefaultClient if a HTTP client is not provided to
4848
// the SDK's Session, or service client constructor. This means that if the
@@ -53,4 +53,7 @@
5353
// a custom HTTP Client to share explicitly through your application. You can
5454
// configure the SDK to use the custom HTTP Client by setting the HTTPClient
5555
// value of the SDK's Config type when creating a Session or service client.
56+
//
57+
// Deprecated: aws-sdk-go is deprecated. Use aws-sdk-go-v2.
58+
// See https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-aws-sdk-for-go-v1-on-july-31-2025/.
5659
package aws

0 commit comments

Comments
 (0)