Support
Service object for interacting with AWS Support service.
public struct Support: AWSService
The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
-
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 does not 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 Amazon Web Services 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 Amazon Web Services Support case management operations:
-
Service names, issue categories, and available severity levels - The DescribeServices and DescribeSeverityLevels operations return Amazon Web Services 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 Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
-
Case communication - The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
The following list describes the operations available from the Amazon Web Services Support service for Trusted Advisor:
-
DescribeTrustedAdvisorChecks returns the list of checks that run against your Amazon Web Services resources.
-
Using the
checkId
for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check that 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, Amazon Web Services Support uses Signature Version 4 Signing Process.
See About the Amazon Web Services Support API in the Amazon Web Services 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.
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the Support client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: Support, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
addAttachmentsToSet(_:logger:on:)
public func addAttachmentsToSet(_ input: AddAttachmentsToSetRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
addCommunicationToCase(_:logger:on:)
public func addCommunicationToCase(_ input: AddCommunicationToCaseRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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>
<ul>
<li>
<p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
API. </p>
</li>
<li>
<p>If you call the Amazon Web Services Support API from an account that does not have a
Business, Enterprise On-Ramp, or Enterprise Support plan, the
<code>SubscriptionRequiredException</code> error message appears. For
information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
</li>
</ul>
</note>
createCase(_:logger:on:)
public func createCase(_ input: CreateCaseRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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
.
-
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 does not 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.
describeAttachment(_:logger:on:)
public func describeAttachment(_ input: DescribeAttachmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
describeCases(_:logger:on:)
public func describeCases(_ input: DescribeCasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
describeCommunications(_:logger:on:)
public func describeCommunications(_ input: DescribeCommunicationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
describeServices(_:logger:on:)
public func describeServices(_ input: DescribeServicesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
describeSeverityLevels(_:logger:on:)
public func describeSeverityLevels(_ input: DescribeSeverityLevelsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
describeTrustedAdvisorCheckRefreshStatuses(_:logger:on:)
public func describeTrustedAdvisorCheckRefreshStatuses(_ input: DescribeTrustedAdvisorCheckRefreshStatusesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
describeTrustedAdvisorCheckResult(_:logger:on:)
public func describeTrustedAdvisorCheckResult(_ input: DescribeTrustedAdvisorCheckResultRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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:
In addition, the response contains these fields:
-
status - The alert status of the check can be
ok
(green),warning
(yellow),error
(red), ornot_available
. -
timestamp - The time of the last refresh of the check.
-
checkId - The unique identifier for the check.
<note>
<ul>
<li>
<p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
API. </p>
</li>
<li>
<p>If you call the Amazon Web Services Support API from an account that does not have a
Business, Enterprise On-Ramp, or Enterprise Support plan, the
<code>SubscriptionRequiredException</code> error message appears. For
information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
</li>
</ul>
</note>
describeTrustedAdvisorCheckSummaries(_:logger:on:)
public func describeTrustedAdvisorCheckSummaries(_ input: DescribeTrustedAdvisorCheckSummariesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
describeTrustedAdvisorChecks(_:logger:on:)
public func describeTrustedAdvisorChecks(_ input: DescribeTrustedAdvisorChecksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeTrustedAdvisorChecksResponse>
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The Amazon Web Services Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
<note>
<ul>
<li>
<p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
API. </p>
</li>
<li>
<p>If you call the Amazon Web Services Support API from an account that does not have a
Business, Enterprise On-Ramp, or Enterprise Support plan, the
<code>SubscriptionRequiredException</code> error message appears. For
information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
</li>
<li>
<p>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.</p>
</li>
</ul>
</note>
refreshTrustedAdvisorCheck(_:logger:on:)
public func refreshTrustedAdvisorCheck(_ input: RefreshTrustedAdvisorCheckRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
-
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 does not 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.
resolveCase(_:logger:on:)
public func resolveCase(_ input: ResolveCaseRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ResolveCaseResponse>
Resolves a support case. This operation takes a caseId
and returns the
initial and final state of the case.
-
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 does not 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.
describeCasesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeCasesPaginator( _ input: DescribeCasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeCasesRequest, DescribeCasesResponse>
Returns a list of cases that you specify by passing one or more case IDs. You can use the
afterTime
andbeforeTime
parameters to filter the cases by date. You can set values for theincludeResolvedCases
andincludeCommunications
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.
-
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 does not 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.
-
describeCommunicationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeCommunicationsPaginator( _ input: DescribeCommunicationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeCommunicationsRequest, DescribeCommunicationsResponse>
Returns communications and attachments for one or more support cases. Use the
afterTime
andbeforeTime
parameters to filter by date. You can use thecaseId
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
andnextToken
parameters to control the pagination of the results. SetmaxResults
to the number of cases that you want to display on each page, and usenextToken
to specify the resumption of pagination.-
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 does not 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.
-
describeCasesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeCasesPaginator<Result>(
_ input: DescribeCasesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeCasesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
-
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 does not 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.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeCasesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeCasesPaginator(
_ input: DescribeCasesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeCasesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeCommunicationsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeCommunicationsPaginator<Result>(
_ input: DescribeCommunicationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeCommunicationsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
-
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 does not 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.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeCommunicationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeCommunicationsPaginator(
_ input: DescribeCommunicationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeCommunicationsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.