azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.yml

### YamlMime:PythonClass
uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError
name: CustomVisionError
fullName: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError
module: azure.cognitiveservices.vision.customvision.training.models
inheritances:
- msrest.serialization.Model
summary: 'CustomVisionError.


  All required parameters must be populated in order to send to Azure.'
constructor:
  syntax: 'CustomVisionError(*, code, message: str, **kwargs)'
  parameters:
  - name: code
    description: 'Required. The error code. Possible values include: ''NoError'',

      ''BadRequest'', ''BadRequestExceededBatchSize'', ''BadRequestNotSupported'',

      ''BadRequestInvalidIds'', ''BadRequestProjectName'',

      ''BadRequestProjectNameNotUnique'', ''BadRequestProjectDescription'',

      ''BadRequestProjectUnknownDomain'',

      ''BadRequestProjectUnknownClassification'',

      ''BadRequestProjectUnsupportedDomainTypeChange'',

      ''BadRequestProjectUnsupportedExportPlatform'',

      ''BadRequestProjectImagePreprocessingSettings'',

      ''BadRequestProjectDuplicated'', ''BadRequestIterationName'',

      ''BadRequestIterationNameNotUnique'', ''BadRequestIterationDescription'',

      ''BadRequestIterationIsNotTrained'', ''BadRequestIterationValidationFailed'',

      ''BadRequestWorkspaceCannotBeModified'', ''BadRequestWorkspaceNotDeletable'',

      ''BadRequestTagName'', ''BadRequestTagNameNotUnique'',

      ''BadRequestTagDescription'', ''BadRequestTagType'',

      ''BadRequestMultipleNegativeTag'', ''BadRequestMultipleGeneralProductTag'',

      ''BadRequestImageTags'', ''BadRequestImageRegions'',

      ''BadRequestNegativeAndRegularTagOnSameImage'',

      ''BadRequestUnsupportedDomain'', ''BadRequestRequiredParamIsNull'',

      ''BadRequestIterationIsPublished'', ''BadRequestInvalidPublishName'',

      ''BadRequestInvalidPublishTarget'', ''BadRequestUnpublishFailed'',

      ''BadRequestIterationNotPublished'', ''BadRequestSubscriptionApi'',

      ''BadRequestExceedProjectLimit'',

      ''BadRequestExceedIterationPerProjectLimit'',

      ''BadRequestExceedTagPerProjectLimit'', ''BadRequestExceedTagPerImageLimit'',

      ''BadRequestExceededQuota'', ''BadRequestCannotMigrateProjectWithName'',

      ''BadRequestNotLimitedTrial'', ''BadRequestImageBatch'',

      ''BadRequestImageStream'', ''BadRequestImageUrl'', ''BadRequestImageFormat'',

      ''BadRequestImageSizeBytes'', ''BadRequestImageDimensions'',

      ''BadRequestImageAspectRatio'', ''BadRequestImageExceededCount'',

      ''BadRequestTrainingNotNeeded'',

      ''BadRequestTrainingNotNeededButTrainingPipelineUpdated'',

      ''BadRequestTrainingValidationFailed'',

      ''BadRequestClassificationTrainingValidationFailed'',

      ''BadRequestMultiClassClassificationTrainingValidationFailed'',

      ''BadRequestMultiLabelClassificationTrainingValidationFailed'',

      ''BadRequestDetectionTrainingValidationFailed'',

      ''BadRequestTrainingAlreadyInProgress'',

      ''BadRequestDetectionTrainingNotAllowNegativeTag'',

      ''BadRequestInvalidEmailAddress'',

      ''BadRequestRetiredDomainNotSupportedForTraining'',

      ''BadRequestDomainNotSupportedForAdvancedTraining'',

      ''BadRequestExportPlatformNotSupportedForAdvancedTraining'',

      ''BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining'',

      ''BadRequestCustomBaseModelIterationStatusNotCompleted'',

      ''BadRequestCustomBaseModelDomainNotCompatible'',

      ''BadRequestCustomBaseModelArchitectureRetired'',

      ''BadRequestExportValidationFailed'', ''BadRequestExportAlreadyInProgress'',

      ''BadRequestPredictionIdsMissing'', ''BadRequestPredictionIdsExceededCount'',

      ''BadRequestPredictionTagsExceededCount'',

      ''BadRequestPredictionResultsExceededCount'',

      ''BadRequestPredictionInvalidApplicationName'',

      ''BadRequestPredictionInvalidQueryParameters'',

      ''BadRequestInvalidImportToken'', ''BadRequestExportWhileTraining'',

      ''BadRequestImageMetadataKey'', ''BadRequestImageMetadataValue'',

      ''BadRequestOperationNotSupported'', ''BadRequestInvalidArtifactUri'',

      ''BadRequestCustomerManagedKeyRevoked'', ''BadRequestInvalidUri'',

      ''BadRequestInvalid'', ''UnsupportedMediaType'', ''Forbidden'', ''ForbiddenUser'',

      ''ForbiddenUserResource'', ''ForbiddenUserSignupDisabled'',

      ''ForbiddenUserSignupAllowanceExceeded'', ''ForbiddenUserDoesNotExist'',

      ''ForbiddenUserDisabled'', ''ForbiddenUserInsufficientCapability'',

      ''ForbiddenDRModeEnabled'', ''ForbiddenInvalid'', ''NotFound'',

      ''NotFoundProject'', ''NotFoundProjectDefaultIteration'', ''NotFoundIteration'',

      ''NotFoundIterationPerformance'', ''NotFoundTag'', ''NotFoundImage'',

      ''NotFoundDomain'', ''NotFoundApimSubscription'', ''NotFoundInvalid'',

      ''Conflict'', ''ConflictInvalid'', ''ErrorUnknown'', ''ErrorIterationCopyFailed'',

      ''ErrorPreparePerformanceMigrationFailed'', ''ErrorProjectInvalidWorkspace'',

      ''ErrorProjectInvalidPipelineConfiguration'', ''ErrorProjectInvalidDomain'',

      ''ErrorProjectTrainingRequestFailed'', ''ErrorProjectImportRequestFailed'',

      ''ErrorProjectExportRequestFailed'', ''ErrorFeaturizationServiceUnavailable'',

      ''ErrorFeaturizationQueueTimeout'', ''ErrorFeaturizationInvalidFeaturizer'',

      ''ErrorFeaturizationAugmentationUnavailable'',

      ''ErrorFeaturizationUnrecognizedJob'',

      ''ErrorFeaturizationAugmentationError'', ''ErrorExporterInvalidPlatform'',

      ''ErrorExporterInvalidFeaturizer'', ''ErrorExporterInvalidClassifier'',

      ''ErrorPredictionServiceUnavailable'', ''ErrorPredictionModelNotFound'',

      ''ErrorPredictionModelNotCached'', ''ErrorPrediction'',

      ''ErrorPredictionStorage'', ''ErrorRegionProposal'', ''ErrorUnknownBaseModel'',

      ''ErrorServerTimeOut'', ''ErrorInvalid'''
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes>
  - name: message
    description: 'Required. A message explaining the error reported by the

      service.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: code
    isRequired: true
  - name: message
    isRequired: true
methods:
- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.as_dict
  name: as_dict
  summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
    \ optionally use a callback as parameter:\n\nKey is the attribute name used in\
    \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
    msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
    \ in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
    **kwargs)
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: deserialize(data, content_type=None)
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.from_dict
  name: from_dict
  summary: 'Parse a dict using given key extractor return a model.


    By default consider key

    extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor

    and last_rest_key_case_insensitive_extractor)'
  signature: from_dict(data, key_extractors=None, content_type=None)
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.serialize
  name: serialize
  summary: 'Return the JSON that would be sent to azure from this model.


    This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.


    If you want XML serialization, you can pass the kwargs is_xml=True.'
  signature: serialize(keep_readonly=False, **kwargs)
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.validate
  name: validate
  summary: Validate this model recursively and return a list of ValidationError.
  signature: validate()
  return:
    description: A list of validation error
    types:
    - <xref:list>