Aws::Synthetics::SyntheticsClient Class Reference

#include <SyntheticsClient.h>

Inheritance diagram for Aws::Synthetics::SyntheticsClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

 

typedef SyntheticsClientConfiguration ClientConfigurationType

 

typedef SyntheticsEndpointProvider EndpointProviderType

 

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSClient BASECLASS

 

Public Member Functions

 SyntheticsClient (const Aws::Synthetics::SyntheticsClientConfiguration &clientConfiguration=Aws::Synthetics::SyntheticsClientConfiguration(), std::shared_ptr< SyntheticsEndpointProviderBase > endpointProvider=nullptr)

 

 SyntheticsClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< SyntheticsEndpointProviderBase > endpointProvider=nullptr, const Aws::Synthetics::SyntheticsClientConfiguration &clientConfiguration=Aws::Synthetics::SyntheticsClientConfiguration())

 

 SyntheticsClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< SyntheticsEndpointProviderBase > endpointProvider=nullptr, const Aws::Synthetics::SyntheticsClientConfiguration &clientConfiguration=Aws::Synthetics::SyntheticsClientConfiguration())

 

 SyntheticsClient (const Aws::Client::ClientConfiguration &clientConfiguration)

 

 SyntheticsClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration)

 

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

 

virtual ~SyntheticsClient ()

 

virtual Model::AssociateResourceOutcome AssociateResource (const Model::AssociateResourceRequest &request) const

 

template<typename AssociateResourceRequestT = Model::AssociateResourceRequest>

Model::AssociateResourceOutcomeCallable AssociateResourceCallable (const AssociateResourceRequestT &request) const

 

template<typename AssociateResourceRequestT = Model::AssociateResourceRequest>

