NAME

Paws::GlueDataBrew::CreateRecipeJob - Arguments for method CreateRecipeJob on Paws::GlueDataBrew

DESCRIPTION

This class represents the parameters used for calling the method CreateRecipeJob on the AWS Glue DataBrew service. Use the attributes of this class as arguments to method CreateRecipeJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRecipeJob.

SYNOPSIS

    my $databrew = Paws->service('GlueDataBrew');
    my $CreateRecipeJobResponse = $databrew->CreateRecipeJob(
      Name               => 'MyJobName',
      RoleArn            => 'MyArn',
      DataCatalogOutputs => [
        {
          DatabaseName    => 'MyDatabaseName',    # min: 1, max: 255
          TableName       => 'MyTableName',       # min: 1, max: 255
          CatalogId       => 'MyCatalogId',       # min: 1, max: 255; OPTIONAL
          DatabaseOptions => {
            TableName     => 'MyDatabaseTableName',    # min: 1, max: 255
            TempDirectory => {
              Bucket => 'MyBucket',    # min: 3, max: 63
              Key    => 'MyKey',       # min: 1, max: 1280; OPTIONAL
            },    # OPTIONAL
          },    # OPTIONAL
          Overwrite => 1,    # OPTIONAL
          S3Options => {
            Location => {
              Bucket => 'MyBucket',    # min: 3, max: 63
              Key    => 'MyKey',       # min: 1, max: 1280; OPTIONAL
            },    # OPTIONAL
          },    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      DatasetName      => 'MyDatasetName',         # OPTIONAL
      EncryptionKeyArn => 'MyEncryptionKeyArn',    # OPTIONAL
      EncryptionMode   => 'SSE-KMS',               # OPTIONAL
      LogSubscription  => 'ENABLE',                # OPTIONAL
      MaxCapacity      => 1,                       # OPTIONAL
      MaxRetries       => 1,                       # OPTIONAL
      Outputs          => [
        {
          Location => {
            Bucket => 'MyBucket',    # min: 3, max: 63
            Key    => 'MyKey',       # min: 1, max: 1280; OPTIONAL
          },    # OPTIONAL
          CompressionFormat => 'GZIP'
          , # values: GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB; OPTIONAL
          Format => 'CSV'
          ,  # values: CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML; OPTIONAL
          FormatOptions => {
            Csv => {
              Delimiter => 'MyDelimiter',    # min: 1, max: 1; OPTIONAL
            },    # OPTIONAL
          },    # OPTIONAL
          Overwrite        => 1,    # OPTIONAL
          PartitionColumns => [
            'MyColumnName', ...     # min: 1, max: 255
          ],    # max: 200; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      ProjectName     => 'MyProjectName',    # OPTIONAL
      RecipeReference => {
        Name          => 'MyRecipeName',       # min: 1, max: 255
        RecipeVersion => 'MyRecipeVersion',    # min: 1, max: 16; OPTIONAL
      },    # OPTIONAL
      Tags => {
        'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
      },    # OPTIONAL
      Timeout => 1,    # OPTIONAL
    );
    # Results:
    my $Name = $CreateRecipeJobResponse->Name;
    # Returns a L<Paws::GlueDataBrew::CreateRecipeJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/databrew/CreateRecipeJob>

ATTRIBUTES

DataCatalogOutputs => ArrayRef[Paws::GlueDataBrew::DataCatalogOutput]

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

DatasetName => Str

The name of the dataset that this job processes.

EncryptionKeyArn => Str

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

EncryptionMode => Str

The encryption mode for the job, which can be one of the following:

"SSE-KMS" - Server-side encryption with keys managed by KMS.
"SSE-S3" - Server-side encryption with keys managed by Amazon S3.

Valid values are: "SSE-KMS", "SSE-S3"

LogSubscription => Str

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

Valid values are: "ENABLE", "DISABLE"

MaxCapacity => Int

The maximum number of nodes that DataBrew can consume when the job processes data.

MaxRetries => Int

The maximum number of times to retry the job after a job run fails.

REQUIRED Name => Str

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Outputs => ArrayRef[Paws::GlueDataBrew::Output]

One or more artifacts that represent the output from running the job.

ProjectName => Str

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

RecipeReference => Paws::GlueDataBrew::RecipeReference

REQUIRED RoleArn => Str

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Tags => Paws::GlueDataBrew::TagMap

Metadata tags to apply to this job.

Timeout => Int

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of "TIMEOUT".

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>