vendor/github.com/aws/aws-sdk-go/service/s3/doc.go

   1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
   2
   3 // Package s3 provides the client and types for making API
   4 // requests to Amazon Simple Storage Service.
   5 //
   6 // See https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01 for more information on this service.
   7 //
   8 // See s3 package documentation for more information.
   9 // https://docs.aws.amazon.com/sdk-for-go/api/service/s3/
  10 //
  11 // Using the Client
  12 //
  13 // To use the client for Amazon Simple Storage Service you will first need
  14 // to create a new instance of it.
  15 //
  16 // When creating a client for an AWS service you'll first need to have a Session
  17 // already created. The Session provides configuration that can be shared
  18 // between multiple service clients. Additional configuration can be applied to
  19 // the Session and service's client when they are constructed. The aws package's
  20 // Config type contains several fields such as Region for the AWS Region the
  21 // client should make API requests too. The optional Config value can be provided
  22 // as the variadic argument for Sessions and client creation.
  23 //
  24 // Once the service's client is created you can use it to make API requests the
  25 // AWS service. These clients are safe to use concurrently.
  26 //
  27 //   // Create a session to share configuration, and load external configuration.
  28 //   sess := session.Must(session.NewSession())
  29 //
  30 //   // Create the service's client with the session.
  31 //   svc := s3.New(sess)
  32 //
  33 // See the SDK's documentation for more information on how to use service clients.
  34 // https://docs.aws.amazon.com/sdk-for-go/api/
  35 //
  36 // See aws package's Config type for more information on configuration options.
  37 // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  38 //
  39 // See the Amazon Simple Storage Service client S3 for more
  40 // information on creating the service's client.
  41 // https://docs.aws.amazon.com/sdk-for-go/api/service/s3/#New
  42 //
  43 // Once the client is created you can make an API request to the service.
  44 // Each API method takes a input parameter, and returns the service response
  45 // and an error.
  46 //
  47 // The API method will document which error codes the service can be returned
  48 // by the operation if the service models the API operation's errors. These
  49 // errors will also be available as const strings prefixed with "ErrCode".
  50 //
  51 //   result, err := svc.AbortMultipartUpload(params)
  52 //   if err != nil {
  53 //       // Cast err to awserr.Error to handle specific error codes.
  54 //       aerr, ok := err.(awserr.Error)
  55 //       if ok && aerr.Code() == <error code to check for> {
  56 //           // Specific error code handling
  57 //       }
  58 //       return err
  59 //   }
  60 //
  61 //   fmt.Println("AbortMultipartUpload result:")
  62 //   fmt.Println(result)
  63 //
  64 // Using the Client with Context
  65 //
  66 // The service's client also provides methods to make API requests with a Context
  67 // value. This allows you to control the timeout, and cancellation of pending
  68 // requests. These methods also take request Option as variadic parameter to apply
  69 // additional configuration to the API request.
  70 //
  71 //   ctx := context.Background()
  72 //
  73 //   result, err := svc.AbortMultipartUploadWithContext(ctx, params)
  74 //
  75 // See the request package documentation for more information on using Context pattern
  76 // with the SDK.
  77 // https://docs.aws.amazon.com/sdk-for-go/api/aws/request/
  78 package s3