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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package securityhub provides the client and types for making API
     4  // requests to AWS SecurityHub.
     5  //
     6  // Security Hub provides you with a comprehensive view of the security state
     7  // of your Amazon Web Services environment and resources. It also provides you
     8  // with the readiness status of your environment based on controls from supported
     9  // security standards. Security Hub collects security data from Amazon Web Services
    10  // accounts, services, and integrated third-party products and helps you analyze
    11  // security trends in your environment to identify the highest priority security
    12  // issues. For more information about Security Hub, see the Security HubUser
    13  // Guide (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) .
    14  //
    15  // When you use operations in the Security Hub API, the requests are executed
    16  // only in the Amazon Web Services Region that is currently active or in the
    17  // specific Amazon Web Services Region that you specify in your request. Any
    18  // configuration or settings change that results from the operation is applied
    19  // only to that Region. To make the same change in other Regions, execute the
    20  // same command for each Region to apply the change to.
    21  //
    22  // For example, if your Region is set to us-west-2, when you use CreateMembers
    23  // to add a member account to Security Hub, the association of the member account
    24  // with the administrator account is created only in the us-west-2 Region. Security
    25  // Hub must be enabled for the member account in the same Region that the invitation
    26  // was sent from.
    27  //
    28  // The following throttling limits apply to using Security Hub API operations.
    29  //
    30  //    * BatchEnableStandards - RateLimit of 1 request per second, BurstLimit
    31  //    of 1 request per second.
    32  //
    33  //    * GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests
    34  //    per second.
    35  //
    36  //    * UpdateFindings - RateLimit of 1 request per second. BurstLimit of 5
    37  //    requests per second.
    38  //
    39  //    * UpdateStandardsControl - RateLimit of 1 request per second, BurstLimit
    40  //    of 5 requests per second.
    41  //
    42  //    * All other operations - RateLimit of 10 requests per second. BurstLimit
    43  //    of 30 requests per second.
    44  //
    45  // See https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26 for more information on this service.
    46  //
    47  // See securityhub package documentation for more information.
    48  // https://docs.aws.amazon.com/sdk-for-go/api/service/securityhub/
    49  //
    50  // Using the Client
    51  //
    52  // To contact AWS SecurityHub with the SDK use the New function to create
    53  // a new service client. With that client you can make API requests to the service.
    54  // These clients are safe to use concurrently.
    55  //
    56  // See the SDK's documentation for more information on how to use the SDK.
    57  // https://docs.aws.amazon.com/sdk-for-go/api/
    58  //
    59  // See aws.Config documentation for more information on configuring SDK clients.
    60  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    61  //
    62  // See the AWS SecurityHub client SecurityHub for more
    63  // information on creating client for this service.
    64  // https://docs.aws.amazon.com/sdk-for-go/api/service/securityhub/#New
    65  package securityhub