Class: Aws::Support::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Support::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-support/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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 AWS Support case.
-
#create_case(params = {}) ⇒ Types::CreateCaseResponse
Creates a case in the AWS 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_services(params = {}) ⇒ Types::DescribeServicesResponse
Returns the current list of AWS 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 an AWS Support case.
-
#describe_trusted_advisor_check_refresh_statuses(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse
Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs.
-
#describe_trusted_advisor_check_result(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckResultResponse
Returns the results of the AWS Trusted Advisor check that has the specified check ID.
-
#describe_trusted_advisor_check_summaries(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckSummariesResponse
Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified.
-
#describe_trusted_advisor_checks(params = {}) ⇒ Types::DescribeTrustedAdvisorChecksResponse
Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata.
-
#refresh_trusted_advisor_check(params = {}) ⇒ Types::RefreshTrustedAdvisorCheckResponse
Refreshes the AWS Trusted Advisor check that you specify using the check ID.
-
#resolve_case(params = {}) ⇒ Types::ResolveCaseResponse
Resolves a support case.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 334 def initialize(*args) super 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
403 404 405 406 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 403 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 AWS 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
465 466 467 468 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 465 def add_communication_to_case(params = {}, = {}) req = build_request(:add_communication_to_case, params) req.send_request() end |
#create_case(params = {}) ⇒ Types::CreateCaseResponse
Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support Center Create Case page.
The AWS 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 AWS Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase
request returns an AWS Support case number.
You can use the DescribeCases operation and specify the case number to
get existing AWS 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 AWS
Support Center. Use the DescribeCases operation to get the
displayId
.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
603 604 605 606 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 603 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
652 653 654 655 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 652 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 theCaseDetails
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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
776 777 778 779 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 776 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
863 864 865 866 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 863 def describe_communications(params = {}, = {}) req = build_request(:describe_communications, params) req.send_request() end |
#describe_services(params = {}) ⇒ Types::DescribeServicesResponse
Returns the current list of AWS services and a list of service categories for each service. 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
appear in the Service and Category lists on the AWS 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
929 930 931 932 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 929 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 an AWS Support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
978 979 980 981 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 978 def describe_severity_levels(params = {}, = {}) req = build_request(:describe_severity_levels, params) req.send_request() end |
#describe_trusted_advisor_check_refresh_statuses(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse
Returns the refresh status of the AWS 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1036 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 AWS 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: "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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
1120 1121 1122 1123 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1120 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 AWS 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
1176 1177 1178 1179 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1176 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 AWS Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The AWS Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the AWS Region to us-east-1.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
1232 1233 1234 1235 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1232 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 AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
RefreshTrustedAdvisorCheck
operation to refresh them, you might see
the InvalidParameterValue
error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
1288 1289 1290 1291 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1288 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.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see AWS Support.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1335 def resolve_case(params = {}, = {}) req = build_request(:resolve_case, params) req.send_request() end |