aws

# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/jkakar/aws-codegen for more details.

defmodule AWS.Support do
  @moduledoc """
  AWS Support

  The AWS Support API reference is intended for programmers who need detailed
  information about the AWS Support operations and data types. This service
  enables you to manage your AWS Support cases programmatically. It uses HTTP
  methods that return results in JSON format.

  The AWS Support service also exposes a set of [Trusted
  Advisor](https://aws.amazon.com/premiumsupport/trustedadvisor/) features.
  You can retrieve a list of checks and their descriptions, get check
  results, specify checks to refresh, and get the refresh status of checks.

  The following list describes the AWS Support case management operations:

  <ul> <li> **Service names, issue categories, and available severity levels.
  **The `DescribeServices` and `DescribeSeverityLevels` operations return AWS
  service names, service codes, service categories, and problem severity
  levels. You use these values when you call the `CreateCase` operation.
  </li> <li> **Case creation, case details, and case resolution.** The
  `CreateCase`, `DescribeCases`, `DescribeAttachment`, and `ResolveCase`
  operations create AWS Support cases, retrieve information about cases, and
  resolve cases.</li> <li> **Case communication.** The
  `DescribeCommunications`, `AddCommunicationToCase`, and
  `AddAttachmentsToSet` operations retrieve and add communications and
  attachments to AWS Support cases. </li> </ul> The following list describes
  the operations available from the AWS Support service for Trusted Advisor:

  <ul> <li> `DescribeTrustedAdvisorChecks` returns the list of checks that
  run against your AWS resources.</li> <li>Using the `CheckId` for a specific
  check returned by `DescribeTrustedAdvisorChecks`, you can call
  `DescribeTrustedAdvisorCheckResult` to obtain the results for the check you
  specified.</li> <li> `DescribeTrustedAdvisorCheckSummaries` returns
  summarized results for one or more Trusted Advisor checks.</li> <li>
  `RefreshTrustedAdvisorCheck` requests that Trusted Advisor rerun a
  specified check. </li> <li> `DescribeTrustedAdvisorCheckRefreshStatuses`
  reports the refresh status of one or more checks. </li> </ul> For
  authentication of requests, AWS Support uses [Signature Version 4 Signing
  Process](http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

  See [About the AWS Support
  API](http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html) in the
  *AWS Support User Guide* for information about how to use this service to
  create and manage your support cases, and how to call Trusted Advisor for
  results of checks on your resources.
  """

  @doc """
  Adds one or more attachments to an attachment set. If an `AttachmentSetId`
  is not specified, a new attachment set is created, and the ID of the set is
  returned in the response. If an `AttachmentSetId` is specified, the
  attachments are added to the specified set, if it exists.

  An attachment set is a temporary container for attachments that are to be
  added to a case or case communication. The set is available for one hour
  after it is created; the `ExpiryTime` returned in the response indicates
  when the set expires. The maximum number of attachments in a set is 3, and
  the maximum size of any attachment in the set is 5 MB.
  """
  def add_attachments_to_set(client, input, options \\ []) do
    request(client, "AddAttachmentsToSet", input, options)
  end

  @doc """
  Adds additional customer communication to an AWS Support case. You use the
  `CaseId` value to identify the case to add communication to. You can list a
  set of email addresses to copy on the communication using the
  `CcEmailAddresses` value. The `CommunicationBody` value contains the text
  of the communication.

  The response indicates the success or failure of the request.

  This operation implements a subset of the features of the AWS Support
  Center.
  """
  def add_communication_to_case(client, input, options \\ []) do
    request(client, "AddCommunicationToCase", input, options)
  end

  @doc """
  Creates a new case in the AWS Support Center. This operation is modeled on
  the behavior of the AWS Support Center [Create
  Case](https://console.aws.amazon.com/support/home#/case/create) page. Its
  parameters require you to specify the following information:

  <ol> <li> **IssueType.** The type of issue for the case. You can specify
  either "customer-service" or "technical." If you do not indicate a value,
  the default is "technical." </li> <li> **ServiceCode.** The code for an AWS
  service. You obtain the `ServiceCode` by calling `DescribeServices`. </li>
  <li> **CategoryCode.** The category for the service defined for the
  `ServiceCode` value. You also obtain the category code for a service by
  calling `DescribeServices`. Each AWS service defines its own set of
  category codes. </li> <li> **SeverityCode.** A value that indicates the
  urgency of the case, which in turn determines the response time according
  to your service level agreement with AWS Support. You obtain the
  SeverityCode by calling `DescribeSeverityLevels`.</li> <li> **Subject.**
  The **Subject** field on the AWS Support Center [Create
  Case](https://console.aws.amazon.com/support/home#/case/create) page.</li>
  <li> **CommunicationBody.** The **Description** field on the AWS Support
  Center [Create
  Case](https://console.aws.amazon.com/support/home#/case/create) page.</li>
  <li> **AttachmentSetId.** The ID of a set of attachments that has been
  created by using `AddAttachmentsToSet`.</li> <li> **Language.** The human
  language in which AWS Support handles the case. English and Japanese are
  currently supported.</li> <li> **CcEmailAddresses.** The AWS Support Center
  **CC** field on the [Create
  Case](https://console.aws.amazon.com/support/home#/case/create) page. You
  can list email addresses to be copied on any correspondence about the case.
  The account that opens the case is already identified by passing the AWS
  Credentials in the HTTP POST method or in a method or function call from
  one of the programming languages supported by an [AWS
  SDK](http://aws.amazon.com/tools/). </li> </ol> <note>To add additional
  communication or attachments to an existing case, use
  `AddCommunicationToCase`.

  </note> A successful `CreateCase` request returns an AWS Support case
  number. Case numbers are used by the `DescribeCases` operation to retrieve
  existing AWS Support cases.
  """
  def create_case(client, input, options \\ []) do
    request(client, "CreateCase", input, options)
  end

  @doc """
  Returns the attachment that has the specified ID. Attachment IDs are
  generated by the case management system when you add an attachment to a
  case or case communication. Attachment IDs are returned in the
  `AttachmentDetails` objects that are returned by the
  `DescribeCommunications` operation.
  """
  def describe_attachment(client, input, options \\ []) do
    request(client, "DescribeAttachment", input, options)
  end

  @doc """
  Returns a list of cases that you specify by passing one or more case IDs.
  In addition, you can filter the cases by date by setting values for the
  `AfterTime` and `BeforeTime` request parameters. You can set values for the
  `IncludeResolvedCases` and `IncludeCommunications` request parameters to
  control how much information is returned.

  Case data is available for 12 months after creation. If a case was created
  more than 12 months ago, a request for data might cause an error.

  The response returns the following in JSON format:

  <ol> <li>One or more `CaseDetails` data types. </li> <li>One or more
  `NextToken` values, which specify where to paginate the returned records
  represented by the `CaseDetails` objects.</li> </ol>
  """
  def describe_cases(client, input, options \\ []) do
    request(client, "DescribeCases", input, options)
  end

  @doc """
  Returns communications (and attachments) for one or more support cases. You
  can use the `AfterTime` and `BeforeTime` parameters to filter by date. You
  can use the `CaseId` parameter to restrict the results to a particular
  case.

  Case data is available for 12 months after creation. If a case was created
  more than 12 months ago, a request for data might cause an error.

  You can use the `MaxResults` and `NextToken` parameters to control the
  pagination of the result set. Set `MaxResults` to the number of cases you
  want displayed on each page, and use `NextToken` to specify the resumption
  of pagination.
  """
  def describe_communications(client, input, options \\ []) do
    request(client, "DescribeCommunications", input, options)
  end

  @doc """
  Returns the current list of AWS services and a list of service categories
  that applies to each one. You then use service names and categories in your
  `CreateCase` requests. Each AWS service has its own set of categories.

  The service codes and category codes correspond to the values that are
  displayed in the **Service** and **Category** drop-down lists on the AWS
  Support Center [Create
  Case](https://console.aws.amazon.com/support/home#/case/create) page. The
  values in those fields, however, do not necessarily match the service codes
  and categories returned by the `DescribeServices` request. Always use the
  service codes and categories obtained programmatically. This practice
  ensures that you always have the most recent set of service and category
  codes.
  """
  def describe_services(client, input, options \\ []) do
    request(client, "DescribeServices", input, options)
  end

  @doc """
  Returns the list of severity levels that you can assign to an AWS Support
  case. The severity level for a case is also a field in the `CaseDetails`
  data type included in any `CreateCase` request.
  """
  def describe_severity_levels(client, input, options \\ []) do
    request(client, "DescribeSeverityLevels", input, options)
  end

  @doc """
  Returns the refresh status of the Trusted Advisor checks that have the
  specified check IDs. Check IDs can be obtained by calling
  `DescribeTrustedAdvisorChecks`.
  """
  def describe_trusted_advisor_check_refresh_statuses(client, input, options \\ []) do
    request(client, "DescribeTrustedAdvisorCheckRefreshStatuses", input, options)
  end

  @doc """
  Returns the results of the Trusted Advisor check that has the specified
  check ID. Check IDs can be obtained by calling
  `DescribeTrustedAdvisorChecks`.

  The response contains a `TrustedAdvisorCheckResult` object, which contains
  these three objects:

  <ul> <li>`TrustedAdvisorCategorySpecificSummary`</li>
  <li>`TrustedAdvisorResourceDetail`</li>
  <li>`TrustedAdvisorResourcesSummary`</li> </ul> In addition, the response
  contains these fields:

  <ul> <li> **Status.** The alert status of the check: "ok" (green),
  "warning" (yellow), "error" (red), or "not_available".</li> <li>
  **Timestamp.** The time of the last refresh of the check.</li> <li>
  **CheckId.** The unique identifier for the check.</li> </ul>
  """
  def describe_trusted_advisor_check_result(client, input, options \\ []) do
    request(client, "DescribeTrustedAdvisorCheckResult", input, options)
  end

  @doc """
  Returns the summaries of the results of the Trusted Advisor checks that
  have the specified check IDs. Check IDs can be obtained by calling
  `DescribeTrustedAdvisorChecks`.

  The response contains an array of `TrustedAdvisorCheckSummary` objects.
  """
  def describe_trusted_advisor_check_summaries(client, input, options \\ []) do
    request(client, "DescribeTrustedAdvisorCheckSummaries", input, options)
  end

  @doc """
  Returns information about all available Trusted Advisor checks, including
  name, ID, category, description, and metadata. You must specify a language
  code; English ("en") and Japanese ("ja") are currently supported. The
  response contains a `TrustedAdvisorCheckDescription` for each check.
  """
  def describe_trusted_advisor_checks(client, input, options \\ []) do
    request(client, "DescribeTrustedAdvisorChecks", input, options)
  end

  @doc """
  Requests a refresh of the Trusted Advisor check that has the specified
  check ID. Check IDs can be obtained by calling
  `DescribeTrustedAdvisorChecks`.

  The response contains a `TrustedAdvisorCheckRefreshStatus` object, which
  contains these fields:

  <ul> <li> **Status.** The refresh status of the check: "none", "enqueued",
  "processing", "success", or "abandoned".</li> <li>
  **MillisUntilNextRefreshable.** The amount of time, in milliseconds, until
  the check is eligible for refresh.</li> <li> **CheckId.** The unique
  identifier for the check.</li> </ul>
  """
  def refresh_trusted_advisor_check(client, input, options \\ []) do
    request(client, "RefreshTrustedAdvisorCheck", input, options)
  end

  @doc """
  Takes a `CaseId` and returns the initial state of the case along with the
  state of the case after the call to `ResolveCase` completed.
  """
  def resolve_case(client, input, options \\ []) do
    request(client, "ResolveCase", input, options)
  end

  @spec request(map(), binary(), map(), list()) ::
    {:ok, Poison.Parser.t | nil, Poison.Response.t} |
    {:error, Poison.Parser.t} |
    {:error, HTTPoison.Error.t}
  defp request(client, action, input, options) do
    client = %{client | service: "support"}
    host = get_host("support", client)
    url = get_url(host, client)
    headers = [{"Host", host},
               {"Content-Type", "application/x-amz-json-1.1"},
               {"X-Amz-Target", "AWSSupport_20130415.#{action}"}]
    payload = Poison.Encoder.encode(input, [])
    headers = AWS.Request.sign_v4(client, "POST", url, headers, payload)
    case HTTPoison.post(url, payload, headers, options) do
      {:ok, response=%HTTPoison.Response{status_code: 200, body: ""}} ->
        {:ok, nil, response}
      {:ok, response=%HTTPoison.Response{status_code: 200, body: body}} ->
        {:ok, Poison.Parser.parse!(body), response}
      {:ok, _response=%HTTPoison.Response{body: body}} ->
        error = Poison.Parser.parse!(body)
        exception = error["__type"]
        message = error["message"]
        {:error, {exception, message}}
      {:error, %HTTPoison.Error{reason: reason}} ->
        {:error, %HTTPoison.Error{reason: reason}}
    end
  end

  defp get_host(endpoint_prefix, client) do
    if client.region == "local" do
      "localhost"
    else
      "#{endpoint_prefix}.#{client.region}.#{client.endpoint}"
    end
  end

  defp get_url(host, %{:proto => proto, :port => port}) do
    "#{proto}://#{host}:#{port}/"
  end

end