Hackage :: [Package]

amazonka-support: Amazon Support SDK.

[ aws, library, mpl ] [ Propose Tags ] [ Report a vulnerability ]

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 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: - 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. - 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. - Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases. The following list describes the operations available from the AWS Support service for Trusted Advisor: - DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources. - Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified. - DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks. - RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check. - DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks. For authentication of requests, AWS Support uses Signature Version 4 Signing Process. See About the AWS Support API 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.

The types from this library are intended to be used with amazonka, which provides mechanisms for specifying AuthN/AuthZ information and sending requests.

Use of lenses is required for constructing and manipulating types. This is due to the amount of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries such as lens or lens-family-core.

See Network.AWS.Support or the AWS Documentation to get started.

[Skip to Readme]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.0.0, 0.0.1, 0.0.2, 0.0.3, 0.0.4, 0.0.5, 0.0.6, 0.0.7, 0.0.8, 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.3.4, 0.3.5, 0.3.6, 1.0.0, 1.0.1, 1.1.0, 1.2.0, 1.2.0.1, 1.2.0.2, 1.3.0, 1.3.1, 1.3.2, 1.3.3, 1.3.3.1, 1.3.4, 1.3.5, 1.3.6, 1.3.7, 1.4.0, 1.4.1, 1.4.2, 1.4.3, 1.4.4, 1.4.5, 1.5.0, 1.6.0, 1.6.1, 2.0
Dependencies amazonka-core (>=1.4.0 && <1.4.1), base (>=4.7 && <4.19) [details]
License LicenseRef-OtherLicense
Copyright Copyright (c) 2013-2016 Brendan Hay
Author Brendan Hay
Maintainer Brendan Hay <brendan.g.hay@gmail.com>
Revised Revision 1 made by jack at 2024-05-13T07:55:24Z
Category Network, AWS, Cloud, Distributed Computing
Home page https://github.com/brendanhay/amazonka
Bug tracker https://github.com/brendanhay/amazonka/issues
Source repo head: git clone git://github.com/brendanhay/amazonka.git
Uploaded by BrendanHay at 2016-03-21T07:15:08Z
Distributions LTSHaskell:2.0, NixOS:2.0
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 37189 total (163 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-03-21 [all 1 reports]

Readme for amazonka-support-1.4.0

[back to package description]

Amazon Support SDK

Version

1.4.0

Description

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 <https://aws.amazon.com/premiumsupport/trustedadvisor/ Trusted Advisor> 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:

  • 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.
  • 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.
  • Case communication. The < DescribeCommunications>, < AddCommunicationToCase>, and < AddAttachmentsToSet> operations retrieve and add communications and attachments to AWS Support cases.

The following list describes the operations available from the AWS Support service for Trusted Advisor:

  • < DescribeTrustedAdvisorChecks> returns the list of checks that run against your AWS resources.
  • Using the @CheckId@ for a specific check returned by < DescribeTrustedAdvisorChecks>, you can call < DescribeTrustedAdvisorCheckResult> to obtain the results for the check you specified.
  • < DescribeTrustedAdvisorCheckSummaries> returns summarized results for one or more Trusted Advisor checks.
  • < RefreshTrustedAdvisorCheck> requests that Trusted Advisor rerun a specified check.
  • < DescribeTrustedAdvisorCheckRefreshStatuses> reports the refresh status of one or more checks.

For authentication of requests, AWS Support uses <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process>.

See <http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html About the AWS Support API> 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.

Documentation is available via Hackage and the AWS API Reference.

The types from this library are intended to be used with amazonka, which provides mechanisms for specifying AuthN/AuthZ information and sending requests.

Use of lenses is required for constructing and manipulating types. This is due to the amount of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries lens or lens-family-core.

Contribute

For any problems, comments, or feedback please create an issue here on GitHub.

Note: this library is an auto-generated Haskell package. Please see amazonka-gen for more information.

Licence

amazonka-support is released under the Mozilla Public License Version 2.0.

Parts of the code are derived from AWS service descriptions, licensed under Apache 2.0. Source files subject to this contain an additional licensing clause in their header.