CreateProfileJob - AWS Glue DataBrew

CreateProfileJob

Creates a new job to analyze a dataset and create its data profile.

Request Syntax

POST /profileJobs HTTP/1.1 Content-type: application/json { "Configuration": { "ColumnStatisticsConfigurations": [ { "Selectors": [ { "Name": "string", "Regex": "string" } ], "Statistics": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] } } ], "DatasetStatisticsConfiguration": { "IncludedStatistics": [ "string" ], "Overrides": [ { "Parameters": { "string" : "string" }, "Statistic": "string" } ] }, "EntityDetectorConfiguration": { "AllowedStatistics": [ { "Statistics": [ "string" ] } ], "EntityTypes": [ "string" ] }, "ProfileColumns": [ { "Name": "string", "Regex": "string" } ] }, "DatasetName": "string", "EncryptionKeyArn": "string", "EncryptionMode": "string", "JobSample": { "Mode": "string", "Size": number }, "LogSubscription": "string", "MaxCapacity": number, "MaxRetries": number, "Name": "string", "OutputLocation": { "Bucket": "string", "Key": "string" }, "RoleArn": "string", "Tags": { "string" : "string" }, "Timeout": number, "ValidationConfigurations": [ { "RulesetArn": "string", "ValidationMode": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DatasetName

The name of the dataset that this job is to act upon.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Name

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 240.

Required: Yes

OutputLocation

Represents an Amazon S3 location (bucket name and object key) where DataBrew can read input data, or write output from a job.

Type: S3Location object

Required: Yes

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Configuration

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

Type: ProfileConfiguration object

Required: No

EncryptionKeyArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

EncryptionMode

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

  • SSE-KMS - SSE-KMS - Server-side encryption with AWS KMS-managed keys.

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

Type: String

Valid Values: SSE-KMS | SSE-S3

Required: No

JobSample

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

Type: JobSample object

Required: No

LogSubscription

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

Type: String

Valid Values: ENABLE | DISABLE

Required: No

MaxCapacity

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

Type: Integer

Required: No

MaxRetries

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Tags

Metadata tags to apply to this job.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Timeout

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

ValidationConfigurations

List of validation configurations that are applied to the profile job.

Type: Array of ValidationConfiguration objects

Array Members: Minimum number of 1 item.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Name": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Name

The name of the job that was created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 240.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to the specified resource was denied.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ServiceQuotaExceededException

A service quota is exceeded.

HTTP Status Code: 402

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: