github.com/aavshr/aws-sdk-go@v1.41.3/service/workdocs/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package workdocs provides the client and types for making API
     4  // requests to Amazon WorkDocs.
     5  //
     6  // The WorkDocs API is designed for the following use cases:
     7  //
     8  //    * File Migration: File migration applications are supported for users
     9  //    who want to migrate their files from an on-premises or off-premises file
    10  //    system or service. Users can insert files into a user directory structure,
    11  //    as well as allow for basic metadata changes, such as modifications to
    12  //    the permissions of files.
    13  //
    14  //    * Security: Support security applications are supported for users who
    15  //    have additional security needs, such as antivirus or data loss prevention.
    16  //    The API actions, along with AWS CloudTrail, allow these applications to
    17  //    detect when changes occur in Amazon WorkDocs. Then, the application can
    18  //    take the necessary actions and replace the target file. If the target
    19  //    file violates the policy, the application can also choose to email the
    20  //    user.
    21  //
    22  //    * eDiscovery/Analytics: General administrative applications are supported,
    23  //    such as eDiscovery and analytics. These applications can choose to mimic
    24  //    or record the actions in an Amazon WorkDocs site, along with AWS CloudTrail,
    25  //    to replicate data for eDiscovery, backup, or analytical applications.
    26  //
    27  // All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
    28  // They not only require the use of the AWS SDK, but also allow for the exclusive
    29  // use of IAM users and roles to help facilitate access, trust, and permission
    30  // policies. By creating a role and allowing an IAM user to access the Amazon
    31  // WorkDocs site, the IAM user gains full administrative visibility into the
    32  // entire Amazon WorkDocs site (or as set in the IAM policy). This includes,
    33  // but is not limited to, the ability to modify file permissions and upload
    34  // any file to any user. This allows developers to perform the three use cases
    35  // above, as well as give users the ability to grant access on a selective basis
    36  // using the IAM model.
    37  //
    38  // See https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01 for more information on this service.
    39  //
    40  // See workdocs package documentation for more information.
    41  // https://docs.aws.amazon.com/sdk-for-go/api/service/workdocs/
    42  //
    43  // Using the Client
    44  //
    45  // To contact Amazon WorkDocs with the SDK use the New function to create
    46  // a new service client. With that client you can make API requests to the service.
    47  // These clients are safe to use concurrently.
    48  //
    49  // See the SDK's documentation for more information on how to use the SDK.
    50  // https://docs.aws.amazon.com/sdk-for-go/api/
    51  //
    52  // See aws.Config documentation for more information on configuring SDK clients.
    53  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    54  //
    55  // See the Amazon WorkDocs client WorkDocs for more
    56  // information on creating client for this service.
    57  // https://docs.aws.amazon.com/sdk-for-go/api/service/workdocs/#New
    58  package workdocs