SageMakerRequest Class

(QtAws::SageMaker::SageMakerRequest)

The SageMakerRequest class provides an interface for SageMaker requests. More...

Header:	#include <SageMakerRequest>
Inherits:	QtAws::Core::AwsAbstractRequest
Inherited By:	QtAws::SageMaker::AddTagsRequest, QtAws::SageMaker::CreateEndpointConfigRequest, QtAws::SageMaker::CreateEndpointRequest, QtAws::SageMaker::CreateModelRequest, QtAws::SageMaker::CreateNotebookInstanceLifecycleConfigRequest, QtAws::SageMaker::CreateNotebookInstanceRequest, QtAws::SageMaker::CreatePresignedNotebookInstanceUrlRequest, QtAws::SageMaker::CreateTrainingJobRequest, QtAws::SageMaker::DeleteEndpointConfigRequest, QtAws::SageMaker::DeleteEndpointRequest, QtAws::SageMaker::DeleteModelRequest, QtAws::SageMaker::DeleteNotebookInstanceLifecycleConfigRequest, QtAws::SageMaker::DeleteNotebookInstanceRequest, QtAws::SageMaker::DeleteTagsRequest, QtAws::SageMaker::DescribeEndpointConfigRequest, QtAws::SageMaker::DescribeEndpointRequest, QtAws::SageMaker::DescribeModelRequest, QtAws::SageMaker::DescribeNotebookInstanceLifecycleConfigRequest, QtAws::SageMaker::DescribeNotebookInstanceRequest, QtAws::SageMaker::DescribeTrainingJobRequest, QtAws::SageMaker::ListEndpointConfigsRequest, QtAws::SageMaker::ListEndpointsRequest, QtAws::SageMaker::ListModelsRequest, QtAws::SageMaker::ListNotebookInstanceLifecycleConfigsRequest, QtAws::SageMaker::ListNotebookInstancesRequest, QtAws::SageMaker::ListTagsRequest, QtAws::SageMaker::ListTrainingJobsRequest, QtAws::SageMaker::StartNotebookInstanceRequest, QtAws::SageMaker::StopNotebookInstanceRequest, QtAws::SageMaker::StopTrainingJobRequest, QtAws::SageMaker::UpdateEndpointRequest, QtAws::SageMaker::UpdateEndpointWeightsAndCapacitiesRequest, QtAws::SageMaker::UpdateNotebookInstanceLifecycleConfigRequest, and QtAws::SageMaker::UpdateNotebookInstanceRequest

List of all members, including inherited members

Public Types

enum	Action { AddTagsAction, CreateEndpointAction, CreateEndpointConfigAction, CreateModelAction, ..., UpdateNotebookInstanceLifecycleConfigAction }
flags	Actions

Public Functions

	SageMakerRequest(const Action action)
	SageMakerRequest(const SageMakerRequest &other)
Action	action() const
QString	actionString() const
QString	apiVersion() const
void	setAction(const Action action)
void	setApiVersion(const QString &version)
SageMakerRequest &	operator=(const SageMakerRequest &other)
virtual bool	operator==(const SageMakerRequest &other) const

7 public functions inherited from QtAws::Core::AwsAbstractRequest

Protected Functions

	SageMakerRequest(SageMakerRequestPrivate * const d)
int	clearParameter(const QString &name)
void	clearParameters()
QVariant	parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &	parameters() const
void	setParameter(const QString &name, const QVariant &value)
void	setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

4 protected functions inherited from QtAws::Core::AwsAbstractRequest

Detailed Description

The SageMakerRequest class provides an interface for SageMaker requests.

Member Type Documentation

enum SageMakerRequest::Action
flags SageMakerRequest::Actions

This enum describes the actions that can be performed as SageMaker requests.

