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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package applicationdiscoveryservice provides the client and types for making API
     4  // requests to AWS Application Discovery Service.
     5  //
     6  // AWS Application Discovery Service helps you plan application migration projects.
     7  // It automatically identifies servers, virtual machines (VMs), and network
     8  // dependencies in your on-premises data centers. For more information, see
     9  // the AWS Application Discovery Service FAQ (http://aws.amazon.com/application-discovery/faqs/).
    10  // Application Discovery Service offers three ways of performing discovery and
    11  // collecting data about your on-premises servers:
    12  //
    13  //    * Agentless discovery is recommended for environments that use VMware
    14  //    vCenter Server. This mode doesn't require you to install an agent on each
    15  //    host. It does not work in non-VMware environments. Agentless discovery
    16  //    gathers server information regardless of the operating systems, which
    17  //    minimizes the time required for initial on-premises infrastructure assessment.
    18  //    Agentless discovery doesn't collect information about network dependencies,
    19  //    only agent-based discovery collects that information.
    20  //
    21  //    * Agent-based discovery collects a richer set of data than agentless discovery
    22  //    by using the AWS Application Discovery Agent, which you install on one
    23  //    or more hosts in your data center. The agent captures infrastructure and
    24  //    application information, including an inventory of running processes,
    25  //    system performance information, resource utilization, and network dependencies.
    26  //    The information collected by agents is secured at rest and in transit
    27  //    to the Application Discovery Service database in the cloud.
    28  //
    29  //    * AWS Partner Network (APN) solutions integrate with Application Discovery
    30  //    Service, enabling you to import details of your on-premises environment
    31  //    directly into Migration Hub without using the discovery connector or discovery
    32  //    agent. Third-party application discovery tools can query AWS Application
    33  //    Discovery Service, and they can write to the Application Discovery Service
    34  //    database using the public API. In this way, you can import data into Migration
    35  //    Hub and view it, so that you can associate applications with servers and
    36  //    track migrations.
    37  //
    38  // Recommendations
    39  //
    40  // We recommend that you use agent-based discovery for non-VMware environments,
    41  // and whenever you want to collect information about network dependencies.
    42  // You can run agent-based and agentless discovery simultaneously. Use agentless
    43  // discovery to complete the initial infrastructure assessment quickly, and
    44  // then install agents on select hosts to collect additional information.
    45  //
    46  // Working With This Guide
    47  //
    48  // This API reference provides descriptions, syntax, and usage examples for
    49  // each of the actions and data types for Application Discovery Service. The
    50  // topic for each action shows the API request parameters and the response.
    51  // Alternatively, you can use one of the AWS SDKs to access an API that is tailored
    52  // to the programming language or platform that you're using. For more information,
    53  // see AWS SDKs (http://aws.amazon.com/tools/#SDKs).
    54  //
    55  //    * Remember that you must set your Migration Hub home region before you
    56  //    call any of these APIs.
    57  //
    58  //    * You must make API calls for write actions (create, notify, associate,
    59  //    disassociate, import, or put) while in your home region, or a HomeRegionNotSetException
    60  //    error is returned.
    61  //
    62  //    * API calls for read actions (list, describe, stop, and delete) are permitted
    63  //    outside of your home region.
    64  //
    65  //    * Although it is unlikely, the Migration Hub home region could change.
    66  //    If you call APIs outside the home region, an InvalidInputException is
    67  //    returned.
    68  //
    69  //    * You must call GetHomeRegion to obtain the latest Migration Hub home
    70  //    region.
    71  //
    72  // This guide is intended for use with the AWS Application Discovery Service
    73  // User Guide (http://docs.aws.amazon.com/application-discovery/latest/userguide/).
    74  //
    75  // All data is handled according to the AWS Privacy Policy (http://aws.amazon.com/privacy/).
    76  // You can operate Application Discovery Service offline to inspect collected
    77  // data before it is shared with the service.
    78  //
    79  // See https://docs.aws.amazon.com/goto/WebAPI/discovery-2015-11-01 for more information on this service.
    80  //
    81  // See applicationdiscoveryservice package documentation for more information.
    82  // https://docs.aws.amazon.com/sdk-for-go/api/service/applicationdiscoveryservice/
    83  //
    84  // Using the Client
    85  //
    86  // To contact AWS Application Discovery Service with the SDK use the New function to create
    87  // a new service client. With that client you can make API requests to the service.
    88  // These clients are safe to use concurrently.
    89  //
    90  // See the SDK's documentation for more information on how to use the SDK.
    91  // https://docs.aws.amazon.com/sdk-for-go/api/
    92  //
    93  // See aws.Config documentation for more information on configuring SDK clients.
    94  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    95  //
    96  // See the AWS Application Discovery Service client ApplicationDiscoveryService for more
    97  // information on creating client for this service.
    98  // https://docs.aws.amazon.com/sdk-for-go/api/service/applicationdiscoveryservice/#New
    99  package applicationdiscoveryservice