/AWS1/IF_DBR=>CREATEPROFILEJOB()¶
About CreateProfileJob¶
Creates a new job to analyze a dataset and create its data profile.
Method Signature¶
METHODS /AWS1/IF_DBR~CREATEPROFILEJOB
IMPORTING
!IV_DATASETNAME TYPE /AWS1/DBRDATASETNAME OPTIONAL
!IV_ENCRYPTIONKEYARN TYPE /AWS1/DBRENCRYPTIONKEYARN OPTIONAL
!IV_ENCRYPTIONMODE TYPE /AWS1/DBRENCRYPTIONMODE OPTIONAL
!IV_NAME TYPE /AWS1/DBRJOBNAME OPTIONAL
!IV_LOGSUBSCRIPTION TYPE /AWS1/DBRLOGSUBSCRIPTION OPTIONAL
!IV_MAXCAPACITY TYPE /AWS1/DBRMAXCAPACITY OPTIONAL
!IV_MAXRETRIES TYPE /AWS1/DBRMAXRETRIES OPTIONAL
!IO_OUTPUTLOCATION TYPE REF TO /AWS1/CL_DBRS3LOCATION OPTIONAL
!IO_CONFIGURATION TYPE REF TO /AWS1/CL_DBRPROFILECONF OPTIONAL
!IT_VALIDATIONCONFIGURATIONS TYPE /AWS1/CL_DBRVALIDATIONCONF=>TT_VALIDATIONCONFIGURATIONLIST OPTIONAL
!IV_ROLEARN TYPE /AWS1/DBRARN OPTIONAL
!IT_TAGS TYPE /AWS1/CL_DBRTAGMAP_W=>TT_TAGMAP OPTIONAL
!IV_TIMEOUT TYPE /AWS1/DBRTIMEOUT OPTIONAL
!IO_JOBSAMPLE TYPE REF TO /AWS1/CL_DBRJOBSAMPLE OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dbrcreatepfljobrsp
RAISING
/AWS1/CX_DBRACCESSDENIEDEX
/AWS1/CX_DBRCONFLICTEXCEPTION
/AWS1/CX_DBRRESOURCENOTFOUNDEX
/AWS1/CX_DBRSERVICEQUOTAEXCDEX
/AWS1/CX_DBRVALIDATIONEX
/AWS1/CX_DBRCLIENTEXC
/AWS1/CX_DBRSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_datasetname TYPE /AWS1/DBRDATASETNAME /AWS1/DBRDATASETNAME¶
The name of the dataset that this job is to act upon.
iv_name TYPE /AWS1/DBRJOBNAME /AWS1/DBRJOBNAME¶
The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
io_outputlocation TYPE REF TO /AWS1/CL_DBRS3LOCATION /AWS1/CL_DBRS3LOCATION¶
OutputLocation
iv_rolearn TYPE /AWS1/DBRARN /AWS1/DBRARN¶
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Optional arguments:¶
iv_encryptionkeyarn TYPE /AWS1/DBRENCRYPTIONKEYARN /AWS1/DBRENCRYPTIONKEYARN¶
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
iv_encryptionmode TYPE /AWS1/DBRENCRYPTIONMODE /AWS1/DBRENCRYPTIONMODE¶
The encryption mode for the job, which can be one of the following:
SSE-KMS-SSE-KMS- Server-side encryption with KMS-managed keys.
SSE-S3- Server-side encryption with keys managed by Amazon S3.
iv_logsubscription TYPE /AWS1/DBRLOGSUBSCRIPTION /AWS1/DBRLOGSUBSCRIPTION¶
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
iv_maxcapacity TYPE /AWS1/DBRMAXCAPACITY /AWS1/DBRMAXCAPACITY¶
The maximum number of nodes that DataBrew can use when the job processes data.
iv_maxretries TYPE /AWS1/DBRMAXRETRIES /AWS1/DBRMAXRETRIES¶
The maximum number of times to retry the job after a job run fails.
io_configuration TYPE REF TO /AWS1/CL_DBRPROFILECONF /AWS1/CL_DBRPROFILECONF¶
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.
it_validationconfigurations TYPE /AWS1/CL_DBRVALIDATIONCONF=>TT_VALIDATIONCONFIGURATIONLIST TT_VALIDATIONCONFIGURATIONLIST¶
List of validation configurations that are applied to the profile job.
it_tags TYPE /AWS1/CL_DBRTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
Metadata tags to apply to this job.
iv_timeout TYPE /AWS1/DBRTIMEOUT /AWS1/DBRTIMEOUT¶
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of
TIMEOUT.
io_jobsample TYPE REF TO /AWS1/CL_DBRJOBSAMPLE /AWS1/CL_DBRJOBSAMPLE¶
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.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_dbrcreatepfljobrsp /AWS1/CL_DBRCREATEPFLJOBRSP¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
Examples¶
Syntax Example¶
This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.
DATA(lo_result) = lo_client->createprofilejob(
io_configuration = new /aws1/cl_dbrprofileconf(
io_datasetstatisticsconf = new /aws1/cl_dbrstatisticsconf(
it_includedstatistics = VALUE /aws1/cl_dbrstatisticlist_w=>tt_statisticlist(
( new /aws1/cl_dbrstatisticlist_w( |string| ) )
)
it_overrides = VALUE /aws1/cl_dbrstatisticoverride=>tt_statisticoverridelist(
(
new /aws1/cl_dbrstatisticoverride(
it_parameters = VALUE /aws1/cl_dbrparametermap_w=>tt_parametermap(
(
VALUE /aws1/cl_dbrparametermap_w=>ts_parametermap_maprow(
value = new /aws1/cl_dbrparametermap_w( |string| )
key = |string|
)
)
)
iv_statistic = |string|
)
)
)
)
io_entitydetectorconf = new /aws1/cl_dbrentitydetectorconf(
it_allowedstatistics = VALUE /aws1/cl_dbrallowedstatistics=>tt_allowedstatisticlist(
(
new /aws1/cl_dbrallowedstatistics(
it_statistics = VALUE /aws1/cl_dbrstatisticlist_w=>tt_statisticlist(
( new /aws1/cl_dbrstatisticlist_w( |string| ) )
)
)
)
)
it_entitytypes = VALUE /aws1/cl_dbrentitytypelist_w=>tt_entitytypelist(
( new /aws1/cl_dbrentitytypelist_w( |string| ) )
)
)
it_columnstatisticsconfs = VALUE /aws1/cl_dbrcolumnstatsconf=>tt_columnstatisticsconflist(
(
new /aws1/cl_dbrcolumnstatsconf(
io_statistics = new /aws1/cl_dbrstatisticsconf(
it_includedstatistics = VALUE /aws1/cl_dbrstatisticlist_w=>tt_statisticlist(
( new /aws1/cl_dbrstatisticlist_w( |string| ) )
)
it_overrides = VALUE /aws1/cl_dbrstatisticoverride=>tt_statisticoverridelist(
(
new /aws1/cl_dbrstatisticoverride(
it_parameters = VALUE /aws1/cl_dbrparametermap_w=>tt_parametermap(
(
VALUE /aws1/cl_dbrparametermap_w=>ts_parametermap_maprow(
value = new /aws1/cl_dbrparametermap_w( |string| )
key = |string|
)
)
)
iv_statistic = |string|
)
)
)
)
it_selectors = VALUE /aws1/cl_dbrcolumnselector=>tt_columnselectorlist(
(
new /aws1/cl_dbrcolumnselector(
iv_name = |string|
iv_regex = |string|
)
)
)
)
)
)
it_profilecolumns = VALUE /aws1/cl_dbrcolumnselector=>tt_columnselectorlist(
(
new /aws1/cl_dbrcolumnselector(
iv_name = |string|
iv_regex = |string|
)
)
)
)
io_jobsample = new /aws1/cl_dbrjobsample(
iv_mode = |string|
iv_size = 123
)
io_outputlocation = new /aws1/cl_dbrs3location(
iv_bucket = |string|
iv_bucketowner = |string|
iv_key = |string|
)
it_tags = VALUE /aws1/cl_dbrtagmap_w=>tt_tagmap(
(
VALUE /aws1/cl_dbrtagmap_w=>ts_tagmap_maprow(
key = |string|
value = new /aws1/cl_dbrtagmap_w( |string| )
)
)
)
it_validationconfigurations = VALUE /aws1/cl_dbrvalidationconf=>tt_validationconfigurationlist(
(
new /aws1/cl_dbrvalidationconf(
iv_rulesetarn = |string|
iv_validationmode = |string|
)
)
)
iv_datasetname = |string|
iv_encryptionkeyarn = |string|
iv_encryptionmode = |string|
iv_logsubscription = |string|
iv_maxcapacity = 123
iv_maxretries = 123
iv_name = |string|
iv_rolearn = |string|
iv_timeout = 123
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lv_jobname = lo_result->get_name( ).
ENDIF.