/AWS1/CL_CRMCOLLABORATIONALY00¶
The analysis template within a collaboration.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_id
TYPE /AWS1/CRMANALYSISTEMPLATEID
/AWS1/CRMANALYSISTEMPLATEID
¶
The identifier of the analysis template.
iv_arn
TYPE /AWS1/CRMANALYSISTEMPLATEARN
/AWS1/CRMANALYSISTEMPLATEARN
¶
The Amazon Resource Name (ARN) of the analysis template.
iv_collaborationid
TYPE /AWS1/CRMUUID
/AWS1/CRMUUID
¶
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
iv_collaborationarn
TYPE /AWS1/CRMCOLLABORATIONARN
/AWS1/CRMCOLLABORATIONARN
¶
The unique ARN for the analysis template’s associated collaboration.
iv_creatoraccountid
TYPE /AWS1/CRMACCOUNTID
/AWS1/CRMACCOUNTID
¶
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
iv_name
TYPE /AWS1/CRMRESOURCEALIAS
/AWS1/CRMRESOURCEALIAS
¶
The name of the analysis template.
iv_createtime
TYPE /AWS1/CRMTIMESTAMP
/AWS1/CRMTIMESTAMP
¶
The time that the analysis template within a collaboration was created.
iv_updatetime
TYPE /AWS1/CRMTIMESTAMP
/AWS1/CRMTIMESTAMP
¶
The time that the analysis template in the collaboration was last updated.
io_schema
TYPE REF TO /AWS1/CL_CRMANALYSISSCHEMA
/AWS1/CL_CRMANALYSISSCHEMA
¶
The entire schema object.
iv_format
TYPE /AWS1/CRMANALYSISFORMAT
/AWS1/CRMANALYSISFORMAT
¶
The format of the analysis template in the collaboration.
Optional arguments:¶
iv_description
TYPE /AWS1/CRMRESOURCEDESCRIPTION
/AWS1/CRMRESOURCEDESCRIPTION
¶
The description of the analysis template.
io_source
TYPE REF TO /AWS1/CL_CRMANALYSISSOURCE
/AWS1/CL_CRMANALYSISSOURCE
¶
The source of the analysis template within a collaboration.
io_sourcemetadata
TYPE REF TO /AWS1/CL_CRMANALYSISSOURCEMET
/AWS1/CL_CRMANALYSISSOURCEMET
¶
The source metadata for the collaboration analysis template.
it_analysisparameters
TYPE /AWS1/CL_CRMANALYSISPARAMETER=>TT_ANALYSISPARAMETERLIST
TT_ANALYSISPARAMETERLIST
¶
The analysis parameters that have been specified in the analysis template.
it_validations
TYPE /AWS1/CL_CRMALYTMPLVALIDATIO00=>TT_ALYTMPLVALIDATIONSTATDETLST
TT_ALYTMPLVALIDATIONSTATDETLST
¶
The validations that were performed.
io_errormessageconfiguration
TYPE REF TO /AWS1/CL_CRMERRORMESSAGECONF
/AWS1/CL_CRMERRORMESSAGECONF
¶
The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to
DETAILED
, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.
Queryable Attributes¶
id¶
The identifier of the analysis template.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
arn¶
The Amazon Resource Name (ARN) of the analysis template.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
collaborationId¶
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
Accessible with the following methods¶
Method | Description |
---|---|
GET_COLLABORATIONID() |
Getter for COLLABORATIONID, with configurable default |
ASK_COLLABORATIONID() |
Getter for COLLABORATIONID w/ exceptions if field has no val |
HAS_COLLABORATIONID() |
Determine if COLLABORATIONID has a value |
collaborationArn¶
The unique ARN for the analysis template’s associated collaboration.
Accessible with the following methods¶
Method | Description |
---|---|
GET_COLLABORATIONARN() |
Getter for COLLABORATIONARN, with configurable default |
ASK_COLLABORATIONARN() |
Getter for COLLABORATIONARN w/ exceptions if field has no va |
HAS_COLLABORATIONARN() |
Determine if COLLABORATIONARN has a value |
description¶
The description of the analysis template.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
creatorAccountId¶
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CREATORACCOUNTID() |
Getter for CREATORACCOUNTID, with configurable default |
ASK_CREATORACCOUNTID() |
Getter for CREATORACCOUNTID w/ exceptions if field has no va |
HAS_CREATORACCOUNTID() |
Determine if CREATORACCOUNTID has a value |
name¶
The name of the analysis template.
Accessible with the following methods¶
Method | Description |
---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
createTime¶
The time that the analysis template within a collaboration was created.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CREATETIME() |
Getter for CREATETIME, with configurable default |
ASK_CREATETIME() |
Getter for CREATETIME w/ exceptions if field has no value |
HAS_CREATETIME() |
Determine if CREATETIME has a value |
updateTime¶
The time that the analysis template in the collaboration was last updated.
Accessible with the following methods¶
Method | Description |
---|---|
GET_UPDATETIME() |
Getter for UPDATETIME, with configurable default |
ASK_UPDATETIME() |
Getter for UPDATETIME w/ exceptions if field has no value |
HAS_UPDATETIME() |
Determine if UPDATETIME has a value |
schema¶
The entire schema object.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SCHEMA() |
Getter for SCHEMA |
format¶
The format of the analysis template in the collaboration.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FORMAT() |
Getter for FORMAT, with configurable default |
ASK_FORMAT() |
Getter for FORMAT w/ exceptions if field has no value |
HAS_FORMAT() |
Determine if FORMAT has a value |
source¶
The source of the analysis template within a collaboration.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SOURCE() |
Getter for SOURCE |
sourceMetadata¶
The source metadata for the collaboration analysis template.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SOURCEMETADATA() |
Getter for SOURCEMETADATA |
analysisParameters¶
The analysis parameters that have been specified in the analysis template.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ANALYSISPARAMETERS() |
Getter for ANALYSISPARAMETERS, with configurable default |
ASK_ANALYSISPARAMETERS() |
Getter for ANALYSISPARAMETERS w/ exceptions if field has no |
HAS_ANALYSISPARAMETERS() |
Determine if ANALYSISPARAMETERS has a value |
validations¶
The validations that were performed.
Accessible with the following methods¶
Method | Description |
---|---|
GET_VALIDATIONS() |
Getter for VALIDATIONS, with configurable default |
ASK_VALIDATIONS() |
Getter for VALIDATIONS w/ exceptions if field has no value |
HAS_VALIDATIONS() |
Determine if VALIDATIONS has a value |
errorMessageConfiguration¶
The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to
DETAILED
, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ERRORMESSAGECONF() |
Getter for ERRORMESSAGECONFIGURATION |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_COLLABORATIONALYTMPLLIST
¶
TYPES TT_COLLABORATIONALYTMPLLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CRMCOLLABORATIONALY00 WITH DEFAULT KEY
.