/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include
#include
#include
#include
#include
#include
namespace Aws
{
namespace CloudControlApi
{
/**
* For more information about Amazon Web Services Cloud Control API, see the Amazon
* Web Services Cloud Control API User Guide.
*/
class AWS_CLOUDCONTROLAPI_API CloudControlApiClient : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods
{
public:
typedef Aws::Client::AWSJsonClient BASECLASS;
static const char* SERVICE_NAME;
static const char* ALLOCATION_TAG;
typedef CloudControlApiClientConfiguration ClientConfigurationType;
typedef CloudControlApiEndpointProvider EndpointProviderType;
/**
* 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.
*/
CloudControlApiClient(const Aws::CloudControlApi::CloudControlApiClientConfiguration& clientConfiguration = Aws::CloudControlApi::CloudControlApiClientConfiguration(),
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG));
/**
* 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.
*/
CloudControlApiClient(const Aws::Auth::AWSCredentials& credentials,
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG),
const Aws::CloudControlApi::CloudControlApiClientConfiguration& clientConfiguration = Aws::CloudControlApi::CloudControlApiClientConfiguration());
/**
* 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
*/
CloudControlApiClient(const std::shared_ptr& credentialsProvider,
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG),
const Aws::CloudControlApi::CloudControlApiClientConfiguration& clientConfiguration = Aws::CloudControlApi::CloudControlApiClientConfiguration());
/* Legacy constructors due deprecation */
/**
* 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.
*/
CloudControlApiClient(const Aws::Client::ClientConfiguration& 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.
*/
CloudControlApiClient(const Aws::Auth::AWSCredentials& credentials,
const Aws::Client::ClientConfiguration& 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
*/
CloudControlApiClient(const std::shared_ptr& credentialsProvider,
const Aws::Client::ClientConfiguration& clientConfiguration);
/* End of legacy constructors due deprecation */
virtual ~CloudControlApiClient();
/**
* Cancels the specified resource operation request. For more information, see
* Canceling
* resource operation requests in the Amazon Web Services Cloud Control API
* User Guide.
Only resource operations requests with a status of
* PENDING
or IN_PROGRESS
can be canceled.
See
* Also:
AWS
* API Reference
*/
virtual Model::CancelResourceRequestOutcome CancelResourceRequest(const Model::CancelResourceRequestRequest& request) const;
/**
* A Callable wrapper for CancelResourceRequest that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CancelResourceRequestOutcomeCallable CancelResourceRequestCallable(const CancelResourceRequestRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::CancelResourceRequest, request);
}
/**
* An Async wrapper for CancelResourceRequest that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CancelResourceRequestAsync(const CancelResourceRequestRequestT& request, const CancelResourceRequestResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::CancelResourceRequest, request, handler, context);
}
/**
* Creates the specified resource. For more information, see Creating
* a resource in the Amazon Web Services Cloud Control API User
* Guide.
After you have initiated a resource creation request, you can
* monitor the progress of your request by calling GetResourceRequestStatus
* using the RequestToken
of the ProgressEvent
type
* returned by CreateResource
.
See Also:
AWS
* API Reference
*/
virtual Model::CreateResourceOutcome CreateResource(const Model::CreateResourceRequest& request) const;
/**
* A Callable wrapper for CreateResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateResourceOutcomeCallable CreateResourceCallable(const CreateResourceRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::CreateResource, request);
}
/**
* An Async wrapper for CreateResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateResourceAsync(const CreateResourceRequestT& request, const CreateResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::CreateResource, request, handler, context);
}
/**
* Deletes the specified resource. For details, see Deleting
* a resource in the Amazon Web Services Cloud Control API User
* Guide.
After you have initiated a resource deletion request, you can
* monitor the progress of your request by calling GetResourceRequestStatus
* using the RequestToken
of the ProgressEvent
returned
* by DeleteResource
.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteResourceOutcome DeleteResource(const Model::DeleteResourceRequest& request) const;
/**
* A Callable wrapper for DeleteResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteResourceOutcomeCallable DeleteResourceCallable(const DeleteResourceRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::DeleteResource, request);
}
/**
* An Async wrapper for DeleteResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteResourceAsync(const DeleteResourceRequestT& request, const DeleteResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::DeleteResource, request, handler, context);
}
/**
* Returns information about the current state of the specified resource. For
* details, see Reading
* a resource's current state.
You can use this action to return
* information about an existing resource in your account and Amazon Web Services
* Region, whether those resources were provisioned using Cloud Control
* API.
See Also:
AWS
* API Reference
*/
virtual Model::GetResourceOutcome GetResource(const Model::GetResourceRequest& request) const;
/**
* A Callable wrapper for GetResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetResourceOutcomeCallable GetResourceCallable(const GetResourceRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::GetResource, request);
}
/**
* An Async wrapper for GetResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetResourceAsync(const GetResourceRequestT& request, const GetResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::GetResource, request, handler, context);
}
/**
* Returns the current status of a resource operation request. For more
* information, see Tracking
* the progress of resource operation requests in the Amazon Web Services
* Cloud Control API User Guide.
See Also:
AWS
* API Reference
*/
virtual Model::GetResourceRequestStatusOutcome GetResourceRequestStatus(const Model::GetResourceRequestStatusRequest& request) const;
/**
* A Callable wrapper for GetResourceRequestStatus that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetResourceRequestStatusOutcomeCallable GetResourceRequestStatusCallable(const GetResourceRequestStatusRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::GetResourceRequestStatus, request);
}
/**
* An Async wrapper for GetResourceRequestStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetResourceRequestStatusAsync(const GetResourceRequestStatusRequestT& request, const GetResourceRequestStatusResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::GetResourceRequestStatus, request, handler, context);
}
/**
* Returns existing resource operation requests. This includes requests of all
* status types. For more information, see Listing
* active resource operation requests in the Amazon Web Services Cloud
* Control API User Guide.
Resource operation requests expire
* after 7 days.
See Also:
AWS
* API Reference
*/
virtual Model::ListResourceRequestsOutcome ListResourceRequests(const Model::ListResourceRequestsRequest& request) const;
/**
* A Callable wrapper for ListResourceRequests that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListResourceRequestsOutcomeCallable ListResourceRequestsCallable(const ListResourceRequestsRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::ListResourceRequests, request);
}
/**
* An Async wrapper for ListResourceRequests that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListResourceRequestsAsync(const ListResourceRequestsRequestT& request, const ListResourceRequestsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::ListResourceRequests, request, handler, context);
}
/**
* Returns information about the specified resources. For more information, see
* Discovering
* resources in the Amazon Web Services Cloud Control API User
* Guide.
You can use this action to return information about existing
* resources in your account and Amazon Web Services Region, whether those
* resources were provisioned using Cloud Control API.
See Also:
* AWS
* API Reference
*/
virtual Model::ListResourcesOutcome ListResources(const Model::ListResourcesRequest& request) const;
/**
* A Callable wrapper for ListResources that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListResourcesOutcomeCallable ListResourcesCallable(const ListResourcesRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::ListResources, request);
}
/**
* An Async wrapper for ListResources that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListResourcesAsync(const ListResourcesRequestT& request, const ListResourcesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::ListResources, request, handler, context);
}
/**
* Updates the specified property values in the resource.
You specify
* your resource property updates as a list of patch operations contained in a JSON
* patch document that adheres to the RFC 6902 - JavaScript
* Object Notation (JSON) Patch standard.
For details on how Cloud
* Control API performs resource update operations, see Updating
* a resource in the Amazon Web Services Cloud Control API User
* Guide.
After you have initiated a resource update request, you can
* monitor the progress of your request by calling GetResourceRequestStatus
* using the RequestToken
of the ProgressEvent
returned
* by UpdateResource
.
For more information about the properties
* of a specific resource, refer to the related topic for the resource in the Resource
* and property types reference in the CloudFormation Users
* Guide.
See Also:
AWS
* API Reference
*/
virtual Model::UpdateResourceOutcome UpdateResource(const Model::UpdateResourceRequest& request) const;
/**
* A Callable wrapper for UpdateResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::UpdateResourceOutcomeCallable UpdateResourceCallable(const UpdateResourceRequestT& request) const
{
return SubmitCallable(&CloudControlApiClient::UpdateResource, request);
}
/**
* An Async wrapper for UpdateResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void UpdateResourceAsync(const UpdateResourceRequestT& request, const UpdateResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CloudControlApiClient::UpdateResource, request, handler, context);
}
void OverrideEndpoint(const Aws::String& endpoint);
std::shared_ptr& accessEndpointProvider();
private:
friend class Aws::Client::ClientWithAsyncTemplateMethods;
void init(const CloudControlApiClientConfiguration& clientConfiguration);
CloudControlApiClientConfiguration m_clientConfiguration;
std::shared_ptr m_executor;
std::shared_ptr m_endpointProvider;
};
} // namespace CloudControlApi
} // namespace Aws