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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package health provides the client and types for making API
     4  // requests to AWS Health APIs and Notifications.
     5  //
     6  // The AWS Health API provides programmatic access to the AWS Health information
     7  // that appears in the AWS Personal Health Dashboard (https://phd.aws.amazon.com/phd/home#/).
     8  // You can use the API operations to get information about AWS Health events
     9  // that affect your AWS services and resources.
    10  //
    11  //    * You must have a Business or Enterprise Support plan from AWS Support
    12  //    (http://aws.amazon.com/premiumsupport/) to use the AWS Health API. If
    13  //    you call the AWS Health API from an AWS account that doesn't have a Business
    14  //    or Enterprise Support plan, you receive a SubscriptionRequiredException
    15  //    error.
    16  //
    17  //    * You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS)
    18  //    to call the AWS Health API operations. AWS Health supports a multi-Region
    19  //    application architecture and has two regional endpoints in an active-passive
    20  //    configuration. You can use the high availability endpoint example to determine
    21  //    which AWS Region is active, so that you can get the latest information
    22  //    from the API. For more information, see Accessing the AWS Health API (https://docs.aws.amazon.com/health/latest/ug/health-api.html)
    23  //    in the AWS Health User Guide.
    24  //
    25  // For authentication of requests, AWS Health uses the Signature Version 4 Signing
    26  // Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
    27  //
    28  // If your AWS account is part of AWS Organizations, you can use the AWS Health
    29  // organizational view feature. This feature provides a centralized view of
    30  // AWS Health events across all accounts in your organization. You can aggregate
    31  // AWS Health events in real time to identify accounts in your organization
    32  // that are affected by an operational event or get notified of security vulnerabilities.
    33  // Use the organizational view API operations to enable this feature and return
    34  // event information. For more information, see Aggregating AWS Health events
    35  // (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in the
    36  // AWS Health User Guide.
    37  //
    38  // When you use the AWS Health API operations to return AWS Health events, see
    39  // the following recommendations:
    40  //
    41  //    * Use the eventScopeCode (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode)
    42  //    parameter to specify whether to return AWS Health events that are public
    43  //    or account-specific.
    44  //
    45  //    * Use pagination to view all events from the response. For example, if
    46  //    you call the DescribeEventsForOrganization operation to get all events
    47  //    in your organization, you might receive several page results. Specify
    48  //    the nextToken in the next request to return more results.
    49  //
    50  // See https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04 for more information on this service.
    51  //
    52  // See health package documentation for more information.
    53  // https://docs.aws.amazon.com/sdk-for-go/api/service/health/
    54  //
    55  // Using the Client
    56  //
    57  // To contact AWS Health APIs and Notifications 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 AWS Health APIs and Notifications client Health for more
    68  // information on creating client for this service.
    69  // https://docs.aws.amazon.com/sdk-for-go/api/service/health/#New
    70  package health