void AssociateResourceAsync (const AssociateResourceRequestT &request, const AssociateResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateCanaryOutcome CreateCanary (const Model::CreateCanaryRequest &request) const

 

template<typename CreateCanaryRequestT = Model::CreateCanaryRequest>

Model::CreateCanaryOutcomeCallable CreateCanaryCallable (const CreateCanaryRequestT &request) const

 

template<typename CreateCanaryRequestT = Model::CreateCanaryRequest>

void CreateCanaryAsync (const CreateCanaryRequestT &request, const CreateCanaryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateGroupOutcome CreateGroup (const Model::CreateGroupRequest &request) const

 

template<typename CreateGroupRequestT = Model::CreateGroupRequest>

Model::CreateGroupOutcomeCallable CreateGroupCallable (const CreateGroupRequestT &request) const

 

template<typename CreateGroupRequestT = Model::CreateGroupRequest>

void CreateGroupAsync (const CreateGroupRequestT &request, const CreateGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteCanaryOutcome DeleteCanary (const Model::DeleteCanaryRequest &request) const

 

template<typename DeleteCanaryRequestT = Model::DeleteCanaryRequest>

Model::DeleteCanaryOutcomeCallable DeleteCanaryCallable (const DeleteCanaryRequestT &request) const

 

template<typename DeleteCanaryRequestT = Model::DeleteCanaryRequest>

void DeleteCanaryAsync (const DeleteCanaryRequestT &request, const DeleteCanaryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteGroupOutcome DeleteGroup (const Model::DeleteGroupRequest &request) const

 

template<typename DeleteGroupRequestT = Model::DeleteGroupRequest>

Model::DeleteGroupOutcomeCallable DeleteGroupCallable (const DeleteGroupRequestT &request) const

 

template<typename DeleteGroupRequestT = Model::DeleteGroupRequest>

void DeleteGroupAsync (const DeleteGroupRequestT &request, const DeleteGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeCanariesOutcome DescribeCanaries (const Model::DescribeCanariesRequest &request={}) const

 

template<typename DescribeCanariesRequestT = Model::DescribeCanariesRequest>

Model::DescribeCanariesOutcomeCallable DescribeCanariesCallable (const DescribeCanariesRequestT &request={}) const

 

template<typename DescribeCanariesRequestT = Model::DescribeCanariesRequest>

void DescribeCanariesAsync (const DescribeCanariesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeCanariesRequestT &request={}) const

 

virtual Model::DescribeCanariesLastRunOutcome DescribeCanariesLastRun (const Model::DescribeCanariesLastRunRequest &request={}) const

 

template<typename DescribeCanariesLastRunRequestT = Model::DescribeCanariesLastRunRequest>

Model::DescribeCanariesLastRunOutcomeCallable DescribeCanariesLastRunCallable (const DescribeCanariesLastRunRequestT &request={}) const

 

template<typename DescribeCanariesLastRunRequestT = Model::DescribeCanariesLastRunRequest>

void DescribeCanariesLastRunAsync (const DescribeCanariesLastRunResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeCanariesLastRunRequestT &request={}) const

 

virtual Model::DescribeRuntimeVersionsOutcome DescribeRuntimeVersions (const Model::DescribeRuntimeVersionsRequest &request={}) const

 

template<typename DescribeRuntimeVersionsRequestT = Model::DescribeRuntimeVersionsRequest>

Model::DescribeRuntimeVersionsOutcomeCallable DescribeRuntimeVersionsCallable (const DescribeRuntimeVersionsRequestT &request={}) const

 

template<typename DescribeRuntimeVersionsRequestT = Model::DescribeRuntimeVersionsRequest>

void DescribeRuntimeVersionsAsync (const DescribeRuntimeVersionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeRuntimeVersionsRequestT &request={}) const

 

virtual Model::DisassociateResourceOutcome DisassociateResource (const Model::DisassociateResourceRequest &request) const

 

template<typename DisassociateResourceRequestT = Model::DisassociateResourceRequest>

Model::DisassociateResourceOutcomeCallable DisassociateResourceCallable (const DisassociateResourceRequestT &request) const

 

template<typename DisassociateResourceRequestT = Model::DisassociateResourceRequest>

void DisassociateResourceAsync (const DisassociateResourceRequestT &request, const DisassociateResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetCanaryOutcome GetCanary (const Model::GetCanaryRequest &request) const

 

template<typename GetCanaryRequestT = Model::GetCanaryRequest>

Model::GetCanaryOutcomeCallable GetCanaryCallable (const GetCanaryRequestT &request) const

 

template<typename GetCanaryRequestT = Model::GetCanaryRequest>

void GetCanaryAsync (const GetCanaryRequestT &request, const GetCanaryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetCanaryRunsOutcome GetCanaryRuns (const Model::GetCanaryRunsRequest &request) const

 

template<typename GetCanaryRunsRequestT = Model::GetCanaryRunsRequest>

Model::GetCanaryRunsOutcomeCallable GetCanaryRunsCallable (const GetCanaryRunsRequestT &request) const

 

template<typename GetCanaryRunsRequestT = Model::GetCanaryRunsRequest>

void GetCanaryRunsAsync (const GetCanaryRunsRequestT &request, const GetCanaryRunsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetGroupOutcome GetGroup (const Model::GetGroupRequest &request) const

 

template<typename GetGroupRequestT = Model::GetGroupRequest>

Model::GetGroupOutcomeCallable GetGroupCallable (const GetGroupRequestT &request) const

 

template<typename GetGroupRequestT = Model::GetGroupRequest>

void GetGroupAsync (const GetGroupRequestT &request, const GetGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListAssociatedGroupsOutcome ListAssociatedGroups (const Model::ListAssociatedGroupsRequest &request) const

 

template<typename ListAssociatedGroupsRequestT = Model::ListAssociatedGroupsRequest>

Model::ListAssociatedGroupsOutcomeCallable ListAssociatedGroupsCallable (const ListAssociatedGroupsRequestT &request) const

 

template<typename ListAssociatedGroupsRequestT = Model::ListAssociatedGroupsRequest>

void ListAssociatedGroupsAsync (const ListAssociatedGroupsRequestT &request, const ListAssociatedGroupsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListGroupResourcesOutcome ListGroupResources (const Model::ListGroupResourcesRequest &request) const

 

template<typename ListGroupResourcesRequestT = Model::ListGroupResourcesRequest>

Model::ListGroupResourcesOutcomeCallable ListGroupResourcesCallable (const ListGroupResourcesRequestT &request) const

 

template<typename ListGroupResourcesRequestT = Model::ListGroupResourcesRequest>

void ListGroupResourcesAsync (const ListGroupResourcesRequestT &request, const ListGroupResourcesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListGroupsOutcome ListGroups (const Model::ListGroupsRequest &request={}) const

 

template<typename ListGroupsRequestT = Model::ListGroupsRequest>

Model::ListGroupsOutcomeCallable ListGroupsCallable (const ListGroupsRequestT &request={}) const

 

template<typename ListGroupsRequestT = Model::ListGroupsRequest>

void ListGroupsAsync (const ListGroupsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListGroupsRequestT &request={}) const

 

virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const ListTagsForResourceRequestT &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void ListTagsForResourceAsync (const ListTagsForResourceRequestT &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StartCanaryOutcome StartCanary (const Model::StartCanaryRequest &request) const

 

template<typename StartCanaryRequestT = Model::StartCanaryRequest>

Model::StartCanaryOutcomeCallable StartCanaryCallable (const StartCanaryRequestT &request) const

 

template<typename StartCanaryRequestT = Model::StartCanaryRequest>

void StartCanaryAsync (const StartCanaryRequestT &request, const StartCanaryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StopCanaryOutcome StopCanary (const Model::StopCanaryRequest &request) const

 

template<typename StopCanaryRequestT = Model::StopCanaryRequest>

Model::StopCanaryOutcomeCallable StopCanaryCallable (const StopCanaryRequestT &request) const

 

template<typename StopCanaryRequestT = Model::StopCanaryRequest>

void StopCanaryAsync (const StopCanaryRequestT &request, const StopCanaryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable TagResourceCallable (const TagResourceRequestT &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

void TagResourceAsync (const TagResourceRequestT &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable UntagResourceCallable (const UntagResourceRequestT &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void UntagResourceAsync (const UntagResourceRequestT &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateCanaryOutcome UpdateCanary (const Model::UpdateCanaryRequest &request) const

 

template<typename UpdateCanaryRequestT = Model::UpdateCanaryRequest>

Model::UpdateCanaryOutcomeCallable UpdateCanaryCallable (const UpdateCanaryRequestT &request) const

 

template<typename UpdateCanaryRequestT = Model::UpdateCanaryRequest>

void UpdateCanaryAsync (const UpdateCanaryRequestT &request, const UpdateCanaryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void OverrideEndpoint (const Aws::String &endpoint)

 

std::shared_ptr< SyntheticsEndpointProviderBase > & accessEndpointProvider ()

 

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)

 

 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, 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)

 

 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

virtual ~AWSClient ()

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const

 

void DisableRequestProcessing ()

 

void EnableRequestProcessing ()

 

virtual const char * GetServiceClientName () const

 

virtual void SetServiceClientName (const Aws::String &name)

 

void AppendToUserAgent (const Aws::String &valueToAppend)

 

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< SyntheticsClient >

 ClientWithAsyncTemplateMethods ()

 

 ClientWithAsyncTemplateMethods (const ClientWithAsyncTemplateMethods &other)

 

ClientWithAsyncTemplateMethods & operator= (const ClientWithAsyncTemplateMethods &other)

 

virtual ~ClientWithAsyncTemplateMethods ()

 

void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>

 

Static Public Member Functions

static const char * GetServiceName ()

 

static const char * GetAllocationTag ()

 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< SyntheticsClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)

 

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< SyntheticsClient >

 

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::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeRequest (const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

Protected Member Functions inherited from Aws::Client::AWSClient

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

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

 

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

 

Aws::Client::AWSAuthSigner * GetSignerByName (const char *name) const

 

std::shared_ptr< Auth::AWSCredentialsProvider > GetCredentialsProvider () const

 

std::shared_ptr< Aws::Http::HttpRequest > BuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const

 

std::shared_ptr< Aws::Http::HttpResponse > MakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)

 

static CoreErrors GuessBodylessErrorType (Aws::Http::HttpResponseCode responseCode)

 

static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)

 

Protected Attributes inherited from Aws::Client::AWSClient

Aws::String m_region

 

std::shared_ptr< smithy::components::tracing::TelemetryProvider > m_telemetryProvider

 

std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > m_signerProvider

 

Protected Attributes inherited from Aws::Client::ClientWithAsyncTemplateMethods< SyntheticsClient >

std::atomic< bool > m_isInitialized

 

std::atomic< size_t > m_operationsProcessed

 

std::condition_variable m_shutdownSignal

 

std::mutex m_shutdownMutex

 

Detailed Description

<fullname>Amazon CloudWatch Synthetics</fullname>

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide.

Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries.

Definition at line 35 of file SyntheticsClient.h.

Member Typedef Documentation

BASECLASS

typedef Aws::Client::AWSJsonClient Aws::Synthetics::SyntheticsClient::BASECLASS

Definition at line 38 of file SyntheticsClient.h.

ClientConfigurationType

typedef SyntheticsClientConfiguration Aws::Synthetics::SyntheticsClient::ClientConfigurationType

Definition at line 42 of file SyntheticsClient.h.

EndpointProviderType

typedef SyntheticsEndpointProvider Aws::Synthetics::SyntheticsClient::EndpointProviderType

Definition at line 43 of file SyntheticsClient.h.

Constructor & Destructor Documentation

SyntheticsClient() [1/6]

Aws::Synthetics::SyntheticsClient::SyntheticsClient ( const Aws::Synthetics::SyntheticsClientConfiguration &  clientConfiguration = Aws::Synthetics::SyntheticsClientConfiguration(),

std::shared_ptr< SyntheticsEndpointProviderBase >  endpointProvider = nullptr 

)

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.

SyntheticsClient() [2/6]

Aws::Synthetics::SyntheticsClient::SyntheticsClient ( const Aws::Auth::AWSCredentials &  credentials,

std::shared_ptr< SyntheticsEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Synthetics::SyntheticsClientConfiguration &  clientConfiguration = Aws::Synthetics::SyntheticsClientConfiguration() 

)

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.

SyntheticsClient() [3/6]

Aws::Synthetics::SyntheticsClient::SyntheticsClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

std::shared_ptr< SyntheticsEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Synthetics::SyntheticsClientConfiguration &  clientConfiguration = Aws::Synthetics::SyntheticsClientConfiguration() 

)

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

SyntheticsClient() [4/6]

Aws::Synthetics::SyntheticsClient::SyntheticsClient ( const Aws::Client::ClientConfiguration &  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.

SyntheticsClient() [5/6]

Aws::Synthetics::SyntheticsClient::SyntheticsClient ( const Aws::Auth::AWSCredentials &  credentials,

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.

SyntheticsClient() [6/6]

Aws::Synthetics::SyntheticsClient::SyntheticsClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

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

~SyntheticsClient()

virtual Aws::Synthetics::SyntheticsClient::~SyntheticsClient ( )

virtual

Member Function Documentation

accessEndpointProvider()

std::shared_ptr< SyntheticsEndpointProviderBase > & Aws::Synthetics::SyntheticsClient::accessEndpointProvider ( )

AssociateResource()

virtual Model::AssociateResourceOutcome Aws::Synthetics::SyntheticsClient::AssociateResource ( const Model::AssociateResourceRequest &  request) const

virtual

Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

You must run this operation in the Region where the canary exists.

See Also:

AWS API Reference

AssociateResourceAsync()

template<typename AssociateResourceRequestT = Model::AssociateResourceRequest>

void Aws::Synthetics::SyntheticsClient::AssociateResourceAsync ( const AssociateResourceRequestT &  request,

const AssociateResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for AssociateResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 116 of file SyntheticsClient.h.

AssociateResourceCallable()

template<typename AssociateResourceRequestT = Model::AssociateResourceRequest>

Model::AssociateResourceOutcomeCallable Aws::Synthetics::SyntheticsClient::AssociateResourceCallable ( const AssociateResourceRequestT &  request) const

inline

A Callable wrapper for AssociateResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 107 of file SyntheticsClient.h.

CreateCanary()

virtual Model::CreateCanaryOutcome Aws::Synthetics::SyntheticsClient::CreateCanary ( const Model::CreateCanaryRequest &  request) const

virtual

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

See Also:

AWS API Reference

CreateCanaryAsync()

template<typename CreateCanaryRequestT = Model::CreateCanaryRequest>

void Aws::Synthetics::SyntheticsClient::CreateCanaryAsync ( const CreateCanaryRequestT &  request,

const CreateCanaryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateCanary that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 159 of file SyntheticsClient.h.

CreateCanaryCallable()

template<typename CreateCanaryRequestT = Model::CreateCanaryRequest>

Model::CreateCanaryOutcomeCallable Aws::Synthetics::SyntheticsClient::CreateCanaryCallable ( const CreateCanaryRequestT &  request) const

inline

A Callable wrapper for CreateCanary that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 150 of file SyntheticsClient.h.

CreateGroup()

virtual Model::CreateGroupOutcome Aws::Synthetics::SyntheticsClient::CreateGroup ( const Model::CreateGroupRequest &  request) const

virtual

Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.

Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region.

Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.

See Also:

AWS API Reference

CreateGroupAsync()

template<typename CreateGroupRequestT = Model::CreateGroupRequest>

void Aws::Synthetics::SyntheticsClient::CreateGroupAsync ( const CreateGroupRequestT &  request,

const CreateGroupResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateGroup that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 199 of file SyntheticsClient.h.

CreateGroupCallable()

template<typename CreateGroupRequestT = Model::CreateGroupRequest>

Model::CreateGroupOutcomeCallable Aws::Synthetics::SyntheticsClient::CreateGroupCallable ( const CreateGroupRequestT &  request) const

inline

A Callable wrapper for CreateGroup that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 190 of file SyntheticsClient.h.

DeleteCanary()

virtual Model::DeleteCanaryOutcome Aws::Synthetics::SyntheticsClient::DeleteCanary ( const Model::DeleteCanaryRequest &  request) const

virtual

Permanently deletes the specified canary.

If you specify DeleteLambda to true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.

Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

• The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-Alarm-first-198-characters-of-canary-name-canaryId-alarm number

• Amazon S3 objects and buckets, such as the canary's artifact location.

• IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-First-21-Characters-of-CanaryName

• CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-First-21-Characters-of-CanaryName

Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

See Also:

AWS API Reference

DeleteCanaryAsync()

template<typename DeleteCanaryRequestT = Model::DeleteCanaryRequest>

void Aws::Synthetics::SyntheticsClient::DeleteCanaryAsync ( const DeleteCanaryRequestT &  request,

const DeleteCanaryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteCanary that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 242 of file SyntheticsClient.h.

DeleteCanaryCallable()

template<typename DeleteCanaryRequestT = Model::DeleteCanaryRequest>

Model::DeleteCanaryOutcomeCallable Aws::Synthetics::SyntheticsClient::DeleteCanaryCallable ( const DeleteCanaryRequestT &  request) const

inline

A Callable wrapper for DeleteCanary that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 233 of file SyntheticsClient.h.

DeleteGroup()

virtual Model::DeleteGroupOutcome Aws::Synthetics::SyntheticsClient::DeleteGroup ( const Model::DeleteGroupRequest &  request) const

virtual

Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.

Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN.

See Also:

AWS API Reference

DeleteGroupAsync()

template<typename DeleteGroupRequestT = Model::DeleteGroupRequest>

void Aws::Synthetics::SyntheticsClient::DeleteGroupAsync ( const DeleteGroupRequestT &  request,

const DeleteGroupResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteGroup that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 271 of file SyntheticsClient.h.

DeleteGroupCallable()

template<typename DeleteGroupRequestT = Model::DeleteGroupRequest>

Model::DeleteGroupOutcomeCallable Aws::Synthetics::SyntheticsClient::DeleteGroupCallable ( const DeleteGroupRequestT &  request) const

inline

A Callable wrapper for DeleteGroup that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 262 of file SyntheticsClient.h.

DescribeCanaries()

virtual Model::DescribeCanariesOutcome Aws::Synthetics::SyntheticsClient::DescribeCanaries ( const Model::DescribeCanariesRequest &  request = {}) const

virtual

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

See Also:

AWS API Reference

DescribeCanariesAsync()

template<typename DescribeCanariesRequestT = Model::DescribeCanariesRequest>

void Aws::Synthetics::SyntheticsClient::DescribeCanariesAsync ( const DescribeCanariesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const DescribeCanariesRequestT &  request = {} 

) const

inline

An Async wrapper for DescribeCanaries that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 307 of file SyntheticsClient.h.

DescribeCanariesCallable()

template<typename DescribeCanariesRequestT = Model::DescribeCanariesRequest>

Model::DescribeCanariesOutcomeCallable Aws::Synthetics::SyntheticsClient::DescribeCanariesCallable ( const DescribeCanariesRequestT &  request = {}) const

inline

A Callable wrapper for DescribeCanaries that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 298 of file SyntheticsClient.h.

DescribeCanariesLastRun()

virtual Model::DescribeCanariesLastRunOutcome Aws::Synthetics::SyntheticsClient::DescribeCanariesLastRun ( const Model::DescribeCanariesLastRunRequest &  request = {}) const

virtual

Use this operation to see information from the most recent run of each canary that you have created.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

See Also:

AWS API Reference

DescribeCanariesLastRunAsync()

template<typename DescribeCanariesLastRunRequestT = Model::DescribeCanariesLastRunRequest>

void Aws::Synthetics::SyntheticsClient::DescribeCanariesLastRunAsync ( const DescribeCanariesLastRunResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const DescribeCanariesLastRunRequestT &  request = {} 

) const

inline

An Async wrapper for DescribeCanariesLastRun that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 343 of file SyntheticsClient.h.

DescribeCanariesLastRunCallable()

template<typename DescribeCanariesLastRunRequestT = Model::DescribeCanariesLastRunRequest>

Model::DescribeCanariesLastRunOutcomeCallable Aws::Synthetics::SyntheticsClient::DescribeCanariesLastRunCallable ( const DescribeCanariesLastRunRequestT &  request = {}) const

inline

A Callable wrapper for DescribeCanariesLastRun that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 334 of file SyntheticsClient.h.

DescribeRuntimeVersions()

virtual Model::DescribeRuntimeVersionsOutcome Aws::Synthetics::SyntheticsClient::DescribeRuntimeVersions ( const Model::DescribeRuntimeVersionsRequest &  request = {}) const

virtual

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.

See Also:

AWS API Reference

DescribeRuntimeVersionsAsync()

template<typename DescribeRuntimeVersionsRequestT = Model::DescribeRuntimeVersionsRequest>

void Aws::Synthetics::SyntheticsClient::DescribeRuntimeVersionsAsync ( const DescribeRuntimeVersionsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const DescribeRuntimeVersionsRequestT &  request = {} 

) const

inline

An Async wrapper for DescribeRuntimeVersions that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 371 of file SyntheticsClient.h.

DescribeRuntimeVersionsCallable()

template<typename DescribeRuntimeVersionsRequestT = Model::DescribeRuntimeVersionsRequest>

Model::DescribeRuntimeVersionsOutcomeCallable Aws::Synthetics::SyntheticsClient::DescribeRuntimeVersionsCallable ( const DescribeRuntimeVersionsRequestT &  request = {}) const

inline

A Callable wrapper for DescribeRuntimeVersions that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 362 of file SyntheticsClient.h.

DisassociateResource()

virtual Model::DisassociateResourceOutcome Aws::Synthetics::SyntheticsClient::DisassociateResource ( const Model::DisassociateResourceRequest &  request) const

virtual

Removes a canary from a group. You must run this operation in the Region where the canary exists.

See Also:

AWS API Reference

DisassociateResourceAsync()

template<typename DisassociateResourceRequestT = Model::DisassociateResourceRequest>

void Aws::Synthetics::SyntheticsClient::DisassociateResourceAsync ( const DisassociateResourceRequestT &  request,

const DisassociateResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DisassociateResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 397 of file SyntheticsClient.h.

DisassociateResourceCallable()

template<typename DisassociateResourceRequestT = Model::DisassociateResourceRequest>

Model::DisassociateResourceOutcomeCallable Aws::Synthetics::SyntheticsClient::DisassociateResourceCallable ( const DisassociateResourceRequestT &  request) const

inline

A Callable wrapper for DisassociateResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 388 of file SyntheticsClient.h.

GetAllocationTag()

static const char * Aws::Synthetics::SyntheticsClient::GetAllocationTag ( )

static

GetCanary()

virtual Model::GetCanaryOutcome Aws::Synthetics::SyntheticsClient::GetCanary ( const Model::GetCanaryRequest &  request) const

virtual

Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.

See Also:

AWS API Reference

GetCanaryAsync()

template<typename GetCanaryRequestT = Model::GetCanaryRequest>

void Aws::Synthetics::SyntheticsClient::GetCanaryAsync ( const GetCanaryRequestT &  request,

const GetCanaryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetCanary that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 425 of file SyntheticsClient.h.

GetCanaryCallable()

template<typename GetCanaryRequestT = Model::GetCanaryRequest>

Model::GetCanaryOutcomeCallable Aws::Synthetics::SyntheticsClient::GetCanaryCallable ( const GetCanaryRequestT &  request) const

inline

A Callable wrapper for GetCanary that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 416 of file SyntheticsClient.h.

GetCanaryRuns()

virtual Model::GetCanaryRunsOutcome Aws::Synthetics::SyntheticsClient::GetCanaryRuns ( const Model::GetCanaryRunsRequest &  request) const

virtual

Retrieves a list of runs for a specified canary.

See Also:

AWS API Reference

GetCanaryRunsAsync()

template<typename GetCanaryRunsRequestT = Model::GetCanaryRunsRequest>

void Aws::Synthetics::SyntheticsClient::GetCanaryRunsAsync ( const GetCanaryRunsRequestT &  request,

const GetCanaryRunsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetCanaryRuns that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 451 of file SyntheticsClient.h.

GetCanaryRunsCallable()

template<typename GetCanaryRunsRequestT = Model::GetCanaryRunsRequest>

Model::GetCanaryRunsOutcomeCallable Aws::Synthetics::SyntheticsClient::GetCanaryRunsCallable ( const GetCanaryRunsRequestT &  request) const

inline

A Callable wrapper for GetCanaryRuns that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 442 of file SyntheticsClient.h.

GetGroup()

virtual Model::GetGroupOutcome Aws::Synthetics::SyntheticsClient::GetGroup ( const Model::GetGroupRequest &  request) const

virtual

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

See Also:

AWS API Reference

GetGroupAsync()

template<typename GetGroupRequestT = Model::GetGroupRequest>

void Aws::Synthetics::SyntheticsClient::GetGroupAsync ( const GetGroupRequestT &  request,

const GetGroupResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 477 of file SyntheticsClient.h.

GetGroupCallable()

template<typename GetGroupRequestT = Model::GetGroupRequest>

Model::GetGroupOutcomeCallable Aws::Synthetics::SyntheticsClient::GetGroupCallable ( const GetGroupRequestT &  request) const

inline

A Callable wrapper for GetGroup that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 468 of file SyntheticsClient.h.

GetServiceName()

static const char * Aws::Synthetics::SyntheticsClient::GetServiceName ( )

static

ListAssociatedGroups()

virtual Model::ListAssociatedGroupsOutcome Aws::Synthetics::SyntheticsClient::ListAssociatedGroups ( const Model::ListAssociatedGroupsRequest &  request) const

virtual

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

See Also:

AWS API Reference

ListAssociatedGroupsAsync()

template<typename ListAssociatedGroupsRequestT = Model::ListAssociatedGroupsRequest>

void Aws::Synthetics::SyntheticsClient::ListAssociatedGroupsAsync ( const ListAssociatedGroupsRequestT &  request,

const ListAssociatedGroupsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListAssociatedGroups that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 504 of file SyntheticsClient.h.

ListAssociatedGroupsCallable()

template<typename ListAssociatedGroupsRequestT = Model::ListAssociatedGroupsRequest>

Model::ListAssociatedGroupsOutcomeCallable Aws::Synthetics::SyntheticsClient::ListAssociatedGroupsCallable ( const ListAssociatedGroupsRequestT &  request) const

inline

A Callable wrapper for ListAssociatedGroups that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 495 of file SyntheticsClient.h.

ListGroupResources()

virtual Model::ListGroupResourcesOutcome Aws::Synthetics::SyntheticsClient::ListGroupResources ( const Model::ListGroupResourcesRequest &  request) const

virtual

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

See Also:

AWS API Reference

ListGroupResourcesAsync()

template<typename ListGroupResourcesRequestT = Model::ListGroupResourcesRequest>

void Aws::Synthetics::SyntheticsClient::ListGroupResourcesAsync ( const ListGroupResourcesRequestT &  request,

const ListGroupResourcesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListGroupResources that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 530 of file SyntheticsClient.h.

ListGroupResourcesCallable()

template<typename ListGroupResourcesRequestT = Model::ListGroupResourcesRequest>

Model::ListGroupResourcesOutcomeCallable Aws::Synthetics::SyntheticsClient::ListGroupResourcesCallable ( const ListGroupResourcesRequestT &  request) const

inline

A Callable wrapper for ListGroupResources that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 521 of file SyntheticsClient.h.

ListGroups()

virtual Model::ListGroupsOutcome Aws::Synthetics::SyntheticsClient::ListGroups ( const Model::ListGroupsRequest &  request = {}) const

virtual

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

See Also:

AWS API Reference

ListGroupsAsync()

template<typename ListGroupsRequestT = Model::ListGroupsRequest>

void Aws::Synthetics::SyntheticsClient::ListGroupsAsync ( const ListGroupsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListGroupsRequestT &  request = {} 

) const

inline

An Async wrapper for ListGroups that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 557 of file SyntheticsClient.h.

ListGroupsCallable()

template<typename ListGroupsRequestT = Model::ListGroupsRequest>

Model::ListGroupsOutcomeCallable Aws::Synthetics::SyntheticsClient::ListGroupsCallable ( const ListGroupsRequestT &  request = {}) const

inline

A Callable wrapper for ListGroups that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 548 of file SyntheticsClient.h.

ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Synthetics::SyntheticsClient::ListTagsForResource ( const Model::ListTagsForResourceRequest &  request) const

virtual

Displays the tags associated with a canary or group.

See Also:

AWS API Reference

ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::Synthetics::SyntheticsClient::ListTagsForResourceAsync ( const ListTagsForResourceRequestT &  request,

const ListTagsForResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 583 of file SyntheticsClient.h.

ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::Synthetics::SyntheticsClient::ListTagsForResourceCallable ( const ListTagsForResourceRequestT &  request) const

inline

A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 574 of file SyntheticsClient.h.

OverrideEndpoint()

void Aws::Synthetics::SyntheticsClient::OverrideEndpoint ( const Aws::String &  endpoint)

StartCanary()

virtual Model::StartCanaryOutcome Aws::Synthetics::SyntheticsClient::StartCanary ( const Model::StartCanaryRequest &  request) const

virtual

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.

See Also:

AWS API Reference

StartCanaryAsync()

template<typename StartCanaryRequestT = Model::StartCanaryRequest>

void Aws::Synthetics::SyntheticsClient::StartCanaryAsync ( const StartCanaryRequestT &  request,

const StartCanaryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StartCanary that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 612 of file SyntheticsClient.h.

StartCanaryCallable()

template<typename StartCanaryRequestT = Model::StartCanaryRequest>

Model::StartCanaryOutcomeCallable Aws::Synthetics::SyntheticsClient::StartCanaryCallable ( const StartCanaryRequestT &  request) const

inline

A Callable wrapper for StartCanary that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 603 of file SyntheticsClient.h.

StopCanary()

virtual Model::StopCanaryOutcome Aws::Synthetics::SyntheticsClient::StopCanary ( const Model::StopCanaryRequest &  request) const

virtual

Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.

See Also:

AWS API Reference

StopCanaryAsync()

template<typename StopCanaryRequestT = Model::StopCanaryRequest>

void Aws::Synthetics::SyntheticsClient::StopCanaryAsync ( const StopCanaryRequestT &  request,

const StopCanaryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StopCanary that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 642 of file SyntheticsClient.h.

StopCanaryCallable()

template<typename StopCanaryRequestT = Model::StopCanaryRequest>

Model::StopCanaryOutcomeCallable Aws::Synthetics::SyntheticsClient::StopCanaryCallable ( const StopCanaryRequestT &  request) const

inline

A Callable wrapper for StopCanary that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 633 of file SyntheticsClient.h.

TagResource()

virtual Model::TagResourceOutcome Aws::Synthetics::SyntheticsClient::TagResource ( const Model::TagResourceRequest &  request) const

virtual

Assigns one or more tags (key-value pairs) to the specified canary or group.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a canary or group.

See Also:

AWS API Reference

TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::Synthetics::SyntheticsClient::TagResourceAsync ( const TagResourceRequestT &  request,

const TagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 678 of file SyntheticsClient.h.

TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::Synthetics::SyntheticsClient::TagResourceCallable ( const TagResourceRequestT &  request) const

inline

A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 669 of file SyntheticsClient.h.

UntagResource()

virtual Model::UntagResourceOutcome Aws::Synthetics::SyntheticsClient::UntagResource ( const Model::UntagResourceRequest &  request) const

virtual

Removes one or more tags from the specified resource.

See Also:

AWS API Reference

UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::Synthetics::SyntheticsClient::UntagResourceAsync ( const UntagResourceRequestT &  request,

const UntagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 704 of file SyntheticsClient.h.

UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::Synthetics::SyntheticsClient::UntagResourceCallable ( const UntagResourceRequestT &  request) const

inline

A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 695 of file SyntheticsClient.h.

UpdateCanary()

virtual Model::UpdateCanaryOutcome Aws::Synthetics::SyntheticsClient::UpdateCanary ( const Model::UpdateCanaryRequest &  request) const

virtual

Updates the configuration of a canary that has already been created.

You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.

See Also:

AWS API Reference

UpdateCanaryAsync()

template<typename UpdateCanaryRequestT = Model::UpdateCanaryRequest>

void Aws::Synthetics::SyntheticsClient::UpdateCanaryAsync ( const UpdateCanaryRequestT &  request,

const UpdateCanaryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateCanary that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 733 of file SyntheticsClient.h.

UpdateCanaryCallable()

template<typename UpdateCanaryRequestT = Model::UpdateCanaryRequest>

Model::UpdateCanaryOutcomeCallable Aws::Synthetics::SyntheticsClient::UpdateCanaryCallable ( const UpdateCanaryRequestT &  request) const

inline

A Callable wrapper for UpdateCanary that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 724 of file SyntheticsClient.h.

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< SyntheticsClient >

friend class Aws::Client::ClientWithAsyncTemplateMethods< SyntheticsClient >

friend

Definition at line 740 of file SyntheticsClient.h.

---

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

• generated/src/aws-cpp-sdk-synthetics/include/aws/synthetics/SyntheticsClient.h