diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,15 @@ ## Description -AWS Support is a one-on-one, fast-response support channel that is staffed with experienced support personnel. The service helps customers get the most from the products and features provided by Amazon Web Services. There are four levels, or tiers, of AWS Support: Basic, Developer, Business, and Enterprise. The Basic tier is free of charge and offers support for account and billing questions and service limit increases. The other tiers offer an unlimited number of technical support cases with pay-by-the-month pricing and no long-term contracts, providing developers and businesses flexibility to choose the level of support that meets their needs. + AWS Support is a one-on-one, fast-response support channel that is staffed + with experienced support personnel. The service helps customers get the most + from the products and features provided by Amazon Web Services. There are + four levels, or tiers, of AWS Support: Basic, Developer, Business, and + Enterprise. The Basic tier is free of charge and offers support for account + and billing questions and service limit increases. The other tiers offer an + unlimited number of technical support cases with pay-by-the-month pricing and + no long-term contracts, providing developers and businesses flexibility to + choose the level of support that meets their needs. Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-support) and [AWS API Reference](http://docs.aws.amazon.com/awssupport/latest/APIReference/Welcome.html). diff --git a/amazonka-support.cabal b/amazonka-support.cabal --- a/amazonka-support.cabal +++ b/amazonka-support.cabal @@ -1,5 +1,5 @@ name: amazonka-support -version: 0.0.1 +version: 0.0.2 synopsis: Amazon Support SDK. homepage: https://github.com/brendanhay/amazonka license: OtherLicense @@ -13,16 +13,15 @@ cabal-version: >= 1.10 description: - AWS Support is a one-on-one, fast-response support channel that is - staffed with experienced support personnel. The service helps customers - get the most from the products and features provided by Amazon Web - Services. There are four levels, or tiers, of AWS Support: Basic, - Developer, Business, and Enterprise. The Basic tier is free of charge - and offers support for account and billing questions and service limit - increases. The other tiers offer an unlimited number of technical - support cases with pay-by-the-month pricing and no long-term contracts, - providing developers and businesses flexibility to choose the level of - support that meets their needs. + AWS Support is a one-on-one, fast-response support channel that is staffed + with experienced support personnel. The service helps customers get the most + from the products and features provided by Amazon Web Services. There are + four levels, or tiers, of AWS Support: Basic, Developer, Business, and + Enterprise. The Basic tier is free of charge and offers support for account + and billing questions and service limit increases. The other tiers offer an + unlimited number of technical support cases with pay-by-the-month pricing and + no long-term contracts, providing developers and businesses flexibility to + choose the level of support that meets their needs. . /See:/ . @@ -60,5 +59,5 @@ other-modules: build-depends: - amazonka-core == 0.0.1.* + amazonka-core == 0.0.2.* , base >= 4.7 && < 5 diff --git a/gen/Network/AWS/Support.hs b/gen/Network/AWS/Support.hs --- a/gen/Network/AWS/Support.hs +++ b/gen/Network/AWS/Support.hs @@ -9,14 +9,14 @@ -- Portability : non-portable (GHC extensions) -- | AWS Support is a one-on-one, fast-response support channel that is staffed --- with experienced support personnel. The service helps customers get the --- most from the products and features provided by Amazon Web Services. There --- are four levels, or tiers, of AWS Support: Basic, Developer, Business, and +-- with experienced support personnel. The service helps customers get the most +-- from the products and features provided by Amazon Web Services. There are +-- four levels, or tiers, of AWS Support: Basic, Developer, Business, and -- Enterprise. The Basic tier is free of charge and offers support for account -- and billing questions and service limit increases. The other tiers offer an --- unlimited number of technical support cases with pay-by-the-month pricing --- and no long-term contracts, providing developers and businesses flexibility --- to choose the level of support that meets their needs. +-- unlimited number of technical support cases with pay-by-the-month pricing and +-- no long-term contracts, providing developers and businesses flexibility to +-- choose the level of support that meets their needs. module Network.AWS.Support ( module Network.AWS.Support.AddAttachmentsToSet , module Network.AWS.Support.AddCommunicationToCase diff --git a/gen/Network/AWS/Support/AddAttachmentsToSet.hs b/gen/Network/AWS/Support/AddAttachmentsToSet.hs --- a/gen/Network/AWS/Support/AddAttachmentsToSet.hs +++ b/gen/Network/AWS/Support/AddAttachmentsToSet.hs @@ -20,16 +20,17 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Adds one or more attachments to an attachment set. If an AttachmentSetId is +-- | 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. +-- 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. +-- -- module Network.AWS.Support.AddAttachmentsToSet ( @@ -74,10 +75,10 @@ , _aatsAttachments = mempty } --- | The ID of the 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. +-- | The ID of the 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. aatsAttachmentSetId :: Lens' AddAttachmentsToSet (Maybe Text) aatsAttachmentSetId = lens _aatsAttachmentSetId (\s a -> s { _aatsAttachmentSetId = a }) @@ -106,10 +107,10 @@ , _aatsrExpiryTime = Nothing } --- | The ID of the attachment set. If an AttachmentSetId was not specified, a --- new attachment set is created, and the ID of the set is returned in the --- response. If an AttachmentSetId was specified, the attachments are added --- to the specified set, if it exists. +-- | The ID of the attachment set. If an 'AttachmentSetId' was not specified, a new +-- attachment set is created, and the ID of the set is returned in the response. +-- If an 'AttachmentSetId' was specified, the attachments are added to the +-- specified set, if it exists. aatsrAttachmentSetId :: Lens' AddAttachmentsToSetResponse (Maybe Text) aatsrAttachmentSetId = lens _aatsrAttachmentSetId (\s a -> s { _aatsrAttachmentSetId = a }) diff --git a/gen/Network/AWS/Support/AddCommunicationToCase.hs b/gen/Network/AWS/Support/AddCommunicationToCase.hs --- a/gen/Network/AWS/Support/AddCommunicationToCase.hs +++ b/gen/Network/AWS/Support/AddCommunicationToCase.hs @@ -20,14 +20,14 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | 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 behavior on the AWS --- Support Your Support Cases web form. +-- | 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 behavior on the AWS Support web form. +-- -- module Network.AWS.Support.AddCommunicationToCase ( @@ -82,15 +82,14 @@ , _actcAttachmentSetId = Nothing } --- | The ID of a set of one or more attachments for the communication to add --- to the case. Create the set by calling AddAttachmentsToSet. +-- | The ID of a set of one or more attachments for the communication to add to +-- the case. Create the set by calling 'AddAttachmentsToSet' actcAttachmentSetId :: Lens' AddCommunicationToCase (Maybe Text) actcAttachmentSetId = lens _actcAttachmentSetId (\s a -> s { _actcAttachmentSetId = a }) --- | The AWS Support case ID requested or returned in the call. The case ID is --- an alphanumeric string formatted as shown in this example: --- case-12345678910-2013-c4c1d2bf33c5cf47. +-- | The AWS Support case ID requested or returned in the call. The case ID is an +-- alphanumeric string formatted as shown in this example: case-/12345678910-2013-c4c1d2bf33c5cf47/ actcCaseId :: Lens' AddCommunicationToCase (Maybe Text) actcCaseId = lens _actcCaseId (\s a -> s { _actcCaseId = a }) @@ -121,7 +120,7 @@ { _actcrResult = Nothing } --- | True if AddCommunicationToCase succeeds. Otherwise, returns an error. +-- | True if 'AddCommunicationToCase' succeeds. Otherwise, returns an error. actcrResult :: Lens' AddCommunicationToCaseResponse (Maybe Bool) actcrResult = lens _actcrResult (\s a -> s { _actcrResult = a }) diff --git a/gen/Network/AWS/Support/CreateCase.hs b/gen/Network/AWS/Support/CreateCase.hs --- a/gen/Network/AWS/Support/CreateCase.hs +++ b/gen/Network/AWS/Support/CreateCase.hs @@ -21,30 +21,31 @@ -- Portability : non-portable (GHC extensions) -- | Creates a new case in the AWS Support Center. This operation is modeled on --- the behavior of the AWS Support Center Open a new case page. Its parameters --- require you to specify the following information: 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." --- ServiceCode. The code for an AWS service. You obtain the ServiceCode by --- calling DescribeServices. 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. 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. Subject. The Subject field on the AWS Support --- Center Open a new case page. CommunicationBody. The Description field on --- the AWS Support Center Open a new case page. AttachmentSetId. The ID of a --- set of attachments that has been created by using AddAttachmentsToSet. +-- the behavior of the AWS Support Center page. Its parameters +-- require you to specify the following information: +-- +-- 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." ServiceCode. The code for an AWS service. You +-- obtain the 'ServiceCode' by calling 'DescribeServices'. 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. 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'. Subject. The Subject field on the AWS +-- Support Center page. CommunicationBody. The Description +-- field on the AWS Support Center page. AttachmentSetId. The +-- ID of a set of attachments that has been created by using 'AddAttachmentsToSet'. -- Language. The human language in which AWS Support handles the case. English --- and Japanese are currently supported. CcEmailAddresses. The AWS Support --- Center CC field on the Open a new case 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. A successful CreateCase request returns --- an AWS Support case number. Case numbers are used by the DescribeCases --- operation to retrieve existing AWS Support cases. +-- and Japanese are currently supported. CcEmailAddresses. The AWS Support +-- Center CC field on the 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 . A successful 'CreateCase' request returns an AWS +-- Support case number. Case numbers are used by the 'DescribeCases' operation to +-- retrieve existing AWS Support cases. -- -- module Network.AWS.Support.CreateCase @@ -126,8 +127,8 @@ , _ccAttachmentSetId = Nothing } --- | The ID of a set of one or more attachments for the case. Create the set --- by using AddAttachmentsToSet. +-- | The ID of a set of one or more attachments for the case. Create the set by +-- using 'AddAttachmentsToSet'. ccAttachmentSetId :: Lens' CreateCase (Maybe Text) ccAttachmentSetId = lens _ccAttachmentSetId (\s a -> s { _ccAttachmentSetId = a }) @@ -142,15 +143,13 @@ lens _ccCcEmailAddresses (\s a -> s { _ccCcEmailAddresses = a }) . _List --- | The communication body text when you create an AWS Support case by --- calling CreateCase. +-- | The communication body text when you create an AWS Support case by calling 'CreateCase'. ccCommunicationBody :: Lens' CreateCase Text ccCommunicationBody = lens _ccCommunicationBody (\s a -> s { _ccCommunicationBody = a }) --- | 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.". +-- | 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." ccIssueType :: Lens' CreateCase (Maybe Text) ccIssueType = lens _ccIssueType (\s a -> s { _ccIssueType = a }) @@ -160,12 +159,12 @@ ccLanguage :: Lens' CreateCase (Maybe Text) ccLanguage = lens _ccLanguage (\s a -> s { _ccLanguage = a }) --- | The code for the AWS service returned by the call to DescribeServices. +-- | The code for the AWS service returned by the call to 'DescribeServices'. ccServiceCode :: Lens' CreateCase (Maybe Text) ccServiceCode = lens _ccServiceCode (\s a -> s { _ccServiceCode = a }) --- | The code for the severity level returned by the call to --- DescribeSeverityLevels. +-- | The code for the severity level returned by the call to 'DescribeSeverityLevels' +-- . ccSeverityCode :: Lens' CreateCase (Maybe Text) ccSeverityCode = lens _ccSeverityCode (\s a -> s { _ccSeverityCode = a }) @@ -188,9 +187,8 @@ { _ccrCaseId = Nothing } --- | The AWS Support case ID requested or returned in the call. The case ID is --- an alphanumeric string formatted as shown in this example: --- case-12345678910-2013-c4c1d2bf33c5cf47. +-- | The AWS Support case ID requested or returned in the call. The case ID is an +-- alphanumeric string formatted as shown in this example: case-/12345678910-2013-c4c1d2bf33c5cf47/ ccrCaseId :: Lens' CreateCaseResponse (Maybe Text) ccrCaseId = lens _ccrCaseId (\s a -> s { _ccrCaseId = a }) diff --git a/gen/Network/AWS/Support/DescribeAttachment.hs b/gen/Network/AWS/Support/DescribeAttachment.hs --- a/gen/Network/AWS/Support/DescribeAttachment.hs +++ b/gen/Network/AWS/Support/DescribeAttachment.hs @@ -21,10 +21,9 @@ -- Portability : non-portable (GHC extensions) -- | 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. +-- 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. -- -- module Network.AWS.Support.DescribeAttachment @@ -65,8 +64,7 @@ { _daAttachmentId = p1 } --- | The ID of the attachment to return. Attachment IDs are returned by the --- DescribeCommunications operation. +-- | The ID of the attachment to return. Attachment IDs are returned by the 'DescribeCommunications' operation. daAttachmentId :: Lens' DescribeAttachment Text daAttachmentId = lens _daAttachmentId (\s a -> s { _daAttachmentId = a }) diff --git a/gen/Network/AWS/Support/DescribeCases.hs b/gen/Network/AWS/Support/DescribeCases.hs --- a/gen/Network/AWS/Support/DescribeCases.hs +++ b/gen/Network/AWS/Support/DescribeCases.hs @@ -20,15 +20,19 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | 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. 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: One or more CaseDetails data types. One or more NextToken --- values, which specify where to paginate the returned records represented by --- the CaseDetails objects. +-- | 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. -- +-- 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: +-- +-- One or more 'CaseDetails' data types. One or more 'NextToken' values, which +-- specify where to paginate the returned records represented by the 'CaseDetails' +-- objects. +-- -- module Network.AWS.Support.DescribeCases ( @@ -113,8 +117,8 @@ dcAfterTime :: Lens' DescribeCases (Maybe Text) dcAfterTime = lens _dcAfterTime (\s a -> s { _dcAfterTime = a }) --- | The end date for a filtered date search on support case communications. --- Case communications are available for 12 months after creation. +-- | The end date for a filtered date search on support case communications. Case +-- communications are available for 12 months after creation. dcBeforeTime :: Lens' DescribeCases (Maybe Text) dcBeforeTime = lens _dcBeforeTime (\s a -> s { _dcBeforeTime = a }) @@ -127,14 +131,13 @@ dcDisplayId :: Lens' DescribeCases (Maybe Text) dcDisplayId = lens _dcDisplayId (\s a -> s { _dcDisplayId = a }) --- | Specifies whether communications should be included in the DescribeCases --- results. The default is true. +-- | Specifies whether communications should be included in the 'DescribeCases' +-- results. The default is /true/. dcIncludeCommunications :: Lens' DescribeCases (Maybe Bool) dcIncludeCommunications = lens _dcIncludeCommunications (\s a -> s { _dcIncludeCommunications = a }) --- | Specifies whether resolved support cases should be included in the --- DescribeCases results. The default is false. +-- | Specifies whether resolved support cases should be included in the 'DescribeCases' results. The default is /false/. dcIncludeResolvedCases :: Lens' DescribeCases (Maybe Bool) dcIncludeResolvedCases = lens _dcIncludeResolvedCases (\s a -> s { _dcIncludeResolvedCases = a }) diff --git a/gen/Network/AWS/Support/DescribeCommunications.hs b/gen/Network/AWS/Support/DescribeCommunications.hs --- a/gen/Network/AWS/Support/DescribeCommunications.hs +++ b/gen/Network/AWS/Support/DescribeCommunications.hs @@ -21,14 +21,17 @@ -- Portability : non-portable (GHC extensions) -- | 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. +-- 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. +-- -- module Network.AWS.Support.DescribeCommunications ( @@ -94,14 +97,13 @@ dc1AfterTime :: Lens' DescribeCommunications (Maybe Text) dc1AfterTime = lens _dc1AfterTime (\s a -> s { _dc1AfterTime = a }) --- | The end date for a filtered date search on support case communications. --- Case communications are available for 12 months after creation. +-- | The end date for a filtered date search on support case communications. Case +-- communications are available for 12 months after creation. dc1BeforeTime :: Lens' DescribeCommunications (Maybe Text) dc1BeforeTime = lens _dc1BeforeTime (\s a -> s { _dc1BeforeTime = a }) --- | The AWS Support case ID requested or returned in the call. The case ID is --- an alphanumeric string formatted as shown in this example: --- case-12345678910-2013-c4c1d2bf33c5cf47. +-- | The AWS Support case ID requested or returned in the call. The case ID is an +-- alphanumeric string formatted as shown in this example: case-/12345678910-2013-c4c1d2bf33c5cf47/ dc1CaseId :: Lens' DescribeCommunications Text dc1CaseId = lens _dc1CaseId (\s a -> s { _dc1CaseId = a }) diff --git a/gen/Network/AWS/Support/DescribeServices.hs b/gen/Network/AWS/Support/DescribeServices.hs --- a/gen/Network/AWS/Support/DescribeServices.hs +++ b/gen/Network/AWS/Support/DescribeServices.hs @@ -21,15 +21,14 @@ -- Portability : non-portable (GHC extensions) -- | 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 +-- 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 Open a new case 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. +-- Center 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. -- -- module Network.AWS.Support.DescribeServices diff --git a/gen/Network/AWS/Support/DescribeSeverityLevels.hs b/gen/Network/AWS/Support/DescribeSeverityLevels.hs --- a/gen/Network/AWS/Support/DescribeSeverityLevels.hs +++ b/gen/Network/AWS/Support/DescribeSeverityLevels.hs @@ -21,8 +21,8 @@ -- Portability : non-portable (GHC extensions) -- | 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. +-- case. The severity level for a case is also a field in the 'CaseDetails' data +-- type included in any 'CreateCase' request. -- -- module Network.AWS.Support.DescribeSeverityLevels @@ -89,8 +89,8 @@ { _dslrSeverityLevels = mempty } --- | The available severity levels for the support case. Available severity --- levels are defined by your service level agreement with AWS. +-- | The available severity levels for the support case. Available severity levels +-- are defined by your service level agreement with AWS. dslrSeverityLevels :: Lens' DescribeSeverityLevelsResponse [SeverityLevel] dslrSeverityLevels = lens _dslrSeverityLevels (\s a -> s { _dslrSeverityLevels = a }) diff --git a/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckRefreshStatuses.hs b/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckRefreshStatuses.hs --- a/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckRefreshStatuses.hs +++ b/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckRefreshStatuses.hs @@ -21,8 +21,7 @@ -- Portability : non-portable (GHC extensions) -- | Returns the refresh status of the Trusted Advisor checks that have the --- specified check IDs. Check IDs can be obtained by calling --- DescribeTrustedAdvisorChecks. +-- specified check IDs. Check IDs can be obtained by calling 'DescribeTrustedAdvisorChecks'. -- -- module Network.AWS.Support.DescribeTrustedAdvisorCheckRefreshStatuses diff --git a/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckResult.hs b/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckResult.hs --- a/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckResult.hs +++ b/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckResult.hs @@ -20,15 +20,17 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | 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: --- TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail --- TrustedAdvisorResourcesSummary In addition, the response contains these --- fields: Status. The alert status of the check: "ok" (green), "warning" --- (yellow), "error" (red), or "not_available". Timestamp. The time of the --- last refresh of the check. CheckId. The unique identifier for the check. +-- | 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: +-- +-- 'TrustedAdvisorCategorySpecificSummary' 'TrustedAdvisorResourceDetail' 'TrustedAdvisorResourcesSummary' In addition, the response contains these fields: +-- +-- Status. The alert status of the check: "ok" (green), "warning" (yellow), +-- "error" (red), or "not_available". Timestamp. The time of the last refresh +-- of the check. CheckId. The unique identifier for the check. -- -- module Network.AWS.Support.DescribeTrustedAdvisorCheckResult diff --git a/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckSummaries.hs b/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckSummaries.hs --- a/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckSummaries.hs +++ b/gen/Network/AWS/Support/DescribeTrustedAdvisorCheckSummaries.hs @@ -20,10 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | 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. +-- | 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. -- -- module Network.AWS.Support.DescribeTrustedAdvisorCheckSummaries diff --git a/gen/Network/AWS/Support/DescribeTrustedAdvisorChecks.hs b/gen/Network/AWS/Support/DescribeTrustedAdvisorChecks.hs --- a/gen/Network/AWS/Support/DescribeTrustedAdvisorChecks.hs +++ b/gen/Network/AWS/Support/DescribeTrustedAdvisorChecks.hs @@ -23,7 +23,7 @@ -- | 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. +-- response contains a 'TrustedAdvisorCheckDescription' for each check. -- -- module Network.AWS.Support.DescribeTrustedAdvisorChecks diff --git a/gen/Network/AWS/Support/RefreshTrustedAdvisorCheck.hs b/gen/Network/AWS/Support/RefreshTrustedAdvisorCheck.hs --- a/gen/Network/AWS/Support/RefreshTrustedAdvisorCheck.hs +++ b/gen/Network/AWS/Support/RefreshTrustedAdvisorCheck.hs @@ -20,13 +20,15 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | 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 --- RefreshTrustedAdvisorCheckResult object, which contains these fields: +-- | 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 'RefreshTrustedAdvisorCheckResult' object, which +-- contains these fields: +-- -- Status. The refresh status of the check: "none", "enqueued", "processing", --- "success", or "abandoned". MillisUntilNextRefreshable. The amount of time, --- in milliseconds, until the check is eligible for refresh. CheckId. The +-- "success", or "abandoned". MillisUntilNextRefreshable. The amount of time, +-- in milliseconds, until the check is eligible for refresh. CheckId. The -- unique identifier for the check. -- -- @@ -88,8 +90,8 @@ { _rtacrStatus = p1 } --- | The current refresh status for a check, including the amount of time --- until the check is eligible for refresh. +-- | The current refresh status for a check, including the amount of time until +-- the check is eligible for refresh. rtacrStatus :: Lens' RefreshTrustedAdvisorCheckResponse TrustedAdvisorCheckRefreshStatus rtacrStatus = lens _rtacrStatus (\s a -> s { _rtacrStatus = a }) diff --git a/gen/Network/AWS/Support/ResolveCase.hs b/gen/Network/AWS/Support/ResolveCase.hs --- a/gen/Network/AWS/Support/ResolveCase.hs +++ b/gen/Network/AWS/Support/ResolveCase.hs @@ -20,8 +20,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Takes a CaseId and returns the initial state of the case along with the --- state of the case after the call to ResolveCase completed. +-- | Takes a 'CaseId' and returns the initial state of the case along with the state +-- of the case after the call to 'ResolveCase' completed. -- -- module Network.AWS.Support.ResolveCase @@ -62,9 +62,8 @@ { _rcCaseId = Nothing } --- | The AWS Support case ID requested or returned in the call. The case ID is --- an alphanumeric string formatted as shown in this example: --- case-12345678910-2013-c4c1d2bf33c5cf47. +-- | The AWS Support case ID requested or returned in the call. The case ID is an +-- alphanumeric string formatted as shown in this example: case-/12345678910-2013-c4c1d2bf33c5cf47/ rcCaseId :: Lens' ResolveCase (Maybe Text) rcCaseId = lens _rcCaseId (\s a -> s { _rcCaseId = a }) @@ -87,12 +86,12 @@ , _rcrFinalCaseStatus = Nothing } --- | The status of the case after the ResolveCase request was processed. +-- | The status of the case after the 'ResolveCase' request was processed. rcrFinalCaseStatus :: Lens' ResolveCaseResponse (Maybe Text) rcrFinalCaseStatus = lens _rcrFinalCaseStatus (\s a -> s { _rcrFinalCaseStatus = a }) --- | The status of the case when the ResolveCase request was sent. +-- | The status of the case when the 'ResolveCase' request was sent. rcrInitialCaseStatus :: Lens' ResolveCaseResponse (Maybe Text) rcrInitialCaseStatus = lens _rcrInitialCaseStatus (\s a -> s { _rcrInitialCaseStatus = a }) diff --git a/gen/Network/AWS/Support/Types.hs b/gen/Network/AWS/Support/Types.hs --- a/gen/Network/AWS/Support/Types.hs +++ b/gen/Network/AWS/Support/Types.hs @@ -209,20 +209,19 @@ , _tarsResourcesSuppressed = p4 } --- | The number of AWS resources that were flagged (listed) by the Trusted --- Advisor check. +-- | The number of AWS resources that were flagged (listed) by the Trusted Advisor +-- check. tarsResourcesFlagged :: Lens' TrustedAdvisorResourcesSummary Integer tarsResourcesFlagged = lens _tarsResourcesFlagged (\s a -> s { _tarsResourcesFlagged = a }) --- | The number of AWS resources ignored by Trusted Advisor because --- information was unavailable. +-- | The number of AWS resources ignored by Trusted Advisor because information +-- was unavailable. tarsResourcesIgnored :: Lens' TrustedAdvisorResourcesSummary Integer tarsResourcesIgnored = lens _tarsResourcesIgnored (\s a -> s { _tarsResourcesIgnored = a }) --- | The number of AWS resources that were analyzed by the Trusted Advisor --- check. +-- | The number of AWS resources that were analyzed by the Trusted Advisor check. tarsResourcesProcessed :: Lens' TrustedAdvisorResourcesSummary Integer tarsResourcesProcessed = lens _tarsResourcesProcessed (\s a -> s { _tarsResourcesProcessed = a }) @@ -263,8 +262,8 @@ { _tacssCostOptimizing = Nothing } --- | The summary information about cost savings for a Trusted Advisor check --- that is in the Cost Optimizing category. +-- | The summary information about cost savings for a Trusted Advisor check that +-- is in the Cost Optimizing category. tacssCostOptimizing :: Lens' TrustedAdvisorCategorySpecificSummary (Maybe TrustedAdvisorCostOptimizingSummary) tacssCostOptimizing = lens _tacssCostOptimizing (\s a -> s { _tacssCostOptimizing = a }) @@ -317,9 +316,8 @@ cBody :: Lens' Communication (Maybe Text) cBody = lens _cBody (\s a -> s { _cBody = a }) --- | The AWS Support case ID requested or returned in the call. The case ID is --- an alphanumeric string formatted as shown in this example: --- case-12345678910-2013-c4c1d2bf33c5cf47. +-- | The AWS Support case ID requested or returned in the call. The case ID is an +-- alphanumeric string formatted as shown in this example: case-/12345678910-2013-c4c1d2bf33c5cf47/ cCaseId :: Lens' Communication (Maybe Text) cCaseId = lens _cCaseId (\s a -> s { _cCaseId = a }) @@ -649,11 +647,11 @@ tacdId :: Lens' TrustedAdvisorCheckDescription Text tacdId = lens _tacdId (\s a -> s { _tacdId = a }) --- | The column headings for the data returned by the Trusted Advisor check. --- The order of the headings corresponds to the order of the data in the --- Metadata element of the TrustedAdvisorResourceDetail for the check. --- Metadata contains all the data that is shown in the Excel download, even --- in those cases where the UI shows just summary data. +-- | The column headings for the data returned by the Trusted Advisor check. The +-- order of the headings corresponds to the order of the data in the Metadata +-- element of the 'TrustedAdvisorResourceDetail' for the check. Metadata contains +-- all the data that is shown in the Excel download, even in those cases where +-- the UI shows just summary data. tacdMetadata :: Lens' TrustedAdvisorCheckDescription [Text] tacdMetadata = lens _tacdMetadata (\s a -> s { _tacdMetadata = a }) . _List @@ -781,17 +779,15 @@ -- | A list of categories that describe the type of support issue a case -- describes. Categories consist of a category name and a category code. --- Category names and codes are passed to AWS Support when you call --- CreateCase. +-- Category names and codes are passed to AWS Support when you call 'CreateCase'. ssCategories :: Lens' SupportService [Category] ssCategories = lens _ssCategories (\s a -> s { _ssCategories = a }) . _List --- | The code for an AWS service returned by the DescribeServices response. --- The Name element contains the corresponding friendly name. +-- | The code for an AWS service returned by the 'DescribeServices' response. The 'Name' element contains the corresponding friendly name. ssCode :: Lens' SupportService (Maybe Text) ssCode = lens _ssCode (\s a -> s { _ssCode = a }) --- | The friendly name for an AWS service. The Code element contains the +-- | The friendly name for an AWS service. The 'Code' element contains the -- corresponding code. ssName :: Lens' SupportService (Maybe Text) ssName = lens _ssName (\s a -> s { _ssName = a }) @@ -843,17 +839,16 @@ , _tardMetadata = mempty } --- | Specifies whether the AWS resource was ignored by Trusted Advisor because --- it was marked as suppressed by the user. +-- | Specifies whether the AWS resource was ignored by Trusted Advisor because it +-- was marked as suppressed by the user. tardIsSuppressed :: Lens' TrustedAdvisorResourceDetail (Maybe Bool) tardIsSuppressed = lens _tardIsSuppressed (\s a -> s { _tardIsSuppressed = a }) --- | Additional information about the identified resource. The exact metadata --- and its order can be obtained by inspecting the --- TrustedAdvisorCheckDescription object returned by the call to --- DescribeTrustedAdvisorChecks. Metadata contains all the data that is --- shown in the Excel download, even in those cases where the UI shows just --- summary data. +-- | Additional information about the identified resource. The exact metadata and +-- its order can be obtained by inspecting the 'TrustedAdvisorCheckDescription' +-- object returned by the call to 'DescribeTrustedAdvisorChecks'. Metadata +-- contains all the data that is shown in the Excel download, even in those +-- cases where the UI shows just summary data. tardMetadata :: Lens' TrustedAdvisorResourceDetail [Text] tardMetadata = lens _tardMetadata (\s a -> s { _tardMetadata = a }) . _List @@ -914,8 +909,8 @@ lens _tacosEstimatedMonthlySavings (\s a -> s { _tacosEstimatedMonthlySavings = a }) --- | The estimated percentage of savings that might be realized if the --- recommended actions are taken. +-- | The estimated percentage of savings that might be realized if the recommended +-- actions are taken. tacosEstimatedPercentMonthlySavings :: Lens' TrustedAdvisorCostOptimizingSummary Double tacosEstimatedPercentMonthlySavings = lens _tacosEstimatedPercentMonthlySavings @@ -952,13 +947,11 @@ } -- | One of four values: "low," "medium," "high," and "urgent". These values --- correspond to response times returned to the caller in --- SeverityLevel.name. +-- correspond to response times returned to the caller in 'SeverityLevel.name'. slCode :: Lens' SeverityLevel (Maybe Text) slCode = lens _slCode (\s a -> s { _slCode = a }) --- | The name of the severity level that corresponds to the severity level --- code. +-- | The name of the severity level that corresponds to the severity level code. slName :: Lens' SeverityLevel (Maybe Text) slName = lens _slName (\s a -> s { _slName = a }) @@ -1032,9 +1025,8 @@ , _cdLanguage = Nothing } --- | The AWS Support case ID requested or returned in the call. The case ID is --- an alphanumeric string formatted as shown in this example: --- case-12345678910-2013-c4c1d2bf33c5cf47. +-- | The AWS Support case ID requested or returned in the call. The case ID is an +-- alphanumeric string formatted as shown in this example: case-/12345678910-2013-c4c1d2bf33c5cf47/ cdCaseId :: Lens' CaseDetails (Maybe Text) cdCaseId = lens _cdCaseId (\s a -> s { _cdCaseId = a }) @@ -1048,8 +1040,8 @@ lens _cdCcEmailAddresses (\s a -> s { _cdCcEmailAddresses = a }) . _List --- | The ID displayed for the case in the AWS Support Center. This is a --- numeric string. +-- | The ID displayed for the case in the AWS Support Center. This is a numeric +-- string. cdDisplayId :: Lens' CaseDetails (Maybe Text) cdDisplayId = lens _cdDisplayId (\s a -> s { _cdDisplayId = a }) @@ -1060,18 +1052,17 @@ cdLanguage = lens _cdLanguage (\s a -> s { _cdLanguage = a }) -- | The five most recent communications between you and AWS Support Center, --- including the IDs of any attachments to the communications. Also includes --- a nextToken that you can use to retrieve earlier communications. +-- including the IDs of any attachments to the communications. Also includes a 'nextToken' that you can use to retrieve earlier communications. cdRecentCommunications :: Lens' CaseDetails (Maybe RecentCaseCommunications) cdRecentCommunications = lens _cdRecentCommunications (\s a -> s { _cdRecentCommunications = a }) --- | The code for the AWS service returned by the call to DescribeServices. +-- | The code for the AWS service returned by the call to 'DescribeServices'. cdServiceCode :: Lens' CaseDetails (Maybe Text) cdServiceCode = lens _cdServiceCode (\s a -> s { _cdServiceCode = a }) --- | The code for the severity level returned by the call to --- DescribeSeverityLevels. +-- | The code for the severity level returned by the call to 'DescribeSeverityLevels' +-- . cdSeverityCode :: Lens' CaseDetails (Maybe Text) cdSeverityCode = lens _cdSeverityCode (\s a -> s { _cdSeverityCode = a })