d.herd-model-api.0.115.0.source-code.herd.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of herd-model-api Show documentation
Show all versions of herd-model-api Show documentation
This project contains the model API classes. This contains the herd XSD and generates Java POJO's from them. These classes are used for incoming
and outgoing calls into the system (e.g. via REST).
The information about the current build of the application
The OS in which the current build was built
The user ID of the user that performed the build
The date/time when the build was performed
The version number (from Maven POM) of the current build
A wrapper for the timeout validation response
A description explaining how long the endpoint waited.
Name of Storage Platform
Name of Storage
Name of Storage Platform (eg S3) associated with this Storage
Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom
user-defined meta-data about this storage
Values that uniquely identify a Storage
Name of Storage
There is nothing that is currently updated, but we will have something in the future
Custom user-defined metadata associated with this storage. "name" is the attribute name (i.e. the key) and "value" is the
attribute value
Name of Storage
Name of Storage Platform (eg S3) associated with this Storage
Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom
user-defined meta-data about this storage
The upload date in YYYY-MM-DD format
The total number of files uploaded to the storage on the date specified
The total number of bytes uploaded to the storage on the date specified
The upload date in YYYY-MM-DD format
The Namespace that Business Object Definition is associated with
The name of the Data Provider that Business Object Definition is associated with
The name of the Business Object Definition
The total number of files uploaded to the storage on the date specified
The total number of bytes uploaded to the storage on the date specified
The Namespace code
The Namespace code
Value that uniquely identifies a Namespace
The Namespace code
The user id
The list of namespace authorizations
The list of security roles
The list of security functions
The namespace authorization
The namespace
The list of namespace permissions
The namespace permission. Supported values are: READ, WRITE, EXECUTE, GRANT
The security role
The security function
The security role name
An optional description of this security role
An optional description of this security role
The security role name
An optional description of this security role
The list of security role keys
Value that uniquely identifies a security role
Values that uniquely identify a security role to function mapping
The internal Id that uniquely references a security role to function mapping
Values that uniquely identify a security role to function mapping
Values that uniquely identify a security role to function mapping
The security role name
The security function name
The user namespace authorization key
The list of namespace permissions
The list of namespace permissions
The user namespace authorization
A system unique ID of this user namespace authorization
The user namespace authorization key
The list of namespace permissions
The user id
The namespace
The data provider name
The data provider name
The list of data provider keys
Value that uniquely identifies a Data Provider
The tag type unique key
The tag type's name in plain text for human readability
The tag type's order relative to other tag types
An optional description of this tag type
The tag type's name in plain text for human readability
The tag type's order relative to other tag types
An optional description of this tag type
The tag type unique key
The tag type's name in plain text for human readability
The tag type's order relative to other tag types
The tag type's description
An ordered list of tag type keys
The tag type reference code
A wrapper for tag type search request. The request does not take any search keys or filters
There is nothing that is currently being posted, but we will have something in the future
A wrapper for tag type search response
An ordered list of tag types. The list is sorted alphabetically by tag type's order value ascending
A wrapper for tag type information
The tag's unique key
The tag's name in plain text for human readability
An optional tag's search score multiplier. Search score multiplier is numeric and can be a decimal
An optional description
An optional parent tag's unique key
The tag's name in plain text for human readability
An optional tag's search score multiplier. Search score multiplier is numeric and can be a decimal
An optional description
An optional parent tag's unique key
The internal identifier that uniquely references a Tag
The tag's unique key
The tag's name in plain text for human readability
An optional tag's search score multiplier. Search score multiplier is numeric and can be a decimal
The tag's description
The User ID of the user who created this tag
The User ID of the user who last updated this tag
The timestamp of when it is last updated
The parent tag's unique key
A boolean flag that shows whether this tag has further children
The tag's unique key
The parent tag's unique key
The list of children tags
An ordered list of children tags
The tag's unique key
A boolean flag that shows whether this tag has further children
The tag type reference code
The tag reference code
A wrapper for tag search request. The request accept only a single search filter and a single search key
A list of tag search filters. Only a single optional search filter is supported
A tag search filter
A list of tag search keys. Only a single search key is supported
A tag search key
The tag type reference code
An optional tag reference code of the parent tag
An optional boolean flag that specifies if parent tag should not be set for the tags that we want to retrieve
A wrapper for tag search response
An ordered list of tags. The list is sorted alphabetically by tag's display name ascending
A wrapper for tag information
The name of a valid Namespace known by the system
The name for this Business Object Definition
The name of a valid Data Provider known by the system
An optional description
An optional business friendly name
Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and
"value" is the attribute value
An optional description
An optional business friendly name
Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and
"value" is the attribute value
An optional description
An optional business friendly name for business object definition
An optional business object definition descriptive format update request
The internal identifier that uniquely references a Business Object Definition
The name of a valid Namespace known by the system
The name for this Business Object Definition
The name of a valid Data Provider known by the system
An optional description
An optional short-description. This is actually the 'description' field truncated to a configurable number of characters
An optional business friendly name
Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and
"value" is the attribute value
An optional business object definition descriptive format. The descriptive format is the single Business Object Format that
will be used to represent this Business Object Definition to consumers
An optional list of sample data files associated with the Business Object Definition
The User ID of the user who created this business object definition
The User ID of the user who last updated this business object definition
The timestamp when this business object definition was last updated on
A list of business object definition change events
Values that uniquely identify a Business Object Definition
The name of a valid Namespace known by the system
The name for this Business Object Definition
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format
The File type for this Business Object Format
The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version
+ 1
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format
The File type for this Business Object Definition
A sample data file associated with the Business Object Definition. The data in this file is expected to match the schema of the
descriptiveFormat for this Business Object Definition – but the data in this file is not validated against the descriptiveFormat schema at
this time
The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the
caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file
The name of the sample data file
A list of business object definition change events
Business friendly name
Description of the Business Object Definition
Business object definition descriptive format. The descriptive format is the single Business Object Format that
will be used to represent this Business Object Definition to consumers
The timestamp of when the business object definition update occured
The User ID of the user who performed business object definition update
A wrapper for business Object Definition search request. The request accept only a single search filter and a single search key
A list of business Object Definition search filters. Only a single search filter is supported
A business Object Definition search filter
An optional boolean flag that specifies if the search filter is an exclusion filter that excludes items from the search results
A list of business Object Definition search keys
A business Object Definition search key
Values that uniquely identify a Tag
An optional boolean flag that specifies if business object definition associated with entire tag hierarchy is to be retrieved
Values that identify a business object definition search response
The timestamp of when the index creation started
Values that uniquely identify a Business Object Definition Column
The name of the schema column
Description of the Business Object Definition Column
Description of the Business Object Definition Column
The internal Id that uniquely references a Business Object Definition Column
Values that uniquely identify a Business Object Definition Column
The name of the schema column
Description of the Business Object Definition Column
A list of business object definition column change events
Values that uniquely identify a Business Object Definition Column
The namespace of the Business Object Definition
The name of the Business Object Definition
The name of the Business Object Definition Column
A wrapper for a business object definition column search request. The request will accept only a single search filter and a single
search key
A business object definition column search filter
A list of business object definition column search keys. Only a single search key is supported
A business object definition column search key
The namespace to which a business object definition column is related
The name of the business object definition to which a business object definition column is related
A wrapper for business object definition column search response
An ordered list of business object definition columns. The list is sorted alphabetically by business object definition column
name ascending
A wrapper for business object definition column information
A business object definition column change event
Description of the Business Object Definition
The timestamp of when the business object definition column update occured
The User ID of the user who performed business object definition column update
Values that uniquely identify a Business Object Definition Tag
The internal Id that uniquely references a Business Object Definition Tag
Values that uniquely identify a Business Object Definition Tag
Values that uniquely identify a Business Object Definition Tag
Values that uniquely identify a Business Object Definition
Values that uniquely identify a Tag
Values that uniquely identify a Business Object Definition Subject Matter Expert
The internal Id that uniquely references a Business Object Definition Subject Matter Expert
Values that uniquely identify a Business Object Definition Subject Matter Expert
Values that uniquely identify a Business Object Definition Subject Matter Expert
The namespace of the Business Object Definition
The name of the Business Object Definition
The user id of the Subject Matter Expert
Values that uniquely identify a Subject Matter Expert
The contact details of the Subject Matter Expert
The user id of the Subject Matter Expert. This must be a fully qualified name as the value will be utilized to look up contact
information in LDAP
The full name of the Subject Matter Expert
The job title of the Subject Matter Expert
The e-mail address of the Subject Matter Expert
The telephone number of the Subject Matter Expert
The business object definition description suggestion key
The description suggestion
The description suggestion
A system unique ID of this business object definition description suggestion
The business object definition description suggestion key
The description suggestion
The status of the business object definition description suggestion. One of the following values: PENDING, ACCEPTED
The User ID of the user who created this business object definition description suggestion
The timestamp when this business object definition description suggestion was created on
The business object definition description suggestion key
The namespace
The name of the Business Object Definition to which this description suggestion is related
The user id
A wrapper for a business object definition description suggestion search request. The request will accept only a single search
filter and a single search key
A business object definition description suggestion search filter
A list of business object definition description suggestion search keys. Only a single search key is supported
A business object definition description suggestion search key
The namespace to which a business object definition description suggestion is related
The name of the business object definition to which a business object definition description suggestion is related
The status code of the business object definition description suggestion
A wrapper for business object definition description suggestion search response
An list of business object definition description suggestions
A wrapper for business object definition description suggestion information
The business object definition description suggestion key
The file type code
The file type code
Value that uniquely identifies a File Type
The File Type code
Value that uniquely identifies a Partition Key Group
Value that uniquely identifies a Partition Key Group
Value that uniquely identifies a Partition Key Group
The name of the Partition Key Group
Value that uniquely identifies a Partition Key Group
List of Expected Partition Values
Value that uniquely identifies an Expected Partition Value
Value that uniquely identifies a Partition Key Group
List of Expected Partition Values
Value that uniquely identifies a Partition Key Group
List of Expected Partition Values
The name of the Partition Key Group associated with the Expected Partition Value
The Expected Partition Value
The Expected Partition Value
The Namespace to which this Business Object Format is related
The name of the Business Object Definition to which this Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under this Business Object Format
The partition key for this Business Object Format
Description of the Business Object Format
The schema for document-style business object data registered with Herd.
The schema allows the publisher to perform self-service validation of incoming data when registering business object data. It also allows
the consumers to perform self-service downstream actions like hydrating objects when consuming business object data. The documentSchema is
optional. Currently any documentSchema is accepted. Its content is not validated
An optional URL of the documentSchema to an externally hosted XSD or JSON. Herd will not access this URL,
it will simply store and retrieve the URL
Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and
"value" is the attribute value
List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified
when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can
still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with
registered data for use by consumers of the data
The schema associated with this Business Object Format
Values that uniquely identify a Business Object Data without version
Values that uniquely identify a Business Object Data without version
Values that uniquely identify a Business Object Format to External Interface mapping. Please note that reference to a Business
Object Format is version-less
Description of the Business Object Format
The schema for document-style business object data registered with Herd. The schema allows the publisher to perform
self-service validation of incoming data when registering business object data. It also allows the consumers to perform self-service
downstream actions like hydrating objects when consuming business object data. The documentSchema is optional. Currently any documentSchema is
accepted. Its content is not validated
An optional URL of the documentSchema to an externally hosted XSD or JSON. Herd will not access this URL,
it will simply store and retrieve the URL and teams can then access the URL
Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and
"value" is the attribute value
The schema associated with this Business Object Format
A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for
data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.
Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and
"value" is the attribute value
A list of attribute definitions that specify attributes which are required to be specified when registering Business Object
Data against this format. Providing a list with no elements will remove all existing attributes for the business object format
Indicates if business object data registered with this format is a record
Retention period (in days) for business object data registered with this format. This value must only be specified for
PARTITION_VALUE retention type
Retention type. Supported retention types are: PARTITION_VALUE, BDATA_RETENTION_DATE
If true, allows non backwards compatible changes to the schema
The internal identifier that uniquely identifies a Business Object Format
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version
+ 1
A Y/N flag that shows whether this instance of format is the latest or not. Once a new version of format is registered, any
previous versions will no longer be the latest
The partition key for this Business Object Format
Description of the Business Object Format
The schema for document-style business object data registered with Herd
An optional URL of the documentSchema to an externally hosted XSD or JSON. Herd will not access this URL,
it will simply store and retrieve the URL and teams can then access the URL
Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and
"value" is the attribute value.
List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified
when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can
still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with
registered data for use by consumers of the data
The schema associated with this Business Object Format
A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for
data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.
A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists
of the key data that uniquely defines a reference to a single Business Object Data.
A list of business object format to external interface mappings
Indicates if business object data registered with this format is a record
Retention period (in days) for business object data registered with this format.
Retention type. Supported retention types: PARTITION_VALUE, BDATA_RETENTION_TYPE.
If true, allows non backwards compatible changes to the schema
A single metadata attribute definition. For now, only the attribute "name" can be specified which implies the attribute is
required. In the future, we may expand how this element is used to support specification of details such as data type, min/max, etc.
Name of an Attribute that will be required when registering a Business Object Data of this Business Object Format
If true, this business object data attribute will be published in notification messages
If true, this business object data attribute will be published in notification message headers and can be used to filter
messages
A container for Schema Columns that are present in data file(s) for this Business Object Format. Required when Schema is
present
A container for partition columns in a specific schema. A schema might have zero, one or more partition columns. If a partition
column is present in the data file(s), it should also be listed as a regular column in the schema with all column information matching (case
sensitive)
The string to use for the null value (e.g. "\\\\N"). Please note that a null value is allowed to be a whitespace character.
XML escaping should be used when specifying non-ASCII characters.
Note: when passing in an empty String, the response XML will return a NULL value (i.e. the tag will be absent). Generate DDL calls will show
the correct empty String value wrapped in single-quotes.
Required when Schema is present
The field delimiter (e.g. "|"). Please note that a field delimiter is allowed to be a whitespace character.
XML escaping should be used when specifying non-ASCII characters
The collection items delimiter (e.g. ","). XML escaping should be used when specifying non-ASCII characters
The map keys delimiter (e.g. "="). XML escaping should be used when specifying non-ASCII characters
The escape character (e.g. "\\\\").
XML escaping should be used when specifying non-ASCII characters.
The customRowFormat is used for defining custom Hive format.
This will override everything after "ROW FORMAT" in DDL including delimiter, escape value, null value statements.
The partition key group that this schema's partition or sub-partition key belongs to. This value will be used to identify the
ordered set of Expected Partition Values when determining Business Object Data Availability or generating DDL using partition value ranges. A
Partition Key Group value is required in the Business Object Format in order to use partition value ranges with the Availability and DDL
services
A container for the Schema Column information. Required when Columns is present
The name of the schema column. Required when Column is present
The data type of the schema column. Required when Column is present
The column size. This is a string value since, for "NUMERIC" and "DECIMAL" data types, we should be able to specify both
the maximum number of digits (p) that are present in the number and the maximum number of decimal places (s) as a "p,s" string. Required when
Column is present
Values true|false. If true, a value isis required for the column (not nullable)
Default value for the column
Description of the column
Values that uniquely identify a Business Object Format
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version
+ 1
Values that uniquely identify a Custom DDL
A container for the custom DDL code
The internal Id that uniquely references the newly created custom DDL
Values that uniquely identify a Custom DDL
A container for the custom DDL code
A container for the custom DDL code
Values that uniquely identify a Custom DDL
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The numeric version of a Business Object Format
A user-defined descriptive name for this Custom DDL
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The numeric version of a Business Object Format. If not supplied, the latest version will be used
The output format for the generated DDL. The only format currently supported is HIVE_13_DDL
The table name to be used in the generated DDL
The name of the Custom DDL. When Custom DDL name is specified, the Custom DDL which had previously been stored Business Object
Format is returned instead of generated DDL. Must not be specified when replaceColumns is true
If true, drop table statement for existing table will be added to the generated DDL. Must not be specified when replaceColumns
is true.
If true, IF NOT EXISTS option will be added to the CREATE TABLE ... statement in the generrated DDL. Please note that this
parameter value has no effect on the relative CREATE TABLE ... statement, if generated DDL uses custom DDL. Must not be specified when
replaceColumns is true.
If true, an ALTER TABLE ... REPLACE COLUMNS will be generated
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The numeric version of a Business Object Format. If not supplied, the latest version will be used
The output format for the generated DDL. The only format currently supported is HIVE_13_DDL
The table name to be used in the generated DDL
he name of the Custom DDL. When Custom DDL name is specified, the Custom DDL which had previously been stored Business Object
Format is returned instead of generated DDL. Must not be specified when replaceColumns is true
A container for the generated DDL code which contains DDL for all the objects in the collection
A container for multiple Business Object Format requests
A container for the Business Object Format responses
A container for the combined DDL for all Business Object Formats in the collection
A container for the DDL for a single Business Object Format
The S3 key prefix to use when writing or accessing the data. Note that the S3 key prefix will not contain a trailing
"directory" separator and it will be up to the caller to append one as needed
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The Business Object Format Version for a previously registered Business Object Format
The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business
Object Format
The Partition Value that this Business Object Data is associated with
A list of Sub-Partition values associated with this Business Object Data
The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID,
ARCHIVED, EXPIRED, or DELETED. Pre-registration status include UPLOADING, PENDING_VALID, and PROCESSING. Defaults to VALID if value is not
provided
A container for Storage Units that contain data associated with the Business Object Data being registered
Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom
user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the
Business Object Format
An optional list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This
is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.
If true, a new Business Object Data Version will be created and registered that supercedes a previous version. If false, then
only an initial Business Object Data Version (version 0) is allowed to be registered
The Partition Value for a Sub-Partition that appears in the Business Object Format. Supply in the order that the Sub-Partition
keys are listed in the Business Object Format
A container of Storage Directory and/or various Storage Files that constitute the data for this object and reside within a
specific Storage. Required when storageUnits is present
The name of the Storage that this Storage Unit is associated with. The Storage must be pre-existing in the system. Required
when storageUnit is present
A container for a Storage Directory that resides within a specific Storage Unit. Required when storageUnit is present and one
of the following is true: storageFiles element is not present, discoverStorageFiles is enabled
A container of various Storage Files that reside within a specific Storage Unit. Required when storageUnit is present and
storageDirectory is not. Note: storageFiles cannot be specified when discoverStorageFiles is enabled.
If true, enables the auto-discovery of all Storage Files in the specified Storage Directory. See notes on S3 consistency for
important information
An optional list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This
is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.
The retention expiration date for this business object data in YYYY-MM-DD format
The business object data
The internal Id that uniquely references the newly created Business Object Data
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The Business Object Format Version for a previously registered Business Object Format
The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business
Object Format
The Partition Value that this Business Object Data is associated with
A list of Sub-Partition values associated with this Business Object Data
The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous
version + 1
*No longer in use* A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is
registered, any previous versions will no longer be the latest
The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID,
ARCHIVED, EXPIRED, or DELETED
A container for the Storage Units associated with a Business Object Data
Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom
user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the
Business Object Format
A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for
data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.
A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists
of the key data that uniquely defines a reference to a single Business Object Data.
Lists all business object data status change events for this business object data
The retention expiration date for this business object data
A container of Storage Directory and/or various Storage Files that constitute the data for this object and reside within a
specific Storage.
The Storage for this Storage Unit
A container for a Storage Directory that resides within a specific Storage Unit
A container of various Storage Files that reside within a specific Storage Unit
The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING
Lists all storage unit status change events for this storage unit
The number of failed attempts to execute a storage policy transition such as archiving to Glacier
The restore expiration time if restored
The fully qualified storage directory path
A container for Storage File information
The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the
Storage Directory path
The file size in bytes
The number of lines in the file
The status of the Storage Unit
The timestamp of when the storage unit status change occurred
The User ID of the user who performed status update or registration of the Storage Unit
An individual piece of metadata associated with the business object data. This can be used to store things such as S3 bucket
names, validation flags, and custom user-defined meta-data about this storage.
Attribute key
Attribute value
Values that uniquely identify a Business Object Data
Values that uniquely identify a Business Object Data
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The Business Object Format Version for a previously registered Business Object Format
The Partition Value that this Business Object Data is associated with
A list of Sub-Partition values this Business Object Data is associated with
The numeric version of a Business Object Data
Values that uniquely identify a Business Object Data
A particular version of business object data that is identified by a business object data key
Values that uniquely identify a Business Object Data
The status of the Business Object Data
The status of the Business Object Data
The timestamp of when the business object data status change occurred
The User ID of the user who performed status update or registration of the Business Object Data
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version
+ 1
A container for Partition Value Filters
A wrapper for the registration date range to check the availability between two dates or start from or end with. The request
must contain either only start registration date or only end registration date or both start and end dates. If only start registration date is
provided, all business object data registered on and after that date will be fetched. If only end registratoin date is provided, all business
object data registered on or before that date will be fetched. And if both start and end registration dates are provided, all business object
data registered in the range will be fetched
A container for Attribute Value Filters
The business object is the latest valid version
The filter for expired business object data with its business object format retention type as PARTITION_VALUE and the business
object data partition value plus the retentionPeriodInDays specified in the business object format expired. Retention information specified
in business object format is version less
Values that identify a Business Object Search Keys
Values that identify a Business Object Data Search Key
Values that identify a Business Object Search Filter
Values that identify a Business Object Search Result
Values that uniquely identify a Business Object Data
The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED
The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED
Values that uniquely identify a Business Object Data
The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED
The status of the Business Object Data prior to the update
Values that uniquely identify a Business Object Data Attribute
The value of the Business Object Data Attribute
The internal Id that uniquely references a Business Object Data Attribute
Values that uniquely identify a Business Object Data Attribute
The value of the Business Object Data Attribute
The value of the Business Object Data Attribute
Custom user-defined metadata associated with this Business Object Data. "name" is the attribute name (i.e. the key) and
"value" is the attribute value
Values that uniquely identify a Business Object Data Attribute
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The Business Object Format Version for a previously registered Business Object Format
The Partition Value that a Business Object Data is associated with
A list of Sub-Partition values associated with a Business Object Data
The numeric version of a Business Object Data
The name of a Business Object Data Attribute
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The Business Object Format Version for a previously registered Business Object Format
A container for Partition Value Filters
A container for the Partition Values to check for availability. The request must contain either a single partition value filter
or up to 5 partition value filters when passed inside partitionValueFilters container. Only the Partition that is listed in the Business
Object Format for this Business Object Data can be specified in a Partition Value Filter
The numeric version of a Business Object Data
A container for Storage Names to include when checking for Business Object Data availability
Name of an existing storage known to the System. Required when StorageName is present
Specifies to perform an exhaustive search to return availability for ALL registered sub-partitions (registered as individual
business object data instances) except for the ones with "DELETED" status. This parameter has no impact when business object data version is
specified. Default value is false, which means that availability ignores any "not available" registered sub-partitions when it finds at least
one "VALID" registered sub-partitions for a requested business object data partition value
A container for the Partition Values to check for availability. The request must contain either a single partition value filter
or up to 5 partition value filters when passed inside partitionValueFilters container. Only the Partition that is listed in the Business
Object Format for this Business Object Data can be specified in a Partition Value Filter
The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required
when partitionValueFilters is present
This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or
latestAfterPartitionValue is not present
A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to
use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to
identify the ordered set of Expected Partition Values. For more information please see *** LINK Business Object Format Post and *** LINK
Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues,
latestBeforePartitionValue, or latestAfterPartitionValue is not present
This specifies that the availability request should return the latest Partition Value available before the specified Partition
Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data
Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required
when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present
This specifies that the availability request should return the latest Partition Value available after the specified Partition
Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data
Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required
when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present
The partition value that the Business Object Data is associated with. Please note that this service supports special token for
minimum and maximum partition values - please see *** NEED LINK Partition Value Tokens subsection below
The start partition value for the partition value range. Required when partitionValueRange is present
The end partition value for the partition value range. Required when partitionValueRange is present
The partition value that is an inclusive upper bound for the latest available partition value. Required when
latestBeforePartitionValue is present
The partition value that is an inclusive lower bound for the latest available partition value. Required when
latestAfterPartitionValue is present
The start date for the registration date range in YYYY-MM-DD format
The end date for the registration date range in YYYY-MM-DD format
Name of an existing storage known to the System
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The Business Object Format Version for a previously registered Business Object Format
A container for Partition Value Filters
A container for the Partition Values to check for availability. The request must contain either a single partition value filter
or up to 5 partition value filters when passed inside partitionValueFilters container. Only the Partition that is listed in the Business
Object Format for this Business Object Data can be specified in a Partition Value Filter
The numeric version of a Business Object Data
A container for Storage Names to include when checking for Business Object Data availability
Name of an existing storage known to the System. Required when StorageName is present
A container for the Business Object Data in this query that are considered available
A container for the Business Object Data in this query that are not considered available
A container for the Business Object Data Status information
The Business Object Format Version for a previously registered Business Object Format
The partition value that the Business Object Data is associated with
A list of Sub-Partition values associated with a Business Object Data
The numeric version of a Business Object Data
A reason for the Business Object Data not being available (NOT_REGISTERED, INVALID, etc...)
A container for the Attribute Value Filter
The Attribute Name
The Attribute Value
A container for multiple availability requests
A container for the availability responses
Aggregate response indicating if all of the data covered in all requests in the collection is available
Aggregate response indicating if none of the data covered in any request in the collection is available
The Business Object Data Availability, see *** LINK for details
Specifies to perform an exhaustive search to return availability for ALL registered sub-partitions (registered as individual
business object data instances) except for the ones with "DELETED" status. This parameter has no impact when business object data version is
specified. Default value is false, which means that this endpoint ignores any "not available" registered sub-partitions when it finds at least
one "VALID" registered sub-partition for a requested business object data partition value.
If true, the call would fail with a "Not Found" (status code 404) error when it finds at least one "not available" (except for "DELETED")
registered sub-partition for a requested business object data partition value
Specifies to suppress scanning of registered storage files to discover sub-partitions and instead of that relies on business
object data registration information to extract primary and sub-partition (if any) values required to identify Hive table partitions. Default
value is false. If true, the call would fail with a "Bad Request" (status code 400) error when number of partitions in any of the discovered
business object data instances does not match to the number of partition columns in the business object format being used to generate the DDL
or retrieve business object partitions
Specifies to add multiple partitions in a single ALTER TABLE statement. If includeDropPartitions is set to true, this flag also
specifies to drop multiple partitions in a single ALTER TABLE statement
Specifies the date and time when the business object status was effective at that time, (ex 2015-12-30T11:08:40).
The feature of 'asOfTime' looks for business object data SOLELY based on business object data status history,
and it does NOT look for storage file status history for the business object selected
Specifies to perform an exhaustive search to return availability for ALL registered sub-partitions (registered as individual
business object data instances) except for the ones with "DELETED" status. This parameter has no impact when business object data version is
specified. Default value is false, which means that this endpoint ignores any "not available" registered sub-partitions when it finds at least
one "VALID" registered sub-partition for a requested business object data partition value.
If true, the call would fail with a "Not Found" (status code 404) error when it finds at least one "not available" (except for "DELETED")
registered sub-partition for a requested business object data partition value
Specifies to suppress scanning of registered storage files to discover sub-partitions and instead of that relies on business
object data registration information to extract primary and sub-partition (if any) values required to identify Hive table partitions. Default
value is false. If true, the call would fail with a "Bad Request" (status code 400) error when number of partitions in any of the discovered
business object data instances does not match to the number of partition columns in the business object format being used to generate the DDL
A wrapper for partition information including: partition columns, partitionLocation
A container for partition columns list
A wrapper of partition column name and partition column value
A partition column name of the business object format
The partition column value that the business object data is associated with
The request to create a business object data notification registration
A unique identifier for a business object data notification registration
The type of business object data event in which this notification should trigger
The filter to use against business object data events. The notification will only trigger for events matching this filter.
The list of jobs to execute when this notification is triggered
The status of the notification registration
The request to update a business object data notification registration
The type of business object data event in which this notification should trigger
The filter to use against business object data events. The notification will only trigger for events matching this filter.
The list of jobs to execute when this notification is triggered
The status of the notification registration
A notification registration for business object data events
A system unique ID of this registration
A unique identifier for a business object data notification registration
The type of business object data event in which this notification should trigger
The filter to use against business object data events
The list of jobs to execute when this notification is triggered
The status of the notification registration
The request to update a notification registration status
The status of the notification registration
The response to update a notification registration status
A unique identifier for a notification registration
The status of the notification registration
The unique key to a notification registration
The filter of business object data notification registration
The namespace of the business object definition
The business object definition name
The business object format usage
The business object format file type
The business object format version
The storage name
The new business object data status
The old business object data status
A notification action which executes an Activiti job when triggered
The namespace
The job name
The correlation data
The request to create a storage unit notification registration
A unique identifier for a storage unit notification registration
The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG
The filter to use against storage unit events. The notification will only trigger for events matching this filter
The list of jobs to execute when this notification is triggered
The status of the notification registration. One of the following values: ENABLED or DISABLED. Default value is ENABLED
The request to update a storage unit notification registration
The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG
The filter to use against storage unit events. The notification will only trigger for events matching this filter
The list of jobs to execute when this notification is triggered
The status of the notification registration. One of the following values: ENABLED or DISABLED
A notification registration for storage unit events
A system unique ID of this registration
A unique identifier for a storage unit notification registration
The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG
The filter to use against storage unit events. The notification will only trigger for events matching this filter
The list of jobs to execute when this notification is triggered
The status of the notification registration. One of the following values: ENABLED or DISABLED
The filter of storage unit notification registration
The namespace of the business object definition
The business object definition name
The business object format usage
The business object format file type
The business object format version
The storage name
The new storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING
The old storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING
The source business object format key
The target business object format key
The business object data attributes
The file to upload
The target storage name to move the encrypted file to
The source business object format key
The target business object format key
The file to upload
The UUID generated for this upload
The AWS access key that must be used to upload to this object in S3
The AWS secret key that must be used to upload to this object in S3
The AWS session token that must be used to upload to this object in S3
The timestamp of when the provided AWS credentials will expire
The KMS key ID that must be used to do SSE
The target storage name
The namespace of the business object definition
The business object definition name
The directory path of the sample data file. Note
that directory path will contain a trailing "directory" separator,
thus the caller needs to concatenate the directory path and the
file name as is in order to construct a fully qualified path for
the sample data file
The name of the sample data file
The namespace of the business object definition
The business object definition name
The format usage of the business object data
The format file type of the business object data
The format version of the business object data
The the primary partition value of the business object data
The subpartition values of the business object data
The version of the business object data
The name of the storage
The fully qualified file path to the data
The name of a valid namespace known by the system
The name of the job definition
An optional description of the job definition
Activiti workflow XML related to the job. Id should be named as "{applicationName}.{jobName}". Activiti XML can not contain a
CDATA section
Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by
parameters
specified during the job execution
The location to the Java properties file in S3
An optional description of the job definition
Activiti workflow XML related to the job. Id should be named as "{applicationName}.{jobName}". Activiti XML can not contain a
CDATA section
Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by
parameters
specified during the job execution
The location to the Java properties file in S3
The internal identifier that uniquely references a job definition
The namespace of the job definition
The name of the job definition
Description of the job definition
Activiti workflow XML related to the job
Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by
parameters
specified during the job execution
The location to the Java properties file in S3
The user ID under whose authorization context the workflow runs
The namespace of the job
The name of the job
List of key/value pairs that will be made available to the job when it is executed. These parameters will override any
parameters defined as
part of the job definition
The location to the Java properties file in S3
The action to take for the job. One of the following values: SUSPEND, RESUME
The internal identifier that uniquely references a job
The status of the job. One of the following values: RUNNING, SUSPENDED, COMPLETED
The namespace of the job
The name of the job
The start time of the job
The end time of the job. It is not returned for a job in RUNNING state
The step where the workflow currently is. It is returned for a job in RUNNING state
The steps that have been completed. For a job in RUNNING state, steps up to the last Async task will be returned. For a job in
COMPLETED state, all executed steps will be returned
Current workflow variables and values
Activiti workflow XML related to the job
The workflow errors
A reason this job has been deleted. It is returned if the job has been deleted
An individual parameter (a key/value pair)
Name of the parameter
Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being
logged into the
application logs
An individual step of the job
The internal identifier that uniquely references a step
The name of the step
The start time of the step
The end time of the step
An individual workflow error
Error message
Number of retries left
The error stack trace
An individual job summary
The job id that uniquely identifies the previously submitted job
The namespace of the job
The name of the job
The start time of the job
The end time of the job. It is not returned for a job in RUNNING state
The status of the job. One of the following values: RUNNING, COMPLETED
The number of exceptions
The job id that uniquely identifies the previously submitted job
The task Id of the receive task in the job workflow to signal. The job must be waiting on this task at the time of this call
List of key/value pairs that will be made available to the job
The location to the Java properties file in S3
Values that uniquely identify an EMR Cluster Definition
The namespace of the EMR cluster definition
The name of the EMR cluster definition
The name of the Amazon EC2 key pair to set as the connection credential
<p>A comma separated list of Amazon VPC subnets.</p>
<ul>
<li>When multiple subnets are specified, the subnet in the AZ with the best price will be used.</li>
<li>When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.</li>
</ul>
<p>Cross-VPC access in PROD will only accept internal/emr subnets at this time.</p>
Amazon S3 bucket to receive log files
Launch a cluster that continues running even after completing all its steps
Makes the instances in an existing cluster visible to all IAM users
Launch the cluster with termination protection enabled
Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than
3.1.0
The AWS account number, without dashes, to launch the Amazon EMR service in
Launches the Amazon EMR service with the specified IAM role
Launches the EC2 instances of a cluster with the specified IAM role
Specify the version of the AMI to use
The release label. Available from 4.x
Specify the version of Hadoop to install
The Hive version to load
The Pig version to load
Bootstrapping scripts that are executed only on the Master node
Bootstrapping scripts that are executed on all the nodes
Specifies additional information during cluster creation
Instance Group Definitions
Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration. The instance
fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions
Custom tags to be applied on the EC2 nodes
Installs third-party software on an Amazon EMR cluster
List of applications
List of configurations
Predefined bootstrap action to configure hadoop daemons
Predefined bootstrap action to specify hadoop configurations
Hadoop jar steps that are added, to be executed once the cluster is started
List of additional master node security groups. The security group defined by the configuration value
emr.herd.support.security.group will automatically be added whether this list is specified or not
List of additional slave node security groups
The name of a security configuration to apply to the cluster
The master security group to use instead of the account default value
The slave security group to use instead of the account default value
The service access security group to use
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized. One of the following values: TERMINATE_AT_INSTANCE_HOUR or TERMINATE_AT_TASK_COMPLETION
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration
Master node security group
Slave node security group
A configuration
The configuration classification
List of configurations
List of properties
A property
An application
Application name
Application version
List of arguments
List of additional info
An argument
An additional info
The EBS configurations that will be attached to each EC2 instance in the instance group
The instance bid price, in USD. If not specified, uses on-demand
The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this
value. If a spot instance is selected by the search, this value will be the bid price
<p>The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to
dynamically balance the cost vs. stability of your instances.</p>
<p>If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when
this parameter is set to $0.</p>
The EBS configurations that will be attached to each EC2 instance in the instance group
The instance bid price, in USD. If not specified, uses on-demand
The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this
value. If a spot instance is selected by the search, this value will be the bid price
<p>The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to
dynamically balance the cost vs. stability of your instances.</p>
<p>If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when
this parameter is set to $0.</p>
The configuration that defines an instance fleet
The configuration that defines an instance fleet
The friendly name of the instance fleet
The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When
the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration
has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity.
Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are
2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is
provisioned, and the target capacity is exceeded by 3 units.
NOTE: If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of
TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and
TargetOnDemandCapacity can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the
instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a
specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR
provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units
remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned,
and the target capacity is exceeded by 3 units.
NOTE: If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and
TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be
specified, and its value must be 1.
The instance type configurations that define the EC2 instances in the instance fleet
The launch specification for the instance fleet
The unique identifier of the instance fleet
The friendly name of the instance fleet
The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When
the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration
has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity.
Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are
2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is
provisioned, and the target capacity is exceeded by 3 units.
NOTE: If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of
TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and
TargetOnDemandCapacity can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the
instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a
specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR
provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units
remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned,
and the target capacity is exceeded by 3 units.
NOTE: If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and
TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be
specified, and its value must be 1.
The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity.
The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity
The current status of the instance fleet
The instance type configurations that define the EC2 instances in the instance fleet
Describes the launch specification for an instance fleet
A code representing the instance fleet status
Provides status change reason details for the instance fleet.
Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs,
and the time of termination.
A code corresponding to the reason the state change occurred
An explanatory message
The time and date the instance fleet was created
The time and date the instance fleet terminated
The time and date the instance fleet was ready to run jobs
The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout
behavior
The spot provisioning timeout period in minutes
The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired
The defined duration for Spot instances (also known as Spot blocks) in minutes
The specification for the instance types that comprise an instance fleet
An EC2 instance type, such as 'm3.xlarge'.
The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in
InstanceFleetConfig
The bid price for each EC2 Spot instance type as defined by InstanceType.
The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType
Evaluates to TRUE when the specified InstanceType is EBS-optimized
The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType
A configuration classification that applies when provisioning cluster instances, which can include configurations for
applications and software bundled with Amazon EMR
Configuration of requested EBS block device associated with the instance group
Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to
every instance
The configuration classification
List of configurations
List of properties
A property
EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an
EC2 instance in the cluster
The device name that is exposed to the instance, such as /dev/sdh.
Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
The volume type. Volume types supported are gp2, io1, standard
The number of I/O operations per second (IOPS) that the volume supports
The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value
is 10
An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR
attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet
An EC2 instance type, such as 'm3.xlarge'.
The number of units that a provisioned instance of this type provides toward fulfilling the target capacities
defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be greater than 0
for core and task instance fleets
The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor
BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%
The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number
between 0 and 1000 (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,
BidPriceAsPercentageOfOnDemandPrice defaults to 100%
The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType
A configuration classification that applies when provisioning cluster instances, which can include configurations for
applications and software that run on the cluster
An array of Amazon EBS volume specifications attached to a cluster instance
Indicates whether an Amazon EBS volume is EBS-optimized
Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to
every instance
EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an
EC2 instance in the cluster
Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
The volume type. Volume types supported are gp2, io1, standard
The number of I/O operations per second (IOPS) that the volume supports
The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value
is 10
The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout
behavior
The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the
TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster
is first created
The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired. Spot instances
are not uprovisioned within the Spot provisioining timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND to fulfill the
remaining capacity
The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not
terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240,
300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the
Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it
terminates
The Active Directory password for ADDomainJoinUser
Required only when establishing a cross-realm trust with an Active Directory domain
Required only when establishing a cross-realm trust with a KDC in a different realm
The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals,
password policies, and keytabs for the cluster
The name of the Kerberos realm to which all nodes in a cluster belong
The reason for the cluster status change
A timeline that represents the status of a cluster over the lifetime of the cluster
The AWS account number, without dashes, where Amazon EMR service is running in
Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration. The instance
fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions
The programmatic code for the state change reason
The descriptive message for the state change reason
The creation date and time of the cluster
The date and time when the cluster was ready to execute steps
The date and time when the cluster was terminated
The namespace of the business object data
The definition name of the business object data
The format usage of the business object data
The format file type of the business object data
The format version of the business object data
The the primary partition value of the business object data
The subpartition values of the business object data
The version of the business object data
The name of the storage
The list of storage files to be added. Storage files are required, unless discovery of storage files is enabled. In that case,
the storage
files are not allowed to be specified
If true, enables the auto-discovery of all storage files in the relative S3 storage under the relative storage directory
The namespace of the business object data
The definition name of the business object data
The format usage of the business object data
The format file type of the business object data
The format version of the business object data
The the primary partition value of the business object data
The subpartition values of the business object data
The version of the business object data
The name of the storage
The list of storage files
Values that uniquely identify a Business Object Data Storage Unit
A container for a Storage Directory that resides within a specific Storage Unit. Required when one
of the following is true: storageFiles element is not present, discoverStorageFiles is enabled
A container of various Storage Files that reside within a specific Storage Unit. Required when
storageDirectory is not present. Note: storageFiles cannot be specified when discoverStorageFiles is enabled
If true, enables the auto-discovery of all Storage Files in the specified Storage Directory
Values that uniquely identify a Business Object Data Storage Unit
A container for a Storage Directory that resides within a specific Storage Unit
A container of various Storage Files that reside within a specific Storage Unit
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object
Definitions
A File Type known to the system that describes the file type of data stored under a Business Object Format
The Business Object Format Version for a previously registered Business Object Format
The Partition Value that this Business Object Data is associated with
A list of Sub-Partition values this Business Object Data is associated with
The numeric version of a Business Object Data
The name of the storage
The status of the Business Object Data Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, ARCHIVED,
RESTORING, RESTORED, EXPIRING
Values that uniquely identify a Business Object Data Storage Unit
The status of the Business Object Data Storage Unit
The status of the Business Object Data Storage Unit prior to the update
The S3 bucket name
The S3 object key
The AWS session credential
The AWS KMS key ID that must be used to upload, if applicable
The AWS session credential
The AWS session credential
The AWS KMS key ID that must be used to upload, if applicable
The AWS session credential
The temporary AWS access key
The temporary AWS secret key
The temporary AWS session token
The temporary AWS credential expiration time
Wrapper for the storage policy unique identifiers
Wrapper for the storage policy rule
The storage policy filter to be used to select business object data
The storage policy transition
The status of the storage policy. Supported values are: ENABLED, DISABLED
Wrapper for the storage policy rule
The storage policy filter to be used to select business object data
The storage policy transition
The status of the storage policy. Supported values are: ENABLED, DISABLED
A system unique ID of this storage policy
Wrapper for the storage policy unique identifiers
Wrapper for the storage policy rule
The storage policy filter to be used to select business object data
The storage policy transition
The status of the storage policy
The namespace of the storage policy
The name of the storage policy
The storage policy rule type. Supported rule types are: DAYS_SINCE_BDATA_REGISTERED, DAYS_SINCE_BDATA_PRIMARY_PARTITION_VALUE
The storage policy rule value. This parameter is required
The namespace of the registered business object definition. It is required when businessObjectDefinitionName is present
The name of the registered business object definition. It is required when namespace is present
The business object format usage. The usage does not need to exist in the system. It is required when
businessObjectFormatFileType is present
The business object format file type. The file type must be known by the system. It is required when businessObjectFormatUsage
is present
The name of the storage that this storage policy applies to. The storage with this name must already exist. Currently, only S3
storage platform type is supported by the storage policies
The name of the transition type. Currently, only GLACIER transition type is supported by the storage policies
Wrapper for the storage policy unique identifiers
The namespace
The list of IAM roles the namespace is authorized to use
An IAM role
The name of the IAM role
A description of the IAM role
The namespace to give authorizations to
The list of IAM roles to authorize
The list of IAM roles to authorize
A wrapper for the values that uniquely identify a Search Index
An optional boolean flag that specifies if full-validation should be run on the index
A wrapper for the values that uniquely identify a Search Index
The timestamp of when the index validation started
A Y/N flag that shows whether the total number of business object definitions in the database is the same as the total number
in the index
A Y/N flag that shows whether the spot check that verifies a percentage of random business object definitions in the database
are the same as the indexed documents
A Y/N flag that shows whether the spot check that verifies the most recently modified business object definitions in the
database are the same as the indexed documents
The type of this Search Index. One of the following values: BUS_OBJCT_DFNTN, TAG
A wrapper for the values that uniquely identify a Search Index
A wrapper for the values that uniquely identify a Search Index
The type of this Search Index. One of the following values: BUS_OBJCT_DFNTN, TAG
The status of this Search Index. One of the following values: BUILDING, READY
A flag to indicate if the index is active or not. If the index is active it will be included in the search results.
A wrapper for the search index information retrieved from the index
The User ID of the user who created this Search Index
The timestamp when this Search Index was created on
The timestamp when this Search Index was last updated on
A wrapper for the values that uniquely identify a Search Index
The type of this Search Index. One of the following values: BUS_OBJCT_DFNTN, TAG
The status of this Search Index. One of the following values: BUILDING, READY
A flag to indicate if the index is active or not. If the index is active it will be included in the search results.
The User ID of the user who created this Search Index
The timestamp when this Search Index was created on
The timestamp when this Search Index was last updated on
The index creation date
The number of active documents in this index
The number of deleted documents in this index
The UUID of the index
The count of the index size from count query
The list of Search Index keys
A wrapper for the values that uniquely identify a Search Index
The name of this Search Index
A wrapper for an index search request. The request will accept only a single search term
The search term upon which to search
A list of index search filters. Multiple filters are supported which are AND-ed
A list of Facet Fields to be included with the response. Only Tag and ResultType facet information is supported
An optional boolean flag that specifies if highlighting should be enabled on the matched terms or not
An index search filter
An optional boolean flag that specifies if the search filter is an exclusion filter that excludes items from the search results
A list of index search keys. Multiple search keys are supported which are OR-ed
An index search key. Only one of tagKey or indexSearchResultKey is allowed
An optional tag key. Only one is allowed
An optional index search result type key. Only one is allowed
An optional boolean flag that specifies if business object definition associated with entire tag hierarchy is to be retrieved
The type of the index from which search results are fetched. One of the following values: BUS_OBJCT_DFNTN, TAG
The total number of index search results that matched the search term query
The top 200 index search results that matched the search term query
Values that identifies a list of facet information.
Search hit document
The type of the index from which search results are fetched. One of the following values: BUS_OBJCT_DFNTN, TAG
A wrapper for the values that uniquely identify a search index from which search results are fetched.
The index search result key container that holds the key for the search result type
The display name of the tag or business object definition
An optional short-description. This is actually the 'description' field truncated to a configurable number of characters
The tag's unique key
Values that uniquely identify a Business Object Definition
A wrapper for the highlighted fields content
A list of fields which matched and have highlighted content
A single field from the document which has a highlighted fragment
Name of the field which has highlighted content
A list of fragments which contain the highlighted content
Actual text fragments (partial) which contain the highlighted content
facet information
The Facet field information to be included with the response. Only Tag facet field is supported.
Display name of the facet
count of the facet
Type of the facet
unique identifier of the facet
list of facets
The security function name
The security function name
The list of security function keys
Value that uniquely identifies a Security Function
The internal Id that uniquely references a Global Attribute Definition
The global attribute definition unique key
The attribute value list
The global attribute definition level. Only BUS_OBJCT_FRMT is currently supported.
The global attribute definition name to be associated with the level.
The global attribute definition unique key
A wrapper for attribute value list information
Values that uniquely identify a Global Attribute Definition
Auto generated ID of the attributeValueList
A wrapper for attribute value list information
Namespace of the attribute value list
Names of the attribute value list
Values that uniquely identify a attribute value list
The attribute value list unique key
Value that uniquely identifies an attribute value list Key
List of Allowed Attribute Values
Value that uniquely identifies an attribute value list Key
List of Allowed Attribute Values
Value that uniquely identifies an attribute value list Key
List of Allowed Attribute Values
The Allowed Attribute Value
The Namespace to which a Business Object Format is related
The name of the Business Object Definition to which a Business Object Format is related
The display name of the business object definition
The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business
Object Format
The name of the data provider
The relational schema name. A schema name must match the actual schema name as it is stored in the relational database
The relational table name. A table name must match the actual table name as it is stored in the relational database
The name of the storage
Value that uniquely identifies an external interface
The external interface display name
The external interface description
Value that uniquely identifies an external interface
The external interface display name
The external interface description
The list of external interface keys
Value that uniquely identifies an external interface
The external interface display name
The external interface description
Values that uniquely identify a business object format to external interface mapping
The internal Id that uniquely references a business object format to external interface mapping
Values that uniquely identify a business object format to external interface mapping
The namespace
The business object definition name
The business object format usage
The business object format file type
The external interface name
Values that uniquely identify a business object format to external interface mapping
The external interface display name
The external interface description
The configuration entry key
The configuration entry key
The configuration entry value
The configuration entry value CLOB (character large object)