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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package detective provides the client and types for making API
     4  // requests to Amazon Detective.
     5  //
     6  // Detective uses machine learning and purpose-built visualizations to help
     7  // you analyze and investigate security issues across your Amazon Web Services
     8  // (AWS) workloads. Detective automatically extracts time-based events such
     9  // as login attempts, API calls, and network traffic from AWS CloudTrail and
    10  // Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings
    11  // detected by Amazon GuardDuty.
    12  //
    13  // The Detective API primarily supports the creation and management of behavior
    14  // graphs. A behavior graph contains the extracted data from a set of member
    15  // accounts, and is created and managed by an administrator account.
    16  //
    17  // Every behavior graph is specific to a Region. You can only use the API to
    18  // manage graphs that belong to the Region that is associated with the currently
    19  // selected endpoint.
    20  //
    21  // A Detective administrator account can use the Detective API to do the following:
    22  //
    23  //    * Enable and disable Detective. Enabling Detective creates a new behavior
    24  //    graph.
    25  //
    26  //    * View the list of member accounts in a behavior graph.
    27  //
    28  //    * Add member accounts to a behavior graph.
    29  //
    30  //    * Remove member accounts from a behavior graph.
    31  //
    32  // A member account can use the Detective API to do the following:
    33  //
    34  //    * View the list of behavior graphs that they are invited to.
    35  //
    36  //    * Accept an invitation to contribute to a behavior graph.
    37  //
    38  //    * Decline an invitation to contribute to a behavior graph.
    39  //
    40  //    * Remove their account from a behavior graph.
    41  //
    42  // All API actions are logged as CloudTrail events. See Logging Detective API
    43  // Calls with CloudTrail (https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html).
    44  //
    45  // We replaced the term "master account" with the term "administrator account."
    46  // An administrator account is used to centrally manage multiple accounts. In
    47  // the case of Detective, the administrator account manages the accounts in
    48  // their behavior graph.
    49  //
    50  // See https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26 for more information on this service.
    51  //
    52  // See detective package documentation for more information.
    53  // https://docs.aws.amazon.com/sdk-for-go/api/service/detective/
    54  //
    55  // Using the Client
    56  //
    57  // To contact Amazon Detective with the SDK use the New function to create
    58  // a new service client. With that client you can make API requests to the service.
    59  // These clients are safe to use concurrently.
    60  //
    61  // See the SDK's documentation for more information on how to use the SDK.
    62  // https://docs.aws.amazon.com/sdk-for-go/api/
    63  //
    64  // See aws.Config documentation for more information on configuring SDK clients.
    65  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    66  //
    67  // See the Amazon Detective client Detective for more
    68  // information on creating client for this service.
    69  // https://docs.aws.amazon.com/sdk-for-go/api/service/detective/#New
    70  package detective