AWS SDK for C++  1.8.99
AWS SDK for C++
Public Member Functions | List of all members
Aws::Glue::Model::CreateMLTransformRequest Class Reference

#include <CreateMLTransformRequest.h>

+ Inheritance diagram for Aws::Glue::Model::CreateMLTransformRequest:

Public Member Functions

 CreateMLTransformRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateMLTransformRequestWithName (const Aws::String &value)
 
CreateMLTransformRequestWithName (Aws::String &&value)
 
CreateMLTransformRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateMLTransformRequestWithDescription (const Aws::String &value)
 
CreateMLTransformRequestWithDescription (Aws::String &&value)
 
CreateMLTransformRequestWithDescription (const char *value)
 
const Aws::Vector< GlueTable > & GetInputRecordTables () const
 
bool InputRecordTablesHasBeenSet () const
 
void SetInputRecordTables (const Aws::Vector< GlueTable > &value)
 
void SetInputRecordTables (Aws::Vector< GlueTable > &&value)
 
CreateMLTransformRequestWithInputRecordTables (const Aws::Vector< GlueTable > &value)
 
CreateMLTransformRequestWithInputRecordTables (Aws::Vector< GlueTable > &&value)
 
CreateMLTransformRequestAddInputRecordTables (const GlueTable &value)
 
CreateMLTransformRequestAddInputRecordTables (GlueTable &&value)
 
const TransformParametersGetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const TransformParameters &value)
 
void SetParameters (TransformParameters &&value)
 
CreateMLTransformRequestWithParameters (const TransformParameters &value)
 
