class EmrError(Exception):
"""
The base exception class for Emr exceptions.
:ivar msg: The descriptive message associated with the error.
"""
fmt = 'An unspecified error occurred'
def __init__(self, **kwargs):
msg = self.fmt.format(**kwargs)
Exception.__init__(self, msg)
self.kwargs = kwargs
class MissingParametersError(EmrError):
"""
One or more required parameters were not supplied.
:ivar object_name: The object that has missing parameters.
This can be an operation or a parameter (in the
case of inner params). The str() of this object
will be used so it doesn't need to implement anything
other than str().
:ivar missing: The names of the missing parameters.
"""
fmt = ('aws: error: The following required parameters are missing for '
'{object_name}: {missing}.')
class EmptyListError(EmrError):
"""
The provided list is empty.
:ivar param: The provided list parameter
"""
fmt = ('aws: error: The prameter {param} cannot be an empty list.')
class MissingRequiredInstanceGroupsError(EmrError):
"""
In create-cluster command, none of --instance-group,
--instance-count nor --instance-type were not supplied.
"""
fmt = ('aws: error: Must specify either --instance-groups or '
'--instance-type with --instance-count(optional) to '
'configure instance groups.')
class InstanceGroupsValidationError(EmrError):
"""
--instance-type and --instance-count are shortcut option
for --instance-groups and they cannot be specified
together with --instance-groups
"""
fmt = ('aws: error: You may not specify --instance-type '
'or --instance-count with --instance-groups, '
'because --instance-type and --instance-count are '
'shortcut options for --instance-groups.')
class InvalidAmiVersionError(EmrError):
"""
The supplied ami-version is invalid.
:ivar ami_version: The provided ami_version.
"""
fmt = ('aws: error: The supplied AMI version "{ami_version}" is invalid.'
' Please see AMI Versions Supported in Amazon EMR in '
'Amazon Elastic MapReduce Developer Guide: '
'http://docs.aws.amazon.com/ElasticMapReduce/'
'latest/DeveloperGuide/ami-versions-supported.html')
class MissingBooleanOptionsError(EmrError):
"""
Required boolean options are not supplied.
:ivar true_option
:ivar false_option
"""
fmt = ('aws: error: Must specify one of the following boolean options: '
'{true_option}|{false_option}.')
class UnknownStepTypeError(EmrError):
"""
The provided step type is not supported.
:ivar step_type: the step_type provided.
"""
fmt = ('aws: error: The step type {step_type} is not supported.')
class UnknownIamEndpointError(EmrError):
"""
The IAM endpoint is not known for the specified region.
:ivar region: The region specified.
"""
fmt = 'IAM endpoint not known for region: {region}.' +\
' Specify the iam-endpoint using the --iam-endpoint option.'
class ResolveServicePrincipalError(EmrError):
"""
The service principal could not be resolved from the region or the
endpoint.
"""
fmt = 'Could not resolve the service principal from' +\
' the region or the endpoint.'
class LogUriError(EmrError):
"""
The LogUri is not specified and debugging is enabled for the cluster.
"""
fmt = ('aws: error: LogUri not specified. You must specify a logUri '
'if you enable debugging when creating a cluster.')
class MasterDNSNotAvailableError(EmrError):
"""
Cannot get dns of master node on the cluster.
"""
fmt = 'Cannot get DNS of master node on the cluster. '\
' Please try again after some time.'
class WrongPuttyKeyError(EmrError):
"""
A wrong key has been used with a compatible program.
"""
fmt = 'Key file file format is incorrect. Putty expects a ppk file. '\
'Please refer to documentation at http://docs.aws.amazon.com/'\
'ElasticMapReduce/latest/DeveloperGuide/EMR_SetUp_SSH.html. '
class SSHNotFoundError(EmrError):
"""
SSH or Putty not available.
"""
fmt = 'SSH or Putty not available. Please refer to the documentation '\
'at http://docs.aws.amazon.com/ElasticMapReduce/latest/'\
'DeveloperGuide/EMR_SetUp_SSH.html.'
class SCPNotFoundError(EmrError):
"""
SCP or Pscp not available.
"""
fmt = 'SCP or Pscp not available. Please refer to the documentation '\
'at http://docs.aws.amazon.com/ElasticMapReduce/latest/'\
'DeveloperGuide/EMR_SetUp_SSH.html. '
class SubnetAndAzValidationError(EmrError):
"""
SubnetId and AvailabilityZone are mutual exclusive in --ec2-attributes.
"""
fmt = ('aws: error: You may not specify both a SubnetId and an Availabili'
'tyZone (placement) because ec2SubnetId implies a placement.')
class RequiredOptionsError(EmrError):
"""
Either of option1 or option2 is required.
"""
fmt = ('aws: error: Either {option1} or {option2} is required.')
class MutualExclusiveOptionError(EmrError):
"""
The provided option1 and option2 are mutually exclusive.
:ivar option1
:ivar option2
:ivar message (optional)
"""
def __init__(self, **kwargs):
msg = ('aws: error: You cannot specify both ' +
kwargs.get('option1', '') + ' and ' +
kwargs.get('option2', '') + ' options together.' +
kwargs.get('message', ''))
Exception.__init__(self, msg)
class MissingApplicationsError(EmrError):
"""
The application required for a step is not installed when creating a
cluster.
:ivar applications
"""
def __init__(self, **kwargs):
msg = ('aws: error: Some of the steps require the following'
' applications to be installed: ' +
', '.join(kwargs['applications']) + '. Please install the'
' applications using --applications.')
Exception.__init__(self, msg)
class ClusterTerminatedError(EmrError):
"""
The cluster is terminating or has already terminated.
"""
fmt = 'aws: error: Cluster terminating or already terminated.'
class ClusterStatesFilterValidationError(EmrError):
"""
In the list-clusters command, customers can specify only one
of the following states filters:
--cluster-states, --active, --terminated, --failed
"""
fmt = ('aws: error: You can specify only one of the cluster state '
'filters: --cluster-states, --active, --terminated, --failed.')
class MissingClusterAttributesError(EmrError):
"""
In the modify-cluster-attributes command, customers need to provide
at least one of the following cluster attributes: --visible-to-all-users,
--no-visible-to-all-users, --termination-protected, --no-termination-protected,
--auto-terminate and --no-auto-terminate
"""
fmt = ('aws: error: Must specify one of the following boolean options: '
'--visible-to-all-users|--no-visible-to-all-users, '
'--termination-protected|--no-termination-protected, '
'--auto-terminate|--no-auto-terminate, '
'--unhealthy-node-replacement|--no-unhealthy-node-replacement.')
class InvalidEmrFsArgumentsError(EmrError):
"""
The provided EMRFS parameters are invalid as parent feature e.g.,
Consistent View, CSE, SSE is not configured
:ivar invalid: Invalid parameters
:ivar parent_object_name: Parent feature name
"""
fmt = ('aws: error: {parent_object_name} is not specified. Thus, '
' following parameters are invalid: {invalid}')
class DuplicateEmrFsConfigurationError(EmrError):
fmt = ('aws: error: EMRFS should be configured either using '
'--configuration or --emrfs but not both')
class UnknownCseProviderTypeError(EmrError):
"""
The provided EMRFS client-side encryption provider type is not supported.
:ivar provider_type: the provider_type provided.
"""
fmt = ('aws: error: The client side encryption type "{provider_type}" is '
'not supported. You must specify either KMS or Custom')
class UnknownEncryptionTypeError(EmrError):
"""
The provided encryption type is not supported.
:ivar provider_type: the provider_type provided.
"""
fmt = ('aws: error: The encryption type "{encryption}" is invalid. '
'You must specify either ServerSide or ClientSide')
class BothSseAndEncryptionConfiguredError(EmrError):
"""
Only one of SSE or Encryption can be configured.
:ivar sse: Value for SSE
:ivar encryption: Value for encryption
"""
fmt = ('aws: error: Both SSE={sse} and Encryption={encryption} are '
'configured for --emrfs. You must specify only one of the two.')
class InvalidBooleanConfigError(EmrError):
fmt = ("aws: error: {config_value} for {config_key} in the config file is "
"invalid. The value should be either 'True' or 'False'. Use "
"'aws configure set {profile_var_name}.emr.{config_key} <value>' "
"command to set a valid value.")
class UnsupportedCommandWithReleaseError(EmrError):
fmt = ("aws: error: {command} is not supported with "
"'{release_label}' release.")
class MissingAutoScalingRoleError(EmrError):
fmt = ("aws: error: Must specify --auto-scaling-role when configuring an "
"AutoScaling policy for an instance group.")
