#include <SupportClient.h>

Inheritance diagram for Aws::Support::SupportClient:

Public Types
typedef Aws::Client::AWSJsonClient	BASECLASS

Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient	BASECLASS

Public Member Functions
	SupportClient (const Client::ClientConfiguration &clientConfiguration=Client::ClientConfiguration())

	SupportClient (const Auth::AWSCredentials &credentials, const Client::ClientConfiguration &clientConfiguration=Client::ClientConfiguration())

	SupportClient (const std::shared_ptr< Auth::AWSCredentialsProvider > &credentialsProvider, const Client::ClientConfiguration &clientConfiguration=Client::ClientConfiguration())

virtual	~SupportClient ()

virtual Model::AddAttachmentsToSetOutcome	AddAttachmentsToSet (const Model::AddAttachmentsToSetRequest &request) const

virtual Model::AddAttachmentsToSetOutcomeCallable	AddAttachmentsToSetCallable (const Model::AddAttachmentsToSetRequest &request) const

virtual void	AddAttachmentsToSetAsync (const Model::AddAttachmentsToSetRequest &request, const AddAttachmentsToSetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::AddCommunicationToCaseOutcome	AddCommunicationToCase (const Model::AddCommunicationToCaseRequest &request) const

virtual Model::AddCommunicationToCaseOutcomeCallable	AddCommunicationToCaseCallable (const Model::AddCommunicationToCaseRequest &request) const

virtual void	AddCommunicationToCaseAsync (const Model::AddCommunicationToCaseRequest &request, const AddCommunicationToCaseResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::CreateCaseOutcome	CreateCase (const Model::CreateCaseRequest &request) const

virtual Model::CreateCaseOutcomeCallable	CreateCaseCallable (const Model::CreateCaseRequest &request) const

virtual void	CreateCaseAsync (const Model::CreateCaseRequest &request, const CreateCaseResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeAttachmentOutcome	DescribeAttachment (const Model::DescribeAttachmentRequest &request) const

virtual Model::DescribeAttachmentOutcomeCallable	DescribeAttachmentCallable (const Model::DescribeAttachmentRequest &request) const

virtual void	DescribeAttachmentAsync (const Model::DescribeAttachmentRequest &request, const DescribeAttachmentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeCasesOutcome	DescribeCases (const Model::DescribeCasesRequest &request) const

virtual Model::DescribeCasesOutcomeCallable	DescribeCasesCallable (const Model::DescribeCasesRequest &request) const

virtual void	DescribeCasesAsync (const Model::DescribeCasesRequest &request, const DescribeCasesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeCommunicationsOutcome	DescribeCommunications (const Model::DescribeCommunicationsRequest &request) const

virtual Model::DescribeCommunicationsOutcomeCallable	DescribeCommunicationsCallable (const Model::DescribeCommunicationsRequest &request) const

virtual void	DescribeCommunicationsAsync (const Model::DescribeCommunicationsRequest &request, const DescribeCommunicationsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeServicesOutcome	DescribeServices (const Model::DescribeServicesRequest &request) const

virtual Model::DescribeServicesOutcomeCallable	DescribeServicesCallable (const Model::DescribeServicesRequest &request) const

virtual void	DescribeServicesAsync (const Model::DescribeServicesRequest &request, const DescribeServicesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeSeverityLevelsOutcome	DescribeSeverityLevels (const Model::DescribeSeverityLevelsRequest &request) const

virtual Model::DescribeSeverityLevelsOutcomeCallable	DescribeSeverityLevelsCallable (const Model::DescribeSeverityLevelsRequest &request) const

virtual void	DescribeSeverityLevelsAsync (const Model::DescribeSeverityLevelsRequest &request, const DescribeSeverityLevelsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeTrustedAdvisorCheckRefreshStatusesOutcome	DescribeTrustedAdvisorCheckRefreshStatuses (const Model::DescribeTrustedAdvisorCheckRefreshStatusesRequest &request) const

virtual Model::DescribeTrustedAdvisorCheckRefreshStatusesOutcomeCallable	DescribeTrustedAdvisorCheckRefreshStatusesCallable (const Model::DescribeTrustedAdvisorCheckRefreshStatusesRequest &request) const

virtual void	DescribeTrustedAdvisorCheckRefreshStatusesAsync (const Model::DescribeTrustedAdvisorCheckRefreshStatusesRequest &request, const DescribeTrustedAdvisorCheckRefreshStatusesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeTrustedAdvisorCheckResultOutcome	DescribeTrustedAdvisorCheckResult (const Model::DescribeTrustedAdvisorCheckResultRequest &request) const

virtual Model::DescribeTrustedAdvisorCheckResultOutcomeCallable	DescribeTrustedAdvisorCheckResultCallable (const Model::DescribeTrustedAdvisorCheckResultRequest &request) const

virtual void	DescribeTrustedAdvisorCheckResultAsync (const Model::DescribeTrustedAdvisorCheckResultRequest &request, const DescribeTrustedAdvisorCheckResultResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeTrustedAdvisorCheckSummariesOutcome	DescribeTrustedAdvisorCheckSummaries (const Model::DescribeTrustedAdvisorCheckSummariesRequest &request) const

virtual Model::DescribeTrustedAdvisorCheckSummariesOutcomeCallable	DescribeTrustedAdvisorCheckSummariesCallable (const Model::DescribeTrustedAdvisorCheckSummariesRequest &request) const

virtual void	DescribeTrustedAdvisorCheckSummariesAsync (const Model::DescribeTrustedAdvisorCheckSummariesRequest &request, const DescribeTrustedAdvisorCheckSummariesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::DescribeTrustedAdvisorChecksOutcome	DescribeTrustedAdvisorChecks (const Model::DescribeTrustedAdvisorChecksRequest &request) const

virtual Model::DescribeTrustedAdvisorChecksOutcomeCallable	DescribeTrustedAdvisorChecksCallable (const Model::DescribeTrustedAdvisorChecksRequest &request) const

virtual void	DescribeTrustedAdvisorChecksAsync (const Model::DescribeTrustedAdvisorChecksRequest &request, const DescribeTrustedAdvisorChecksResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::RefreshTrustedAdvisorCheckOutcome	RefreshTrustedAdvisorCheck (const Model::RefreshTrustedAdvisorCheckRequest &request) const

virtual Model::RefreshTrustedAdvisorCheckOutcomeCallable	RefreshTrustedAdvisorCheckCallable (const Model::RefreshTrustedAdvisorCheckRequest &request) const

virtual void	RefreshTrustedAdvisorCheckAsync (const Model::RefreshTrustedAdvisorCheckRequest &request, const RefreshTrustedAdvisorCheckResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

virtual Model::ResolveCaseOutcome	ResolveCase (const Model::ResolveCaseRequest &request) const

virtual Model::ResolveCaseOutcomeCallable	ResolveCaseCallable (const Model::ResolveCaseRequest &request) const

virtual void	ResolveCaseAsync (const Model::ResolveCaseRequest &request, const ResolveCaseResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

Public Member Functions inherited from Aws::Client::AWSJsonClient
	AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

virtual	~AWSJsonClient ()=default

Public Member Functions inherited from Aws::Client::AWSClient
	AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

virtual	~AWSClient ()

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)

void	DisableRequestProcessing ()

void	EnableRequestProcessing ()

Additional Inherited Members
Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrors >	BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override

JsonOutcome	MakeRequest (const Aws::String &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST) const

JsonOutcome	MakeRequest (const Aws::String &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST) const

Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome	AttemptExhaustively (const Aws::String &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod) const

HttpResponseOutcome	AttemptExhaustively (const Aws::String &uri, Http::HttpMethod httpMethod) const

HttpResponseOutcome	AttemptOneRequest (const Aws::String &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod) const

HttpResponseOutcome	AttemptOneRequest (const Aws::String &uri, Http::HttpMethod httpMethod) const

StreamOutcome	MakeRequestWithUnparsedResponse (const Aws::String &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST) const

virtual void	BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const

const std::shared_ptr< AWSErrorMarshaller > &	GetErrorMarshaller () const

Detailed Description

<fullname>AWS Support</fullname>

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.

The AWS 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 AWS Support case management operations:

Service names, issue categories, and available severity levels. The DescribeServices and DescribeSeverityLevels operations return AWS 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 AWS Support cases, retrieve information about cases, and resolve cases.
Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.

The following list describes the operations available from the AWS Support service for Trusted Advisor:

DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.
Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check 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, AWS Support uses Signature Version 4 Signing Process.

See About the AWS Support API in the AWS 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.

Definition at line 184 of file SupportClient.h.

Member Typedef Documentation

typedef Aws::Client::AWSJsonClient Aws::Support::SupportClient::BASECLASS

Definition at line 187 of file SupportClient.h.

Constructor & Destructor Documentation

Aws::Support::SupportClient::SupportClient ( const Client::ClientConfiguration & clientConfiguration = Client::ClientConfiguration() )

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

Aws::Support::SupportClient::SupportClient	(	const Auth::AWSCredentials &	credentials,
		const Client::ClientConfiguration &	clientConfiguration = `Client::ClientConfiguration()`
	)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

Aws::Support::SupportClient::SupportClient	(	const std::shared_ptr< Auth::AWSCredentialsProvider > &	credentialsProvider,
		const Client::ClientConfiguration &	clientConfiguration = `Client::ClientConfiguration()`
	)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

virtual Aws::Support::SupportClient::~SupportClient ( )

virtual

Member Function Documentation

virtual Model::AddAttachmentsToSetOutcome Aws::Support::SupportClient::AddAttachmentsToSet ( const Model::AddAttachmentsToSetRequest & request ) const

virtual

Adds one or more attachments to an attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

virtual void Aws::Support::SupportClient::AddAttachmentsToSetAsync	(	const Model::AddAttachmentsToSetRequest &	request,
		const AddAttachmentsToSetResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Adds one or more attachments to an attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::AddAttachmentsToSetOutcomeCallable Aws::Support::SupportClient::AddAttachmentsToSetCallable ( const Model::AddAttachmentsToSetRequest & request ) const

virtual

Adds one or more attachments to an attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::AddCommunicationToCaseOutcome Aws::Support::SupportClient::AddCommunicationToCase ( const Model::AddCommunicationToCaseRequest & request ) const

virtual

Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

virtual void Aws::Support::SupportClient::AddCommunicationToCaseAsync	(	const Model::AddCommunicationToCaseRequest &	request,
		const AddCommunicationToCaseResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::AddCommunicationToCaseOutcomeCallable Aws::Support::SupportClient::AddCommunicationToCaseCallable ( const Model::AddCommunicationToCaseRequest & request ) const

virtual

Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::CreateCaseOutcome Aws::Support::SupportClient::CreateCase ( const Model::CreateCaseRequest & request ) const

virtual

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

IssueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
SeverityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
Subject. The Subject field on the AWS Support Center Create Case page.
CommunicationBody. The Description field on the AWS Support Center Create Case page.
AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
CcEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.

<note>

To add additional communication or attachments to an existing case, use AddCommunicationToCase.

</note>

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

virtual void Aws::Support::SupportClient::CreateCaseAsync	(	const Model::CreateCaseRequest &	request,
		const CreateCaseResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

IssueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
SeverityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
Subject. The Subject field on the AWS Support Center Create Case page.
CommunicationBody. The Description field on the AWS Support Center Create Case page.
AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
CcEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.

<note>

To add additional communication or attachments to an existing case, use AddCommunicationToCase.

</note>

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::CreateCaseOutcomeCallable Aws::Support::SupportClient::CreateCaseCallable ( const Model::CreateCaseRequest & request ) const

virtual

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

IssueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
SeverityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
Subject. The Subject field on the AWS Support Center Create Case page.
CommunicationBody. The Description field on the AWS Support Center Create Case page.
AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
CcEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.

<note>

To add additional communication or attachments to an existing case, use AddCommunicationToCase.

</note>

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeAttachmentOutcome Aws::Support::SupportClient::DescribeAttachment ( const Model::DescribeAttachmentRequest & request ) const

virtual

Returns the attachment that has the specified ID. 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.

virtual void Aws::Support::SupportClient::DescribeAttachmentAsync	(	const Model::DescribeAttachmentRequest &	request,
		const DescribeAttachmentResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns the attachment that has the specified ID. 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.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeAttachmentOutcomeCallable Aws::Support::SupportClient::DescribeAttachmentCallable ( const Model::DescribeAttachmentRequest & request ) const

virtual

Returns the attachment that has the specified ID. 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.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeCasesOutcome Aws::Support::SupportClient::DescribeCases ( const Model::DescribeCasesRequest & request ) const

virtual

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.

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.

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 the CaseDetails objects.

virtual void Aws::Support::SupportClient::DescribeCasesAsync	(	const Model::DescribeCasesRequest &	request,
		const DescribeCasesResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.

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.

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 the CaseDetails objects.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeCasesOutcomeCallable Aws::Support::SupportClient::DescribeCasesCallable ( const Model::DescribeCasesRequest & request ) const

virtual

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.

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.

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 the CaseDetails objects.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeCommunicationsOutcome Aws::Support::SupportClient::DescribeCommunications ( const Model::DescribeCommunicationsRequest & request ) const

virtual

Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular 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 result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

virtual void Aws::Support::SupportClient::DescribeCommunicationsAsync	(	const Model::DescribeCommunicationsRequest &	request,
		const DescribeCommunicationsResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular 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 result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeCommunicationsOutcomeCallable Aws::Support::SupportClient::DescribeCommunicationsCallable ( const Model::DescribeCommunicationsRequest & request ) const

virtual

Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular 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 result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeServicesOutcome Aws::Support::SupportClient::DescribeServices ( const Model::DescribeServicesRequest & request ) const

virtual

Returns the current list of AWS services and a list of service categories that applies to each one. 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 are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

virtual void Aws::Support::SupportClient::DescribeServicesAsync	(	const Model::DescribeServicesRequest &	request,
		const DescribeServicesResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns the current list of AWS services and a list of service categories that applies to each one. 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 are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeServicesOutcomeCallable Aws::Support::SupportClient::DescribeServicesCallable ( const Model::DescribeServicesRequest & request ) const

virtual

Returns the current list of AWS services and a list of service categories that applies to each one. 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 are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeSeverityLevelsOutcome Aws::Support::SupportClient::DescribeSeverityLevels ( const Model::DescribeSeverityLevelsRequest & request ) const

virtual

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 included in any CreateCase request.

virtual void Aws::Support::SupportClient::DescribeSeverityLevelsAsync	(	const Model::DescribeSeverityLevelsRequest &	request,
		const DescribeSeverityLevelsResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

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 included in any CreateCase request.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeSeverityLevelsOutcomeCallable Aws::Support::SupportClient::DescribeSeverityLevelsCallable ( const Model::DescribeSeverityLevelsRequest & request ) const

virtual

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 included in any CreateCase request.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeTrustedAdvisorCheckRefreshStatusesOutcome Aws::Support::SupportClient::DescribeTrustedAdvisorCheckRefreshStatuses ( const Model::DescribeTrustedAdvisorCheckRefreshStatusesRequest & request ) const

virtual

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

virtual void Aws::Support::SupportClient::DescribeTrustedAdvisorCheckRefreshStatusesAsync	(	const Model::DescribeTrustedAdvisorCheckRefreshStatusesRequest &	request,
		const DescribeTrustedAdvisorCheckRefreshStatusesResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeTrustedAdvisorCheckRefreshStatusesOutcomeCallable Aws::Support::SupportClient::DescribeTrustedAdvisorCheckRefreshStatusesCallable ( const Model::DescribeTrustedAdvisorCheckRefreshStatusesRequest & request ) const

virtual

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeTrustedAdvisorCheckResultOutcome Aws::Support::SupportClient::DescribeTrustedAdvisorCheckResult ( const Model::DescribeTrustedAdvisorCheckResultRequest & request ) const

virtual

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

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.

virtual void Aws::Support::SupportClient::DescribeTrustedAdvisorCheckResultAsync	(	const Model::DescribeTrustedAdvisorCheckResultRequest &	request,
		const DescribeTrustedAdvisorCheckResultResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

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.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeTrustedAdvisorCheckResultOutcomeCallable Aws::Support::SupportClient::DescribeTrustedAdvisorCheckResultCallable ( const Model::DescribeTrustedAdvisorCheckResultRequest & request ) const

virtual

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

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.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeTrustedAdvisorChecksOutcome Aws::Support::SupportClient::DescribeTrustedAdvisorChecks ( const Model::DescribeTrustedAdvisorChecksRequest & request ) const

virtual

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

virtual void Aws::Support::SupportClient::DescribeTrustedAdvisorChecksAsync	(	const Model::DescribeTrustedAdvisorChecksRequest &	request,
		const DescribeTrustedAdvisorChecksResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeTrustedAdvisorChecksOutcomeCallable Aws::Support::SupportClient::DescribeTrustedAdvisorChecksCallable ( const Model::DescribeTrustedAdvisorChecksRequest & request ) const

virtual

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::DescribeTrustedAdvisorCheckSummariesOutcome Aws::Support::SupportClient::DescribeTrustedAdvisorCheckSummaries ( const Model::DescribeTrustedAdvisorCheckSummariesRequest & request ) const

virtual

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

virtual void Aws::Support::SupportClient::DescribeTrustedAdvisorCheckSummariesAsync	(	const Model::DescribeTrustedAdvisorCheckSummariesRequest &	request,
		const DescribeTrustedAdvisorCheckSummariesResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::DescribeTrustedAdvisorCheckSummariesOutcomeCallable Aws::Support::SupportClient::DescribeTrustedAdvisorCheckSummariesCallable ( const Model::DescribeTrustedAdvisorCheckSummariesRequest & request ) const

virtual

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::RefreshTrustedAdvisorCheckOutcome Aws::Support::SupportClient::RefreshTrustedAdvisorCheck ( const Model::RefreshTrustedAdvisorCheckRequest & request ) const

virtual

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

Status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
MillisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
CheckId. The unique identifier for the check.

virtual void Aws::Support::SupportClient::RefreshTrustedAdvisorCheckAsync	(	const Model::RefreshTrustedAdvisorCheckRequest &	request,
		const RefreshTrustedAdvisorCheckResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

Status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
MillisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
CheckId. The unique identifier for the check.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::RefreshTrustedAdvisorCheckOutcomeCallable Aws::Support::SupportClient::RefreshTrustedAdvisorCheckCallable ( const Model::RefreshTrustedAdvisorCheckRequest & request ) const

virtual

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

Status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
MillisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
CheckId. The unique identifier for the check.

returns a future to the operation so that it can be executed in parallel to other requests.

virtual Model::ResolveCaseOutcome Aws::Support::SupportClient::ResolveCase ( const Model::ResolveCaseRequest & request ) const

virtual

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

virtual void Aws::Support::SupportClient::ResolveCaseAsync	(	const Model::ResolveCaseRequest &	request,
		const ResolveCaseResponseReceivedHandler &	handler,
		const std::shared_ptr< const Aws::Client::AsyncCallerContext > &	context = `nullptr`
	)		const

virtual

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

Queues the request into a thread executor and triggers associated callback when operation has finished.

virtual Model::ResolveCaseOutcomeCallable Aws::Support::SupportClient::ResolveCaseCallable ( const Model::ResolveCaseRequest & request ) const

virtual

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

returns a future to the operation so that it can be executed in parallel to other requests.

The documentation for this class was generated from the following file:

aws-cpp-sdk-support/include/aws/support/SupportClient.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation