From c4aa4c12821949841a877cac9eeb8d97434e9dbd Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Thu, 14 Sep 2023 18:04:55 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/appstream.json | 531 +++--- .../aws-models/cloudformation.json | 24 +- .../aws-models/entityresolution.json | 288 +-- .../aws-models/lookoutequipment.json | 1544 ++++++++++++++--- 4 files changed, 1770 insertions(+), 617 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/appstream.json b/codegen/sdk-codegen/aws-models/appstream.json index 4fec1a1c566..64cae6ace0d 100644 --- a/codegen/sdk-codegen/aws-models/appstream.json +++ b/codegen/sdk-codegen/aws-models/appstream.json @@ -1187,8 +1187,13 @@ "DesiredInstances": { "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The desired number of streaming instances.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The desired number of streaming instances.

" + } + }, + "DesiredSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.

\n

When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.

" } } }, @@ -1223,6 +1228,30 @@ "traits": { "smithy.api#documentation": "

The number of currently available instances that can be used to stream\n sessions.

" } + }, + "DesiredUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.

\n

DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

\n

This only applies to multi-session fleets.

" + } + }, + "AvailableUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The number of idle session slots currently available for user sessions.

\n

AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

\n

This only applies to multi-session fleets.

" + } + }, + "ActiveUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

" + } + }, + "ActualUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The total number of session slots that are available for streaming or are currently streaming.

\n

ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

\n

This only applies to multi-session fleets.

" + } } }, "traits": { @@ -1988,7 +2017,7 @@ "MaxUserDurationInSeconds": { "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 360000.

" + "smithy.api#documentation": "

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 432000.

" } }, "DisconnectTimeoutInSeconds": { @@ -2068,6 +2097,12 @@ "traits": { "smithy.api#documentation": "

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" } + }, + "MaxSessionsPerInstance": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

" + } } }, "traits": { @@ -3828,7 +3863,7 @@ "matcher": { "output": { "path": "Fleets[].State", - "expected": "RUNNING", + "expected": "ACTIVE", "comparator": "allStringEquals" } } @@ -3838,7 +3873,7 @@ "matcher": { "output": { "path": "Fleets[].State", - "expected": "STOPPING", + "expected": "PENDING_DEACTIVATE", "comparator": "anyStringEquals" } } @@ -3848,7 +3883,7 @@ "matcher": { "output": { "path": "Fleets[].State", - "expected": "STOPPED", + "expected": "INACTIVE", "comparator": "anyStringEquals" } } @@ -3863,7 +3898,7 @@ "matcher": { "output": { "path": "Fleets[].State", - "expected": "STOPPED", + "expected": "INACTIVE", "comparator": "allStringEquals" } } @@ -3873,7 +3908,7 @@ "matcher": { "output": { "path": "Fleets[].State", - "expected": "STARTING", + "expected": "PENDING_ACTIVATE", "comparator": "anyStringEquals" } } @@ -3883,7 +3918,7 @@ "matcher": { "output": { "path": "Fleets[].State", - "expected": "RUNNING", + "expected": "ACTIVE", "comparator": "anyStringEquals" } } @@ -4191,14 +4226,14 @@ "type": "structure", "members": { "StackName": { - "target": "com.amazonaws.appstream#String", + "target": "com.amazonaws.appstream#Name", "traits": { "smithy.api#documentation": "

The name of the stack. This value is case-sensitive.

", "smithy.api#required": {} } }, "FleetName": { - "target": "com.amazonaws.appstream#String", + "target": "com.amazonaws.appstream#Name", "traits": { "smithy.api#documentation": "

The name of the fleet. This value is case-sensitive.

", "smithy.api#required": {} @@ -4227,6 +4262,12 @@ "traits": { "smithy.api#documentation": "

The authentication method. Specify API for a user\n authenticated using a streaming URL or SAML for a SAML federated user. \n The default is to authenticate users using a streaming URL.

" } + }, + "InstanceId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "

The identifier for the instance hosting the session.

" + } } }, "traits": { @@ -5337,6 +5378,12 @@ "traits": { "smithy.api#documentation": "

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" } + }, + "MaxSessionsPerInstance": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

" + } } }, "traits": { @@ -5381,6 +5428,12 @@ "traits": { "smithy.api#enumValue": "SESSION_SCRIPT_S3_LOCATION" } + }, + "MAX_SESSIONS_PER_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_SESSIONS_PER_INSTANCE" + } } }, "traits": { @@ -6877,52 +6930,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -6930,13 +6987,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -6946,274 +7012,225 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://appstream2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], + "conditions": [], "endpoint": { - "url": "https://appstream2.{Region}.amazonaws.com", + "url": "https://appstream2-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ + true, { - "fn": "stringEquals", + "fn": "getAttr", "argv": [ - "aws-us-gov", { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } - ], - "endpoint": { - "url": "https://appstream2.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [], "endpoint": { - "url": "https://appstream2.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://appstream2.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://appstream2.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://appstream2.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://appstream2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -8075,6 +8092,12 @@ "traits": { "smithy.api#documentation": "

The network details for the streaming session.

" } + }, + "InstanceId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "

The identifier for the instance hosting the session.

" + } } }, "traits": { @@ -9443,7 +9466,7 @@ } }, "Name": { - "target": "com.amazonaws.appstream#String", + "target": "com.amazonaws.appstream#Name", "traits": { "smithy.api#documentation": "

A unique name for the fleet.

" } @@ -9557,6 +9580,12 @@ "traits": { "smithy.api#documentation": "

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" } + }, + "MaxSessionsPerInstance": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cloudformation.json b/codegen/sdk-codegen/aws-models/cloudformation.json index f0751d187a1..f5ab3ef6507 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.json @@ -2682,7 +2682,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.

\n

Default: false\n

" } } }, @@ -2877,7 +2877,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.

\n " + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.

\n " } }, "Tags": { @@ -2889,7 +2889,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.

" } }, "ExecutionRoleName": { @@ -4777,7 +4777,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "\n

If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account. This requires ListStacks and DescribeStacks permissions.

\n

The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:

\n

{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }

\n \n

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n \n

Default: There is no default value.

" + "smithy.api#documentation": "\n

If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.

\n

Consider using the ListStacks API if you're not passing a parameter to StackName.

\n

The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:

\n

{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }

\n \n

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n \n

Default: There is no default value.

" } }, "NextToken": { @@ -5505,7 +5505,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.

\n

Default: false\n

" } } }, @@ -9204,7 +9204,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.

\n

Default: false\n

" } } }, @@ -9648,7 +9648,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.

\n

Default: false\n

" } } }, @@ -10815,7 +10815,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

\n

Use customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations\n in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

\n

Use customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations\n in the CloudFormation User Guide.

" } }, "ExecutionRoleName": { @@ -11075,7 +11075,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

\n

Use customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple Administrators in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

\n

Use customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple Administrators in the\n CloudFormation User Guide.

" } }, "ExecutionRoleName": { @@ -12715,7 +12715,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.

\n

Default: false\n

" } } }, @@ -12919,7 +12919,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.

\n " + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.

\n " } }, "Tags": { @@ -12937,7 +12937,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.

" } }, "ExecutionRoleName": { diff --git a/codegen/sdk-codegen/aws-models/entityresolution.json b/codegen/sdk-codegen/aws-models/entityresolution.json index 09d563f84c4..2240859dd3c 100644 --- a/codegen/sdk-codegen/aws-models/entityresolution.json +++ b/codegen/sdk-codegen/aws-models/entityresolution.json @@ -80,7 +80,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

Welcome to the AWS Entity Resolution API Reference.

\n

AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities \n that enable developers and analysts at advertising and marketing companies to build an accurate and \n complete view of their consumers.

\n

\n With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, \n such as name, email address, and phone number. This holds true even when these records have incomplete or \n conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a \n customer relationship management (CRM) system, which includes account information like first name, last name, \n postal address, phone number, and email address, with a source record from a marketing system containing \n campaign information, such as username and email address.

\n

To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the\n AWS Entity Resolution \n User Guide.

", + "smithy.api#documentation": "

Welcome to the Entity Resolution API Reference.

\n

Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities \n that enable developers and analysts at advertising and marketing companies to build an accurate and \n complete view of their consumers.

\n

\n With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, \n and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, \n Entity Resolution can effectively match a source record from a customer relationship management (CRM) system \n with a source record from a marketing system containing campaign information.

\n

To learn more about Entity Resolution concepts, procedures, and best practices, see the\n Entity Resolution \n User Guide.

", "smithy.api#title": "AWS EntityResolution", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -435,55 +435,55 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://entityresolution-fips.us-gov-east-1.api.aws" + "url": "https://entityresolution-fips.us-east-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entityresolution-fips.us-gov-east-1.amazonaws.com" + "url": "https://entityresolution-fips.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://entityresolution.us-gov-east-1.api.aws" + "url": "https://entityresolution.us-east-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entityresolution.us-gov-east-1.amazonaws.com" + "url": "https://entityresolution.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -495,8 +495,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -508,8 +508,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -521,8 +521,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -534,108 +534,108 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://entityresolution-fips.us-gov-east-1.api.aws" + } }, "params": { - "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entityresolution-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://entityresolution-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://entityresolution.us-gov-east-1.api.aws" + } }, "params": { - "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entityresolution.us-iso-east-1.c2s.ic.gov" + "url": "https://entityresolution.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://entityresolution-fips.us-east-1.api.aws" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entityresolution-fips.us-east-1.amazonaws.com" + "url": "https://entityresolution-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://entityresolution.us-east-1.api.aws" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entityresolution.us-east-1.amazonaws.com" + "url": "https://entityresolution.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -645,8 +645,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -658,8 +658,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -669,8 +669,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -682,12 +682,12 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -695,8 +695,21 @@ }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -707,8 +720,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -719,10 +732,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -851,7 +870,7 @@ "resolutionTechniques": { "target": "com.amazonaws.entityresolution#ResolutionTechniques", "traits": { - "smithy.api#documentation": "

An object which defines the resolutionType and the ruleBasedProperties\n

", + "smithy.api#documentation": "

An object which defines the resolutionType and the\n ruleBasedProperties.

", "smithy.api#required": {} } }, @@ -864,7 +883,7 @@ "roleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", "smithy.api#required": {} } }, @@ -919,7 +938,7 @@ "resolutionTechniques": { "target": "com.amazonaws.entityresolution#ResolutionTechniques", "traits": { - "smithy.api#documentation": "

An object which defines the resolutionType and the ruleBasedProperties\n

", + "smithy.api#documentation": "

An object which defines the resolutionType and the\n ruleBasedProperties.

", "smithy.api#required": {} } }, @@ -932,7 +951,7 @@ "roleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", "smithy.api#required": {} } } @@ -997,7 +1016,8 @@ "mappedInputFields": { "target": "com.amazonaws.entityresolution#SchemaInputAttributes", "traits": { - "smithy.api#documentation": "

A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.

" + "smithy.api#documentation": "

A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.

", + "smithy.api#required": {} } }, "tags": { @@ -1221,10 +1241,22 @@ "members": { "message": { "target": "com.amazonaws.entityresolution#ErrorMessage" + }, + "quotaName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the quota that has been breached.

" + } + }, + "quotaValue": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The current quota value for the customers.

" + } } }, "traits": { - "smithy.api#documentation": "

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. \n The error message describes the limit exceeded. HTTP Status Code: 402\n

", + "smithy.api#documentation": "

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. \n The error message describes the limit exceeded. HTTP Status Code: 402\n

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -1373,7 +1405,7 @@ "status": { "target": "com.amazonaws.entityresolution#JobStatus", "traits": { - "smithy.api#documentation": "

The current status of the job. Either running, succeeded, \n queued, or failed.

", + "smithy.api#documentation": "

The current status of the job.

", "smithy.api#required": {} } }, @@ -1498,7 +1530,7 @@ "resolutionTechniques": { "target": "com.amazonaws.entityresolution#ResolutionTechniques", "traits": { - "smithy.api#documentation": "

An object which defines the resolutionType and the ruleBasedProperties\n

", + "smithy.api#documentation": "

An object which defines the resolutionType and the\n ruleBasedProperties.

", "smithy.api#required": {} } }, @@ -1525,7 +1557,7 @@ "roleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access \n resources on your behalf.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access \n resources on your behalf.

", "smithy.api#required": {} } }, @@ -1720,7 +1752,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500\n

", + "smithy.api#documentation": "

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500\n

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -1753,16 +1785,16 @@ "smithy.api#documentation": "

The total number of records processed.

" } }, - "matchIDs": { + "recordsNotProcessed": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The total number of matchIDs generated.

" + "smithy.api#documentation": "

The total number of records that did not get processed.

" } }, - "recordsNotProcessed": { + "matchIDs": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The total number of records that did not get processed,

" + "smithy.api#documentation": "

The total number of matchIDs generated.

" } } }, @@ -1812,7 +1844,7 @@ "status": { "target": "com.amazonaws.entityresolution#JobStatus", "traits": { - "smithy.api#documentation": "

The current status of the job. Either running, succeeded, \n queued, or failed.

", + "smithy.api#documentation": "

The current status of the job.

", "smithy.api#required": {} } }, @@ -1921,7 +1953,7 @@ "jobs": { "target": "com.amazonaws.entityresolution#JobList", "traits": { - "smithy.api#documentation": "

A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

" + "smithy.api#documentation": "

A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

" } }, "nextToken": { @@ -1958,7 +1990,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all the MatchingWorkflows that have been created for an AWS account.

", + "smithy.api#documentation": "

Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2041,7 +2073,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all the SchemaMappings that have been created for an AWS account.

", + "smithy.api#documentation": "

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2121,7 +2153,7 @@ } ], "traits": { - "smithy.api#documentation": "

Displays the tags associated with an AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.

", + "smithy.api#documentation": "

Displays the tags associated with an Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}" @@ -2242,7 +2274,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.

" + "smithy.api#documentation": "

A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.

" } }, "com.amazonaws.entityresolution#OutputAttributes": { @@ -2255,29 +2287,28 @@ "type": "structure", "members": { "outputS3Path": { - "target": "smithy.api#String", + "target": "com.amazonaws.entityresolution#S3Path", "traits": { "smithy.api#documentation": "

The S3 path to which Entity Resolution will write the output table.

", - "smithy.api#pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", "smithy.api#required": {} } }, + "KMSArn": { + "target": "com.amazonaws.entityresolution#KMSArn", + "traits": { + "smithy.api#documentation": "

Customer KMS ARN for encryption at rest. If not provided, system will use an \n Entity Resolution managed KMS key.

" + } + }, "output": { "target": "com.amazonaws.entityresolution#OutputAttributes", "traits": { - "smithy.api#documentation": "

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.

", + "smithy.api#documentation": "

A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.

", "smithy.api#length": { "max": 750 }, "smithy.api#required": {} } }, - "KMSArn": { - "target": "com.amazonaws.entityresolution#KMSArn", - "traits": { - "smithy.api#documentation": "

Customer KMS ARN for encryption at rest. If not provided, system will use an \n Entity Resolution managed KMS key.

" - } - }, "applyNormalization": { "target": "smithy.api#Boolean", "traits": { @@ -2286,7 +2317,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.

" + "smithy.api#documentation": "

A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.

" } }, "com.amazonaws.entityresolution#OutputSourceConfig": { @@ -2331,7 +2362,8 @@ "resolutionType": { "target": "com.amazonaws.entityresolution#ResolutionType", "traits": { - "smithy.api#documentation": "

There are two types of matching, RULE_MATCHING and ML_MATCHING\n

" + "smithy.api#documentation": "

The type of matching. There are two types of matching: RULE_MATCHING and\n ML_MATCHING.

", + "smithy.api#required": {} } }, "ruleBasedProperties": { @@ -2342,7 +2374,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object which defines the resolutionType and the ruleBasedProperties\n

" + "smithy.api#documentation": "

An object which defines the resolutionType and the\n ruleBasedProperties.

" } }, "com.amazonaws.entityresolution#ResolutionType": { @@ -2411,7 +2443,7 @@ "rules": { "target": "com.amazonaws.entityresolution#RuleList", "traits": { - "smithy.api#documentation": "

A list of Rule objects, each of which have fields RuleName and MatchingKeys.

", + "smithy.api#documentation": "

A list of Rule objects, each of which have fields RuleName and\n MatchingKeys.

", "smithy.api#length": { "min": 1, "max": 15 @@ -2422,7 +2454,7 @@ "attributeMatchingModel": { "target": "com.amazonaws.entityresolution#AttributeMatchingModel", "traits": { - "smithy.api#documentation": "

You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When \n choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For \n example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, \n the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if \n the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of \n the Email field of Profile B matches, the two profiles are matched on the Email type.

", + "smithy.api#documentation": "

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When \n choosing MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For \n example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, \n the two profiles are matched on the Email type. When choosing ONE_TO_ONE ,the system can only match if \n the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of \n the Email field of Profile B matches, the two profiles are matched on the Email type.

", "smithy.api#required": {} } } @@ -2437,6 +2469,12 @@ "target": "com.amazonaws.entityresolution#Rule" } }, + "com.amazonaws.entityresolution#S3Path": { + "type": "string", + "traits": { + "smithy.api#pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$" + } + }, "com.amazonaws.entityresolution#SchemaAttributeType": { "type": "enum", "members": { @@ -2582,7 +2620,7 @@ "matchKey": { "target": "com.amazonaws.entityresolution#AttributeName", "traits": { - "smithy.api#documentation": "

A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the MatchKey\n Address' to both attributes, Entity Resolution will match records\n across these fields to create a consolidated matching group. If no MatchKey is\n specified for a column, it won't be utilized for matching purposes but will still be\n included in the output table.

" + "smithy.api#documentation": "

A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the MatchKey\n Address to both attributes, Entity Resolution will match records across these\n fields to create a consolidated matching group. If no MatchKey is specified\n for a column, it won't be utilized for matching purposes but will still be included in the\n output table.

" } } }, @@ -2777,7 +2815,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution\n resource. Tags can help you organize and categorize your resources. You can also use them\n to scope user permissions by granting a user permission to access or change only resources\n with certain tag values. In Entity Resolution, SchemaMapping, and\n MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS\n and are interpreted strictly as strings of characters. You can use the\n TagResource action with a resource that already has tags. If you specify a\n new tag key, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you\n specify replaces the previous value for that tag.

", + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Entity Resolution\n resource. Tags can help you organize and categorize your resources. You can also use them\n to scope user permissions by granting a user permission to access or change only resources\n with certain tag values. In Entity Resolution, SchemaMapping and\n MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services\n and are interpreted strictly as strings of characters. You can use the\n TagResource action with a resource that already has tags. If you specify a\n new tag key, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you\n specify replaces the previous value for that tag.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}" @@ -2856,7 +2894,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more tags from the specified AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.

", + "smithy.api#documentation": "

Removes one or more tags from the specified Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}" @@ -2964,7 +3002,7 @@ "resolutionTechniques": { "target": "com.amazonaws.entityresolution#ResolutionTechniques", "traits": { - "smithy.api#documentation": "

