View on GitHub

aws-sdk-swift

SupportClient

public class SupportClient

Inheritance

SupportClientProtocol

Initializers

init(config:)

public init(config: AWSClientRuntime.AWSClientConfiguration)

init(region:)

public convenience init(region: Swift.String? = nil) throws

Properties

clientName

public static let clientName = "SupportClient"

Methods

addAttachmentsToSet(input:completion:)

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.

public func addAttachmentsToSet(input: AddAttachmentsToSetInput, completion: @escaping (ClientRuntime.SdkResult<AddAttachmentsToSetOutputResponse, AddAttachmentsToSetOutputError>) -> Void)

addCommunicationToCase(input:completion:)

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.

public func addCommunicationToCase(input: AddCommunicationToCaseInput, completion: @escaping (ClientRuntime.SdkResult<AddCommunicationToCaseOutputResponse, AddCommunicationToCaseOutputError>) -> Void)

createCase(input:completion:)

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:

public func createCase(input: CreateCaseInput, completion: @escaping (ClientRuntime.SdkResult<CreateCaseOutputResponse, CreateCaseOutputError>) -> Void)

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.

describeAttachment(input:completion:)

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.

public func describeAttachment(input: DescribeAttachmentInput, completion: @escaping (ClientRuntime.SdkResult<DescribeAttachmentOutputResponse, DescribeAttachmentOutputError>) -> Void)

describeCases(input:completion:)

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:

public func describeCases(input: DescribeCasesInput, completion: @escaping (ClientRuntime.SdkResult<DescribeCasesOutputResponse, DescribeCasesOutputError>) -> Void)

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.

describeCommunications(input:completion:)

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.

public func describeCommunications(input: DescribeCommunicationsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeCommunicationsOutputResponse, DescribeCommunicationsOutputError>) -> Void)

describeServices(input:completion:)

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.

public func describeServices(input: DescribeServicesInput, completion: @escaping (ClientRuntime.SdkResult<DescribeServicesOutputResponse, DescribeServicesOutputError>) -> Void)

describeSeverityLevels(input:completion:)

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.

public func describeSeverityLevels(input: DescribeSeverityLevelsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeSeverityLevelsOutputResponse, DescribeSeverityLevelsOutputError>) -> Void)

describeTrustedAdvisorCheckRefreshStatuses(input:completion:)

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.

public func describeTrustedAdvisorCheckRefreshStatuses(input: DescribeTrustedAdvisorCheckRefreshStatusesInput, completion: @escaping (ClientRuntime.SdkResult<DescribeTrustedAdvisorCheckRefreshStatusesOutputResponse, DescribeTrustedAdvisorCheckRefreshStatusesOutputError>) -> Void)

describeTrustedAdvisorCheckResult(input:completion:)

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:

public func describeTrustedAdvisorCheckResult(input: DescribeTrustedAdvisorCheckResultInput, completion: @escaping (ClientRuntime.SdkResult<DescribeTrustedAdvisorCheckResultOutputResponse, DescribeTrustedAdvisorCheckResultOutputError>) -> Void)

In addition, the response contains these fields:

describeTrustedAdvisorCheckSummaries(input:completion:)

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.

public func describeTrustedAdvisorCheckSummaries(input: DescribeTrustedAdvisorCheckSummariesInput, completion: @escaping (ClientRuntime.SdkResult<DescribeTrustedAdvisorCheckSummariesOutputResponse, DescribeTrustedAdvisorCheckSummariesOutputError>) -> Void)

describeTrustedAdvisorChecks(input:completion:)

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.

public func describeTrustedAdvisorChecks(input: DescribeTrustedAdvisorChecksInput, completion: @escaping (ClientRuntime.SdkResult<DescribeTrustedAdvisorChecksOutputResponse, DescribeTrustedAdvisorChecksOutputError>) -> Void)

refreshTrustedAdvisorCheck(input:completion:)

Refreshes the AWS 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.

public func refreshTrustedAdvisorCheck(input: RefreshTrustedAdvisorCheckInput, completion: @escaping (ClientRuntime.SdkResult<RefreshTrustedAdvisorCheckOutputResponse, RefreshTrustedAdvisorCheckOutputError>) -> Void)

resolveCase(input:completion:)

Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.

public func resolveCase(input: ResolveCaseInput, completion: @escaping (ClientRuntime.SdkResult<ResolveCaseOutputResponse, ResolveCaseOutputError>) -> Void)