Constant	Value	Description
`QtAws::SageMaker::SageMakerRequest::AddTagsAction`	`0`	SageMaker AddTags action.
`QtAws::SageMaker::SageMakerRequest::CreateEndpointAction`	`1`	SageMaker CreateEndpoint action.
`QtAws::SageMaker::SageMakerRequest::CreateEndpointConfigAction`	`2`	SageMaker CreateEndpointConfig action.
`QtAws::SageMaker::SageMakerRequest::CreateModelAction`	`3`	SageMaker CreateModel action.
`QtAws::SageMaker::SageMakerRequest::CreateNotebookInstanceAction`	`4`	SageMaker CreateNotebookInstance action.
`QtAws::SageMaker::SageMakerRequest::CreateNotebookInstanceLifecycleConfigAction`	`5`	SageMaker CreateNotebookInstanceLifecycleConfig action.
`QtAws::SageMaker::SageMakerRequest::CreatePresignedNotebookInstanceUrlAction`	`6`	SageMaker CreatePresignedNotebookInstanceUrl action.
`QtAws::SageMaker::SageMakerRequest::CreateTrainingJobAction`	`7`	SageMaker CreateTrainingJob action.
`QtAws::SageMaker::SageMakerRequest::DeleteEndpointAction`	`8`	SageMaker DeleteEndpoint action.
`QtAws::SageMaker::SageMakerRequest::DeleteEndpointConfigAction`	`9`	SageMaker DeleteEndpointConfig action.
`QtAws::SageMaker::SageMakerRequest::DeleteModelAction`	`10`	SageMaker DeleteModel action.
`QtAws::SageMaker::SageMakerRequest::DeleteNotebookInstanceAction`	`11`	SageMaker DeleteNotebookInstance action.
`QtAws::SageMaker::SageMakerRequest::DeleteNotebookInstanceLifecycleConfigAction`	`12`	SageMaker DeleteNotebookInstanceLifecycleConfig action.
`QtAws::SageMaker::SageMakerRequest::DeleteTagsAction`	`13`	SageMaker DeleteTags action.
`QtAws::SageMaker::SageMakerRequest::DescribeEndpointAction`	`14`	SageMaker DescribeEndpoint action.
`QtAws::SageMaker::SageMakerRequest::DescribeEndpointConfigAction`	`15`	SageMaker DescribeEndpointConfig action.
`QtAws::SageMaker::SageMakerRequest::DescribeModelAction`	`16`	SageMaker DescribeModel action.
`QtAws::SageMaker::SageMakerRequest::DescribeNotebookInstanceAction`	`17`	SageMaker DescribeNotebookInstance action.
`QtAws::SageMaker::SageMakerRequest::DescribeNotebookInstanceLifecycleConfigAction`	`18`	SageMaker DescribeNotebookInstanceLifecycleConfig action.
`QtAws::SageMaker::SageMakerRequest::DescribeTrainingJobAction`	`19`	SageMaker DescribeTrainingJob action.
`QtAws::SageMaker::SageMakerRequest::ListEndpointConfigsAction`	`20`	SageMaker ListEndpointConfigs action.
`QtAws::SageMaker::SageMakerRequest::ListEndpointsAction`	`21`	SageMaker ListEndpoints action.
`QtAws::SageMaker::SageMakerRequest::ListModelsAction`	`22`	SageMaker ListModels action.
`QtAws::SageMaker::SageMakerRequest::ListNotebookInstanceLifecycleConfigsAction`	`23`	SageMaker ListNotebookInstanceLifecycleConfigs action.
`QtAws::SageMaker::SageMakerRequest::ListNotebookInstancesAction`	`24`	SageMaker ListNotebookInstances action.
`QtAws::SageMaker::SageMakerRequest::ListTagsAction`	`25`	SageMaker ListTags action.
`QtAws::SageMaker::SageMakerRequest::ListTrainingJobsAction`	`26`	SageMaker ListTrainingJobs action.
`QtAws::SageMaker::SageMakerRequest::StartNotebookInstanceAction`	`27`	SageMaker StartNotebookInstance action.
`QtAws::SageMaker::SageMakerRequest::StopNotebookInstanceAction`	`28`	SageMaker StopNotebookInstance action.
`QtAws::SageMaker::SageMakerRequest::StopTrainingJobAction`	`29`	SageMaker StopTrainingJob action.
`QtAws::SageMaker::SageMakerRequest::UpdateEndpointAction`	`30`	SageMaker UpdateEndpoint action.
`QtAws::SageMaker::SageMakerRequest::UpdateEndpointWeightsAndCapacitiesAction`	`31`	SageMaker UpdateEndpointWeightsAndCapacities action.
`QtAws::SageMaker::SageMakerRequest::UpdateNotebookInstanceAction`	`32`	SageMaker UpdateNotebookInstance action.
`QtAws::SageMaker::SageMakerRequest::UpdateNotebookInstanceLifecycleConfigAction`	`33`	SageMaker UpdateNotebookInstanceLifecycleConfig action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

SageMakerRequest::SageMakerRequest(const Action action)

Constructs a SageMakerRequest object for SageMaker action.

SageMakerRequest::SageMakerRequest(const SageMakerRequest &other)

Constructs a copy of other.

`[protected]` SageMakerRequest::SageMakerRequest(SageMakerRequestPrivate * const d)

Constructs aa SageMakerRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from SageMakerRequestPrivate.

Action SageMakerRequest::action() const

Returns the SageMaker action to be performed by this request.

See also setAction().

QString SageMakerRequest::actionString() const

Returns the name of the SageMaker action to be performed by this request.

QString SageMakerRequest::apiVersion() const

Returns the SageMaker API version implemented by this request.

See also setApiVersion().

`[protected]` int SageMakerRequest::clearParameter(const QString &name)

Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).

`[protected]` void SageMakerRequest::clearParameters()

Removes all parameters from the request.

`[protected]` QVariant SageMakerRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const

Returns the value of the name pararemter if set; defaultValue otherwise.

See also setParameter().

`[protected]` const QVariantMap &SageMakerRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void SageMakerRequest::setAction(const Action action)

Sets the SageMaker action to be performed by this request to action.

See also action().

void SageMakerRequest::setApiVersion(const QString &version)

Sets the SageMaker API version to include in this request to version.

See also apiVersion().

`[protected]` void SageMakerRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

`[protected]` void SageMakerRequest::setParameters(const QVariantMap &parameters)

Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.

See also parameters().

`[override virtual protected]` QNetworkRequest SageMakerRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the SageMaker request using the given endpoint.

This SageMaker implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.

SageMakerRequest &SageMakerRequest::operator=(const SageMakerRequest &other)

Sets the SageMakerRequest object to be equal to other.

`[virtual]` bool SageMakerRequest::operator==(const SageMakerRequest &other) const

Returns true if this request is equal to other; false otherwise.

Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Contents