Class: Aws::Support::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Support::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-support/client.rb
Overview
An API client for Support. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Support::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#add_attachments_to_set(params = {}) ⇒ Types::AddAttachmentsToSetResponse
Adds one or more attachments to an attachment set.
-
#add_communication_to_case(params = {}) ⇒ Types::AddCommunicationToCaseResponse
Adds additional customer communication to an Amazon Web Services Support case.
-
#create_case(params = {}) ⇒ Types::CreateCaseResponse
Creates a case in the Amazon Web Services Support Center.
-
#describe_attachment(params = {}) ⇒ Types::DescribeAttachmentResponse
Returns the attachment that has the specified ID.
-
#describe_cases(params = {}) ⇒ Types::DescribeCasesResponse
Returns a list of cases that you specify by passing one or more case IDs.
-
#describe_communications(params = {}) ⇒ Types::DescribeCommunicationsResponse
Returns communications and attachments for one or more support cases.
-
#describe_create_case_options(params = {}) ⇒ Types::DescribeCreateCaseOptionsResponse
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
-
#describe_services(params = {}) ⇒ Types::DescribeServicesResponse
Returns the current list of Amazon Web Services services and a list of service categories for each service.
-
#describe_severity_levels(params = {}) ⇒ Types::DescribeSeverityLevelsResponse
Returns the list of severity levels that you can assign to a support case.
-
#describe_supported_languages(params = {}) ⇒ Types::DescribeSupportedLanguagesResponse
Returns a list of supported languages for a specified ‘categoryCode`, `issueType` and `serviceCode`.
-
#describe_trusted_advisor_check_refresh_statuses(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
-
#describe_trusted_advisor_check_result(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckResultResponse
Returns the results of the Trusted Advisor check that has the specified check ID.
-
#describe_trusted_advisor_check_summaries(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckSummariesResponse
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
-
#describe_trusted_advisor_checks(params = {}) ⇒ Types::DescribeTrustedAdvisorChecksResponse
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata.
-
#refresh_trusted_advisor_check(params = {}) ⇒ Types::RefreshTrustedAdvisorCheckResponse
Refreshes the Trusted Advisor check that you specify using the check ID.
-
#resolve_case(params = {}) ⇒ Types::ResolveCaseResponse
Resolves a support case.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'lib/aws-sdk-support/client.rb', line 429 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1716 1717 1718 |
# File 'lib/aws-sdk-support/client.rb', line 1716 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1719 1720 1721 |
# File 'lib/aws-sdk-support/client.rb', line 1719 def errors_module Errors end |
Instance Method Details
#add_attachments_to_set(params = {}) ⇒ Types::AddAttachmentsToSetResponse
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it’s created. The ‘expiryTime` returned in the response is when the set expires.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
499 500 501 502 |
# File 'lib/aws-sdk-support/client.rb', line 499 def (params = {}, = {}) req = build_request(:add_attachments_to_set, params) req.send_request() end |
#add_communication_to_case(params = {}) ⇒ Types::AddCommunicationToCaseResponse
Adds additional customer communication to an Amazon Web Services Support case. Use the ‘caseId` parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the `ccEmailAddresses` parameter. The `communicationBody` value contains the text of the communication.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
562 563 564 565 |
# File 'lib/aws-sdk-support/client.rb', line 562 def add_communication_to_case(params = {}, = {}) req = build_request(:add_communication_to_case, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 |
# File 'lib/aws-sdk-support/client.rb', line 1694 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-support' context[:gem_version] = '1.63.0' Seahorse::Client::Request.new(handlers, context) end |
#create_case(params = {}) ⇒ Types::CreateCaseResponse
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center [Create Case] page.
The Amazon Web Services Support API doesn’t support requesting service limit increases. You can submit a service limit increase in the following ways:
-
Submit a request from the Amazon Web Services Support Center [Create Case] page.
-
Use the Service Quotas [RequestServiceQuotaIncrease] operation.
A successful ‘CreateCase` request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.
The ‘caseId` is separate from the `displayId` that appears in the [Amazon Web Services Support Center]. Use the DescribeCases operation to get the `displayId`.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
[1]: console.aws.amazon.com/support/home#/case/create [2]: docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html [3]: console.aws.amazon.com/support [4]: aws.amazon.com/premiumsupport/
707 708 709 710 |
# File 'lib/aws-sdk-support/client.rb', line 707 def create_case(params = {}, = {}) req = build_request(:create_case, params) req.send_request() end |
#describe_attachment(params = {}) ⇒ Types::DescribeAttachmentResponse
Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. 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.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
757 758 759 760 |
# File 'lib/aws-sdk-support/client.rb', line 757 def (params = {}, = {}) req = build_request(:describe_attachment, params) req.send_request() end |
#describe_cases(params = {}) ⇒ Types::DescribeCasesResponse
Returns a list of cases that you specify by passing one or more case IDs. You can use the ‘afterTime` and `beforeTime` parameters to filter the cases by date. You can set values for the `includeResolvedCases` and `includeCommunications` parameters to specify how much information to return.
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.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
[1]: docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html [2]: aws.amazon.com/premiumsupport/
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
884 885 886 887 |
# File 'lib/aws-sdk-support/client.rb', line 884 def describe_cases(params = {}, = {}) req = build_request(:describe_cases, params) req.send_request() end |
#describe_communications(params = {}) ⇒ Types::DescribeCommunicationsResponse
Returns communications and attachments for one or more support cases. Use the ‘afterTime` and `beforeTime` parameters to filter by date. You can use the `caseId` parameter to restrict the results to a specific 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 results. Set `maxResults` to the number of cases that you want to display on each page, and use `nextToken` to specify the resumption of pagination.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
[1]: aws.amazon.com/premiumsupport/
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
972 973 974 975 |
# File 'lib/aws-sdk-support/client.rb', line 972 def describe_communications(params = {}, = {}) req = build_request(:describe_communications, params) req.send_request() end |
#describe_create_case_options(params = {}) ⇒ Types::DescribeCreateCaseOptionsResponse
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the ‘language` `categoryCode`, `issueType` and `serviceCode` used to retrieve the CreateCaseOptions.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
1049 1050 1051 1052 |
# File 'lib/aws-sdk-support/client.rb', line 1049 def (params = {}, = {}) req = build_request(:describe_create_case_options, params) req.send_request() end |
#describe_services(params = {}) ⇒ Types::DescribeServicesResponse
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center [Create Case] page. The values in those fields don’t necessarily match the service codes and categories returned by the ‘DescribeServices` operation. Always use the service codes and categories that the `DescribeServices` operation returns, so that you have the most recent set of service and category codes.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
[1]: console.aws.amazon.com/support/home#/case/create [2]: aws.amazon.com/premiumsupport/
1118 1119 1120 1121 |
# File 'lib/aws-sdk-support/client.rb', line 1118 def describe_services(params = {}, = {}) req = build_request(:describe_services, params) req.send_request() end |
#describe_severity_levels(params = {}) ⇒ Types::DescribeSeverityLevelsResponse
Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
1169 1170 1171 1172 |
# File 'lib/aws-sdk-support/client.rb', line 1169 def describe_severity_levels(params = {}, = {}) req = build_request(:describe_severity_levels, params) req.send_request() end |
#describe_supported_languages(params = {}) ⇒ Types::DescribeSupportedLanguagesResponse
Returns a list of supported languages for a specified ‘categoryCode`, `issueType` and `serviceCode`. The returned supported languages will include a ISO 639-1 code for the `language`, and the language display name.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
1231 1232 1233 1234 |
# File 'lib/aws-sdk-support/client.rb', line 1231 def describe_supported_languages(params = {}, = {}) req = build_request(:describe_supported_languages, params) req.send_request() end |
#describe_trusted_advisor_check_refresh_statuses(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can’t return their refresh statuses by using the ‘DescribeTrustedAdvisorCheckRefreshStatuses` operation. If you call this operation for these checks, you might see an `InvalidParameterValue` error.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don’t support the Trusted Advisor operations. For more information, see
- About the Amazon Web Services Support API][2
-
in the *Amazon Web
Services Support User Guide*.
[1]: aws.amazon.com/premiumsupport/ [2]: docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint
1298 1299 1300 1301 |
# File 'lib/aws-sdk-support/client.rb', line 1298 def describe_trusted_advisor_check_refresh_statuses(params = {}, = {}) req = build_request(:describe_trusted_advisor_check_refresh_statuses, params) req.send_request() end |
#describe_trusted_advisor_check_result(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckResultResponse
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
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 can be ‘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.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don’t support the Trusted Advisor operations. For more information, see
- About the Amazon Web Services Support API][2
-
in the *Amazon Web
Services Support User Guide*.
[1]: aws.amazon.com/premiumsupport/ [2]: docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint
1414 1415 1416 1417 |
# File 'lib/aws-sdk-support/client.rb', line 1414 def describe_trusted_advisor_check_result(params = {}, = {}) req = build_request(:describe_trusted_advisor_check_result, params) req.send_request() end |
#describe_trusted_advisor_check_summaries(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckSummariesResponse
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don’t support the Trusted Advisor operations. For more information, see
- About the Amazon Web Services Support API][2
-
in the *Amazon Web
Services Support User Guide*.
[1]: aws.amazon.com/premiumsupport/ [2]: docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint
1479 1480 1481 1482 |
# File 'lib/aws-sdk-support/client.rb', line 1479 def describe_trusted_advisor_check_summaries(params = {}, = {}) req = build_request(:describe_trusted_advisor_check_summaries, params) req.send_request() end |
#describe_trusted_advisor_checks(params = {}) ⇒ Types::DescribeTrustedAdvisorChecksResponse
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.
The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
-
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
</note>
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don’t support the Trusted Advisor operations. For more information, see
- About the Amazon Web Services Support API][2
-
in the *Amazon Web
Services Support User Guide*.
[1]: aws.amazon.com/premiumsupport/ [2]: docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint
1571 1572 1573 1574 |
# File 'lib/aws-sdk-support/client.rb', line 1571 def describe_trusted_advisor_checks(params = {}, = {}) req = build_request(:describe_trusted_advisor_checks, params) req.send_request() end |
#refresh_trusted_advisor_check(params = {}) ⇒ Types::RefreshTrustedAdvisorCheckResponse
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the ‘RefreshTrustedAdvisorCheck` operation to refresh them, you might see the `InvalidParameterValue` error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don’t support the Trusted Advisor operations. For more information, see
- About the Amazon Web Services Support API][2
-
in the *Amazon Web
Services Support User Guide*.
[1]: aws.amazon.com/premiumsupport/ [2]: docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint
1637 1638 1639 1640 |
# File 'lib/aws-sdk-support/client.rb', line 1637 def refresh_trusted_advisor_check(params = {}, = {}) req = build_request(:refresh_trusted_advisor_check, params) req.send_request() end |
#resolve_case(params = {}) ⇒ Types::ResolveCaseResponse
Resolves a support case. This operation takes a ‘caseId` and returns the initial and final state of the case.
<note markdown=“1”> * You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the ‘SubscriptionRequiredException` error message appears. For information about changing your support plan, see [Amazon Web Services Support].
</note>
1685 1686 1687 1688 |
# File 'lib/aws-sdk-support/client.rb', line 1685 def resolve_case(params = {}, = {}) req = build_request(:resolve_case, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1709 1710 1711 |
# File 'lib/aws-sdk-support/client.rb', line 1709 def waiter_names [] end |