Support class

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

• You must have a Business or Enterprise support plan to use the AWS Support API.
• 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 AWS Support service also exposes a set of AWS 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.

Constructors

Support({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addAttachmentsToSet({required List<Attachment> attachments, String? attachmentSetId}) → Future<AddAttachmentsToSetResponse>

Adds one or more attachments to an attachment set.

addCommunicationToCase({required String communicationBody, String? attachmentSetId, String? caseId, List<String>? ccEmailAddresses}) → Future<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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createCase({required String communicationBody, required String subject, String? attachmentSetId, String? categoryCode, List<String>? ccEmailAddresses, String? issueType, String? language, String? serviceCode, String? severityCode}) → Future<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.

describeAttachment({required String attachmentId}) → Future<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.

describeCases({String? afterTime, String? beforeTime, List<String>? caseIdList, String? displayId, bool? includeCommunications, bool? includeResolvedCases, String? language, int? maxResults, String? nextToken}) → Future<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.

describeCommunications({required String caseId, String? afterTime, String? beforeTime, int? maxResults, String? nextToken}) → Future<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.

describeServices({String? language, List<String>? serviceCodeList}) → Future<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.

describeSeverityLevels({String? language}) → Future<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.

describeTrustedAdvisorCheckRefreshStatuses({required List<String> checkIds}) → Future<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.

describeTrustedAdvisorCheckResult({required String checkId, String? language}) → Future<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.

describeTrustedAdvisorChecks({required String language}) → Future<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.

describeTrustedAdvisorCheckSummaries({required List<String> checkIds}) → Future<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.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

refreshTrustedAdvisorCheck({required String checkId}) → Future<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. The response contains a TrustedAdvisorCheckRefreshStatus object.

resolveCase({String? caseId}) → Future<ResolveCaseResponse>

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

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited