LookoutEquipment / Client / update_model

update_model#

LookoutEquipment.Client.update_model(**kwargs)#

Updates a model in the account.

See also: AWS API Documentation

Request Syntax

response = client.update_model(
    ModelName='string',
    LabelsInputConfiguration={
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'LabelGroupName': 'string'
    },
    RoleArn='string',
    ModelDiagnosticsOutputConfiguration={
        'S3OutputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'KmsKeyId': 'string'
    }
)
Parameters:

  • ModelName (string) –

    [REQUIRED]

    The name of the model to update.

  • LabelsInputConfiguration (dict) –

    Contains the configuration information for the S3 location being used to hold label data.

    • S3InputConfiguration (dict) –

      Contains location information for the S3 location being used for label data.

      • Bucket (string) – [REQUIRED]

        The name of the S3 bucket holding the label data.

      • Prefix (string) –

        The prefix for the S3 bucket used for the label data.

    • LabelGroupName (string) –

      The name of the label group to be used for label data.

  • RoleArn (string) – The ARN of the model to update.

  • ModelDiagnosticsOutputConfiguration (dict) –

    The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics for the model. You must also specify the RoleArn request parameter.

    • S3OutputConfiguration (dict) – [REQUIRED]

      The Amazon S3 location for the pointwise model diagnostics.

      • Bucket (string) – [REQUIRED]

        The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.

      • Prefix (string) –

        The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. ( bucket).

        When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz.

        When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.

    • KmsKeyId (string) –

      The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.

Returns:

None

Exceptions