support/aws.sdk.kotlin.services.support/SupportClient

SupportClient

Amazon Web Services Support

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 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. You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

You can manage your support cases with the following Amazon Web Services Support API operations:

The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
The DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.

For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Types

Builder

class Builder : AbstractSdkClientBuilder<SupportClient.Config, SupportClient.Config.Builder, SupportClient>

Companion

object Companion : AbstractAwsSdkClientFactory<SupportClient.Config, SupportClient.Config.Builder, SupportClient, SupportClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: SupportClient.Config

SupportClient's configuration

Functions

addAttachmentsToSet

abstract suspend fun addAttachmentsToSet(input: AddAttachmentsToSetRequest): AddAttachmentsToSetResponse

Adds one or more attachments to an attachment set.

addCommunicationToCase

abstract suspend fun addCommunicationToCase(input: AddCommunicationToCaseRequest): 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.

createCase

abstract suspend fun createCase(input: CreateCaseRequest): 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.

describeAttachment

abstract suspend fun describeAttachment(input: DescribeAttachmentRequest): 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

abstract suspend fun describeCases(input: DescribeCasesRequest = DescribeCasesRequest { }): 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

abstract suspend fun describeCommunications(input: DescribeCommunicationsRequest): 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.

describeCreateCaseOptions

abstract suspend fun describeCreateCaseOptions(input: DescribeCreateCaseOptionsRequest): 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.

describeServices

abstract suspend fun describeServices(input: DescribeServicesRequest = DescribeServicesRequest { }): 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.

describeSeverityLevels

abstract suspend fun describeSeverityLevels(input: DescribeSeverityLevelsRequest = DescribeSeverityLevelsRequest { }): 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.

describeSupportedLanguages

abstract suspend fun describeSupportedLanguages(input: DescribeSupportedLanguagesRequest): 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.

describeTrustedAdvisorCheckRefreshStatuses

abstract suspend fun describeTrustedAdvisorCheckRefreshStatuses(input: DescribeTrustedAdvisorCheckRefreshStatusesRequest): 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.

describeTrustedAdvisorCheckResult

abstract suspend fun describeTrustedAdvisorCheckResult(input: DescribeTrustedAdvisorCheckResultRequest): 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.

describeTrustedAdvisorChecks

abstract suspend fun describeTrustedAdvisorChecks(input: DescribeTrustedAdvisorChecksRequest): DescribeTrustedAdvisorChecksResponse

Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

describeTrustedAdvisorCheckSummaries

abstract suspend fun describeTrustedAdvisorCheckSummaries(input: DescribeTrustedAdvisorCheckSummariesRequest): 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.

refreshTrustedAdvisorCheck

abstract suspend fun refreshTrustedAdvisorCheck(input: RefreshTrustedAdvisorCheckRequest): RefreshTrustedAdvisorCheckResponse

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

resolveCase

abstract suspend fun resolveCase(input: ResolveCaseRequest = ResolveCaseRequest { }): ResolveCaseResponse

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

Inherited functions

addAttachmentsToSet

inline suspend fun SupportClient.addAttachmentsToSet(crossinline block: AddAttachmentsToSetRequest.Builder.() -> Unit): AddAttachmentsToSetResponse

Adds one or more attachments to an attachment set.

addCommunicationToCase

inline suspend fun SupportClient.addCommunicationToCase(crossinline block: AddCommunicationToCaseRequest.Builder.() -> Unit): AddCommunicationToCaseResponse

expect abstract fun close()

createCase

inline suspend fun SupportClient.createCase(crossinline block: CreateCaseRequest.Builder.() -> Unit): 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.

describeAttachment

inline suspend fun SupportClient.describeAttachment(crossinline block: DescribeAttachmentRequest.Builder.() -> Unit): DescribeAttachmentResponse

describeCases

inline suspend fun SupportClient.describeCases(crossinline block: DescribeCasesRequest.Builder.() -> Unit): DescribeCasesResponse

describeCasesPaginated

fun SupportClient.describeCasesPaginated(initialRequest: DescribeCasesRequest = DescribeCasesRequest { }): Flow<DescribeCasesResponse>

fun SupportClient.describeCasesPaginated(block: DescribeCasesRequest.Builder.() -> Unit): Flow<DescribeCasesResponse>

Paginate over DescribeCasesResponse results.

describeCommunications

inline suspend fun SupportClient.describeCommunications(crossinline block: DescribeCommunicationsRequest.Builder.() -> Unit): DescribeCommunicationsResponse

describeCommunicationsPaginated

fun SupportClient.describeCommunicationsPaginated(initialRequest: DescribeCommunicationsRequest): Flow<DescribeCommunicationsResponse>

fun SupportClient.describeCommunicationsPaginated(block: DescribeCommunicationsRequest.Builder.() -> Unit): Flow<DescribeCommunicationsResponse>

Paginate over DescribeCommunicationsResponse results.

describeCreateCaseOptions

inline suspend fun SupportClient.describeCreateCaseOptions(crossinline block: DescribeCreateCaseOptionsRequest.Builder.() -> Unit): DescribeCreateCaseOptionsResponse

describeServices

inline suspend fun SupportClient.describeServices(crossinline block: DescribeServicesRequest.Builder.() -> Unit): DescribeServicesResponse

describeSeverityLevels

inline suspend fun SupportClient.describeSeverityLevels(crossinline block: DescribeSeverityLevelsRequest.Builder.() -> Unit): 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.

describeSupportedLanguages

inline suspend fun SupportClient.describeSupportedLanguages(crossinline block: DescribeSupportedLanguagesRequest.Builder.() -> Unit): DescribeSupportedLanguagesResponse

describeTrustedAdvisorCheckRefreshStatuses

inline suspend fun SupportClient.describeTrustedAdvisorCheckRefreshStatuses(crossinline block: DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder.() -> Unit): 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.

describeTrustedAdvisorCheckResult

inline suspend fun SupportClient.describeTrustedAdvisorCheckResult(crossinline block: DescribeTrustedAdvisorCheckResultRequest.Builder.() -> Unit): 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.

describeTrustedAdvisorChecks

inline suspend fun SupportClient.describeTrustedAdvisorChecks(crossinline block: DescribeTrustedAdvisorChecksRequest.Builder.() -> Unit): DescribeTrustedAdvisorChecksResponse

Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

describeTrustedAdvisorCheckSummaries

inline suspend fun SupportClient.describeTrustedAdvisorCheckSummaries(crossinline block: DescribeTrustedAdvisorCheckSummariesRequest.Builder.() -> Unit): 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.

refreshTrustedAdvisorCheck

inline suspend fun SupportClient.refreshTrustedAdvisorCheck(crossinline block: RefreshTrustedAdvisorCheckRequest.Builder.() -> Unit): RefreshTrustedAdvisorCheckResponse

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

resolveCase

inline suspend fun SupportClient.resolveCase(crossinline block: ResolveCaseRequest.Builder.() -> Unit): ResolveCaseResponse

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

withConfig

fun SupportClient.withConfig(block: SupportClient.Config.Builder.() -> Unit): SupportClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.