AWS API Changes

2021/02/03 - Amazon Lookout for Vision - 3 new 1 updated api methods

Changes This release includes the General Availability (GA) SDK for Amazon Lookout for Vision. New for GA is tagging support for Amazon Lookout for Vision models.

ListTagsForResource (new)

Link ¶

Returns a list of tags attached to the specified Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:ListTagsForResource operation.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the model for which you want to list tags.

rtype

dict

returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  
  A map of tag keys and values attached to the specified model.
  - (dict) --
    
    A key and value pair that is attached to the specified Amazon Lookout for Vision model.
    - Key (string) --
      
      The key of the tag that is attached to the specified model.
    - Value (string) --
      
      The value of the tag that is attached to the specified model.

TagResource (new)

Link ¶

Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide .

This operation requires permissions to perform the lookoutvision:TagResource operation.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the model to assign the tags.

type Tags

list

param Tags

[REQUIRED]

The key-value tags to assign to the model.

(dict) --

A key and value pair that is attached to the specified Amazon Lookout for Vision model.
- Key (string) -- [REQUIRED]
  
  The key of the tag that is attached to the specified model.
- Value (string) -- [REQUIRED]
  
  The value of the tag that is attached to the specified model.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UntagResource (new)

Link ¶

Removes one or more tags from an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide .

This operation requires permissions to perform the lookoutvision:UntagResource operation.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the model from which you want to remove tags.

type TagKeys

list

param TagKeys

[REQUIRED]

A list of the keys of the tags that you want to remove.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateModel (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.

To get the current status, check the Status field returned in the response from DescribeModel.

If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.

After training completes, the evaluation metrics are stored at the location specified in OutputConfig .

This operation requires permissions to perform the lookoutvision:CreateModel operation. If you want to tag your model, you also require permission to the lookoutvision:TagResource operation.

See also: AWS API Documentation

Request Syntax

client.create_model(
    ProjectName='string',
    Description='string',
    ClientToken='string',
    OutputConfig={
        'S3Location': {
            'Bucket': 'string',
            'Prefix': 'string'
        }
    },
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ProjectName

string

param ProjectName

[REQUIRED]

The name of the project in which you want to create a model version.

type Description

string

param Description

A description for the version of the model.

type ClientToken

string

param ClientToken

ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from CreateModel . In this case, safely retry your call to CreateModel by using the same ClientToken parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateModel . An idempotency token is active for 8 hours.

This field is autopopulated if not provided.

type OutputConfig

dict

param OutputConfig

[REQUIRED]

The location where Amazon Lookout for Vision saves the training results.

S3Location (dict) -- [REQUIRED]

The S3 location for the output.
- Bucket (string) -- [REQUIRED]
  
  The S3 bucket that contain the manifest file.
- Prefix (string) --
  
  The path and name of the manifest file with the S3 bucket.

type KmsKeyId

string

param KmsKeyId

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encypting the model. If this parameter is not specified, the model is encrypted by a key that AWS owns and manages.

type Tags

list

param Tags

A set of tags (key-value pairs) that you want to attach to the model.

(dict) --

A key and value pair that is attached to the specified Amazon Lookout for Vision model.
- Key (string) -- [REQUIRED]
  
  The key of the tag that is attached to the specified model.
- Value (string) -- [REQUIRED]
  
  The value of the tag that is attached to the specified model.

rtype

dict

returns

Response Syntax

{
    'ModelMetadata': {
        'CreationTimestamp': datetime(2015, 1, 1),
        'ModelVersion': 'string',
        'ModelArn': 'string',
        'Description': 'string',
        'Status': 'TRAINING'|'TRAINED'|'TRAINING_FAILED'|'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'|'DELETING',
        'StatusMessage': 'string',
        'Performance': {
            'F1Score': ...,
            'Recall': ...,
            'Precision': ...
        }
    }
}

Response Structure

(dict) --
- ModelMetadata (dict) --
  
  The response from a call to CreateModel .
  - CreationTimestamp (datetime) --
    
    The unix timestamp for the date and time that the model was created.
  - ModelVersion (string) --
    
    The version of the model.
  - ModelArn (string) --
    
    The Amazon Resource Name (ARN) of the model.
  - Description (string) --
    
    The description for the model.
  - Status (string) --
    
    The status of the model.
  - StatusMessage (string) --
    
    The status message for the model.
  - Performance (dict) --
    
    Performance metrics for the model. Not available until training has successfully completed.
    - F1Score (float) --
      
      The overall F1 score metric for the trained model.
    - Recall (float) --
      
      The overall recall metric value for the trained model.
    - Precision (float) --
      
      The overall precision metric value for the trained model.