CreateMLTransformRequestWithParameters (TransformParameters &&value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
CreateMLTransformRequestWithRole (const Aws::String &value)
 
CreateMLTransformRequestWithRole (Aws::String &&value)
 
CreateMLTransformRequestWithRole (const char *value)
 
const Aws::StringGetGlueVersion () const
 
bool GlueVersionHasBeenSet () const
 
void SetGlueVersion (const Aws::String &value)
 
void SetGlueVersion (Aws::String &&value)
 
void SetGlueVersion (const char *value)
 
CreateMLTransformRequestWithGlueVersion (const Aws::String &value)
 
CreateMLTransformRequestWithGlueVersion (Aws::String &&value)
 
CreateMLTransformRequestWithGlueVersion (const char *value)
 
double GetMaxCapacity () const
 
bool MaxCapacityHasBeenSet () const
 
void SetMaxCapacity (double value)
 
CreateMLTransformRequestWithMaxCapacity (double value)
 
const WorkerTypeGetWorkerType () const
 
bool WorkerTypeHasBeenSet () const
 
void SetWorkerType (const WorkerType &value)
 
void SetWorkerType (WorkerType &&value)
 
CreateMLTransformRequestWithWorkerType (const WorkerType &value)
 
CreateMLTransformRequestWithWorkerType (WorkerType &&value)
 
int GetNumberOfWorkers () const
 
bool NumberOfWorkersHasBeenSet () const
 
void SetNumberOfWorkers (int value)
 
CreateMLTransformRequestWithNumberOfWorkers (int value)
 
int GetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (int value)
 
CreateMLTransformRequestWithTimeout (int value)
 
int GetMaxRetries () const
 
bool MaxRetriesHasBeenSet () const
 
void SetMaxRetries (int value)
 
CreateMLTransformRequestWithMaxRetries (int value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateMLTransformRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateMLTransformRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateMLTransformRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateMLTransformRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateMLTransformRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateMLTransformRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateMLTransformRequestAddTags (const char *key, Aws::String &&value)
 
CreateMLTransformRequestAddTags (Aws::String &&key, const char *value)
 
CreateMLTransformRequestAddTags (const char *key, const char *value)
 
const TransformEncryptionGetTransformEncryption () const
 
bool TransformEncryptionHasBeenSet () const
 
void SetTransformEncryption (const TransformEncryption &value)
 
void SetTransformEncryption (TransformEncryption &&value)
 
CreateMLTransformRequestWithTransformEncryption (const TransformEncryption &value)
 
CreateMLTransformRequestWithTransformEncryption (TransformEncryption &&value)
 
- Public Member Functions inherited from Aws::Glue::GlueRequest
virtual ~GlueRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file CreateMLTransformRequest.h.

Constructor & Destructor Documentation

◆ CreateMLTransformRequest()

Aws::Glue::Model::CreateMLTransformRequest::CreateMLTransformRequest ( )

Member Function Documentation

◆ AddInputRecordTables() [1/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddInputRecordTables ( const GlueTable value)
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 166 of file CreateMLTransformRequest.h.

◆ AddInputRecordTables() [2/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddInputRecordTables ( GlueTable &&  value)
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 171 of file CreateMLTransformRequest.h.

◆ AddTags() [1/7]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 773 of file CreateMLTransformRequest.h.

◆ AddTags() [2/7]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 782 of file CreateMLTransformRequest.h.

◆ AddTags() [3/7]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 791 of file CreateMLTransformRequest.h.

◆ AddTags() [4/7]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 800 of file CreateMLTransformRequest.h.

◆ AddTags() [5/7]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 809 of file CreateMLTransformRequest.h.

◆ AddTags() [6/7]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 818 of file CreateMLTransformRequest.h.

◆ AddTags() [7/7]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::AddTags ( const char *  key,
const char *  value 
)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 827 of file CreateMLTransformRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::DescriptionHasBeenSet ( ) const
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 94 of file CreateMLTransformRequest.h.

◆ GetDescription()

const Aws::String& Aws::Glue::Model::CreateMLTransformRequest::GetDescription ( ) const
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 88 of file CreateMLTransformRequest.h.

◆ GetGlueVersion()

const Aws::String& Aws::Glue::Model::CreateMLTransformRequest::GetGlueVersion ( ) const
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 332 of file CreateMLTransformRequest.h.

◆ GetInputRecordTables()

const Aws::Vector<GlueTable>& Aws::Glue::Model::CreateMLTransformRequest::GetInputRecordTables ( ) const
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 136 of file CreateMLTransformRequest.h.

◆ GetMaxCapacity()

double Aws::Glue::Model::CreateMLTransformRequest::GetMaxCapacity ( ) const
inline

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

Definition at line 426 of file CreateMLTransformRequest.h.

◆ GetMaxRetries()

int Aws::Glue::Model::CreateMLTransformRequest::GetMaxRetries ( ) const
inline

The maximum number of times to retry a task for this transform after a task run fails.

Definition at line 691 of file CreateMLTransformRequest.h.

◆ GetName()

const Aws::String& Aws::Glue::Model::CreateMLTransformRequest::GetName ( ) const
inline

The unique name that you give the transform when you create it.

Definition at line 46 of file CreateMLTransformRequest.h.

◆ GetNumberOfWorkers()

int Aws::Glue::Model::CreateMLTransformRequest::GetNumberOfWorkers ( ) const
inline

The number of workers of a defined workerType that are allocated when this task runs.

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

Definition at line 630 of file CreateMLTransformRequest.h.

◆ GetParameters()

const TransformParameters& Aws::Glue::Model::CreateMLTransformRequest::GetParameters ( ) const
inline

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

Definition at line 178 of file CreateMLTransformRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Glue::Model::CreateMLTransformRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Glue::GlueRequest.

◆ GetRole()

const Aws::String& Aws::Glue::Model::CreateMLTransformRequest::GetRole ( ) const
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 223 of file CreateMLTransformRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Glue::Model::CreateMLTransformRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateMLTransformRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Glue::Model::CreateMLTransformRequest::GetTags ( ) const
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 719 of file CreateMLTransformRequest.h.

◆ GetTimeout()

int Aws::Glue::Model::CreateMLTransformRequest::GetTimeout ( ) const
inline

The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Definition at line 660 of file CreateMLTransformRequest.h.

◆ GetTransformEncryption()

const TransformEncryption& Aws::Glue::Model::CreateMLTransformRequest::GetTransformEncryption ( ) const
inline

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

Definition at line 835 of file CreateMLTransformRequest.h.

◆ GetWorkerType()

const WorkerType& Aws::Glue::Model::CreateMLTransformRequest::GetWorkerType ( ) const
inline

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

Definition at line 517 of file CreateMLTransformRequest.h.

◆ GlueVersionHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::GlueVersionHasBeenSet ( ) const
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 342 of file CreateMLTransformRequest.h.

◆ InputRecordTablesHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::InputRecordTablesHasBeenSet ( ) const
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 141 of file CreateMLTransformRequest.h.

◆ MaxCapacityHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::MaxCapacityHasBeenSet ( ) const
inline

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

Definition at line 449 of file CreateMLTransformRequest.h.

◆ MaxRetriesHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::MaxRetriesHasBeenSet ( ) const
inline

The maximum number of times to retry a task for this transform after a task run fails.

Definition at line 697 of file CreateMLTransformRequest.h.

◆ NameHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::NameHasBeenSet ( ) const
inline

The unique name that you give the transform when you create it.

Definition at line 51 of file CreateMLTransformRequest.h.

◆ NumberOfWorkersHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::NumberOfWorkersHasBeenSet ( ) const
inline

The number of workers of a defined workerType that are allocated when this task runs.

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

Definition at line 637 of file CreateMLTransformRequest.h.

◆ ParametersHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::ParametersHasBeenSet ( ) const
inline

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

Definition at line 184 of file CreateMLTransformRequest.h.

◆ RoleHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::RoleHasBeenSet ( ) const
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 237 of file CreateMLTransformRequest.h.

◆ SerializePayload()

Aws::String Aws::Glue::Model::CreateMLTransformRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetDescription ( const Aws::String value)
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 100 of file CreateMLTransformRequest.h.

◆ SetDescription() [2/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetDescription ( Aws::String &&  value)
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 106 of file CreateMLTransformRequest.h.

◆ SetDescription() [3/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetDescription ( const char *  value)
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 112 of file CreateMLTransformRequest.h.

◆ SetGlueVersion() [1/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetGlueVersion ( const Aws::String value)
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 352 of file CreateMLTransformRequest.h.

◆ SetGlueVersion() [2/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetGlueVersion ( Aws::String &&  value)
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 362 of file CreateMLTransformRequest.h.

◆ SetGlueVersion() [3/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetGlueVersion ( const char *  value)
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 372 of file CreateMLTransformRequest.h.

◆ SetInputRecordTables() [1/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetInputRecordTables ( const Aws::Vector< GlueTable > &  value)
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 146 of file CreateMLTransformRequest.h.

◆ SetInputRecordTables() [2/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetInputRecordTables ( Aws::Vector< GlueTable > &&  value)
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 151 of file CreateMLTransformRequest.h.

◆ SetMaxCapacity()

void Aws::Glue::Model::CreateMLTransformRequest::SetMaxCapacity ( double  value)
inline

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

Definition at line 472 of file CreateMLTransformRequest.h.

◆ SetMaxRetries()

void Aws::Glue::Model::CreateMLTransformRequest::SetMaxRetries ( int  value)
inline

The maximum number of times to retry a task for this transform after a task run fails.

Definition at line 703 of file CreateMLTransformRequest.h.

◆ SetName() [1/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetName ( const Aws::String value)
inline

The unique name that you give the transform when you create it.

Definition at line 56 of file CreateMLTransformRequest.h.

◆ SetName() [2/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetName ( Aws::String &&  value)
inline

The unique name that you give the transform when you create it.

Definition at line 61 of file CreateMLTransformRequest.h.

◆ SetName() [3/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetName ( const char *  value)
inline

The unique name that you give the transform when you create it.

Definition at line 66 of file CreateMLTransformRequest.h.

◆ SetNumberOfWorkers()

void Aws::Glue::Model::CreateMLTransformRequest::SetNumberOfWorkers ( int  value)
inline

The number of workers of a defined workerType that are allocated when this task runs.

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

Definition at line 644 of file CreateMLTransformRequest.h.

◆ SetParameters() [1/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetParameters ( const TransformParameters value)
inline

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

Definition at line 190 of file CreateMLTransformRequest.h.

◆ SetParameters() [2/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetParameters ( TransformParameters &&  value)
inline

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

Definition at line 196 of file CreateMLTransformRequest.h.

◆ SetRole() [1/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetRole ( const Aws::String value)
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 251 of file CreateMLTransformRequest.h.

◆ SetRole() [2/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetRole ( Aws::String &&  value)
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 265 of file CreateMLTransformRequest.h.

◆ SetRole() [3/3]

void Aws::Glue::Model::CreateMLTransformRequest::SetRole ( const char *  value)
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 279 of file CreateMLTransformRequest.h.

◆ SetTags() [1/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 737 of file CreateMLTransformRequest.h.

◆ SetTags() [2/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 746 of file CreateMLTransformRequest.h.

◆ SetTimeout()

void Aws::Glue::Model::CreateMLTransformRequest::SetTimeout ( int  value)
inline

The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Definition at line 676 of file CreateMLTransformRequest.h.

◆ SetTransformEncryption() [1/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetTransformEncryption ( const TransformEncryption value)
inline

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

Definition at line 849 of file CreateMLTransformRequest.h.

◆ SetTransformEncryption() [2/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetTransformEncryption ( TransformEncryption &&  value)
inline

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

Definition at line 856 of file CreateMLTransformRequest.h.

◆ SetWorkerType() [1/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetWorkerType ( const WorkerType value)
inline

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

Definition at line 559 of file CreateMLTransformRequest.h.

◆ SetWorkerType() [2/2]

void Aws::Glue::Model::CreateMLTransformRequest::SetWorkerType ( WorkerType &&  value)
inline

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

Definition at line 580 of file CreateMLTransformRequest.h.

◆ TagsHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::TagsHasBeenSet ( ) const
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 728 of file CreateMLTransformRequest.h.

◆ TimeoutHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::TimeoutHasBeenSet ( ) const
inline

The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Definition at line 668 of file CreateMLTransformRequest.h.

◆ TransformEncryptionHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::TransformEncryptionHasBeenSet ( ) const
inline

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

Definition at line 842 of file CreateMLTransformRequest.h.

◆ WithDescription() [1/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithDescription ( const Aws::String value)
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 118 of file CreateMLTransformRequest.h.

◆ WithDescription() [2/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithDescription ( Aws::String &&  value)
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 124 of file CreateMLTransformRequest.h.

◆ WithDescription() [3/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithDescription ( const char *  value)
inline

A description of the machine learning transform that is being defined. The default is an empty string.

Definition at line 130 of file CreateMLTransformRequest.h.

◆ WithGlueVersion() [1/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithGlueVersion ( const Aws::String value)
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 382 of file CreateMLTransformRequest.h.

◆ WithGlueVersion() [2/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithGlueVersion ( Aws::String &&  value)
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 392 of file CreateMLTransformRequest.h.

◆ WithGlueVersion() [3/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithGlueVersion ( const char *  value)
inline

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

Definition at line 402 of file CreateMLTransformRequest.h.

◆ WithInputRecordTables() [1/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithInputRecordTables ( const Aws::Vector< GlueTable > &  value)
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 156 of file CreateMLTransformRequest.h.

◆ WithInputRecordTables() [2/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithInputRecordTables ( Aws::Vector< GlueTable > &&  value)
inline

A list of AWS Glue table definitions used by the transform.

Definition at line 161 of file CreateMLTransformRequest.h.

◆ WithMaxCapacity()

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithMaxCapacity ( double  value)
inline

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

Definition at line 495 of file CreateMLTransformRequest.h.

◆ WithMaxRetries()

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithMaxRetries ( int  value)
inline

The maximum number of times to retry a task for this transform after a task run fails.

Definition at line 709 of file CreateMLTransformRequest.h.

◆ WithName() [1/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithName ( const Aws::String value)
inline

The unique name that you give the transform when you create it.

Definition at line 71 of file CreateMLTransformRequest.h.

◆ WithName() [2/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithName ( Aws::String &&  value)
inline

The unique name that you give the transform when you create it.

Definition at line 76 of file CreateMLTransformRequest.h.

◆ WithName() [3/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithName ( const char *  value)
inline

The unique name that you give the transform when you create it.

Definition at line 81 of file CreateMLTransformRequest.h.

◆ WithNumberOfWorkers()

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithNumberOfWorkers ( int  value)
inline

The number of workers of a defined workerType that are allocated when this task runs.

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

Definition at line 651 of file CreateMLTransformRequest.h.

◆ WithParameters() [1/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithParameters ( const TransformParameters value)
inline

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

Definition at line 202 of file CreateMLTransformRequest.h.

◆ WithParameters() [2/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithParameters ( TransformParameters &&  value)
inline

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

Definition at line 208 of file CreateMLTransformRequest.h.

◆ WithRole() [1/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithRole ( const Aws::String value)
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 293 of file CreateMLTransformRequest.h.

◆ WithRole() [2/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithRole ( Aws::String &&  value)
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 307 of file CreateMLTransformRequest.h.

◆ WithRole() [3/3]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithRole ( const char *  value)
inline

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

  • This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.

  • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

Definition at line 321 of file CreateMLTransformRequest.h.

◆ WithTags() [1/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 755 of file CreateMLTransformRequest.h.

◆ WithTags() [2/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Definition at line 764 of file CreateMLTransformRequest.h.

◆ WithTimeout()

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithTimeout ( int  value)
inline

The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Definition at line 684 of file CreateMLTransformRequest.h.

◆ WithTransformEncryption() [1/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithTransformEncryption ( const TransformEncryption value)
inline

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

Definition at line 863 of file CreateMLTransformRequest.h.

◆ WithTransformEncryption() [2/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithTransformEncryption ( TransformEncryption &&  value)
inline

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

Definition at line 870 of file CreateMLTransformRequest.h.

◆ WithWorkerType() [1/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithWorkerType ( const WorkerType value)
inline

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

Definition at line 601 of file CreateMLTransformRequest.h.

◆ WithWorkerType() [2/2]

CreateMLTransformRequest& Aws::Glue::Model::CreateMLTransformRequest::WithWorkerType ( WorkerType &&  value)
inline

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

Definition at line 622 of file CreateMLTransformRequest.h.

◆ WorkerTypeHasBeenSet()

bool Aws::Glue::Model::CreateMLTransformRequest::WorkerTypeHasBeenSet ( ) const
inline

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

  • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

  • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

  • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

  • MaxCapacity and NumberOfWorkers must both be at least 1.

Definition at line 538 of file CreateMLTransformRequest.h.


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