An object which defines the resolutionType and the ruleBasedProperties\n

", + "smithy.api#documentation": "

An object which defines the resolutionType and the ruleBasedProperties.

", "smithy.api#required": {} } }, @@ -2977,7 +3015,7 @@ "roleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", "smithy.api#required": {} } } @@ -3032,7 +3070,7 @@ "roleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.

", "smithy.api#required": {} } } @@ -3049,7 +3087,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400\n

", + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/lookoutequipment.json b/codegen/sdk-codegen/aws-models/lookoutequipment.json index 54cccb29df8..f545f4a0287 100644 --- a/codegen/sdk-codegen/aws-models/lookoutequipment.json +++ b/codegen/sdk-codegen/aws-models/lookoutequipment.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.lookoutequipment#CreateModel" }, + { + "target": "com.amazonaws.lookoutequipment#CreateRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#DeleteDataset" }, @@ -66,6 +69,9 @@ { "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicy" }, + { + "target": "com.amazonaws.lookoutequipment#DeleteRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJob" }, @@ -90,6 +96,9 @@ { "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicy" }, + { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#ImportDataset" }, @@ -123,6 +132,9 @@ { "target": "com.amazonaws.lookoutequipment#ListModelVersions" }, + { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulers" + }, { "target": "com.amazonaws.lookoutequipment#ListSensorStatistics" }, @@ -138,9 +150,15 @@ { "target": "com.amazonaws.lookoutequipment#StartInferenceScheduler" }, + { + "target": "com.amazonaws.lookoutequipment#StartRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#StopInferenceScheduler" }, + { + "target": "com.amazonaws.lookoutequipment#StopRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#TagResource" }, @@ -155,6 +173,12 @@ }, { "target": "com.amazonaws.lookoutequipment#UpdateLabelGroup" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateModel" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateRetrainingScheduler" } ], "traits": { @@ -852,6 +876,50 @@ } } }, + "com.amazonaws.lookoutequipment#AutoPromotionResult": { + "type": "enum", + "members": { + "MODEL_PROMOTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_PROMOTED" + } + }, + "MODEL_NOT_PROMOTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_NOT_PROMOTED" + } + }, + "RETRAINING_INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_INTERNAL_ERROR" + } + }, + "RETRAINING_CUSTOMER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_CUSTOMER_ERROR" + } + }, + "RETRAINING_CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_CANCELLED" + } + } + } + }, + "com.amazonaws.lookoutequipment#AutoPromotionResultReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.lookoutequipment#Boolean": { "type": "boolean", "traits": { @@ -1098,7 +1166,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the previously trained ML model being used to create the inference\n scheduler.

", + "smithy.api#documentation": "

The name of the previously trained machine learning model being used to create the\n inference scheduler.

", "smithy.api#required": {} } }, @@ -1112,13 +1180,13 @@ "DataDelayOffsetInMinutes": { "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", "traits": { - "smithy.api#documentation": "

The interval (in minutes) of planned delay at the start of each inference segment. For\n example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the\n configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3\n bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and\n restart the scheduler when uploading new data.

\n

For more information, see Understanding the inference process.

" + "smithy.api#documentation": "

The interval (in minutes) of planned delay at the start of each inference segment. For\n example, if inference is set to run every ten minutes, the delay is set to five minutes and\n the time is 09:08. The inference scheduler will wake up at the configured interval (which,\n without a delay configured, would be 09:10) plus the additional five minute delay time (so\n 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the\n same frequency, so that you don't have to stop and restart the scheduler when uploading new\n data.

\n

For more information, see Understanding\n the inference process.

" } }, "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "

How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.

\n

For more information, see Understanding the inference process.

", + "smithy.api#documentation": "

How often data is uploaded to the source Amazon S3 bucket for the input data. The value\n chosen is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This\n frequency also determines how often Amazon Lookout for Equipment runs inference on your data.

\n

For more information, see Understanding\n the inference process.

", "smithy.api#required": {} } }, @@ -1226,7 +1294,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates a label for an event.\n

" + "smithy.api#documentation": "

Creates a label for an event.

" } }, "com.amazonaws.lookoutequipment#CreateLabelGroup": { @@ -1258,7 +1326,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates a group of labels.\n

" + "smithy.api#documentation": "

Creates a group of labels.

" } }, "com.amazonaws.lookoutequipment#CreateLabelGroupRequest": { @@ -1267,20 +1335,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n Names a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

", + "smithy.api#documentation": "

Names a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

", "smithy.api#required": {} } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "

\n The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

The acceptable fault codes (indicating the type of anomaly associated with the label)\n that can be used with this label group.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "

\n A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.\n

", + "smithy.api#documentation": "

A unique identifier for the request to create a label group. If you do not set the\n client request token, Lookout for Equipment generates one.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1288,7 +1356,7 @@ "Tags": { "target": "com.amazonaws.lookoutequipment#TagList", "traits": { - "smithy.api#documentation": "

\n Tags that provide metadata about the label group you are creating.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

Tags that provide metadata about the label group you are creating.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } } }, @@ -1302,13 +1370,13 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

" + "smithy.api#documentation": "

The name of the label group that you have created. Data in this field will be retained\n for service usage. Follow best practices for the security of your data.

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group that you have created.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the label group that you have created.

" } } }, @@ -1322,53 +1390,53 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

", + "smithy.api#documentation": "

The name of a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The start time of the labeled event.\n

", + "smithy.api#documentation": "

The start time of the labeled event.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The end time of the labeled event.\n

", + "smithy.api#documentation": "

The end time of the labeled event.

", "smithy.api#required": {} } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "

\n Indicates whether a labeled event represents an anomaly.\n

", + "smithy.api#documentation": "

Indicates whether a labeled event represents an anomaly.

", "smithy.api#required": {} } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "

\n Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

" + "smithy.api#documentation": "

Provides additional information about the label. The fault code must be defined in the\n FaultCodes attribute of the label group.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } }, "Notes": { "target": "com.amazonaws.lookoutequipment#Comments", "traits": { - "smithy.api#documentation": "

\n Metadata providing additional information about the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

Metadata providing additional information about the label.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\n Indicates that a label pertains to a particular piece of equipment.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

Indicates that a label pertains to a particular piece of equipment.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "

\n A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.\n

", + "smithy.api#documentation": "

A unique identifier for the request to create a label. If you do not set the client\n request token, Lookout for Equipment generates one.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1384,7 +1452,7 @@ "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\n The ID of the label that you have created.\n

" + "smithy.api#documentation": "

The ID of the label that you have created.

" } } }, @@ -1424,7 +1492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an ML model for data inference.

\n

A machine-learning (ML) model is a mathematical model that finds patterns in your data.\n In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and\n detects abnormal behavior that could be potential equipment failure (or maintenance\n events). The models are made by analyzing normal data and abnormalities in machine behavior\n that have already occurred.

\n

Your model is trained using a portion of the data from your dataset and uses that data\n to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.\n Another portion of the data is used to evaluate the model's accuracy.

" + "smithy.api#documentation": "

Creates a machine learning model for data inference.

\n

A machine-learning (ML) model is a mathematical model that finds patterns in your data.\n In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal\n behavior that could be potential equipment failure (or maintenance events). The models are\n made by analyzing normal data and abnormalities in machine behavior that have already\n occurred.

\n

Your model is trained using a portion of the data from your dataset and uses that data\n to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.\n Another portion of the data is used to evaluate the model's accuracy.

" } }, "com.amazonaws.lookoutequipment#CreateModelRequest": { @@ -1433,27 +1501,27 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name for the ML model to be created.

", + "smithy.api#documentation": "

The name for the machine learning model to be created.

", "smithy.api#required": {} } }, "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", "traits": { - "smithy.api#documentation": "

The name of the dataset for the ML model being created.

", + "smithy.api#documentation": "

The name of the dataset for the machine learning model being created.

", "smithy.api#required": {} } }, "DatasetSchema": { "target": "com.amazonaws.lookoutequipment#DatasetSchema", "traits": { - "smithy.api#documentation": "

The data schema for the ML model being created.

" + "smithy.api#documentation": "

The data schema for the machine learning model being created.

" } }, "LabelsInputConfiguration": { "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration", "traits": { - "smithy.api#documentation": "

The input configuration for the labels being used for the ML model that's being created.\n

" + "smithy.api#documentation": "

The input configuration for the labels being used for the machine learning model that's\n being created.

" } }, "ClientToken": { @@ -1467,37 +1535,37 @@ "TrainingDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to begin the subset of\n training data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to begin the subset of\n training data for the machine learning model.

" } }, "TrainingDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to end the subset of\n training data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to end the subset of\n training data for the machine learning model.

" } }, "EvaluationDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to begin the subset of\n evaluation data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to begin the subset of\n evaluation data for the machine learning model.

" } }, "EvaluationDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to end the subset of\n evaluation data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that should be used to end the subset of\n evaluation data for the machine learning model.

" } }, "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to access the data source\n being used to create the ML model.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to access the data source\n being used to create the machine learning model.

" } }, "DataPreProcessingConfiguration": { "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" + "smithy.api#documentation": "

The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" } }, "ServerSideKmsKeyId": { @@ -1509,7 +1577,7 @@ "Tags": { "target": "com.amazonaws.lookoutequipment#TagList", "traits": { - "smithy.api#documentation": "

Any tags associated with the ML model being created.

" + "smithy.api#documentation": "

Any tags associated with the machine learning model being created.

" } }, "OffCondition": { @@ -1543,6 +1611,131 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#CreateRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a retraining scheduler on the specified model.

", + "smithy.api#examples": [ + { + "title": "Creates a retraining scheduler with manual promote mode", + "documentation": "", + "input": { + "ModelName": "sample-model", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D", + "PromoteMode": "MANUAL", + "ClientToken": "sample-client-token" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "PENDING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model to add the retraining scheduler to.

", + "smithy.api#required": {} + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.

" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "

This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in\n terms of Years, Months, and/or Days (note: other parameters like Time are not currently\n supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For\n example, the following values are valid:

\n ", + "smithy.api#required": {} + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "

The number of past days of data that will be used for retraining.

", + "smithy.api#required": {} + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "

Indicates how the service will use new models. In MANAGED mode, new models\n will automatically be used for inference if they have better performance than the current\n model. In MANUAL mode, the new models will not be used until they\n are manually activated.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model that you added the retraining scheduler to.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model that you added the retraining scheduler to.

" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

The status of the retraining scheduler.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes": { "type": "long", "traits": { @@ -1602,12 +1795,12 @@ "TargetSamplingRate": { "target": "com.amazonaws.lookoutequipment#TargetSamplingRate", "traits": { - "smithy.api#documentation": "

The sampling rate of the data after post processing by Amazon Lookout for Equipment. For\n example, if you provide data that has been collected at a 1 second level and you want the\n system to resample the data at a 1 minute rate before training, the\n TargetSamplingRate is 1 minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" + "smithy.api#documentation": "

The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you\n provide data that has been collected at a 1 second level and you want the system to\n resample the data at a 1 minute rate before training, the TargetSamplingRate\n is 1 minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" } } }, "traits": { - "smithy.api#documentation": "

The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" + "smithy.api#documentation": "

The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" } }, "com.amazonaws.lookoutequipment#DataQualitySummary": { @@ -1732,7 +1925,7 @@ "InlineDataSchema": { "target": "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema", "traits": { - "smithy.api#documentation": "

\n

" + "smithy.api#documentation": "

The data schema used within the given dataset.

" } } }, @@ -1883,7 +2076,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an inference scheduler that has been set up. Already processed output results\n are not affected.

" + "smithy.api#documentation": "

Deletes an inference scheduler that has been set up. Prior inference results will not be\n deleted.

" } }, "com.amazonaws.lookoutequipment#DeleteInferenceSchedulerRequest": { @@ -1930,7 +2123,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Deletes a label.\n

" + "smithy.api#documentation": "

Deletes a label.

" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroup": { @@ -1962,7 +2155,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Deletes a group of labels.\n

" + "smithy.api#documentation": "

Deletes a group of labels.

" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest": { @@ -1971,7 +2164,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

", + "smithy.api#documentation": "

The name of the label group that you want to delete. Data in this field will be\n retained for service usage. Follow best practices for the security of your data.

", "smithy.api#required": {} } } @@ -1986,14 +2179,14 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

", + "smithy.api#documentation": "

The name of the label group that contains the label that you want to delete. Data in\n this field will be retained for service usage. Follow best practices for the security of\n your data.

", "smithy.api#required": {} } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\n The ID of the label that you want to delete.\n

", + "smithy.api#documentation": "

The ID of the label that you want to delete.

", "smithy.api#required": {} } } @@ -2031,7 +2224,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an ML model currently available for Amazon Lookout for Equipment. This will\n prevent it from being used with an inference scheduler, even one that is already set up.\n

" + "smithy.api#documentation": "

Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it\n from being used with an inference scheduler, even one that is already set up.

" } }, "com.amazonaws.lookoutequipment#DeleteModelRequest": { @@ -2040,7 +2233,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model to be deleted.

", + "smithy.api#documentation": "

The name of the machine learning model to be deleted.

", "smithy.api#required": {} } } @@ -2087,7 +2280,63 @@ "ResourceArn": { "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the resource policy should be\n deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteRetrainingSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a retraining scheduler from a model. The retraining scheduler must be in the\n STOPPED status.

", + "smithy.api#examples": [ + { + "title": "Deletes a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#DeleteRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model whose retraining scheduler you want to delete.

", "smithy.api#required": {} } } @@ -2221,7 +2470,7 @@ "SourceDatasetArn": { "target": "com.amazonaws.lookoutequipment#DatasetArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source dataset from which the data \n used for the data ingestion job was imported from.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source dataset from which the data used for the\n data ingestion job was imported from.

" } } }, @@ -2357,7 +2606,7 @@ "SourceDatasetArn": { "target": "com.amazonaws.lookoutequipment#DatasetArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source dataset from which the \n current data being described was imported from.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source dataset from which the current data being\n described was imported from.

" } } }, @@ -2415,13 +2664,13 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model of the inference scheduler being\n described.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler\n being described.

" } }, "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model of the inference scheduler being described.

" + "smithy.api#documentation": "

The name of the machine learning model of the inference scheduler being described.\n

" } }, "InferenceSchedulerName": { @@ -2451,7 +2700,7 @@ "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "

Specifies how often data is uploaded to the source S3 bucket for the input data. This\n value is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every\n 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a\n scheduled inference on your data. In this example, it starts once every 5 minutes.

" + "smithy.api#documentation": "

Specifies how often data is uploaded to the source S3 bucket for the input data. This\n value is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This\n frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In\n this example, it starts once every 5 minutes.

" } }, "CreatedAt": { @@ -2527,7 +2776,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns the name of the label.\n

" + "smithy.api#documentation": "

Returns the name of the label.

" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroup": { @@ -2556,7 +2805,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns information about the label group.\n

" + "smithy.api#documentation": "

Returns information about the label group.

" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest": { @@ -2565,7 +2814,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n Returns the name of the label group.\n

", + "smithy.api#documentation": "

Returns the name of the label group.

", "smithy.api#required": {} } } @@ -2580,31 +2829,31 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the label group.\n

" + "smithy.api#documentation": "

The name of the label group.

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the label group.

" } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "

\n Codes indicating the type of anomaly associated with the labels in the lagbel group.\n

" + "smithy.api#documentation": "

Codes indicating the type of anomaly associated with the labels in the lagbel group.\n

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time at which the label group was created.\n

" + "smithy.api#documentation": "

The time at which the label group was created.

" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time at which the label group was updated.\n

" + "smithy.api#documentation": "

The time at which the label group was updated.

" } } }, @@ -2618,14 +2867,14 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n Returns the name of the group containing the label.\n

", + "smithy.api#documentation": "

Returns the name of the group containing the label.

", "smithy.api#required": {} } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\n Returns the ID of the label.\n

", + "smithy.api#documentation": "

Returns the ID of the label.

", "smithy.api#required": {} } } @@ -2640,61 +2889,61 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the requested label group.\n

" + "smithy.api#documentation": "

The name of the requested label group.

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the requested label group.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the requested label group.

" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\n The ID of the requested label.\n

" + "smithy.api#documentation": "

The ID of the requested label.

" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The start time of the requested label.\n

" + "smithy.api#documentation": "

The start time of the requested label.

" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The end time of the requested label.\n

" + "smithy.api#documentation": "

The end time of the requested label.

" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "

\n Indicates whether a labeled event represents an anomaly.\n

" + "smithy.api#documentation": "

Indicates whether a labeled event represents an anomaly.

" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "

\n Indicates the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

Indicates the type of anomaly associated with the label.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } }, "Notes": { "target": "com.amazonaws.lookoutequipment#Comments", "traits": { - "smithy.api#documentation": "

Metadata providing additional information about the label.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

Metadata providing additional information about the label.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\n Indicates that a label pertains to a particular piece of equipment.\n

" + "smithy.api#documentation": "

Indicates that a label pertains to a particular piece of equipment.

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time at which the label was created.\n

" + "smithy.api#documentation": "

The time at which the label was created.

" } } }, @@ -2728,7 +2977,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a JSON containing the overall information about a specific ML model, including\n model name and ARN, dataset, training and evaluation information, status, and so on.\n

" + "smithy.api#documentation": "

Provides a JSON containing the overall information about a specific machine learning\n model, including model name and ARN, dataset, training and evaluation information, status,\n and so on.

" } }, "com.amazonaws.lookoutequipment#DescribeModelRequest": { @@ -2737,7 +2986,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model to be described.

", + "smithy.api#documentation": "

The name of the machine learning model to be described.

", "smithy.api#required": {} } } @@ -2752,25 +3001,25 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model being described.

" + "smithy.api#documentation": "

The name of the machine learning model being described.

" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model being described.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model being described.

" } }, "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "

The name of the dataset being used by the ML being described.

" + "smithy.api#documentation": "

The name of the dataset being used by the machine learning being described.

" } }, "DatasetArn": { "target": "com.amazonaws.lookoutequipment#DatasetArn", "traits": { - "smithy.api#documentation": "

The Amazon Resouce Name (ARN) of the dataset used to create the ML model being\n described.

" + "smithy.api#documentation": "

The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model\n being described.

" } }, "Schema": { @@ -2788,37 +3037,37 @@ "TrainingDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to begin the subset of\n training data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to begin the subset of\n training data for the machine learning model.

" } }, "TrainingDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to end the subset of training\n data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to end the subset of training\n data for the machine learning model.

" } }, "EvaluationDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to begin the subset of\n evaluation data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to begin the subset of\n evaluation data for the machine learning model.

" } }, "EvaluationDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to end the subset of\n evaluation data for the ML model.

" + "smithy.api#documentation": "

Indicates the time reference in the dataset that was used to end the subset of\n evaluation data for the machine learning model.

" } }, "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the ML model being described.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the machine learning model being described.

" } }, "DataPreProcessingConfiguration": { "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" + "smithy.api#documentation": "

The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.

\n

When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n

" } }, "Status": { @@ -2830,19 +3079,19 @@ "TrainingExecutionStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time at which the training of the ML model began.

" + "smithy.api#documentation": "

Indicates the time at which the training of the machine learning model began.

" } }, "TrainingExecutionEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time at which the training of the ML model was completed.

" + "smithy.api#documentation": "

Indicates the time at which the training of the machine learning model was completed.\n

" } }, "FailedReason": { "target": "com.amazonaws.lookoutequipment#BoundedLengthString", "traits": { - "smithy.api#documentation": "

If the training of the ML model failed, this indicates the reason for that failure.\n

" + "smithy.api#documentation": "

If the training of the machine learning model failed, this indicates the reason for that\n failure.

" } }, "ModelMetrics": { @@ -2854,13 +3103,13 @@ "LastUpdatedTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the last time the ML model was updated. The type of update is not specified.\n

" + "smithy.api#documentation": "

Indicates the last time the machine learning model was updated. The type of update is\n not specified.

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time and date at which the ML model was created.

" + "smithy.api#documentation": "

Indicates the time and date at which the machine learning model was created.

" } }, "ServerSideKmsKeyId": { @@ -2872,37 +3121,37 @@ "OffCondition": { "target": "com.amazonaws.lookoutequipment#OffCondition", "traits": { - "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.

" + "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or\n inference.

" } }, "SourceModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version \n was imported.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source model version. This field appears if the\n active model version was imported.

" } }, "ImportJobStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the import job was started. \n This field appears if the active model version was imported.

" + "smithy.api#documentation": "

The date and time when the import job was started. This field appears if the active\n model version was imported.

" } }, "ImportJobEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the import job was completed. \n This field appears if the active model version was imported.

" + "smithy.api#documentation": "

The date and time when the import job was completed. This field appears if the active\n model version was imported.

" } }, "ActiveModelVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "

The name of the model version used by the inference schedular when running a\n scheduled inference execution.

" + "smithy.api#documentation": "

The name of the model version used by the inference schedular when running a scheduled\n inference execution.

" } }, "ActiveModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version used by the\n inference scheduler when running a scheduled inference execution.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version used by the inference scheduler when\n running a scheduled inference execution.

" } }, "ModelVersionActivatedAt": { @@ -2914,13 +3163,13 @@ "PreviousActiveModelVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "

The model version that was set as the active model version prior to the \n current active model version.

" + "smithy.api#documentation": "

The model version that was set as the active model version prior to the current active\n model version.

" } }, "PreviousActiveModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

The ARN of the model version that was set as the active model version prior to the \n current active model version.

" + "smithy.api#documentation": "

The ARN of the model version that was set as the active model version prior to the\n current active model version.

" } }, "PreviousModelVersionActivatedAt": { @@ -2928,6 +3177,66 @@ "traits": { "smithy.api#documentation": "

The date and time when the previous active model version was activated.

" } + }, + "PriorModelMetrics": { + "target": "com.amazonaws.lookoutequipment#SynthesizedJsonModelMetrics", + "traits": { + "smithy.api#documentation": "

If the model version was retrained, this field shows a summary of the performance of the\n prior model on the new training range. You can use the information in this JSON-formatted\n object to compare the new model version and the prior model version.

" + } + }, + "LatestScheduledRetrainingFailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "

If the model version was generated by retraining and the training failed, this indicates\n the reason for that failure.

" + } + }, + "LatestScheduledRetrainingStatus": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the most recent scheduled retraining run.

" + } + }, + "LatestScheduledRetrainingModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

Indicates the most recent model version that was generated by retraining.

" + } + }, + "LatestScheduledRetrainingStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the start time of the most recent scheduled retraining run.

" + } + }, + "LatestScheduledRetrainingAvailableDataInDays": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the number of days of data used in the most recent scheduled retraining run.\n

" + } + }, + "NextScheduledRetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment\n truncates the time you provide to the nearest UTC day.

" + } + }, + "AccumulatedInferenceDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the start time of the inference data that has been accumulated.

" + } + }, + "AccumulatedInferenceDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the end time of the inference data that has been accumulated.

" + } + }, + "RetrainingSchedulerStatus": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the retraining scheduler.

" + } } }, "traits": { @@ -2997,7 +3306,7 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parent machine learning model that this version\n belong to.

" } }, "ModelVersion": { @@ -3048,31 +3357,31 @@ "TrainingDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date on which the training data began being gathered. If you imported\n the version, this is the date that the training data in the source \n version began being gathered.

" + "smithy.api#documentation": "

The date on which the training data began being gathered. If you imported the version,\n this is the date that the training data in the source version began being gathered.

" } }, "TrainingDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date on which the training data finished being gathered. \n If you imported the version, this is the date that the training data in the\n source version finished being gathered.

" + "smithy.api#documentation": "

The date on which the training data finished being gathered. If you imported the\n version, this is the date that the training data in the source version finished being\n gathered.

" } }, "EvaluationDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in \n the source version began being gathered.

" + "smithy.api#documentation": "

The date on which the data in the evaluation set began being gathered. If you imported\n the version, this is the date that the evaluation set data in the source version began\n being gathered.

" } }, "EvaluationDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in the\n source version finished being gathered.

" + "smithy.api#documentation": "

The date on which the data in the evaluation set began being gathered. If you imported\n the version, this is the date that the evaluation set data in the source version finished\n being gathered.

" } }, "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that was used to train the model version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that was used to train the model\n version.

" } }, "DataPreProcessingConfiguration": { @@ -3099,7 +3408,7 @@ "ModelMetrics": { "target": "com.amazonaws.lookoutequipment#ModelMetrics", "traits": { - "smithy.api#documentation": "

Shows an aggregated summary, in JSON format, of the model's \n performance within the evaluation time range. These metrics \n are created when evaluating the model.

" + "smithy.api#documentation": "

Shows an aggregated summary, in JSON format, of the model's performance within the\n evaluation time range. These metrics are created when evaluating the model.

" } }, "LastUpdatedTime": { @@ -3111,43 +3420,67 @@ "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time and date at which the machine learning model version was created.

" + "smithy.api#documentation": "

Indicates the time and date at which the machine learning model version was\n created.

" } }, "ServerSideKmsKeyId": { "target": "com.amazonaws.lookoutequipment#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The identifier of the KMS key key used to encrypt model version data by \n Amazon Lookout for Equipment.

" + "smithy.api#documentation": "

The identifier of the KMS key key used to encrypt model version data by\n Amazon Lookout for Equipment.

" } }, "OffCondition": { "target": "com.amazonaws.lookoutequipment#OffCondition", "traits": { - "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been \n shut off. As long as this condition is met, Lookout for Equipment \n will not use data from this asset for training, evaluation, or inference.

" + "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.

" } }, "SourceModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

If model version was imported, then this field is the arn\n of the source model version.

" + "smithy.api#documentation": "

If model version was imported, then this field is the arn of the source model\n version.

" } }, "ImportJobStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the import job began. \n This field appears if the model version was imported.

" + "smithy.api#documentation": "

The date and time when the import job began. This field appears if the model version was\n imported.

" } }, "ImportJobEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the import job completed. \n This field appears if the model version was imported.

" + "smithy.api#documentation": "

The date and time when the import job completed. This field appears if the model version\n was imported.

" } }, "ImportedDataSizeInBytes": { "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", "traits": { - "smithy.api#documentation": "

The size in bytes of the imported data. \n This field appears if the model version was imported.

" + "smithy.api#documentation": "

The size in bytes of the imported data. This field appears if the model version was\n imported.

" + } + }, + "PriorModelMetrics": { + "target": "com.amazonaws.lookoutequipment#ModelMetrics", + "traits": { + "smithy.api#documentation": "

If the model version was retrained, this field shows a summary of the performance of the\n prior model on the new training range. You can use the information in this JSON-formatted\n object to compare the new model version and the prior model version.

" + } + }, + "RetrainingAvailableDataInDays": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the number of days of data used in the most recent scheduled retraining run.\n

" + } + }, + "AutoPromotionResult": { + "target": "com.amazonaws.lookoutequipment#AutoPromotionResult", + "traits": { + "smithy.api#documentation": "

Indicates whether the model version was promoted to be the active version after\n retraining or if there was an error with or cancellation of the retraining.

" + } + }, + "AutoPromotionResultReason": { + "target": "com.amazonaws.lookoutequipment#AutoPromotionResultReason", + "traits": { + "smithy.api#documentation": "

Indicates the reason for the AutoPromotionResult. For example, a model\n might not be promoted if its performance was worse than the active version, if there was an\n error during training, or if the retraining scheduler was using MANUAL promote\n mode. The model will be promoted in MANAGED promote mode if the performance is\n better than the previous model.

" } } }, @@ -3190,7 +3523,7 @@ "ResourceArn": { "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that is associated with the resource\n policy.

", "smithy.api#required": {} } } @@ -3231,26 +3564,152 @@ "smithy.api#output": {} } }, - "com.amazonaws.lookoutequipment#DuplicateTimestamps": { - "type": "structure", - "members": { - "TotalNumberOfDuplicateTimestamps": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "

Indicates the total number of duplicate timestamps.

", - "smithy.api#required": {} - } - } + "com.amazonaws.lookoutequipment#DescribeRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerRequest" }, - "traits": { - "smithy.api#documentation": "

Entity that comprises information abount duplicate timestamps in the dataset.

" - } - }, - "com.amazonaws.lookoutequipment#Equipment": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a description of the retraining scheduler, including information such as the\n model name and retraining parameters.

", + "smithy.api#examples": [ + { + "title": "Describes a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "RetrainingStartDate": "2023-11-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D", + "Status": "RUNNING", + "PromoteMode": "MANAGED", + "CreatedAt": "2023-10-01T15:00:00Z", + "UpdatedAt": "2023-10-01T15:00:00Z" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model that the retraining scheduler is attached to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model that the retraining scheduler is attached to.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model that the retraining scheduler is attached to.

" + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.

" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "

The frequency at which the model retraining is set. This follows the ISO 8601\n guidelines.

" + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "

The number of past days of data used for retraining.

" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

The status of the retraining scheduler.

" + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "

Indicates how the service uses new models. In MANAGED mode, new models are\n used for inference if they have better performance than the current model. In\n MANUAL mode, the new models are not used until they are manually\n activated.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the time and date at which the retraining scheduler was created.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the time and date at which the retraining scheduler was updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DuplicateTimestamps": { + "type": "structure", + "members": { + "TotalNumberOfDuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the total number of duplicate timestamps.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Entity that comprises information abount duplicate timestamps in the dataset.

" + } + }, + "com.amazonaws.lookoutequipment#Equipment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, "max": 200 }, "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,200}$" @@ -3366,13 +3825,13 @@ "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "

The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.

" + "smithy.api#documentation": "

The name of the machine learning dataset to be created. If the dataset already exists,\n Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled\n with the name of the source dataset.

" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. \n If you do not set the client request token, \n Amazon Lookout for Equipment generates one.

", + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -3380,7 +3839,7 @@ "ServerSideKmsKeyId": { "target": "com.amazonaws.lookoutequipment#NameOrArn", "traits": { - "smithy.api#documentation": "

Provides the identifier of the KMS key key used to \n encrypt model data by Amazon Lookout for Equipment.

" + "smithy.api#documentation": "

Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.\n

" } }, "Tags": { @@ -3474,7 +3933,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name for the machine learning model to be created.\n If the model already exists, Amazon Lookout for Equipment creates a new version. \n If you do not specify this field, it is filled with the name of the source model.

" + "smithy.api#documentation": "

The name for the machine learning model to be created. If the model already exists,\n Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the\n name of the source model.

" } }, "DatasetName": { @@ -3490,7 +3949,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request\n token, Amazon Lookout for Equipment generates one.

", + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -3498,13 +3957,13 @@ "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to \n access the data source being used to create the machine learning model.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to access the data source being\n used to create the machine learning model.

" } }, "ServerSideKmsKeyId": { "target": "com.amazonaws.lookoutequipment#NameOrArn", "traits": { - "smithy.api#documentation": "

Provides the identifier of the KMS key key used to encrypt \n model data by Amazon Lookout for Equipment.

" + "smithy.api#documentation": "

Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.\n

" } }, "Tags": { @@ -3512,6 +3971,12 @@ "traits": { "smithy.api#documentation": "

The tags associated with the machine learning model to be created.

" } + }, + "InferenceDataImportStrategy": { + "target": "com.amazonaws.lookoutequipment#InferenceDataImportStrategy", + "traits": { + "smithy.api#documentation": "

Indicates how to import the accumulated inference data when a model version is imported.\n The possible values are as follows:

\n " + } } }, "traits": { @@ -3556,6 +4021,29 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#InferenceDataImportStrategy": { + "type": "enum", + "members": { + "NO_IMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_IMPORT" + } + }, + "ADD_WHEN_EMPTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_WHEN_EMPTY" + } + }, + "OVERWRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERWRITE" + } + } + } + }, "com.amazonaws.lookoutequipment#InferenceEventSummaries": { "type": "list", "member": { @@ -3641,13 +4129,13 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model being used for the inference execution.

" + "smithy.api#documentation": "

The name of the machine learning model being used for the inference execution.

" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model used for the inference execution.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model used for the inference\n execution.

" } }, "InferenceSchedulerName": { @@ -3695,7 +4183,7 @@ "CustomerResultObject": { "target": "com.amazonaws.lookoutequipment#S3Object", "traits": { - "smithy.api#documentation": "

\n

" + "smithy.api#documentation": "

The S3 object that the inference execution results were uploaded to.

" } }, "Status": { @@ -3709,6 +4197,18 @@ "traits": { "smithy.api#documentation": "

Specifies the reason for failure when an inference execution has failed.

" } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The model version used for the inference execution.

" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model version used for the inference\n execution.

" + } } }, "traits": { @@ -3895,13 +4395,13 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model used for the inference scheduler.

" + "smithy.api#documentation": "

The name of the machine learning model used for the inference scheduler.

" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model used by the inference\n scheduler.

" } }, "InferenceSchedulerName": { @@ -3931,7 +4431,7 @@ "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "

How often data is uploaded to the source S3 bucket for the input data. This value is the\n length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout\n for Equipment will upload the real-time data to the source bucket once every 5 minutes.\n This frequency also determines how often Amazon Lookout for Equipment starts a scheduled\n inference on your data. In this example, it starts once every 5 minutes.

" + "smithy.api#documentation": "

How often data is uploaded to the source S3 bucket for the input data. This value is the\n length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout\n for Equipment will upload the real-time data to the source bucket once every 5 minutes.\n This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your\n data. In this example, it starts once every 5 minutes.

" } }, "LatestInferenceResult": { @@ -4046,7 +4546,7 @@ "KeyPattern": { "target": "com.amazonaws.lookoutequipment#KeyPattern", "traits": { - "smithy.api#documentation": "

\n\t\t\t The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

\n

Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)

" + "smithy.api#documentation": "

The pattern for matching the Amazon S3 files that will be used for ingestion.\n If the schema was created previously without any KeyPattern, then the default KeyPattern\n {prefix}/{component_name}/* is used to download files from Amazon S3 according to\n the schema. This field is required when ingestion is being done for the first time.

\n

Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* |\n {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore,\n hyphen)

" } } }, @@ -4177,30 +4677,30 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the label group.\n

" + "smithy.api#documentation": "

The name of the label group.

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the label group.

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time at which the label group was created.\n

" + "smithy.api#documentation": "

The time at which the label group was created.

" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time at which the label group was updated.\n

" + "smithy.api#documentation": "

The time at which the label group was updated.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains information about the label group.\n

" + "smithy.api#documentation": "

Contains information about the label group.

" } }, "com.amazonaws.lookoutequipment#LabelId": { @@ -4248,60 +4748,60 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the label group.\n

" + "smithy.api#documentation": "

The name of the label group.

" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\n The ID of the label.\n

" + "smithy.api#documentation": "

The ID of the label.

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the label group.

" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The timestamp indicating the start of the label.\n

" + "smithy.api#documentation": "

The timestamp indicating the start of the label.

" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The timestamp indicating the end of the label.\n

" + "smithy.api#documentation": "

The timestamp indicating the end of the label.

" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "

\n Indicates whether a labeled event represents an anomaly.\n

" + "smithy.api#documentation": "

Indicates whether a labeled event represents an anomaly.

" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "

\n Indicates the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

Indicates the type of anomaly associated with the label.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\n Indicates that a label pertains to a particular piece of equipment.\n

" + "smithy.api#documentation": "

Indicates that a label pertains to a particular piece of equipment.

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time at which the label was created.\n

" + "smithy.api#documentation": "

The time at which the label was created.

" } } }, "traits": { - "smithy.api#documentation": "

\n Information about the label.\n

" + "smithy.api#documentation": "

Information about the label.

" } }, "com.amazonaws.lookoutequipment#LabelsInputConfiguration": { @@ -4316,7 +4816,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -4608,14 +5108,14 @@ "IntervalStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Lookout for Equipment will return all the inference events with an end time equal to or greater than the\n start time given.

", + "smithy.api#documentation": "

Lookout for Equipment will return all the inference events with an end time equal to or greater than\n the start time given.

", "smithy.api#required": {} } }, "IntervalEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Returns all the inference events with an end start time equal to or greater than less than the end time given.

", + "smithy.api#documentation": "

Returns all the inference events with an end start time equal to or greater than less\n than the end time given.

", "smithy.api#required": {} } } @@ -4703,13 +5203,13 @@ "DataStartTimeAfter": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The time reference in the inferenced dataset after which Amazon Lookout for Equipment\n started the inference execution.

" + "smithy.api#documentation": "

The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference\n execution.

" } }, "DataEndTimeBefore": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

The time reference in the inferenced dataset before which Amazon Lookout for Equipment\n stopped the inference execution.

" + "smithy.api#documentation": "

The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the\n inference execution.

" } }, "Status": { @@ -4798,7 +5298,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model used by the inference scheduler to be listed.

" + "smithy.api#documentation": "

The name of the machine learning model used by the inference scheduler to be listed.\n

" } }, "Status": { @@ -4855,7 +5355,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of the label groups.\n

", + "smithy.api#documentation": "

Returns a list of the label groups.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4869,19 +5369,19 @@ "LabelGroupNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The beginning of the name of the label groups to be listed.\n

" + "smithy.api#documentation": "

The beginning of the name of the label groups to be listed.

" } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of label groups.\n

" + "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of label groups.\n

" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "

\n Specifies the maximum number of label groups to list.\n

" + "smithy.api#documentation": "

Specifies the maximum number of label groups to list.

" } } }, @@ -4895,13 +5395,13 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of label groups.\n

" + "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of label groups.\n

" } }, "LabelGroupSummaries": { "target": "com.amazonaws.lookoutequipment#LabelGroupSummaries", "traits": { - "smithy.api#documentation": "

\n A summary of the label groups.\n

" + "smithy.api#documentation": "

A summary of the label groups.

" } } }, @@ -4932,7 +5432,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Provides a list of labels.\n

", + "smithy.api#documentation": "

Provides a list of labels.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4946,44 +5446,44 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n Retruns the name of the label group.\n

", + "smithy.api#documentation": "

Retruns the name of the label group.

", "smithy.api#required": {} } }, "IntervalStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n Returns all the labels with a end time equal to or later than the start time given.\n

" + "smithy.api#documentation": "

Returns all the labels with a end time equal to or later than the start time given.\n

" } }, "IntervalEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\n Returns all labels with a start time earlier than the end time given.\n

" + "smithy.api#documentation": "

Returns all labels with a start time earlier than the end time given.

" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "

\n Returns labels with a particular fault code.\n

" + "smithy.api#documentation": "

Returns labels with a particular fault code.

" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\n Lists the labels that pertain to a particular piece of equipment.\n

" + "smithy.api#documentation": "

Lists the labels that pertain to a particular piece of equipment.

" } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of label groups.\n

" + "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of label groups.\n

" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "

\n Specifies the maximum number of labels to list.\n

" + "smithy.api#documentation": "

Specifies the maximum number of labels to list.

" } } }, @@ -4997,13 +5497,13 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of datasets.\n

" + "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of datasets.\n

" } }, "LabelSummaries": { "target": "com.amazonaws.lookoutequipment#LabelSummaries", "traits": { - "smithy.api#documentation": "

\n A summary of the items in the label group.\n

" + "smithy.api#documentation": "

A summary of the items in the label group.

" } } }, @@ -5037,7 +5537,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a list of all model versions for a given model, \n including the model version, model version ARN, and status. To list a \n subset of versions, use the MaxModelVersion and MinModelVersion fields.

", + "smithy.api#documentation": "

Generates a list of all model versions for a given model, including the model version,\n model version ARN, and status. To list a subset of versions, use the\n MaxModelVersion and MinModelVersion fields.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5051,14 +5551,14 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

Then name of the machine learning model for which the \n model versions are to be listed.

", + "smithy.api#documentation": "

Then name of the machine learning model for which the model versions are to be\n listed.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.

" + "smithy.api#documentation": "

If the total number of results exceeds the limit that the response can display, the\n response returns an opaque pagination token indicating where to continue the listing of\n machine learning model versions. Use this token in the NextToken field in the\n request to list the next page of results.

" } }, "MaxResults": { @@ -5114,13 +5614,13 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.

" + "smithy.api#documentation": "

If the total number of results exceeds the limit that the response can display, the\n response returns an opaque pagination token indicating where to continue the listing of\n machine learning model versions. Use this token in the NextToken field in the\n request to list the next page of results.

" } }, "ModelVersionSummaries": { "target": "com.amazonaws.lookoutequipment#ModelVersionSummaries", "traits": { - "smithy.api#documentation": "

Provides information on the specified model version, \n including the created time, model and dataset ARNs, and status.

" + "smithy.api#documentation": "

Provides information on the specified model version, including the created time, model\n and dataset ARNs, and status.

" } } }, @@ -5165,31 +5665,31 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of ML models.\n

" + "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of machine learning\n models.

" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of ML models to list.

" + "smithy.api#documentation": "

Specifies the maximum number of machine learning models to list.

" } }, "Status": { "target": "com.amazonaws.lookoutequipment#ModelStatus", "traits": { - "smithy.api#documentation": "

The status of the ML model.

" + "smithy.api#documentation": "

The status of the machine learning model.

" } }, "ModelNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The beginning of the name of the ML models being listed.

" + "smithy.api#documentation": "

The beginning of the name of the machine learning models being listed.

" } }, "DatasetNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "

The beginning of the name of the dataset of the ML models to be listed.

" + "smithy.api#documentation": "

The beginning of the name of the dataset of the machine learning models to be listed.\n

" } } }, @@ -5203,7 +5703,7 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of ML models.\n

" + "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of machine learning\n models.

" } }, "ModelSummaries": { @@ -5228,6 +5728,126 @@ } } }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulersRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all retraining schedulers in your account, filtering by model name prefix and\n status.

", + "smithy.api#examples": [ + { + "title": "Listing retraining schedulers", + "documentation": "", + "input": { + "MaxResults": 50 + }, + "output": { + "RetrainingSchedulerSummaries": [ + { + "ModelName": "sample-model-1", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "RUNNING", + "RetrainingStartDate": "2023-06-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P180D" + }, + { + "ModelName": "sample-model-2", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Status": "RUNNING", + "RetrainingStartDate": "2023-08-15T00:00:00Z", + "RetrainingFrequency": "P30D", + "LookbackWindow": "P180D" + }, + { + "ModelName": "sample-model-3", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "Status": "STOPPED", + "RetrainingStartDate": "2023-09-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulersRequest": { + "type": "structure", + "members": { + "ModelNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

Specify this field to only list retraining schedulers whose machine learning models\n begin with the value you specify.

" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

Specify this field to only list retraining schedulers whose status matches the value you\n specify.

" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "

If the number of results exceeds the maximum, a pagination token is returned. Use the\n token in the request to show the next page of retraining schedulers.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of retraining schedulers to list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulersResponse": { + "type": "structure", + "members": { + "RetrainingSchedulerSummaries": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerSummaries", + "traits": { + "smithy.api#documentation": "

Provides information on the specified retraining scheduler, including the model name,\n model ARN, status, and start date.

" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "

If the number of results exceeds the maximum, this pagination token is returned. Use\n this token in the request to show the next page of retraining schedulers.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#ListSensorStatistics": { "type": "operation", "input": { @@ -5373,6 +5993,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#LookbackWindow": { + "type": "string", + "traits": { + "smithy.api#pattern": "^P180D$|^P360D$|^P540D$|^P720D$" + } + }, "com.amazonaws.lookoutequipment#MaxResults": { "type": "integer", "traits": { @@ -5448,6 +6074,23 @@ "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" } }, + "com.amazonaws.lookoutequipment#ModelPromoteMode": { + "type": "enum", + "members": { + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, "com.amazonaws.lookoutequipment#ModelStatus": { "type": "enum", "members": { @@ -5489,19 +6132,19 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model.

" + "smithy.api#documentation": "

The name of the machine learning model.

" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model.

" } }, "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "

The name of the dataset being used for the ML model.

" + "smithy.api#documentation": "

The name of the dataset being used for the machine learning model.

" } }, "DatasetArn": { @@ -5513,7 +6156,7 @@ "Status": { "target": "com.amazonaws.lookoutequipment#ModelStatus", "traits": { - "smithy.api#documentation": "

Indicates the status of the ML model.

" + "smithy.api#documentation": "

Indicates the status of the machine learning model.

" } }, "CreatedAt": { @@ -5531,12 +6174,42 @@ "ActiveModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version that is set as active. The active model version \n is the model version that the inference scheduler uses to run an inference\n execution.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version that is set as active. The active\n model version is the model version that the inference scheduler uses to run an inference\n execution.

" + } + }, + "LatestScheduledRetrainingStatus": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the most recent scheduled retraining run.

" + } + }, + "LatestScheduledRetrainingModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

Indicates the most recent model version that was generated by retraining.

" + } + }, + "LatestScheduledRetrainingStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the start time of the most recent scheduled retraining run.

" + } + }, + "NextScheduledRetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates\n the time you provide to the nearest UTC day.

" + } + }, + "RetrainingSchedulerStatus": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the retraining scheduler.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status.

" + "smithy.api#documentation": "

Provides information about the specified machine learning model, including dataset and\n model names and ARNs, as well as status.

" } }, "com.amazonaws.lookoutequipment#ModelVersion": { @@ -5633,7 +6306,7 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model that this model version is a version of.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model that this model version is a version\n of.

" } }, "ModelVersion": { @@ -5820,7 +6493,7 @@ "ResourceArn": { "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the \n policy is being created.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the policy is being\n created.

", "smithy.api#required": {} } }, @@ -5840,7 +6513,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. \n If you do not set the client request token, Amazon Lookout for Equipment \n generates one.

", + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -5856,7 +6529,7 @@ "ResourceArn": { "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the \n policy was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the policy was created.

" } }, "PolicyRevisionId": { @@ -5896,22 +6569,111 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.lookoutequipment#S3Bucket": { + "com.amazonaws.lookoutequipment#RetrainingFrequency": { "type": "string", "traits": { "smithy.api#length": { - "min": 3, - "max": 63 + "min": 1, + "max": 10 }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + "smithy.api#pattern": "^P(\\dY)?(\\d{1,2}M)?(\\d{1,3}D)?$" } }, - "com.amazonaws.lookoutequipment#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 + "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.lookoutequipment#RetrainingSchedulerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerSummary" + } + }, + "com.amazonaws.lookoutequipment#RetrainingSchedulerSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model that the retraining scheduler is attached to.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model that the retraining scheduler is attached to.

" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

The status of the retraining scheduler.

" + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.

" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "

The frequency at which the model retraining is set. This follows the ISO 8601\n guidelines.

" + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "

The number of past days of data used for retraining.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the specified retraining scheduler, including model name,\n status, start date, frequency, and lookback window.

" + } + }, + "com.amazonaws.lookoutequipment#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.lookoutequipment#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 }, "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,1024}[^/]$" } @@ -6114,7 +6876,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.\n

" + "smithy.api#documentation": "

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

" } }, "com.amazonaws.lookoutequipment#StartDataIngestionJobRequest": { @@ -6227,13 +6989,13 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model being used by the inference\n scheduler.

" } }, "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model being used by the inference scheduler.

" + "smithy.api#documentation": "

The name of the machine learning model being used by the inference scheduler.

" } }, "InferenceSchedulerName": { @@ -6259,6 +7021,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#StartRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StartRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StartRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a retraining scheduler.

", + "smithy.api#examples": [ + { + "title": "Starts a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "PENDING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#StartRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model whose retraining scheduler you want to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StartRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model whose retraining scheduler is being started.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model whose retraining scheduler is being started.

" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

The status of the retraining scheduler.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { "type": "enum", "members": { @@ -6329,13 +7178,13 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being\n stopped.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model used by the inference\n scheduler being stopped.

" } }, "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model used by the inference scheduler being stopped.

" + "smithy.api#documentation": "

The name of the machine learning model used by the inference scheduler being stopped.\n

" } }, "InferenceSchedulerName": { @@ -6361,6 +7210,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#StopRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StopRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StopRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a retraining scheduler.

", + "smithy.api#examples": [ + { + "title": "Stops a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "STOPPING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#StopRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model whose retraining scheduler you want to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StopRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model whose retraining scheduler is being stopped.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model whose retraining scheduler is being stopped.

" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "

The status of the retraining scheduler.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema": { "type": "string", "traits": { @@ -6466,7 +7402,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a given tag to a resource in your account. A tag is a key-value pair which\n can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for\n organizing your resources as well as helping you to search and filter by tag. Multiple tags\n can be added to a resource, either when you create it, or later. Up to 50 tags can be\n associated with each resource.

" + "smithy.api#documentation": "

Associates a given tag to a resource in your account. A tag is a key-value pair which\n can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your\n resources as well as helping you to search and filter by tag. Multiple tags can be added to\n a resource, either when you create it, or later. Up to 50 tags can be associated with each\n resource.

" } }, "com.amazonaws.lookoutequipment#TagResourceRequest": { @@ -6715,14 +7651,14 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the machine learning model for which the active model version \n is being set.

", + "smithy.api#documentation": "

The name of the machine learning model for which the active model version is being\n set.

", "smithy.api#required": {} } }, "ModelVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "

The version of the machine learning model for which the active model version \n is being set.

", + "smithy.api#documentation": "

The version of the machine learning model for which the active model version is being\n set.

", "smithy.api#required": {} } } @@ -6737,37 +7673,37 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the machine learning model for which the active model version was set.

" + "smithy.api#documentation": "

The name of the machine learning model for which the active model version was\n set.

" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model for which \n the active model version was set.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model for which the active model\n version was set.

" } }, "CurrentActiveVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "

The version that is currently active of the machine learning model \n for which the active model version was set.

" + "smithy.api#documentation": "

The version that is currently active of the machine learning model for which the active\n model version was set.

" } }, "PreviousActiveVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "

The previous version that was active of the machine learning model \n for which the active model version was set.

" + "smithy.api#documentation": "

The previous version that was active of the machine learning model for which the active\n model version was set.

" } }, "CurrentActiveVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model version that is the\n current active model version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model version that is the current\n active model version.

" } }, "PreviousActiveVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model version that was the\n previous active model version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model version that was the\n previous active model version.

" } } }, @@ -6826,7 +7762,7 @@ "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "

How often data is uploaded to the source S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon\n Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment starts a\n scheduled inference on your data. In this example, it starts once every 5 minutes.

" + "smithy.api#documentation": "

How often data is uploaded to the source S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon\n Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on\n your data. In this example, it starts once every 5 minutes.

" } }, "DataInputConfiguration": { @@ -6881,7 +7817,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Updates the label group.\n

" + "smithy.api#documentation": "

Updates the label group.

" } }, "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest": { @@ -6890,14 +7826,164 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\n The name of the label group to be updated.\n

", + "smithy.api#documentation": "

The name of the label group to be updated.

", "smithy.api#required": {} } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "

\n Updates the code indicating the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

Updates the code indicating the type of anomaly associated with the label.

\n

Data in this field will be retained for service usage. Follow best practices for the\n security of your data.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a model in the account.

", + "smithy.api#examples": [ + { + "title": "Updates a model", + "documentation": "", + "input": { + "ModelName": "sample-model", + "LabelsInputConfiguration": { + "LabelGroupName": "sample-label-group" + } + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#UpdateModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model to update.

", + "smithy.api#required": {} + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model to update.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateRetrainingSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a retraining scheduler.

", + "smithy.api#examples": [ + { + "title": "Updates a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model", + "RetrainingStartDate": "2024-01-01T00:00:00Z", + "RetrainingFrequency": "P1Y" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#UpdateRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the model whose retraining scheduler you want to update.

", + "smithy.api#required": {} + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.

" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "

This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in\n terms of Years, Months, and/or Days (note: other parameters like Time are not currently\n supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For\n example, the following values are valid:

\n " + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "

The number of past days of data that will be used for retraining.

" + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "

Indicates how the service will use new models. In MANAGED mode, new models\n will automatically be used for inference if they have better performance than the current\n model. In MANUAL mode, the new models will not be used until they\n are manually activated.

" } } }, @@ -6916,7 +8002,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a\n related Amazon Web Services service that's being utilized.

", + "smithy.api#documentation": "

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services\n service that's being utilized.

", "smithy.api#error": "client", "smithy.api#httpError": 400 }