The desired number of streaming instances.
", + "ComputeCapacity$DesiredSessions": "The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
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.
", "ComputeCapacityStatus$Desired": "The desired number of streaming instances.
", "ComputeCapacityStatus$Running": "The total number of simultaneous streaming instances that are running.
", "ComputeCapacityStatus$InUse": "The number of instances in use for streaming.
", "ComputeCapacityStatus$Available": "The number of currently available instances that can be used to stream sessions.
", - "CreateFleetRequest$MaxUserDurationInSeconds": "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.
Specify a value between 600 and 360000.
", + "ComputeCapacityStatus$DesiredUserSessions": "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.
DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
This only applies to multi-session fleets.
", + "ComputeCapacityStatus$AvailableUserSessions": "The number of idle session slots currently available for user sessions.
AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
This only applies to multi-session fleets.
", + "ComputeCapacityStatus$ActiveUserSessions": "The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
", + "ComputeCapacityStatus$ActualUserSessions": "The total number of session slots that are available for streaming or are currently streaming.
ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
This only applies to multi-session fleets.
", + "CreateFleetRequest$MaxUserDurationInSeconds": "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.
Specify a value between 600 and 432000.
", "CreateFleetRequest$DisconnectTimeoutInSeconds": "The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 360000.
", "CreateFleetRequest$IdleDisconnectTimeoutInSeconds": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
", + "CreateFleetRequest$MaxSessionsPerInstance": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
", "DescribeAppBlockBuilderAppBlockAssociationsRequest$MaxResults": "The maximum size of each page of results.
", "DescribeAppBlockBuildersRequest$MaxResults": "The maximum size of each page of results. The maximum value is 25.
", "DescribeAppBlocksRequest$MaxResults": "The maximum size of each page of results.
", @@ -1342,12 +1348,14 @@ "Fleet$DisconnectTimeoutInSeconds": "The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 360000.
", "Fleet$IdleDisconnectTimeoutInSeconds": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
The maximum number of concurrent sessions for the fleet.
", + "Fleet$MaxSessionsPerInstance": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
", "ListEntitledApplicationsRequest$MaxResults": "The maximum size of each page of results.
", "ScriptDetails$TimeoutInSeconds": "The run timeout, in seconds, for the script.
", "UpdateFleetRequest$MaxUserDurationInSeconds": "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.
Specify a value between 600 and 432000.
", "UpdateFleetRequest$DisconnectTimeoutInSeconds": "The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 360000.
", "UpdateFleetRequest$IdleDisconnectTimeoutInSeconds": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
The maximum number of concurrent sessions for a fleet.
" + "UpdateFleetRequest$MaxConcurrentSessions": "The maximum number of concurrent sessions for a fleet.
", + "UpdateFleetRequest$MaxSessionsPerInstance": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
" } }, "InvalidAccountStatusException": { @@ -1486,6 +1494,8 @@ "DescribeEntitlementsRequest$StackName": "The name of the stack with which the entitlement is associated.
", "DescribeImagePermissionsRequest$Name": "The name of the private image for which to describe permissions. The image must be one that you own.
", "DescribeImagePermissionsResult$Name": "The name of the private image.
", + "DescribeSessionsRequest$StackName": "The name of the stack. This value is case-sensitive.
", + "DescribeSessionsRequest$FleetName": "The name of the fleet. This value is case-sensitive.
", "DisassociateAppBlockBuilderAppBlockRequest$AppBlockBuilderName": "The name of the app block builder.
", "DisassociateApplicationFleetRequest$FleetName": "The name of the fleet.
", "DisassociateApplicationFromEntitlementRequest$StackName": "The name of the stack with which the entitlement is associated.
", @@ -1500,6 +1510,7 @@ "UpdateApplicationRequest$Name": "The name of the application. This name is visible to users when display name is not specified.
", "UpdateEntitlementRequest$Name": "The name of the entitlement.
", "UpdateEntitlementRequest$StackName": "The name of the stack with which the entitlement is associated.
", + "UpdateFleetRequest$Name": "A unique name for the fleet.
", "UpdateImagePermissionsRequest$Name": "The name of the private image.
" } }, @@ -1929,9 +1940,8 @@ "DescribeImagePermissionsResult$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "DescribeImagesRequest$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
", "DescribeImagesResult$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", - "DescribeSessionsRequest$StackName": "The name of the stack. This value is case-sensitive.
", - "DescribeSessionsRequest$FleetName": "The name of the fleet. This value is case-sensitive.
", "DescribeSessionsRequest$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
", + "DescribeSessionsRequest$InstanceId": "The identifier for the instance hosting the session.
", "DescribeSessionsResult$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "DescribeStacksRequest$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
", "DescribeStacksResult$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", @@ -1987,6 +1997,7 @@ "Session$Id": "The identifier of the streaming session.
", "Session$StackName": "The name of the stack for the streaming session.
", "Session$FleetName": "The name of the fleet for the streaming session.
", + "Session$InstanceId": "The identifier for the instance hosting the session.
", "Stack$Name": "The name of the stack.
", "Stack$Description": "The description to display.
", "Stack$DisplayName": "The stack name to display.
", @@ -2002,7 +2013,6 @@ "UpdateApplicationRequest$WorkingDirectory": "The working directory of the application.
", "UpdateApplicationRequest$LaunchParameters": "The launch parameters of the application.
", "UpdateFleetRequest$ImageName": "The name of the image used to create the fleet.
", - "UpdateFleetRequest$Name": "A unique name for the fleet.
", "UpdateFleetRequest$InstanceType": "The instance type to use when launching fleet instances. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
The following instance types are available for Elastic fleets:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
The name of the stack.
", "UsageReportSubscription$S3BucketName": "The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
", diff --git a/models/apis/appstream/2016-12-01/endpoint-rule-set-1.json b/models/apis/appstream/2016-12-01/endpoint-rule-set-1.json index cb742758cfb..28c0f984e51 100644 --- a/models/apis/appstream/2016-12-01/endpoint-rule-set-1.json +++ b/models/apis/appstream/2016-12-01/endpoint-rule-set-1.json @@ -58,52 +58,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", @@ -111,13 +115,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -127,274 +140,225 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "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" } ] } \ No newline at end of file diff --git a/models/apis/appstream/2016-12-01/waiters-2.json b/models/apis/appstream/2016-12-01/waiters-2.json index 1c8dea0ded5..f53f609cb7c 100644 --- a/models/apis/appstream/2016-12-01/waiters-2.json +++ b/models/apis/appstream/2016-12-01/waiters-2.json @@ -10,19 +10,19 @@ "state": "success", "matcher": "pathAll", "argument": "Fleets[].State", - "expected": "RUNNING" + "expected": "ACTIVE" }, { "state": "failure", "matcher": "pathAny", "argument": "Fleets[].State", - "expected": "STOPPING" + "expected": "PENDING_DEACTIVATE" }, { "state": "failure", "matcher": "pathAny", "argument": "Fleets[].State", - "expected": "STOPPED" + "expected": "INACTIVE" } ] }, @@ -35,19 +35,19 @@ "state": "success", "matcher": "pathAll", "argument": "Fleets[].State", - "expected": "STOPPED" + "expected": "INACTIVE" }, { "state": "failure", "matcher": "pathAny", "argument": "Fleets[].State", - "expected": "STARTING" + "expected": "PENDING_ACTIVATE" }, { "state": "failure", "matcher": "pathAny", "argument": "Fleets[].State", - "expected": "RUNNING" + "expected": "ACTIVE" } ] } diff --git a/models/apis/cloudformation/2010-05-15/docs-2.json b/models/apis/cloudformation/2010-05-15/docs-2.json index b52080455a5..d5123319923 100644 --- a/models/apis/cloudformation/2010-05-15/docs-2.json +++ b/models/apis/cloudformation/2010-05-15/docs-2.json @@ -282,13 +282,13 @@ "refs": { "CreateChangeSetInput$Capabilities": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
", "GetTemplateSummaryOutput$Capabilities": "The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
", "Stack$Capabilities": "The capabilities allowed in the stack.
", "StackSet$Capabilities": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
", "UpdateStackInput$Capabilities": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
" } }, @@ -2164,11 +2164,11 @@ "RetainExceptOnCreate": { "base": null, "refs": { - "CreateStackInput$RetainExceptOnCreate": "This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are retained. RetainExceptOnCreate can be specified for any resource that supports the DeletionPolicy attribute.
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are retained. RetainExceptOnCreate can be specified for any resource that supports the DeletionPolicy attribute.
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are retained. RetainExceptOnCreate can be specified for any resource that supports the DeletionPolicy attribute.
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are retained. RetainExceptOnCreate can be specified for any resource that supports the DeletionPolicy attribute.
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are retained. RetainExceptOnCreate can be specified for any resource that supports the DeletionPolicy attribute.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.
Default: false
When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.
Default: false
When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.
Default: false
When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.
Default: false
When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.
Default: false
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
", "CreateChangeSetInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
", "CreateStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
", - "CreateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", + "CreateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", "DeleteStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
", "RollbackStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.
", "Stack$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
", - "StackSet$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", - "StackSetOperation$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
", + "StackSet$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
", + "StackSetOperation$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
", "UpdateStackInput$RoleARN": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
", - "UpdateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
" + "UpdateStackSetInput$AdministrationRoleARN": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
" } }, "RoleArn": { @@ -2494,7 +2494,7 @@ "DescribeStackEventsInput$StackName": "The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
", "DescribeStackResourceInput$StackName": "The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
", "DescribeStackResourcesInput$StackName": "The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
Required: Conditional. If you don't specify StackName, you must specify PhysicalResourceId.
If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account. This requires ListStacks and DescribeStacks permissions.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:
{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
", + "DescribeStacksInput$StackName": "If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to StackName.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:
{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
", "GetStackPolicyInput$StackName": "The name or unique stack ID that's associated with the stack whose policy you want to get.
", "GetTemplateInput$StackName": "The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
", "Imports$member": null, diff --git a/models/apis/entityresolution/2018-05-10/api-2.json b/models/apis/entityresolution/2018-05-10/api-2.json index 0e7ef7a3704..7e480b8d2ee 100644 --- a/models/apis/entityresolution/2018-05-10/api-2.json +++ b/models/apis/entityresolution/2018-05-10/api-2.json @@ -367,7 +367,10 @@ }, "CreateSchemaMappingInput":{ "type":"structure", - "required":["schemaName"], + "required":[ + "mappedInputFields", + "schemaName" + ], "members":{ "description":{"shape":"Description"}, "mappedInputFields":{"shape":"SchemaInputAttributes"}, @@ -451,7 +454,9 @@ "ExceedsLimitException":{ "type":"structure", "members":{ - "message":{"shape":"ErrorMessage"} + "message":{"shape":"ErrorMessage"}, + "quotaName":{"shape":"String"}, + "quotaValue":{"shape":"Integer"} }, "error":{ "httpStatusCode":402, @@ -825,7 +830,7 @@ "KMSArn":{"shape":"KMSArn"}, "applyNormalization":{"shape":"Boolean"}, "output":{"shape":"OutputSourceOutputList"}, - "outputS3Path":{"shape":"OutputSourceOutputS3PathString"} + "outputS3Path":{"shape":"S3Path"} } }, "OutputSourceConfig":{ @@ -840,10 +845,6 @@ "max":750, "min":0 }, - "OutputSourceOutputS3PathString":{ - "type":"string", - "pattern":"^s3://([^/]+)/?(.*?([^/]+)/?)$" - }, "RecordAttributeMap":{ "type":"map", "key":{"shape":"RecordAttributeMapKeyString"}, @@ -864,6 +865,7 @@ }, "ResolutionTechniques":{ "type":"structure", + "required":["resolutionType"], "members":{ "resolutionType":{"shape":"ResolutionType"}, "ruleBasedProperties":{"shape":"RuleBasedProperties"} @@ -927,6 +929,10 @@ "min":0, "pattern":"^[a-zA-Z_0-9- \\t]*$" }, + "S3Path":{ + "type":"string", + "pattern":"^s3://([^/]+)/?(.*?([^/]+)/?)$" + }, "SchemaAttributeType":{ "type":"string", "enum":[ diff --git a/models/apis/entityresolution/2018-05-10/docs-2.json b/models/apis/entityresolution/2018-05-10/docs-2.json index 4200b328b9b..ef2839635c7 100644 --- a/models/apis/entityresolution/2018-05-10/docs-2.json +++ b/models/apis/entityresolution/2018-05-10/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Welcome to the AWS Entity Resolution API Reference.
AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.
With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, such as name, email address, and phone number. This holds true even when these records have incomplete or conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a customer relationship management (CRM) system, which includes account information like first name, last name, postal address, phone number, and email address, with a source record from a marketing system containing campaign information, such as username and email address.
To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the AWS Entity Resolution User Guide.
", + "service": "Welcome to the Entity Resolution API Reference.
Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.
With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, Entity Resolution can effectively match a source record from a customer relationship management (CRM) system with a source record from a marketing system containing campaign information.
To learn more about Entity Resolution concepts, procedures, and best practices, see the Entity Resolution User Guide.
", "operations": { "CreateMatchingWorkflow": "Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.
Returns the MatchingWorkflow with a given name, if it exists.
Returns the SchemaMapping of a given name.
", "ListMatchingJobs": "Lists all jobs for a given workflow.
", - "ListMatchingWorkflows": "Returns a list of all the MatchingWorkflows that have been created for an AWS account.
Returns a list of all the SchemaMappings that have been created for an AWS account.
Displays the tags associated with an AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.
Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
Removes one or more tags from the specified AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Updates an existing MatchingWorkflow. This method is identical to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.
You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.
The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email type. When choosing ONE_TO_ONE ,the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.
A string containing the field name.
", "SchemaInputAttribute$groupName": "Instruct Entity Resolution to combine several columns into a unified column with the identical attribute type. For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common GroupName will prompt Entity Resolution to concatenate them into a single value.
A key that allows grouping of multiple input attributes into a unified matching group. For example, let's consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning the MatchKey Address' to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group. If no MatchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.
A key that allows grouping of multiple input attributes into a unified matching group. For example, let's consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning the MatchKey Address to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group. If no MatchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.
The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
The current quota value for the customers.
", "JobMetrics$inputRecords": "The total number of input records.
", "JobMetrics$matchIDs": "The total number of matchIDs generated.
The total number of records that did not get processed,
", + "JobMetrics$recordsNotProcessed": "The total number of records that did not get processed.
", "JobMetrics$totalRecordsProcessed": "The total number of records processed.
" } }, "InternalServerException": { - "base": "This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
" + "ListMatchingJobsOutput$jobs": "A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
The current status of the job. Either running, succeeded, queued, or failed.
The current status of the job. Either running, succeeded, queued, or failed.
The current status of the job.
", + "JobSummary$status": "The current status of the job.
" } }, "JobSummary": { @@ -377,13 +378,13 @@ } }, "OutputAttribute": { - "base": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
The S3 path to which Entity Resolution will write the output table.
" + "OutputSource$output": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
An object which defines the resolutionType and the ruleBasedProperties
An object which defines the resolutionType and the ruleBasedProperties.
An object which defines the resolutionType and the ruleBasedProperties
An object which defines the resolutionType and the ruleBasedProperties
An object which defines the resolutionType and the ruleBasedProperties
An object which defines the resolutionType and the ruleBasedProperties
An object which defines the resolutionType and the ruleBasedProperties.
An object which defines the resolutionType and the ruleBasedProperties.
An object which defines the resolutionType and the ruleBasedProperties.
An object which defines the resolutionType and the ruleBasedProperties.
An object which defines the resolutionType and the ruleBasedProperties
There are two types of matching, RULE_MATCHING and ML_MATCHING
The type of matching. There are two types of matching: RULE_MATCHING and ML_MATCHING.
A list of Rule objects, each of which have fields RuleName and MatchingKeys.
A list of Rule objects, each of which have fields RuleName and MatchingKeys.
A name for the matching rule.
" } }, + "S3Path": { + "base": null, + "refs": { + "OutputSource$outputS3Path": "The S3 path to which Entity Resolution will write the output table.
" + } + }, "SchemaAttributeType": { "base": null, "refs": { @@ -532,14 +533,15 @@ "String": { "base": null, "refs": { - "CreateMatchingWorkflowInput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
", - "CreateMatchingWorkflowOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
", + "CreateMatchingWorkflowInput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
", + "CreateMatchingWorkflowOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
", "DeleteMatchingWorkflowOutput$message": "A successful operation message.
", "DeleteSchemaMappingOutput$message": "A successful operation message.
", + "ExceedsLimitException$quotaName": "The name of the quota that has been breached.
", "GetMatchIdOutput$matchId": "The unique identifiers for this group of match records.
", - "GetMatchingWorkflowOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access resources on your behalf.
", - "UpdateMatchingWorkflowInput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
", - "UpdateMatchingWorkflowOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" + "GetMatchingWorkflowOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.
", + "UpdateMatchingWorkflowInput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
", + "UpdateMatchingWorkflowOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
" } }, "TagKey": { @@ -625,7 +627,7 @@ } }, "ValidationException": { - "base": "The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
Creates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.
", "CreateLabel": "Creates a label for an event.
", "CreateLabelGroup": "Creates a group of labels.
", - "CreateModel": "Creates an ML model for data inference.
A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred.
Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.
", + "CreateModel": "Creates a machine learning model for data inference.
A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred.
Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.
", + "CreateRetrainingScheduler": "Creates a retraining scheduler on the specified model.
", "DeleteDataset": "Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.
", - "DeleteInferenceScheduler": "Deletes an inference scheduler that has been set up. Already processed output results are not affected.
", + "DeleteInferenceScheduler": "Deletes an inference scheduler that has been set up. Prior inference results will not be deleted.
", "DeleteLabel": "Deletes a label.
", "DeleteLabelGroup": "Deletes a group of labels.
", - "DeleteModel": "Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.
", + "DeleteModel": "Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.
", "DeleteResourcePolicy": "Deletes the resource policy attached to the resource.
", + "DeleteRetrainingScheduler": "Deletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.
Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.
", "DescribeDataset": "Provides a JSON description of the data in each time series dataset, including names, column names, and data types.
", "DescribeInferenceScheduler": "Specifies information about the inference scheduler being used, including name, model, status, and associated metadata
", "DescribeLabel": "Returns the name of the label.
", "DescribeLabelGroup": "Returns information about the label group.
", - "DescribeModel": "Provides a JSON containing the overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.
", + "DescribeModel": "Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.
", "DescribeModelVersion": "Retrieves information about a specific machine learning model version.
", "DescribeResourcePolicy": "Provides the details of a resource policy attached to a resource.
", + "DescribeRetrainingScheduler": "Provides a description of the retraining scheduler, including information such as the model name and retraining parameters.
", "ImportDataset": "Imports a dataset.
", "ImportModelVersion": "Imports a model that has been trained successfully.
", "ListDataIngestionJobs": "Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.
", @@ -32,17 +35,22 @@ "ListLabels": "Provides a list of labels.
", "ListModelVersions": "Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.
Generates a list of all models in the account, including model name and ARN, dataset, and status.
", + "ListRetrainingSchedulers": "Lists all retraining schedulers in your account, filtering by model name prefix and status.
", "ListSensorStatistics": "Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.
", "ListTagsForResource": "Lists all the tags for a specified resource, including key and value.
", "PutResourcePolicy": "Creates a resource control policy for a given resource.
", "StartDataIngestionJob": "Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
", "StartInferenceScheduler": "Starts an inference scheduler.
", + "StartRetrainingScheduler": "Starts a retraining scheduler.
", "StopInferenceScheduler": "Stops an inference scheduler.
", + "StopRetrainingScheduler": "Stops a retraining scheduler.
", "TagResource": "Associates a given tag to a resource in your account. A tag is a key-value pair which can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your resources as well as helping you to search and filter by tag. Multiple tags can be added to a resource, either when you create it, or later. Up to 50 tags can be associated with each resource.
", "UntagResource": "Removes a specific tag from a given resource. The tag is specified by its key.
", "UpdateActiveModelVersion": "Sets the active model version for a given machine learning model.
", "UpdateInferenceScheduler": "Updates an inference scheduler.
", - "UpdateLabelGroup": "Updates the label group.
" + "UpdateLabelGroup": "Updates the label group.
", + "UpdateModel": "Updates a model in the account.
", + "UpdateRetrainingScheduler": "Updates a retraining scheduler.
" }, "shapes": { "AccessDeniedException": { @@ -58,6 +66,18 @@ "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.
" } }, + "AutoPromotionResult": { + "base": null, + "refs": { + "DescribeModelVersionResponse$AutoPromotionResult": "Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.
" + } + }, + "AutoPromotionResultReason": { + "base": null, + "refs": { + "DescribeModelVersionResponse$AutoPromotionResultReason": "Indicates the reason for the AutoPromotionResult. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using MANUAL promote mode. The model will be promoted in MANAGED promote mode if the performance is better than the previous model.
Specifies the reason for failure when a data ingestion job has failed.
", "DescribeDataIngestionJobResponse$StatusDetail": "Provides details about status of the ingestion job that is currently in progress.
", - "DescribeModelResponse$FailedReason": "If the training of the ML model failed, this indicates the reason for that failure.
", + "DescribeModelResponse$FailedReason": "If the training of the machine learning model failed, this indicates the reason for that failure.
", + "DescribeModelResponse$LatestScheduledRetrainingFailedReason": "If the model version was generated by retraining and the training failed, this indicates the reason for that failure.
", "DescribeModelVersionResponse$FailedReason": "The failure message if the training of the model version failed.
", "InferenceExecutionSummary$FailedReason": "Specifies the reason for failure when an inference execution has failed.
", "InternalServerException$Message": null, @@ -170,6 +191,16 @@ "refs": { } }, + "CreateRetrainingSchedulerRequest": { + "base": null, + "refs": { + } + }, + "CreateRetrainingSchedulerResponse": { + "base": null, + "refs": { + } + }, "DataDelayOffsetInMinutes": { "base": null, "refs": { @@ -232,7 +263,7 @@ "DescribeDataIngestionJobResponse$SourceDatasetArn": "The Amazon Resource Name (ARN) of the source dataset from which the data used for the data ingestion job was imported from.
", "DescribeDatasetResponse$DatasetArn": "The Amazon Resource Name (ARN) of the dataset being described.
", "DescribeDatasetResponse$SourceDatasetArn": "The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.
", - "DescribeModelResponse$DatasetArn": "The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
", + "DescribeModelResponse$DatasetArn": "The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model being described.
", "DescribeModelVersionResponse$DatasetArn": "The Amazon Resource Name (ARN) of the dataset used to train the model version.
", "ImportDatasetRequest$SourceDatasetArn": "The Amazon Resource Name (ARN) of the dataset to import.
", "ImportDatasetResponse$DatasetArn": "The Amazon Resource Name (ARN) of the dataset that was imported.
", @@ -242,7 +273,7 @@ "DatasetIdentifier": { "base": null, "refs": { - "CreateModelRequest$DatasetName": "The name of the dataset for the ML model being created.
", + "CreateModelRequest$DatasetName": "The name of the dataset for the machine learning model being created.
", "DeleteDatasetRequest$DatasetName": "The name of the dataset to be deleted.
", "DescribeDatasetRequest$DatasetName": "The name of the dataset to be described.
", "ImportModelVersionRequest$DatasetName": "The name of the dataset for the machine learning model being imported.
", @@ -257,22 +288,22 @@ "DataIngestionJobSummary$DatasetName": "The name of the dataset used for the data ingestion job.
", "DatasetSummary$DatasetName": "The name of the dataset.
", "DescribeDatasetResponse$DatasetName": "The name of the dataset being described.
", - "DescribeModelResponse$DatasetName": "The name of the dataset being used by the ML being described.
", + "DescribeModelResponse$DatasetName": "The name of the dataset being used by the machine learning being described.
", "DescribeModelVersionResponse$DatasetName": "The name of the dataset used to train the model version.
", "ImportDatasetRequest$DatasetName": "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.
", "ImportDatasetResponse$DatasetName": "The name of the created machine learning dataset.
", "ListDataIngestionJobsRequest$DatasetName": "The name of the dataset being used for the data ingestion job.
", "ListDatasetsRequest$DatasetNameBeginsWith": "The beginning of the name of the datasets to be listed.
", - "ListModelsRequest$DatasetNameBeginsWith": "The beginning of the name of the dataset of the ML models to be listed.
", + "ListModelsRequest$DatasetNameBeginsWith": "The beginning of the name of the dataset of the machine learning models to be listed.
", "ListSensorStatisticsRequest$DatasetName": "The name of the dataset associated with the list of Sensor Statistics.
", - "ModelSummary$DatasetName": "The name of the dataset being used for the ML model.
" + "ModelSummary$DatasetName": "The name of the dataset being used for the machine learning model.
" } }, "DatasetSchema": { "base": "Provides information about the data schema used with the given dataset.
", "refs": { "CreateDatasetRequest$DatasetSchema": "A JSON description of the data that is in each time series dataset, including names, column names, and data types.
", - "CreateModelRequest$DatasetSchema": "The data schema for the ML model being created.
" + "CreateModelRequest$DatasetSchema": "The data schema for the machine learning model being created.
" } }, "DatasetStatus": { @@ -326,6 +357,11 @@ "refs": { } }, + "DeleteRetrainingSchedulerRequest": { + "base": null, + "refs": { + } + }, "DescribeDataIngestionJobRequest": { "base": null, "refs": { @@ -406,6 +442,16 @@ "refs": { } }, + "DescribeRetrainingSchedulerRequest": { + "base": null, + "refs": { + } + }, + "DescribeRetrainingSchedulerResponse": { + "base": null, + "refs": { + } + }, "DuplicateTimestamps": { "base": "Entity that comprises information abount duplicate timestamps in the dataset.
", "refs": { @@ -461,15 +507,16 @@ "base": null, "refs": { "CreateInferenceSchedulerRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
", - "CreateModelRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.
", + "CreateModelRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.
", "DescribeDataIngestionJobResponse$RoleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.
", "DescribeDatasetResponse$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.
", "DescribeInferenceSchedulerResponse$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.
", - "DescribeModelResponse$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.
", + "DescribeModelResponse$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described.
", "DescribeModelVersionResponse$RoleArn": "The Amazon Resource Name (ARN) of the role that was used to train the model version.
", "ImportModelVersionRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.
", "StartDataIngestionJobRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.
", - "UpdateInferenceSchedulerRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.
" + "UpdateInferenceSchedulerRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.
", + "UpdateModelRequest$RoleArn": "The ARN of the model to update.
" } }, "IdempotenceToken": { @@ -480,6 +527,7 @@ "CreateLabelGroupRequest$ClientToken": "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.
", "CreateLabelRequest$ClientToken": "A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.
", "CreateModelRequest$ClientToken": "A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
", + "CreateRetrainingSchedulerRequest$ClientToken": "A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
", "ImportDatasetRequest$ClientToken": "A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
", "ImportModelVersionRequest$ClientToken": "A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
", "PutResourcePolicyRequest$ClientToken": "A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
", @@ -506,6 +554,12 @@ "refs": { } }, + "InferenceDataImportStrategy": { + "base": null, + "refs": { + "ImportModelVersionRequest$InferenceDataImportStrategy": "Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows:
NO_IMPORT – Don't import the data.
ADD_WHEN_EMPTY – Only import the data from the source model if there is no existing data in the target model.
OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.
", + "DatasetSchema$InlineDataSchema": "
The data schema used within the given dataset.
", "DescribeDatasetResponse$Schema": "A JSON description of the data that is in each time series dataset, including names, column names, and data types.
", "DescribeModelResponse$Schema": "A JSON description of the data that is in each time series dataset, including names, column names, and data types.
", "DescribeModelVersionResponse$Schema": "The schema of the data used to train the model version.
" @@ -696,6 +750,8 @@ "refs": { "CategoricalValues$NumberOfCategory": "Indicates the number of categories in the data.
", "CountPercent$Count": "Indicates the count of occurences of the given statistic.
", + "DescribeModelResponse$LatestScheduledRetrainingAvailableDataInDays": "Indicates the number of days of data used in the most recent scheduled retraining run.
", + "DescribeModelVersionResponse$RetrainingAvailableDataInDays": "Indicates the number of days of data used in the most recent scheduled retraining run.
", "DuplicateTimestamps$TotalNumberOfDuplicateTimestamps": "Indicates the total number of duplicate timestamps.
", "IngestedFilesSummary$TotalNumberOfFiles": "Indicates the total number of files that were submitted for ingestion.
", "IngestedFilesSummary$IngestedNumberOfFiles": "Indicates the number of files that were successfully ingested.
", @@ -811,10 +867,11 @@ "LabelsInputConfiguration": { "base": "Contains the configuration information for the S3 location being used to hold label data.
", "refs": { - "CreateModelRequest$LabelsInputConfiguration": "The input configuration for the labels being used for the ML model that's being created.
", + "CreateModelRequest$LabelsInputConfiguration": "The input configuration for the labels being used for the machine learning model that's being created.
", "DescribeModelResponse$LabelsInputConfiguration": "Specifies configuration information about the labels input, including its S3 location.
", "DescribeModelVersionResponse$LabelsInputConfiguration": null, - "ImportModelVersionRequest$LabelsInputConfiguration": null + "ImportModelVersionRequest$LabelsInputConfiguration": null, + "UpdateModelRequest$LabelsInputConfiguration": null } }, "LabelsS3InputConfiguration": { @@ -932,6 +989,16 @@ "IngestedFilesSummary$DiscardedFiles": "Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.
" } }, + "ListRetrainingSchedulersRequest": { + "base": null, + "refs": { + } + }, + "ListRetrainingSchedulersResponse": { + "base": null, + "refs": { + } + }, "ListSensorStatisticsRequest": { "base": null, "refs": { @@ -952,6 +1019,15 @@ "refs": { } }, + "LookbackWindow": { + "base": null, + "refs": { + "CreateRetrainingSchedulerRequest$LookbackWindow": "The number of past days of data that will be used for retraining.
", + "DescribeRetrainingSchedulerResponse$LookbackWindow": "The number of past days of data used for retraining.
", + "RetrainingSchedulerSummary$LookbackWindow": "The number of past days of data used for retraining.
", + "UpdateRetrainingSchedulerRequest$LookbackWindow": "The number of past days of data that will be used for retraining.
" + } + }, "MaxResults": { "base": null, "refs": { @@ -963,7 +1039,8 @@ "ListLabelGroupsRequest$MaxResults": "Specifies the maximum number of label groups to list.
", "ListLabelsRequest$MaxResults": "Specifies the maximum number of labels to list.
", "ListModelVersionsRequest$MaxResults": "Specifies the maximum number of machine learning model versions to list.
", - "ListModelsRequest$MaxResults": "Specifies the maximum number of ML models to list.
", + "ListModelsRequest$MaxResults": "Specifies the maximum number of machine learning models to list.
", + "ListRetrainingSchedulersRequest$MaxResults": "Specifies the maximum number of retraining schedulers to list.
", "ListSensorStatisticsRequest$MaxResults": "Specifies the maximum number of sensors for which to retrieve statistics.
" } }, @@ -983,16 +1060,21 @@ "base": null, "refs": { "CreateModelResponse$ModelArn": "The Amazon Resource Name (ARN) of the model being created.
", - "DescribeInferenceSchedulerResponse$ModelArn": "The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.
", - "DescribeModelResponse$ModelArn": "The Amazon Resource Name (ARN) of the ML model being described.
", + "CreateRetrainingSchedulerResponse$ModelArn": "The ARN of the model that you added the retraining scheduler to.
", + "DescribeInferenceSchedulerResponse$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler being described.
", + "DescribeModelResponse$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model being described.
", "DescribeModelVersionResponse$ModelArn": "The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.
", + "DescribeRetrainingSchedulerResponse$ModelArn": "The ARN of the model that the retraining scheduler is attached to.
", "ImportModelVersionResponse$ModelArn": "The Amazon Resource Name (ARN) of the model being created.
", - "InferenceExecutionSummary$ModelArn": "The Amazon Resource Name (ARN) of the ML model used for the inference execution.
", - "InferenceSchedulerSummary$ModelArn": "The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.
", - "ModelSummary$ModelArn": "The Amazon Resource Name (ARN) of the ML model.
", + "InferenceExecutionSummary$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model used for the inference execution.
", + "InferenceSchedulerSummary$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model used by the inference scheduler.
", + "ModelSummary$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model.
", "ModelVersionSummary$ModelArn": "The Amazon Resource Name (ARN) of the model that this model version is a version of.
", - "StartInferenceSchedulerResponse$ModelArn": "The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.
", - "StopInferenceSchedulerResponse$ModelArn": "The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being stopped.
", + "RetrainingSchedulerSummary$ModelArn": "The ARN of the model that the retraining scheduler is attached to.
", + "StartInferenceSchedulerResponse$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model being used by the inference scheduler.
", + "StartRetrainingSchedulerResponse$ModelArn": "The ARN of the model whose retraining scheduler is being started.
", + "StopInferenceSchedulerResponse$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model used by the inference scheduler being stopped.
", + "StopRetrainingSchedulerResponse$ModelArn": "The ARN of the model whose retraining scheduler is being stopped.
", "UpdateActiveModelVersionResponse$ModelArn": "The Amazon Resource Name (ARN) of the machine learning model for which the active model version was set.
" } }, @@ -1000,34 +1082,57 @@ "base": null, "refs": { "DescribeModelResponse$ModelMetrics": "The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
", + "DescribeModelResponse$PriorModelMetrics": "If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.
", "DescribeModelVersionResponse$ModelMetrics": "Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range. These metrics are created when evaluating the model.
", + "DescribeModelVersionResponse$PriorModelMetrics": "If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.
", "InferenceEventSummary$Diagnostics": "An array which specifies the names and values of all sensors contributing to an inference event.
" } }, "ModelName": { "base": null, "refs": { - "CreateInferenceSchedulerRequest$ModelName": "The name of the previously trained ML model being used to create the inference scheduler.
", - "CreateModelRequest$ModelName": "The name for the ML model to be created.
", - "DeleteModelRequest$ModelName": "The name of the ML model to be deleted.
", - "DescribeInferenceSchedulerResponse$ModelName": "The name of the ML model of the inference scheduler being described.
", - "DescribeModelRequest$ModelName": "The name of the ML model to be described.
", - "DescribeModelResponse$ModelName": "The name of the ML model being described.
", + "CreateInferenceSchedulerRequest$ModelName": "The name of the previously trained machine learning model being used to create the inference scheduler.
", + "CreateModelRequest$ModelName": "The name for the machine learning model to be created.
", + "CreateRetrainingSchedulerRequest$ModelName": "The name of the model to add the retraining scheduler to.
", + "CreateRetrainingSchedulerResponse$ModelName": "The name of the model that you added the retraining scheduler to.
", + "DeleteModelRequest$ModelName": "The name of the machine learning model to be deleted.
", + "DeleteRetrainingSchedulerRequest$ModelName": "The name of the model whose retraining scheduler you want to delete.
", + "DescribeInferenceSchedulerResponse$ModelName": "The name of the machine learning model of the inference scheduler being described.
", + "DescribeModelRequest$ModelName": "The name of the machine learning model to be described.
", + "DescribeModelResponse$ModelName": "The name of the machine learning model being described.
", "DescribeModelVersionRequest$ModelName": "The name of the machine learning model that this version belongs to.
", "DescribeModelVersionResponse$ModelName": "The name of the machine learning model that this version belongs to.
", + "DescribeRetrainingSchedulerRequest$ModelName": "The name of the model that the retraining scheduler is attached to.
", + "DescribeRetrainingSchedulerResponse$ModelName": "The name of the model that the retraining scheduler is attached to.
", "ImportModelVersionRequest$ModelName": "The name for the machine learning model to be created. If the model already exists, Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the name of the source model.
", "ImportModelVersionResponse$ModelName": "The name for the machine learning model.
", - "InferenceExecutionSummary$ModelName": "The name of the ML model being used for the inference execution.
", - "InferenceSchedulerSummary$ModelName": "The name of the ML model used for the inference scheduler.
", - "ListInferenceSchedulersRequest$ModelName": "The name of the ML model used by the inference scheduler to be listed.
", + "InferenceExecutionSummary$ModelName": "The name of the machine learning model being used for the inference execution.
", + "InferenceSchedulerSummary$ModelName": "The name of the machine learning model used for the inference scheduler.
", + "ListInferenceSchedulersRequest$ModelName": "The name of the machine learning model used by the inference scheduler to be listed.
", "ListModelVersionsRequest$ModelName": "Then name of the machine learning model for which the model versions are to be listed.
", - "ListModelsRequest$ModelNameBeginsWith": "The beginning of the name of the ML models being listed.
", - "ModelSummary$ModelName": "The name of the ML model.
", + "ListModelsRequest$ModelNameBeginsWith": "The beginning of the name of the machine learning models being listed.
", + "ListRetrainingSchedulersRequest$ModelNameBeginsWith": "Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.
", + "ModelSummary$ModelName": "The name of the machine learning model.
", "ModelVersionSummary$ModelName": "The name of the model that this model version is a version of.
", - "StartInferenceSchedulerResponse$ModelName": "The name of the ML model being used by the inference scheduler.
", - "StopInferenceSchedulerResponse$ModelName": "The name of the ML model used by the inference scheduler being stopped.
", + "RetrainingSchedulerSummary$ModelName": "The name of the model that the retraining scheduler is attached to.
", + "StartInferenceSchedulerResponse$ModelName": "The name of the machine learning model being used by the inference scheduler.
", + "StartRetrainingSchedulerRequest$ModelName": "The name of the model whose retraining scheduler you want to start.
", + "StartRetrainingSchedulerResponse$ModelName": "The name of the model whose retraining scheduler is being started.
", + "StopInferenceSchedulerResponse$ModelName": "The name of the machine learning model used by the inference scheduler being stopped.
", + "StopRetrainingSchedulerRequest$ModelName": "The name of the model whose retraining scheduler you want to stop.
", + "StopRetrainingSchedulerResponse$ModelName": "The name of the model whose retraining scheduler is being stopped.
", "UpdateActiveModelVersionRequest$ModelName": "The name of the machine learning model for which the active model version is being set.
", - "UpdateActiveModelVersionResponse$ModelName": "The name of the machine learning model for which the active model version was set.
" + "UpdateActiveModelVersionResponse$ModelName": "The name of the machine learning model for which the active model version was set.
", + "UpdateModelRequest$ModelName": "The name of the model to update.
", + "UpdateRetrainingSchedulerRequest$ModelName": "The name of the model whose retraining scheduler you want to update.
" + } + }, + "ModelPromoteMode": { + "base": null, + "refs": { + "CreateRetrainingSchedulerRequest$PromoteMode": "Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.
Indicates how the service uses new models. In MANAGED mode, new models are used for inference if they have better performance than the current model. In MANUAL mode, the new models are not used until they are manually activated.
Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.
Indicates the status of the CreateModel operation.
Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
", - "ListModelsRequest$Status": "The status of the ML model.
", - "ModelSummary$Status": "Indicates the status of the ML model.
" + "ListModelsRequest$Status": "The status of the machine learning model.
", + "ModelSummary$Status": "Indicates the status of the machine learning model.
" } }, "ModelSummaries": { @@ -1046,7 +1151,7 @@ } }, "ModelSummary": { - "base": "Provides information about the specified ML model, including dataset and model names and ARNs, as well as status.
", + "base": "Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status.
", "refs": { "ModelSummaries$member": null } @@ -1056,12 +1161,15 @@ "refs": { "DescribeModelResponse$ActiveModelVersion": "The name of the model version used by the inference schedular when running a scheduled inference execution.
", "DescribeModelResponse$PreviousActiveModelVersion": "The model version that was set as the active model version prior to the current active model version.
", + "DescribeModelResponse$LatestScheduledRetrainingModelVersion": "Indicates the most recent model version that was generated by retraining.
", "DescribeModelVersionRequest$ModelVersion": "The version of the machine learning model.
", "DescribeModelVersionResponse$ModelVersion": "The version of the machine learning model.
", "ImportModelVersionResponse$ModelVersion": "The version of the model being created.
", + "InferenceExecutionSummary$ModelVersion": "The model version used for the inference execution.
", "ListModelVersionsRequest$MaxModelVersion": "Specifies the highest version of the model to return in the list.
", "ListModelVersionsRequest$MinModelVersion": "Specifies the lowest version of the model to return in the list.
", "ModelSummary$ActiveModelVersion": "The model version that the inference scheduler uses to run an inference execution.
", + "ModelSummary$LatestScheduledRetrainingModelVersion": "Indicates the most recent model version that was generated by retraining.
", "ModelVersionSummary$ModelVersion": "The version of the model.
", "UpdateActiveModelVersionRequest$ModelVersion": "The version of the machine learning model for which the active model version is being set.
", "UpdateActiveModelVersionResponse$CurrentActiveVersion": "The version that is currently active of the machine learning model for which the active model version was set.
", @@ -1078,6 +1186,7 @@ "DescribeModelVersionResponse$SourceModelVersionArn": "If model version was imported, then this field is the arn of the source model version.
", "ImportModelVersionRequest$SourceModelVersionArn": "The Amazon Resource Name (ARN) of the model version to import.
", "ImportModelVersionResponse$ModelVersionArn": "The Amazon Resource Name (ARN) of the model version being created.
", + "InferenceExecutionSummary$ModelVersionArn": "The Amazon Resource Number (ARN) of the model version used for the inference execution.
", "ModelSummary$ActiveModelVersionArn": "The Amazon Resource Name (ARN) of the model version that is set as active. The active model version is the model version that the inference scheduler uses to run an inference execution.
", "ModelVersionSummary$ModelVersionArn": "The Amazon Resource Name (ARN) of the model version.
", "UpdateActiveModelVersionResponse$CurrentActiveVersionArn": "The Amazon Resource Name (ARN) of the machine learning model version that is the current active model version.
", @@ -1095,9 +1204,11 @@ "ModelVersionStatus": { "base": null, "refs": { + "DescribeModelResponse$LatestScheduledRetrainingStatus": "Indicates the status of the most recent scheduled retraining run.
", "DescribeModelVersionResponse$Status": "The current status of the model version.
", "ImportModelVersionResponse$Status": "The status of the ImportModelVersion operation.
Filter the results based on the current status of the model version.
", + "ModelSummary$LatestScheduledRetrainingStatus": "Indicates the status of the most recent scheduled retraining run.
", "ModelVersionSummary$Status": "The current status of the model version.
" } }, @@ -1161,8 +1272,10 @@ "ListLabelsResponse$NextToken": "An opaque pagination token indicating where to continue the listing of datasets.
", "ListModelVersionsRequest$NextToken": "If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.
If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.
An opaque pagination token indicating where to continue the listing of ML models.
", - "ListModelsResponse$NextToken": "An opaque pagination token indicating where to continue the listing of ML models.
", + "ListModelsRequest$NextToken": "An opaque pagination token indicating where to continue the listing of machine learning models.
", + "ListModelsResponse$NextToken": "An opaque pagination token indicating where to continue the listing of machine learning models.
", + "ListRetrainingSchedulersRequest$NextToken": "If the number of results exceeds the maximum, a pagination token is returned. Use the token in the request to show the next page of retraining schedulers.
", + "ListRetrainingSchedulersResponse$NextToken": "If the number of results exceeds the maximum, this pagination token is returned. Use this token in the request to show the next page of retraining schedulers.
", "ListSensorStatisticsRequest$NextToken": "An opaque pagination token indicating where to continue the listing of sensor statistics.
", "ListSensorStatisticsResponse$NextToken": "An opaque pagination token indicating where to continue the listing of sensor statistics.
" } @@ -1214,6 +1327,40 @@ "refs": { } }, + "RetrainingFrequency": { + "base": null, + "refs": { + "CreateRetrainingSchedulerRequest$RetrainingFrequency": "This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:
P3M15D – Every 3 months and 15 days
P2M – Every 2 months
P150D – Every 150 days
The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.
", + "RetrainingSchedulerSummary$RetrainingFrequency": "The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.
", + "UpdateRetrainingSchedulerRequest$RetrainingFrequency": "This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:
P3M15D – Every 3 months and 15 days
P2M – Every 2 months
P150D – Every 150 days
The status of the retraining scheduler.
", + "DescribeModelResponse$RetrainingSchedulerStatus": "Indicates the status of the retraining scheduler.
", + "DescribeRetrainingSchedulerResponse$Status": "The status of the retraining scheduler.
", + "ListRetrainingSchedulersRequest$Status": "Specify this field to only list retraining schedulers whose status matches the value you specify.
", + "ModelSummary$RetrainingSchedulerStatus": "Indicates the status of the retraining scheduler.
", + "RetrainingSchedulerSummary$Status": "The status of the retraining scheduler.
", + "StartRetrainingSchedulerResponse$Status": "The status of the retraining scheduler.
", + "StopRetrainingSchedulerResponse$Status": "The status of the retraining scheduler.
" + } + }, + "RetrainingSchedulerSummaries": { + "base": null, + "refs": { + "ListRetrainingSchedulersResponse$RetrainingSchedulerSummaries": "Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.
" + } + }, + "RetrainingSchedulerSummary": { + "base": "Provides information about the specified retraining scheduler, including model name, status, start date, frequency, and lookback window.
", + "refs": { + "RetrainingSchedulerSummaries$member": null + } + }, "S3Bucket": { "base": null, "refs": { @@ -1233,7 +1380,7 @@ "S3Object": { "base": "Contains information about an S3 bucket.
", "refs": { - "InferenceExecutionSummary$CustomerResultObject": "", + "InferenceExecutionSummary$CustomerResultObject": "
The S3 object that the inference execution results were uploaded to.
", "ListOfDiscardedFiles$member": null } }, @@ -1295,6 +1442,16 @@ "refs": { } }, + "StartRetrainingSchedulerRequest": { + "base": null, + "refs": { + } + }, + "StartRetrainingSchedulerResponse": { + "base": null, + "refs": { + } + }, "StatisticalIssueStatus": { "base": null, "refs": { @@ -1314,6 +1471,16 @@ "refs": { } }, + "StopRetrainingSchedulerRequest": { + "base": null, + "refs": { + } + }, + "StopRetrainingSchedulerResponse": { + "base": null, + "refs": { + } + }, "Tag": { "base": "A tag is a key-value pair that can be added to a resource as metadata.
", "refs": { @@ -1339,7 +1506,7 @@ "CreateDatasetRequest$Tags": "Any tags associated with the ingested data described in the dataset.
", "CreateInferenceSchedulerRequest$Tags": "Any tags associated with the inference scheduler.
", "CreateLabelGroupRequest$Tags": "Tags that provide metadata about the label group you are creating.
Data in this field will be retained for service usage. Follow best practices for the security of your data.
", - "CreateModelRequest$Tags": "Any tags associated with the ML model being created.
", + "CreateModelRequest$Tags": "Any tags associated with the machine learning model being created.
", "ImportDatasetRequest$Tags": "Any tags associated with the dataset to be created.
", "ImportModelVersionRequest$Tags": "The tags associated with the machine learning model to be created.
", "ListTagsForResourceResponse$Tags": "Any tags associated with the resource.
", @@ -1384,10 +1551,11 @@ "refs": { "CreateLabelRequest$StartTime": "The start time of the labeled event.
", "CreateLabelRequest$EndTime": "The end time of the labeled event.
", - "CreateModelRequest$TrainingDataStartTime": "Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.
", - "CreateModelRequest$TrainingDataEndTime": "Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.
", - "CreateModelRequest$EvaluationDataStartTime": "Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.
", - "CreateModelRequest$EvaluationDataEndTime": "Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.
", + "CreateModelRequest$TrainingDataStartTime": "Indicates the time reference in the dataset that should be used to begin the subset of training data for the machine learning model.
", + "CreateModelRequest$TrainingDataEndTime": "Indicates the time reference in the dataset that should be used to end the subset of training data for the machine learning model.
", + "CreateModelRequest$EvaluationDataStartTime": "Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the machine learning model.
", + "CreateModelRequest$EvaluationDataEndTime": "Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the machine learning model.
", + "CreateRetrainingSchedulerRequest$RetrainingStartDate": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
", "DatasetSummary$CreatedAt": "The time at which the dataset was created in Amazon Lookout for Equipment.
", "DescribeDataIngestionJobResponse$CreatedAt": "The time at which the data ingestion job was created.
", "DescribeDataIngestionJobResponse$DataStartTime": "Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.
", @@ -1403,18 +1571,22 @@ "DescribeLabelResponse$StartTime": "The start time of the requested label.
", "DescribeLabelResponse$EndTime": "The end time of the requested label.
", "DescribeLabelResponse$CreatedAt": "The time at which the label was created.
", - "DescribeModelResponse$TrainingDataStartTime": "Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
", - "DescribeModelResponse$TrainingDataEndTime": "Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
", - "DescribeModelResponse$EvaluationDataStartTime": "Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.
", - "DescribeModelResponse$EvaluationDataEndTime": "Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
", - "DescribeModelResponse$TrainingExecutionStartTime": "Indicates the time at which the training of the ML model began.
", - "DescribeModelResponse$TrainingExecutionEndTime": "Indicates the time at which the training of the ML model was completed.
", - "DescribeModelResponse$LastUpdatedTime": "Indicates the last time the ML model was updated. The type of update is not specified.
", - "DescribeModelResponse$CreatedAt": "Indicates the time and date at which the ML model was created.
", + "DescribeModelResponse$TrainingDataStartTime": "Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model.
", + "DescribeModelResponse$TrainingDataEndTime": "Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model.
", + "DescribeModelResponse$EvaluationDataStartTime": "Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model.
", + "DescribeModelResponse$EvaluationDataEndTime": "Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model.
", + "DescribeModelResponse$TrainingExecutionStartTime": "Indicates the time at which the training of the machine learning model began.
", + "DescribeModelResponse$TrainingExecutionEndTime": "Indicates the time at which the training of the machine learning model was completed.
", + "DescribeModelResponse$LastUpdatedTime": "Indicates the last time the machine learning model was updated. The type of update is not specified.
", + "DescribeModelResponse$CreatedAt": "Indicates the time and date at which the machine learning model was created.
", "DescribeModelResponse$ImportJobStartTime": "The date and time when the import job was started. This field appears if the active model version was imported.
", "DescribeModelResponse$ImportJobEndTime": "The date and time when the import job was completed. This field appears if the active model version was imported.
", "DescribeModelResponse$ModelVersionActivatedAt": "The date the active model version was activated.
", "DescribeModelResponse$PreviousModelVersionActivatedAt": "The date and time when the previous active model version was activated.
", + "DescribeModelResponse$LatestScheduledRetrainingStartTime": "Indicates the start time of the most recent scheduled retraining run.
", + "DescribeModelResponse$NextScheduledRetrainingStartDate": "Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
", + "DescribeModelResponse$AccumulatedInferenceDataStartTime": "Indicates the start time of the inference data that has been accumulated.
", + "DescribeModelResponse$AccumulatedInferenceDataEndTime": "Indicates the end time of the inference data that has been accumulated.
", "DescribeModelVersionResponse$TrainingDataStartTime": "The date on which the training data began being gathered. If you imported the version, this is the date that the training data in the source version began being gathered.
", "DescribeModelVersionResponse$TrainingDataEndTime": "The date on which the training data finished being gathered. If you imported the version, this is the date that the training data in the source version finished being gathered.
", "DescribeModelVersionResponse$EvaluationDataStartTime": "The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version began being gathered.
", @@ -1427,6 +1599,9 @@ "DescribeModelVersionResponse$ImportJobEndTime": "The date and time when the import job completed. This field appears if the model version was imported.
", "DescribeResourcePolicyResponse$CreationTime": "The time when the resource policy was created.
", "DescribeResourcePolicyResponse$LastModifiedTime": "The time when the resource policy was last modified.
", + "DescribeRetrainingSchedulerResponse$RetrainingStartDate": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
", + "DescribeRetrainingSchedulerResponse$CreatedAt": "Indicates the time and date at which the retraining scheduler was created.
", + "DescribeRetrainingSchedulerResponse$UpdatedAt": "Indicates the time and date at which the retraining scheduler was updated.
", "InferenceEventSummary$EventStartTime": "Indicates the starting time of an inference event.
", "InferenceEventSummary$EventEndTime": "Indicates the ending time of an inference event.
", "InferenceExecutionSummary$ScheduledStartTime": "Indicates the start time at which the inference scheduler began the specific inference execution.
", @@ -1446,9 +1621,13 @@ "ListModelVersionsRequest$CreatedAtEndTime": "Filter results to return all the model versions created before this time.
", "ListModelVersionsRequest$CreatedAtStartTime": "Filter results to return all the model versions created after this time.
", "ModelSummary$CreatedAt": "The time at which the specific model was created.
", + "ModelSummary$LatestScheduledRetrainingStartTime": "Indicates the start time of the most recent scheduled retraining run.
", + "ModelSummary$NextScheduledRetrainingStartDate": "Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
", "ModelVersionSummary$CreatedAt": "The time when this model version was created.
", + "RetrainingSchedulerSummary$RetrainingStartDate": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
", "SensorStatisticsSummary$DataStartTime": "Indicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.
", - "SensorStatisticsSummary$DataEndTime": "Indicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.
" + "SensorStatisticsSummary$DataEndTime": "Indicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.
", + "UpdateRetrainingSchedulerRequest$RetrainingStartDate": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
" } }, "UnsupportedTimestamps": { @@ -1487,6 +1666,16 @@ "refs": { } }, + "UpdateModelRequest": { + "base": null, + "refs": { + } + }, + "UpdateRetrainingSchedulerRequest": { + "base": null, + "refs": { + } + }, "ValidationException": { "base": "The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.
", "refs": { diff --git a/models/apis/lookoutequipment/2020-12-15/examples-1.json b/models/apis/lookoutequipment/2020-12-15/examples-1.json index 0ea7e3b0bbe..1eb4987edc7 100644 --- a/models/apis/lookoutequipment/2020-12-15/examples-1.json +++ b/models/apis/lookoutequipment/2020-12-15/examples-1.json @@ -1,5 +1,219 @@ { "version": "1.0", "examples": { + "CreateRetrainingScheduler": [ + { + "input": { + "ClientToken": "sample-client-token", + "LookbackWindow": "P360D", + "ModelName": "sample-model", + "PromoteMode": "MANUAL", + "RetrainingFrequency": "P1M" + }, + "output": { + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ModelName": "sample-model", + "Status": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "creates-a-retraining-scheduler-with-manual-promote-mode-1694018486212", + "title": "Creates a retraining scheduler with manual promote mode" + }, + { + "input": { + "ClientToken": "sample-client-token", + "LookbackWindow": "P360D", + "ModelName": "sample-model", + "RetrainingFrequency": "P1M", + "RetrainingStartDate": "2024-01-01T00:00:00Z" + }, + "output": { + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ModelName": "sample-model", + "Status": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "creates-a-retraining-scheduler-with-a-specific-start-date-1694018790519", + "title": "Creates a retraining scheduler with a specific start date" + } + ], + "DeleteRetrainingScheduler": [ + { + "input": { + "ModelName": "sample-model" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "deletes-a-retraining-scheduler-1694019240097", + "title": "Deletes a retraining scheduler" + } + ], + "DescribeRetrainingScheduler": [ + { + "input": { + "ModelName": "sample-model" + }, + "output": { + "CreatedAt": "2023-10-01T15:00:00Z", + "LookbackWindow": "P360D", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ModelName": "sample-model", + "PromoteMode": "MANAGED", + "RetrainingFrequency": "P1M", + "RetrainingStartDate": "2023-11-01T00:00:00Z", + "Status": "RUNNING", + "UpdatedAt": "2023-10-01T15:00:00Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "describes-a-retraining-scheduler-1694019344252", + "title": "Describes a retraining scheduler" + } + ], + "ListRetrainingSchedulers": [ + { + "input": { + "MaxResults": 50 + }, + "output": { + "RetrainingSchedulerSummaries": [ + { + "LookbackWindow": "P180D", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ModelName": "sample-model-1", + "RetrainingFrequency": "P1M", + "RetrainingStartDate": "2023-06-01T00:00:00Z", + "Status": "RUNNING" + }, + { + "LookbackWindow": "P180D", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "ModelName": "sample-model-2", + "RetrainingFrequency": "P30D", + "RetrainingStartDate": "2023-08-15T00:00:00Z", + "Status": "RUNNING" + }, + { + "LookbackWindow": "P360D", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "ModelName": "sample-model-3", + "RetrainingFrequency": "P1M", + "RetrainingStartDate": "2023-09-01T00:00:00Z", + "Status": "STOPPED" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "listing-retraining-schedulers-1694016740503", + "title": "Listing retraining schedulers" + } + ], + "StartRetrainingScheduler": [ + { + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ModelName": "sample-model", + "Status": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "starts-a-retraining-scheduler-1694019629413", + "title": "Starts a retraining scheduler" + } + ], + "StopRetrainingScheduler": [ + { + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ModelName": "sample-model", + "Status": "STOPPING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "stops-a-retraining-scheduler-1694019734149", + "title": "Stops a retraining scheduler" + } + ], + "UpdateModel": [ + { + "input": { + "LabelsInputConfiguration": { + "LabelGroupName": "sample-label-group" + }, + "ModelName": "sample-model" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "updates-a-model-1694020683458", + "title": "Updates a model" + } + ], + "UpdateRetrainingScheduler": [ + { + "input": { + "ModelName": "sample-model", + "RetrainingFrequency": "P1Y", + "RetrainingStartDate": "2024-01-01T00:00:00Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "updates-a-retraining-scheduler-1694019840918", + "title": "Updates a retraining scheduler" + } + ] } } diff --git a/models/apis/lookoutequipment/2020-12-15/paginators-1.json b/models/apis/lookoutequipment/2020-12-15/paginators-1.json index 18e13f7d3a9..299bf028ebe 100644 --- a/models/apis/lookoutequipment/2020-12-15/paginators-1.json +++ b/models/apis/lookoutequipment/2020-12-15/paginators-1.json @@ -45,6 +45,11 @@ "output_token": "NextToken", "limit_key": "MaxResults" }, + "ListRetrainingSchedulers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "ListSensorStatistics": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/service/appstream/api.go b/service/appstream/api.go index d772a16d7ff..2e9cee2902e 100644 --- a/service/appstream/api.go +++ b/service/appstream/api.go @@ -8321,9 +8321,15 @@ type ComputeCapacity struct { _ struct{} `type:"structure"` // The desired number of streaming instances. + DesiredInstances *int64 `type:"integer"` + + // The desired number of user sessions for a multi-session fleet. This is not + // allowed for single-session fleets. // - // DesiredInstances is a required field - DesiredInstances *int64 `type:"integer" required:"true"` + // 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. + DesiredSessions *int64 `type:"integer"` } // String returns the string representation. @@ -8344,37 +8350,58 @@ func (s ComputeCapacity) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ComputeCapacity) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ComputeCapacity"} - if s.DesiredInstances == nil { - invalidParams.Add(request.NewErrParamRequired("DesiredInstances")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - // SetDesiredInstances sets the DesiredInstances field's value. func (s *ComputeCapacity) SetDesiredInstances(v int64) *ComputeCapacity { s.DesiredInstances = &v return s } +// SetDesiredSessions sets the DesiredSessions field's value. +func (s *ComputeCapacity) SetDesiredSessions(v int64) *ComputeCapacity { + s.DesiredSessions = &v + return s +} + // Describes the capacity status for a fleet. type ComputeCapacityStatus struct { _ struct{} `type:"structure"` + // The number of user sessions currently being used for streaming sessions. + // This only applies to multi-session fleets. + ActiveUserSessions *int64 `type:"integer"` + + // The total number of session slots that are available for streaming or are + // currently streaming. + // + // ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions + // + // This only applies to multi-session fleets. + ActualUserSessions *int64 `type:"integer"` + // The number of currently available instances that can be used to stream sessions. Available *int64 `type:"integer"` + // The number of idle session slots currently available for user sessions. + // + // AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions + // + // This only applies to multi-session fleets. + AvailableUserSessions *int64 `type:"integer"` + // The desired number of streaming instances. // // Desired is a required field Desired *int64 `type:"integer" required:"true"` + // 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. + // + // DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity + // + // This only applies to multi-session fleets. + DesiredUserSessions *int64 `type:"integer"` + // The number of instances in use for streaming. InUse *int64 `type:"integer"` @@ -8400,18 +8427,42 @@ func (s ComputeCapacityStatus) GoString() string { return s.String() } +// SetActiveUserSessions sets the ActiveUserSessions field's value. +func (s *ComputeCapacityStatus) SetActiveUserSessions(v int64) *ComputeCapacityStatus { + s.ActiveUserSessions = &v + return s +} + +// SetActualUserSessions sets the ActualUserSessions field's value. +func (s *ComputeCapacityStatus) SetActualUserSessions(v int64) *ComputeCapacityStatus { + s.ActualUserSessions = &v + return s +} + // SetAvailable sets the Available field's value. func (s *ComputeCapacityStatus) SetAvailable(v int64) *ComputeCapacityStatus { s.Available = &v return s } +// SetAvailableUserSessions sets the AvailableUserSessions field's value. +func (s *ComputeCapacityStatus) SetAvailableUserSessions(v int64) *ComputeCapacityStatus { + s.AvailableUserSessions = &v + return s +} + // SetDesired sets the Desired field's value. func (s *ComputeCapacityStatus) SetDesired(v int64) *ComputeCapacityStatus { s.Desired = &v return s } +// SetDesiredUserSessions sets the DesiredUserSessions field's value. +func (s *ComputeCapacityStatus) SetDesiredUserSessions(v int64) *ComputeCapacityStatus { + s.DesiredUserSessions = &v + return s +} + // SetInUse sets the InUse field's value. func (s *ComputeCapacityStatus) SetInUse(v int64) *ComputeCapacityStatus { s.InUse = &v @@ -9753,13 +9804,17 @@ type CreateFleetInput struct { // Elastic fleets, and not allowed for other fleet types. MaxConcurrentSessions *int64 `type:"integer"` + // The maximum number of user sessions on an instance. This only applies to + // multi-session fleets. + MaxSessionsPerInstance *int64 `type:"integer"` + // 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. // - // Specify a value between 600 and 360000. + // Specify a value between 600 and 432000. MaxUserDurationInSeconds *int64 `type:"integer"` // A unique name for the fleet. @@ -9842,11 +9897,6 @@ func (s *CreateFleetInput) Validate() error { if s.Tags != nil && len(s.Tags) < 1 { invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) } - if s.ComputeCapacity != nil { - if err := s.ComputeCapacity.Validate(); err != nil { - invalidParams.AddNested("ComputeCapacity", err.(request.ErrInvalidParams)) - } - } if s.SessionScriptS3Location != nil { if err := s.SessionScriptS3Location.Validate(); err != nil { invalidParams.AddNested("SessionScriptS3Location", err.(request.ErrInvalidParams)) @@ -9937,6 +9987,12 @@ func (s *CreateFleetInput) SetMaxConcurrentSessions(v int64) *CreateFleetInput { return s } +// SetMaxSessionsPerInstance sets the MaxSessionsPerInstance field's value. +func (s *CreateFleetInput) SetMaxSessionsPerInstance(v int64) *CreateFleetInput { + s.MaxSessionsPerInstance = &v + return s +} + // SetMaxUserDurationInSeconds sets the MaxUserDurationInSeconds field's value. func (s *CreateFleetInput) SetMaxUserDurationInSeconds(v int64) *CreateFleetInput { s.MaxUserDurationInSeconds = &v @@ -13267,7 +13323,10 @@ type DescribeSessionsInput struct { // The name of the fleet. This value is case-sensitive. // // FleetName is a required field - FleetName *string `min:"1" type:"string" required:"true"` + FleetName *string `type:"string" required:"true"` + + // The identifier for the instance hosting the session. + InstanceId *string `min:"1" type:"string"` // The size of each page of results. The default value is 20 and the maximum // value is 50. @@ -13280,7 +13339,7 @@ type DescribeSessionsInput struct { // The name of the stack. This value is case-sensitive. // // StackName is a required field - StackName *string `min:"1" type:"string" required:"true"` + StackName *string `type:"string" required:"true"` // The user identifier (ID). If you specify a user ID, you must also specify // the authentication type. @@ -13311,8 +13370,8 @@ func (s *DescribeSessionsInput) Validate() error { if s.FleetName == nil { invalidParams.Add(request.NewErrParamRequired("FleetName")) } - if s.FleetName != nil && len(*s.FleetName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("FleetName", 1)) + if s.InstanceId != nil && len(*s.InstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1)) } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) @@ -13320,9 +13379,6 @@ func (s *DescribeSessionsInput) Validate() error { if s.StackName == nil { invalidParams.Add(request.NewErrParamRequired("StackName")) } - if s.StackName != nil && len(*s.StackName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("StackName", 1)) - } if s.UserId != nil && len(*s.UserId) < 2 { invalidParams.Add(request.NewErrParamMinLen("UserId", 2)) } @@ -13345,6 +13401,12 @@ func (s *DescribeSessionsInput) SetFleetName(v string) *DescribeSessionsInput { return s } +// SetInstanceId sets the InstanceId field's value. +func (s *DescribeSessionsInput) SetInstanceId(v string) *DescribeSessionsInput { + s.InstanceId = &v + return s +} + // SetLimit sets the Limit field's value. func (s *DescribeSessionsInput) SetLimit(v int64) *DescribeSessionsInput { s.Limit = &v @@ -15139,6 +15201,10 @@ type Fleet struct { // The maximum number of concurrent sessions for the fleet. MaxConcurrentSessions *int64 `type:"integer"` + // The maximum number of user sessions on an instance. This only applies to + // multi-session fleets. + MaxSessionsPerInstance *int64 `type:"integer"` + // 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 @@ -15294,6 +15360,12 @@ func (s *Fleet) SetMaxConcurrentSessions(v int64) *Fleet { return s } +// SetMaxSessionsPerInstance sets the MaxSessionsPerInstance field's value. +func (s *Fleet) SetMaxSessionsPerInstance(v int64) *Fleet { + s.MaxSessionsPerInstance = &v + return s +} + // SetMaxUserDurationInSeconds sets the MaxUserDurationInSeconds field's value. func (s *Fleet) SetMaxUserDurationInSeconds(v int64) *Fleet { s.MaxUserDurationInSeconds = &v @@ -17486,6 +17558,9 @@ type Session struct { // Id is a required field Id *string `min:"1" type:"string" required:"true"` + // The identifier for the instance hosting the session. + InstanceId *string `min:"1" type:"string"` + // The time when the streaming session is set to expire. This time is based // on the MaxUserDurationinSeconds value, which determines the maximum length // of time that a streaming session can run. A streaming session might end earlier @@ -17559,6 +17634,12 @@ func (s *Session) SetId(v string) *Session { return s } +// SetInstanceId sets the InstanceId field's value. +func (s *Session) SetInstanceId(v string) *Session { + s.InstanceId = &v + return s +} + // SetMaxExpirationTime sets the MaxExpirationTime field's value. func (s *Session) SetMaxExpirationTime(v time.Time) *Session { s.MaxExpirationTime = &v @@ -19368,6 +19449,10 @@ type UpdateFleetInput struct { // The maximum number of concurrent sessions for a fleet. MaxConcurrentSessions *int64 `type:"integer"` + // The maximum number of user sessions on an instance. This only applies to + // multi-session fleets. + MaxSessionsPerInstance *int64 `type:"integer"` + // 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 @@ -19378,7 +19463,7 @@ type UpdateFleetInput struct { MaxUserDurationInSeconds *int64 `type:"integer"` // A unique name for the fleet. - Name *string `min:"1" type:"string"` + Name *string `type:"string"` // The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported // for Elastic fleets. @@ -19434,14 +19519,6 @@ func (s *UpdateFleetInput) Validate() error { if s.InstanceType != nil && len(*s.InstanceType) < 1 { invalidParams.Add(request.NewErrParamMinLen("InstanceType", 1)) } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.ComputeCapacity != nil { - if err := s.ComputeCapacity.Validate(); err != nil { - invalidParams.AddNested("ComputeCapacity", err.(request.ErrInvalidParams)) - } - } if s.SessionScriptS3Location != nil { if err := s.SessionScriptS3Location.Validate(); err != nil { invalidParams.AddNested("SessionScriptS3Location", err.(request.ErrInvalidParams)) @@ -19538,6 +19615,12 @@ func (s *UpdateFleetInput) SetMaxConcurrentSessions(v int64) *UpdateFleetInput { return s } +// SetMaxSessionsPerInstance sets the MaxSessionsPerInstance field's value. +func (s *UpdateFleetInput) SetMaxSessionsPerInstance(v int64) *UpdateFleetInput { + s.MaxSessionsPerInstance = &v + return s +} + // SetMaxUserDurationInSeconds sets the MaxUserDurationInSeconds field's value. func (s *UpdateFleetInput) SetMaxUserDurationInSeconds(v int64) *UpdateFleetInput { s.MaxUserDurationInSeconds = &v @@ -20620,6 +20703,9 @@ const ( // FleetAttributeSessionScriptS3Location is a FleetAttribute enum value FleetAttributeSessionScriptS3Location = "SESSION_SCRIPT_S3_LOCATION" + + // FleetAttributeMaxSessionsPerInstance is a FleetAttribute enum value + FleetAttributeMaxSessionsPerInstance = "MAX_SESSIONS_PER_INSTANCE" ) // FleetAttribute_Values returns all elements of the FleetAttribute enum @@ -20631,6 +20717,7 @@ func FleetAttribute_Values() []string { FleetAttributeIamRoleArn, FleetAttributeUsbDeviceFilterStrings, FleetAttributeSessionScriptS3Location, + FleetAttributeMaxSessionsPerInstance, } } diff --git a/service/appstream/waiters.go b/service/appstream/waiters.go index 90ec459f0fb..1f9f17f2dca 100644 --- a/service/appstream/waiters.go +++ b/service/appstream/waiters.go @@ -34,17 +34,17 @@ func (c *AppStream) WaitUntilFleetStartedWithContext(ctx aws.Context, input *Des { State: request.SuccessWaiterState, Matcher: request.PathAllWaiterMatch, Argument: "Fleets[].State", - Expected: "RUNNING", + Expected: "ACTIVE", }, { State: request.FailureWaiterState, Matcher: request.PathAnyWaiterMatch, Argument: "Fleets[].State", - Expected: "STOPPING", + Expected: "PENDING_DEACTIVATE", }, { State: request.FailureWaiterState, Matcher: request.PathAnyWaiterMatch, Argument: "Fleets[].State", - Expected: "STOPPED", + Expected: "INACTIVE", }, }, Logger: c.Config.Logger, @@ -90,17 +90,17 @@ func (c *AppStream) WaitUntilFleetStoppedWithContext(ctx aws.Context, input *Des { State: request.SuccessWaiterState, Matcher: request.PathAllWaiterMatch, Argument: "Fleets[].State", - Expected: "STOPPED", + Expected: "INACTIVE", }, { State: request.FailureWaiterState, Matcher: request.PathAnyWaiterMatch, Argument: "Fleets[].State", - Expected: "STARTING", + Expected: "PENDING_ACTIVATE", }, { State: request.FailureWaiterState, Matcher: request.PathAnyWaiterMatch, Argument: "Fleets[].State", - Expected: "RUNNING", + Expected: "ACTIVE", }, }, Logger: c.Config.Logger, diff --git a/service/cloudformation/api.go b/service/cloudformation/api.go index 3ecbe4bd9ad..a70ffd5b95c 100644 --- a/service/cloudformation/api.go +++ b/service/cloudformation/api.go @@ -8783,12 +8783,11 @@ type CreateStackInput struct { // see Controlling Access with Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). ResourceTypes []*string `type:"list"` - // This deletion policy deletes newly created resources, but retains existing - // resources, when a stack operation is rolled back. This ensures new, empty, - // and unused resources are deleted, while critical resources and their data - // are retained. RetainExceptOnCreate can be specified for any resource that - // supports the DeletionPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) - // attribute. + // When set to true, newly created resources are deleted when the operation + // rolls back. This includes newly created resources marked with a deletion + // policy of Retain. + // + // Default: false RetainExceptOnCreate *bool `type:"boolean"` // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) @@ -9290,7 +9289,7 @@ type CreateStackSetInput struct { // Specify an IAM role only if you are using customized administrator roles // to control which users or groups can manage specific stack sets within the // same administrator account. For more information, see Prerequisites: Granting - // Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) + // Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` @@ -9343,17 +9342,17 @@ type CreateStackSetInput struct { // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in CloudFormation - // Templates (https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities). + // Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack // set template references one or more macros, you must create the stack // set directly from the processed template, without first reviewing the // resulting changes in a change set. To create the stack set directly, you // must acknowledge this capability. For more information, see Using CloudFormation - // Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html). + // Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). // Stack sets with service-managed permissions don't currently support the - // use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html) + // use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by CloudFormation.) Even if you specify // this capability for a stack set with service-managed permissions, if you // reference a macro in your template the stack set operation will fail. @@ -12211,8 +12210,10 @@ type DescribeStacksInput struct { // // If you don't pass a parameter to StackName, the API returns a response that - // describes all resources in the account. This requires ListStacks and DescribeStacks - // permissions. + // describes all resources in the account, which can impact performance. This + // requires ListStacks and DescribeStacks permissions. + // + // Consider using the ListStacks API if you're not passing a parameter to StackName. // // The IAM policy below can be added to IAM policies when you want to limit // resource-level permissions and avoid returning a response when no parameter @@ -13415,12 +13416,11 @@ type ExecuteChangeSetInput struct { // Default: True DisableRollback *bool `type:"boolean"` - // This deletion policy deletes newly created resources, but retains existing - // resources, when a stack operation is rolled back. This ensures new, empty, - // and unused resources are deleted, while critical resources and their data - // are retained. RetainExceptOnCreate can be specified for any resource that - // supports the DeletionPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) - // attribute. + // When set to true, newly created resources are deleted when the operation + // rolls back. This includes newly created resources marked with a deletion + // policy of Retain. + // + // Default: false RetainExceptOnCreate *bool `type:"boolean"` // If you specified the name of a change set, specify the stack name or Amazon @@ -17851,12 +17851,11 @@ type RollbackStackInput struct { // A unique identifier for this RollbackStack request. ClientRequestToken *string `min:"1" type:"string"` - // This deletion policy deletes newly created resources, but retains existing - // resources, when a stack operation is rolled back. This ensures new, empty, - // and unused resources are deleted, while critical resources and their data - // are retained. RetainExceptOnCreate can be specified for any resource that - // supports the DeletionPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) - // attribute. + // When set to true, newly created resources are deleted when the operation + // rolls back. This includes newly created resources marked with a deletion + // policy of Retain. + // + // Default: false RetainExceptOnCreate *bool `type:"boolean"` // The Amazon Resource Name (ARN) of an Identity and Access Management role @@ -18575,12 +18574,11 @@ type Stack struct { // in the CloudFormation User Guide. ParentId *string `type:"string"` - // This deletion policy deletes newly created resources, but retains existing - // resources, when a stack operation is rolled back. This ensures new, empty, - // and unused resources are deleted, while critical resources and their data - // are retained. RetainExceptOnCreate can be specified for any resource that - // supports the DeletionPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) - // attribute. + // When set to true, newly created resources are deleted when the operation + // rolls back. This includes newly created resources marked with a deletion + // policy of Retain. + // + // Default: false RetainExceptOnCreate *bool `type:"boolean"` // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) @@ -20354,7 +20352,7 @@ type StackSet struct { // // Use customized administrator roles to control which users or groups can manage // specific stack sets within the same administrator account. For more information, - // see Prerequisites: Granting Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) + // see Prerequisites: Granting Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` @@ -20717,7 +20715,7 @@ type StackSetOperation struct { // // Use customized administrator roles to control which users or groups can manage // specific stack sets within the same administrator account. For more information, - // see Define Permissions for Multiple Administrators (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) + // see Define Permissions for Multiple Administrators (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` @@ -22671,12 +22669,11 @@ type UpdateStackInput struct { // see Controlling Access with Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). ResourceTypes []*string `type:"list"` - // This deletion policy deletes newly created resources, but retains existing - // resources, when a stack operation is rolled back. This ensures new, empty, - // and unused resources are deleted, while critical resources and their data - // are retained. RetainExceptOnCreate can be specified for any resource that - // supports the DeletionPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) - // attribute. + // When set to true, newly created resources are deleted when the operation + // rolls back. This includes newly created resources marked with a deletion + // policy of Retain. + // + // Default: false RetainExceptOnCreate *bool `type:"boolean"` // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) @@ -23232,7 +23229,7 @@ type UpdateStackSetInput struct { // Specify an IAM role only if you are using customized administrator roles // to control which users or groups can manage specific stack sets within the // same administrator account. For more information, see Granting Permissions - // for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html) + // for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. // // If you specified a customized administrator role when you created the stack @@ -23286,17 +23283,17 @@ type UpdateStackSetInput struct { // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in CloudFormation - // Templates (https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities). + // Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack // set template references one or more macros, you must update the stack // set directly from the processed template, without first reviewing the // resulting changes in a change set. To update the stack set directly, you // must acknowledge this capability. For more information, see Using CloudFormation - // Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html). + // Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). // Stack sets with service-managed permissions do not currently support the - // use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html) + // use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by CloudFormation.) Even if you specify // this capability for a stack set with service-managed permissions, if you // reference a macro in your template the stack set operation will fail. diff --git a/service/entityresolution/api.go b/service/entityresolution/api.go index 8b6773f4dda..5d55edf5a53 100644 --- a/service/entityresolution/api.go +++ b/service/entityresolution/api.go @@ -74,8 +74,8 @@ func (c *EntityResolution) CreateMatchingWorkflowRequest(input *CreateMatchingWo // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - AccessDeniedException // You do not have sufficient access to perform this action. HTTP Status Code: @@ -83,7 +83,7 @@ func (c *EntityResolution) CreateMatchingWorkflowRequest(input *CreateMatchingWo // // - ExceedsLimitException // The request was rejected because it attempted to create resources beyond -// the current AWS Entity Resolution account limits. The error message describes +// the current Entity Resolution account limits. The error message describes // the limit exceeded. HTTP Status Code: 402 // // - ConflictException @@ -92,7 +92,7 @@ func (c *EntityResolution) CreateMatchingWorkflowRequest(input *CreateMatchingWo // Workflow is currently running, etc. HTTP Status Code: 400 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateMatchingWorkflow @@ -178,8 +178,8 @@ func (c *EntityResolution) CreateSchemaMappingRequest(input *CreateSchemaMapping // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - AccessDeniedException // You do not have sufficient access to perform this action. HTTP Status Code: @@ -187,7 +187,7 @@ func (c *EntityResolution) CreateSchemaMappingRequest(input *CreateSchemaMapping // // - ExceedsLimitException // The request was rejected because it attempted to create resources beyond -// the current AWS Entity Resolution account limits. The error message describes +// the current Entity Resolution account limits. The error message describes // the limit exceeded. HTTP Status Code: 402 // // - ConflictException @@ -196,7 +196,7 @@ func (c *EntityResolution) CreateSchemaMappingRequest(input *CreateSchemaMapping // Workflow is currently running, etc. HTTP Status Code: 400 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateSchemaMapping @@ -280,15 +280,15 @@ func (c *EntityResolution) DeleteMatchingWorkflowRequest(input *DeleteMatchingWo // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - AccessDeniedException // You do not have sufficient access to perform this action. HTTP Status Code: // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteMatchingWorkflow @@ -374,8 +374,8 @@ func (c *EntityResolution) DeleteSchemaMappingRequest(input *DeleteSchemaMapping // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - AccessDeniedException // You do not have sufficient access to perform this action. HTTP Status Code: @@ -387,7 +387,7 @@ func (c *EntityResolution) DeleteSchemaMappingRequest(input *DeleteSchemaMapping // Workflow is currently running, etc. HTTP Status Code: 400 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteSchemaMapping @@ -471,8 +471,8 @@ func (c *EntityResolution) GetMatchIdRequest(input *GetMatchIdInput) (req *reque // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -482,7 +482,7 @@ func (c *EntityResolution) GetMatchIdRequest(input *GetMatchIdInput) (req *reque // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchId @@ -566,8 +566,8 @@ func (c *EntityResolution) GetMatchingJobRequest(input *GetMatchingJobInput) (re // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -577,7 +577,7 @@ func (c *EntityResolution) GetMatchingJobRequest(input *GetMatchingJobInput) (re // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchingJob @@ -660,8 +660,8 @@ func (c *EntityResolution) GetMatchingWorkflowRequest(input *GetMatchingWorkflow // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -671,7 +671,7 @@ func (c *EntityResolution) GetMatchingWorkflowRequest(input *GetMatchingWorkflow // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchingWorkflow @@ -754,8 +754,8 @@ func (c *EntityResolution) GetSchemaMappingRequest(input *GetSchemaMappingInput) // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -765,7 +765,7 @@ func (c *EntityResolution) GetSchemaMappingRequest(input *GetSchemaMappingInput) // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetSchemaMapping @@ -854,8 +854,8 @@ func (c *EntityResolution) ListMatchingJobsRequest(input *ListMatchingJobsInput) // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -865,7 +865,7 @@ func (c *EntityResolution) ListMatchingJobsRequest(input *ListMatchingJobsInput) // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingJobs @@ -991,7 +991,7 @@ func (c *EntityResolution) ListMatchingWorkflowsRequest(input *ListMatchingWorkf // ListMatchingWorkflows API operation for AWS EntityResolution. // // Returns a list of all the MatchingWorkflows that have been created for an -// AWS account. +// Amazon Web Services account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1006,15 +1006,15 @@ func (c *EntityResolution) ListMatchingWorkflowsRequest(input *ListMatchingWorkf // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - AccessDeniedException // You do not have sufficient access to perform this action. HTTP Status Code: // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingWorkflows @@ -1139,8 +1139,8 @@ func (c *EntityResolution) ListSchemaMappingsRequest(input *ListSchemaMappingsIn // ListSchemaMappings API operation for AWS EntityResolution. // -// Returns a list of all the SchemaMappings that have been created for an AWS -// account. +// Returns a list of all the SchemaMappings that have been created for an Amazon +// Web Services account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1155,15 +1155,15 @@ func (c *EntityResolution) ListSchemaMappingsRequest(input *ListSchemaMappingsIn // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - AccessDeniedException // You do not have sufficient access to perform this action. HTTP Status Code: // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListSchemaMappings @@ -1282,7 +1282,7 @@ func (c *EntityResolution) ListTagsForResourceRequest(input *ListTagsForResource // ListTagsForResource API operation for AWS EntityResolution. // -// Displays the tags associated with an AWS Entity Resolution resource. In Entity +// Displays the tags associated with an Entity Resolution resource. In Entity // Resolution, SchemaMapping, and MatchingWorkflow can be tagged. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1295,14 +1295,14 @@ func (c *EntityResolution) ListTagsForResourceRequest(input *ListTagsForResource // Returned Error Types: // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListTagsForResource @@ -1386,8 +1386,8 @@ func (c *EntityResolution) StartMatchingJobRequest(input *StartMatchingJobInput) // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -1398,7 +1398,7 @@ func (c *EntityResolution) StartMatchingJobRequest(input *StartMatchingJobInput) // // - ExceedsLimitException // The request was rejected because it attempted to create resources beyond -// the current AWS Entity Resolution account limits. The error message describes +// the current Entity Resolution account limits. The error message describes // the limit exceeded. HTTP Status Code: 402 // // - ConflictException @@ -1407,7 +1407,7 @@ func (c *EntityResolution) StartMatchingJobRequest(input *StartMatchingJobInput) // Workflow is currently running, etc. HTTP Status Code: 400 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/StartMatchingJob @@ -1476,17 +1476,17 @@ func (c *EntityResolution) TagResourceRequest(input *TagResourceInput) (req *req // TagResource API operation for AWS EntityResolution. // -// Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution +// Assigns one or more tags (key-value pairs) to the specified Entity Resolution // resource. Tags can help you organize and categorize your resources. You can // also use them to scope user permissions by granting a user permission to // access or change only resources with certain tag values. In Entity Resolution, -// SchemaMapping, and MatchingWorkflow can be tagged. Tags don't have any semantic -// meaning to AWS and are interpreted strictly as strings of characters. You -// can use the TagResource action with a resource that already has tags. If -// you specify a new tag key, this tag is appended to the list of tags associated -// with the resource. If you specify a tag key that is already associated with -// the resource, the new tag value that you specify replaces the previous value -// for that tag. +// SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic +// meaning to Amazon Web Services and are interpreted strictly as strings of +// characters. You can use the TagResource action with a resource that already +// has tags. If you specify a new tag key, this tag is appended to the list +// of tags associated with the resource. If you specify a tag key that is already +// associated with the resource, the new tag value that you specify replaces +// the previous value for that tag. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1498,14 +1498,14 @@ func (c *EntityResolution) TagResourceRequest(input *TagResourceInput) (req *req // Returned Error Types: // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/TagResource @@ -1574,8 +1574,8 @@ func (c *EntityResolution) UntagResourceRequest(input *UntagResourceInput) (req // UntagResource API operation for AWS EntityResolution. // -// Removes one or more tags from the specified AWS Entity Resolution resource. -// In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged. +// Removes one or more tags from the specified Entity Resolution resource. In +// Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1587,8 +1587,8 @@ func (c *EntityResolution) UntagResourceRequest(input *UntagResourceInput) (req // Returned Error Types: // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -1675,8 +1675,8 @@ func (c *EntityResolution) UpdateMatchingWorkflowRequest(input *UpdateMatchingWo // The request was denied due to request throttling. HTTP Status Code: 429 // // - InternalServerException -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 // // - ResourceNotFoundException // The resource could not be found. HTTP Status Code: 404 @@ -1686,7 +1686,7 @@ func (c *EntityResolution) UpdateMatchingWorkflowRequest(input *UpdateMatchingWo // 403 // // - ValidationException -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 // // See also, https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateMatchingWorkflow @@ -1863,12 +1863,12 @@ type CreateMatchingWorkflowInput struct { // OutputSourceConfig is a required field OutputSourceConfig []*OutputSource `locationName:"outputSourceConfig" min:"1" type:"list" required:"true"` - // An object which defines the resolutionType and the ruleBasedProperties + // An object which defines the resolutionType and the ruleBasedProperties. // // ResolutionTechniques is a required field ResolutionTechniques *ResolutionTechniques `locationName:"resolutionTechniques" type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes + // The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // RoleArn is a required field @@ -2027,12 +2027,12 @@ type CreateMatchingWorkflowOutput struct { // OutputSourceConfig is a required field OutputSourceConfig []*OutputSource `locationName:"outputSourceConfig" min:"1" type:"list" required:"true"` - // An object which defines the resolutionType and the ruleBasedProperties + // An object which defines the resolutionType and the ruleBasedProperties. // // ResolutionTechniques is a required field ResolutionTechniques *ResolutionTechniques `locationName:"resolutionTechniques" type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes + // The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // RoleArn is a required field @@ -2124,7 +2124,9 @@ type CreateSchemaMappingInput struct { // A list of MappedInputFields. Each MappedInputField corresponds to a column // the source data table, and contains column name plus additional information // that Entity Resolution uses for matching. - MappedInputFields []*SchemaInputAttribute `locationName:"mappedInputFields" min:"2" type:"list"` + // + // MappedInputFields is a required field + MappedInputFields []*SchemaInputAttribute `locationName:"mappedInputFields" min:"2" type:"list" required:"true"` // The name of the schema. There cannot be multiple SchemaMappings with the // same name. @@ -2157,6 +2159,9 @@ func (s CreateSchemaMappingInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateSchemaMappingInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateSchemaMappingInput"} + if s.MappedInputFields == nil { + invalidParams.Add(request.NewErrParamRequired("MappedInputFields")) + } if s.MappedInputFields != nil && len(s.MappedInputFields) < 2 { invalidParams.Add(request.NewErrParamMinLen("MappedInputFields", 2)) } @@ -2469,13 +2474,19 @@ func (s *ErrorDetails) SetErrorMessage(v string) *ErrorDetails { } // The request was rejected because it attempted to create resources beyond -// the current AWS Entity Resolution account limits. The error message describes +// the current Entity Resolution account limits. The error message describes // the limit exceeded. HTTP Status Code: 402 type ExceedsLimitException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" min:"1" type:"string"` + + // The name of the quota that has been breached. + QuotaName *string `locationName:"quotaName" type:"string"` + + // The current quota value for the customers. + QuotaValue *int64 `locationName:"quotaValue" type:"integer"` } // String returns the string representation. @@ -2521,7 +2532,7 @@ func (s *ExceedsLimitException) OrigErr() error { } func (s *ExceedsLimitException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) } // Status code returns the HTTP status code for the request's response error. @@ -2721,7 +2732,7 @@ type GetMatchingJobOutput struct { // StartTime is a required field StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"` - // The current status of the job. Either running, succeeded, queued, or failed. + // The current status of the job. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"` @@ -2856,12 +2867,12 @@ type GetMatchingWorkflowOutput struct { // OutputSourceConfig is a required field OutputSourceConfig []*OutputSource `locationName:"outputSourceConfig" min:"1" type:"list" required:"true"` - // An object which defines the resolutionType and the ruleBasedProperties + // An object which defines the resolutionType and the ruleBasedProperties. // // ResolutionTechniques is a required field ResolutionTechniques *ResolutionTechniques `locationName:"resolutionTechniques" type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes + // The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes // this role to access resources on your behalf. // // RoleArn is a required field @@ -3222,8 +3233,8 @@ func (s *InputSource) SetSchemaName(v string) *InputSource { return s } -// This exception occurs when there is an internal failure in the AWS Entity -// Resolution service. HTTP Status Code: 500 +// This exception occurs when there is an internal failure in the Entity Resolution +// service. HTTP Status Code: 500 type InternalServerException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -3297,7 +3308,7 @@ type JobMetrics struct { // The total number of matchIDs generated. MatchIDs *int64 `locationName:"matchIDs" type:"integer"` - // The total number of records that did not get processed, + // The total number of records that did not get processed. RecordsNotProcessed *int64 `locationName:"recordsNotProcessed" type:"integer"` // The total number of records processed. @@ -3363,7 +3374,7 @@ type JobSummary struct { // StartTime is a required field StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"` - // The current status of the job. Either running, succeeded, queued, or failed. + // The current status of the job. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"` @@ -4019,12 +4030,15 @@ func (s *OutputSource) SetOutputS3Path(v string) *OutputSource { return s } -// An object which defines the resolutionType and the ruleBasedProperties +// An object which defines the resolutionType and the ruleBasedProperties. type ResolutionTechniques struct { _ struct{} `type:"structure"` - // There are two types of matching, RULE_MATCHING and ML_MATCHING - ResolutionType *string `locationName:"resolutionType" type:"string" enum:"ResolutionType"` + // The type of matching. There are two types of matching: RULE_MATCHING and + // ML_MATCHING. + // + // ResolutionType is a required field + ResolutionType *string `locationName:"resolutionType" type:"string" required:"true" enum:"ResolutionType"` // An object which defines the list of matching rules to run and has a field // Rules, which is a list of rule objects. @@ -4052,6 +4066,9 @@ func (s ResolutionTechniques) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ResolutionTechniques) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ResolutionTechniques"} + if s.ResolutionType == nil { + invalidParams.Add(request.NewErrParamRequired("ResolutionType")) + } if s.RuleBasedProperties != nil { if err := s.RuleBasedProperties.Validate(); err != nil { invalidParams.AddNested("RuleBasedProperties", err.(request.ErrInvalidParams)) @@ -4211,14 +4228,15 @@ func (s *Rule) SetRuleName(v string) *Rule { type RuleBasedProperties struct { _ struct{} `type:"structure"` - // You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. - // When choosing MANY_TO_MANY, the system can match attribute across the sub-types - // of an attribute type. For example, if the value of the Email field of Profile - // A and the value of BusinessEmail field of Profile B matches, the two profiles - // are matched on the Email type. When choosing ONE_TO_ONE the system can only - // match if the sub-types are exact matches. For example, only when the value - // of the Email field of Profile A and the value of the Email field of Profile - // B matches, the two profiles are matched on the Email type. + // The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as + // the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match + // attributes across the sub-types of an attribute type. For example, if the + // value of the Email field of Profile A and the value of BusinessEmail field + // of Profile B matches, the two profiles are matched on the Email type. When + // choosing ONE_TO_ONE ,the system can only match if the sub-types are exact + // matches. For example, only when the value of the Email field of Profile A + // and the value of the Email field of Profile B matches, the two profiles are + // matched on the Email type. // // AttributeMatchingModel is a required field AttributeMatchingModel *string `locationName:"attributeMatchingModel" type:"string" required:"true" enum:"AttributeMatchingModel"` @@ -4306,7 +4324,7 @@ type SchemaInputAttribute struct { // A key that allows grouping of multiple input attributes into a unified matching // group. For example, let's consider a scenario where the source table contains // various addresses, such as business_address and shipping_address. By assigning - // the MatchKey Address' to both attributes, Entity Resolution will match records + // the MatchKey Address to both attributes, Entity Resolution will match records // across these fields to create a consolidated matching group. If no MatchKey // is specified for a column, it won't be utilized for matching purposes but // will still be included in the output table. @@ -4780,12 +4798,12 @@ type UpdateMatchingWorkflowInput struct { // OutputSourceConfig is a required field OutputSourceConfig []*OutputSource `locationName:"outputSourceConfig" min:"1" type:"list" required:"true"` - // An object which defines the resolutionType and the ruleBasedProperties + // An object which defines the resolutionType and the ruleBasedProperties. // // ResolutionTechniques is a required field ResolutionTechniques *ResolutionTechniques `locationName:"resolutionTechniques" type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes + // The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // RoleArn is a required field @@ -4942,7 +4960,7 @@ type UpdateMatchingWorkflowOutput struct { // ResolutionTechniques is a required field ResolutionTechniques *ResolutionTechniques `locationName:"resolutionTechniques" type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes + // The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // RoleArn is a required field @@ -5014,7 +5032,7 @@ func (s *UpdateMatchingWorkflowOutput) SetWorkflowName(v string) *UpdateMatching return s } -// The input fails to satisfy the constraints specified by AWS Entity Resolution. +// The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 type ValidationException struct { _ struct{} `type:"structure"` diff --git a/service/entityresolution/doc.go b/service/entityresolution/doc.go index 3e9a9c5435e..164933c3d28 100644 --- a/service/entityresolution/doc.go +++ b/service/entityresolution/doc.go @@ -3,23 +3,21 @@ // Package entityresolution provides the client and types for making API // requests to AWS EntityResolution. // -// Welcome to the AWS Entity Resolution API Reference. +// Welcome to the Entity Resolution API Reference. // -// AWS Entity Resolution is an AWS service that provides pre-configured entity -// resolution capabilities that enable developers and analysts at advertising +// Entity Resolution is an Amazon Web Services service that provides pre-configured +// entity resolution capabilities that enable developers and analysts at advertising // and marketing companies to build an accurate and complete view of their consumers. // -// With AWS Entity Resolution, you have the ability to match source records -// containing consumer identifiers, such as name, email address, and phone number. -// This holds true even when these records have incomplete or conflicting identifiers. -// For example, AWS Entity Resolution can effectively match a source record -// from a customer relationship management (CRM) system, which includes account -// information like first name, last name, postal address, phone number, and -// email address, with a source record from a marketing system containing campaign -// information, such as username and email address. -// -// To learn more about AWS Entity Resolution concepts, procedures, and best -// practices, see the AWS Entity Resolution User Guide (https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html). +// With Entity Resolution, you can match source records containing consumer +// identifiers, such as name, email address, and phone number. This is true +// even when these records have incomplete or conflicting identifiers. For example, +// Entity Resolution can effectively match a source record from a customer relationship +// management (CRM) system with a source record from a marketing system containing +// campaign information. +// +// To learn more about Entity Resolution concepts, procedures, and best practices, +// see the Entity Resolution User Guide (https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html). // // See https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10 for more information on this service. // diff --git a/service/entityresolution/errors.go b/service/entityresolution/errors.go index b2f1fe07866..0a56a81381d 100644 --- a/service/entityresolution/errors.go +++ b/service/entityresolution/errors.go @@ -27,15 +27,15 @@ const ( // "ExceedsLimitException". // // The request was rejected because it attempted to create resources beyond - // the current AWS Entity Resolution account limits. The error message describes + // the current Entity Resolution account limits. The error message describes // the limit exceeded. HTTP Status Code: 402 ErrCodeExceedsLimitException = "ExceedsLimitException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // - // This exception occurs when there is an internal failure in the AWS Entity - // Resolution service. HTTP Status Code: 500 + // This exception occurs when there is an internal failure in the Entity Resolution + // service. HTTP Status Code: 500 ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code @@ -53,7 +53,7 @@ const ( // ErrCodeValidationException for service response error code // "ValidationException". // - // The input fails to satisfy the constraints specified by AWS Entity Resolution. + // The input fails to satisfy the constraints specified by Entity Resolution. // HTTP Status Code: 400 ErrCodeValidationException = "ValidationException" ) diff --git a/service/lookoutequipment/api.go b/service/lookoutequipment/api.go index 52a14d48b69..d30f5cbd4ea 100644 --- a/service/lookoutequipment/api.go +++ b/service/lookoutequipment/api.go @@ -465,7 +465,7 @@ func (c *LookoutEquipment) CreateModelRequest(input *CreateModelInput) (req *req // CreateModel API operation for Amazon Lookout for Equipment. // -// Creates an ML model for data inference. +// Creates a machine learning model for data inference. // // A machine-learning (ML) model is a mathematical model that finds patterns // in your data. In Amazon Lookout for Equipment, the model learns the patterns @@ -535,6 +535,105 @@ func (c *LookoutEquipment) CreateModelWithContext(ctx aws.Context, input *Create return out, req.Send() } +const opCreateRetrainingScheduler = "CreateRetrainingScheduler" + +// CreateRetrainingSchedulerRequest generates a "aws/request.Request" representing the +// client's request for the CreateRetrainingScheduler operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateRetrainingScheduler for more information on using the CreateRetrainingScheduler +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateRetrainingSchedulerRequest method. +// req, resp := client.CreateRetrainingSchedulerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateRetrainingScheduler +func (c *LookoutEquipment) CreateRetrainingSchedulerRequest(input *CreateRetrainingSchedulerInput) (req *request.Request, output *CreateRetrainingSchedulerOutput) { + op := &request.Operation{ + Name: opCreateRetrainingScheduler, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateRetrainingSchedulerInput{} + } + + output = &CreateRetrainingSchedulerOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateRetrainingScheduler API operation for Amazon Lookout for Equipment. +// +// Creates a retraining scheduler on the specified model. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation CreateRetrainingScheduler for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ConflictException +// The request could not be completed due to a conflict with the current state +// of the target resource. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateRetrainingScheduler +func (c *LookoutEquipment) CreateRetrainingScheduler(input *CreateRetrainingSchedulerInput) (*CreateRetrainingSchedulerOutput, error) { + req, out := c.CreateRetrainingSchedulerRequest(input) + return out, req.Send() +} + +// CreateRetrainingSchedulerWithContext is the same as CreateRetrainingScheduler with the addition of +// the ability to pass a context and additional request options. +// +// See CreateRetrainingScheduler for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) CreateRetrainingSchedulerWithContext(ctx aws.Context, input *CreateRetrainingSchedulerInput, opts ...request.Option) (*CreateRetrainingSchedulerOutput, error) { + req, out := c.CreateRetrainingSchedulerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteDataset = "DeleteDataset" // DeleteDatasetRequest generates a "aws/request.Request" representing the @@ -683,8 +782,8 @@ func (c *LookoutEquipment) DeleteInferenceSchedulerRequest(input *DeleteInferenc // DeleteInferenceScheduler API operation for Amazon Lookout for Equipment. // -// Deletes an inference scheduler that has been set up. Already processed output -// results are not affected. +// Deletes an inference scheduler that has been set up. Prior inference results +// will not be deleted. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -984,9 +1083,9 @@ func (c *LookoutEquipment) DeleteModelRequest(input *DeleteModelInput) (req *req // DeleteModel API operation for Amazon Lookout for Equipment. // -// Deletes an ML model currently available for Amazon Lookout for Equipment. -// This will prevent it from being used with an inference scheduler, even one -// that is already set up. +// Deletes a machine learning model currently available for Amazon Lookout for +// Equipment. This will prevent it from being used with an inference scheduler, +// even one that is already set up. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1142,6 +1241,107 @@ func (c *LookoutEquipment) DeleteResourcePolicyWithContext(ctx aws.Context, inpu return out, req.Send() } +const opDeleteRetrainingScheduler = "DeleteRetrainingScheduler" + +// DeleteRetrainingSchedulerRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRetrainingScheduler operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteRetrainingScheduler for more information on using the DeleteRetrainingScheduler +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteRetrainingSchedulerRequest method. +// req, resp := client.DeleteRetrainingSchedulerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteRetrainingScheduler +func (c *LookoutEquipment) DeleteRetrainingSchedulerRequest(input *DeleteRetrainingSchedulerInput) (req *request.Request, output *DeleteRetrainingSchedulerOutput) { + op := &request.Operation{ + Name: opDeleteRetrainingScheduler, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteRetrainingSchedulerInput{} + } + + output = &DeleteRetrainingSchedulerOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteRetrainingScheduler API operation for Amazon Lookout for Equipment. +// +// Deletes a retraining scheduler from a model. The retraining scheduler must +// be in the STOPPED status. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation DeleteRetrainingScheduler for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ConflictException +// The request could not be completed due to a conflict with the current state +// of the target resource. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteRetrainingScheduler +func (c *LookoutEquipment) DeleteRetrainingScheduler(input *DeleteRetrainingSchedulerInput) (*DeleteRetrainingSchedulerOutput, error) { + req, out := c.DeleteRetrainingSchedulerRequest(input) + return out, req.Send() +} + +// DeleteRetrainingSchedulerWithContext is the same as DeleteRetrainingScheduler with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteRetrainingScheduler for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) DeleteRetrainingSchedulerWithContext(ctx aws.Context, input *DeleteRetrainingSchedulerInput, opts ...request.Option) (*DeleteRetrainingSchedulerOutput, error) { + req, out := c.DeleteRetrainingSchedulerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeDataIngestionJob = "DescribeDataIngestionJob" // DescribeDataIngestionJobRequest generates a "aws/request.Request" representing the @@ -1663,9 +1863,9 @@ func (c *LookoutEquipment) DescribeModelRequest(input *DescribeModelInput) (req // DescribeModel API operation for Amazon Lookout for Equipment. // -// Provides a JSON containing the overall information about a specific ML model, -// including model name and ARN, dataset, training and evaluation information, -// status, and so on. +// Provides a JSON containing the overall information about a specific machine +// learning model, including model name and ARN, dataset, training and evaluation +// information, status, and so on. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1907,6 +2107,102 @@ func (c *LookoutEquipment) DescribeResourcePolicyWithContext(ctx aws.Context, in return out, req.Send() } +const opDescribeRetrainingScheduler = "DescribeRetrainingScheduler" + +// DescribeRetrainingSchedulerRequest generates a "aws/request.Request" representing the +// client's request for the DescribeRetrainingScheduler operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeRetrainingScheduler for more information on using the DescribeRetrainingScheduler +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeRetrainingSchedulerRequest method. +// req, resp := client.DescribeRetrainingSchedulerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeRetrainingScheduler +func (c *LookoutEquipment) DescribeRetrainingSchedulerRequest(input *DescribeRetrainingSchedulerInput) (req *request.Request, output *DescribeRetrainingSchedulerOutput) { + op := &request.Operation{ + Name: opDescribeRetrainingScheduler, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeRetrainingSchedulerInput{} + } + + output = &DescribeRetrainingSchedulerOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeRetrainingScheduler API operation for Amazon Lookout for Equipment. +// +// Provides a description of the retraining scheduler, including information +// such as the model name and retraining parameters. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation DescribeRetrainingScheduler for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeRetrainingScheduler +func (c *LookoutEquipment) DescribeRetrainingScheduler(input *DescribeRetrainingSchedulerInput) (*DescribeRetrainingSchedulerOutput, error) { + req, out := c.DescribeRetrainingSchedulerRequest(input) + return out, req.Send() +} + +// DescribeRetrainingSchedulerWithContext is the same as DescribeRetrainingScheduler with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeRetrainingScheduler for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) DescribeRetrainingSchedulerWithContext(ctx aws.Context, input *DescribeRetrainingSchedulerInput, opts ...request.Option) (*DescribeRetrainingSchedulerOutput, error) { + req, out := c.DescribeRetrainingSchedulerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opImportDataset = "ImportDataset" // ImportDatasetRequest generates a "aws/request.Request" representing the @@ -3463,34 +3759,34 @@ func (c *LookoutEquipment) ListModelsPagesWithContext(ctx aws.Context, input *Li return p.Err() } -const opListSensorStatistics = "ListSensorStatistics" +const opListRetrainingSchedulers = "ListRetrainingSchedulers" -// ListSensorStatisticsRequest generates a "aws/request.Request" representing the -// client's request for the ListSensorStatistics operation. The "output" return +// ListRetrainingSchedulersRequest generates a "aws/request.Request" representing the +// client's request for the ListRetrainingSchedulers operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListSensorStatistics for more information on using the ListSensorStatistics +// See ListRetrainingSchedulers for more information on using the ListRetrainingSchedulers // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListSensorStatisticsRequest method. -// req, resp := client.ListSensorStatisticsRequest(params) +// // Example sending a request using the ListRetrainingSchedulersRequest method. +// req, resp := client.ListRetrainingSchedulersRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics -func (c *LookoutEquipment) ListSensorStatisticsRequest(input *ListSensorStatisticsInput) (req *request.Request, output *ListSensorStatisticsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListRetrainingSchedulers +func (c *LookoutEquipment) ListRetrainingSchedulersRequest(input *ListRetrainingSchedulersInput) (req *request.Request, output *ListRetrainingSchedulersOutput) { op := &request.Operation{ - Name: opListSensorStatistics, + Name: opListRetrainingSchedulers, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -3502,26 +3798,25 @@ func (c *LookoutEquipment) ListSensorStatisticsRequest(input *ListSensorStatisti } if input == nil { - input = &ListSensorStatisticsInput{} + input = &ListRetrainingSchedulersInput{} } - output = &ListSensorStatisticsOutput{} + output = &ListRetrainingSchedulersOutput{} req = c.newRequest(op, input, output) return } -// ListSensorStatistics API operation for Amazon Lookout for Equipment. +// ListRetrainingSchedulers API operation for Amazon Lookout for Equipment. // -// Lists statistics about the data collected for each of the sensors that have -// been successfully ingested in the particular dataset. Can also be used to -// retreive Sensor Statistics for a previous ingestion job. +// Lists all retraining schedulers in your account, filtering by model name +// prefix and status. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Lookout for Equipment's -// API operation ListSensorStatistics for usage and error information. +// API operation ListRetrainingSchedulers for usage and error information. // // Returned Error Types: // @@ -3529,10 +3824,6 @@ func (c *LookoutEquipment) ListSensorStatisticsRequest(input *ListSensorStatisti // The input fails to satisfy constraints specified by Amazon Lookout for Equipment // or a related Amazon Web Services service that's being utilized. // -// - ResourceNotFoundException -// The resource requested could not be found. Verify the resource ID and retry -// your request. -// // - ThrottlingException // The request was denied due to request throttling. // @@ -3544,16 +3835,170 @@ func (c *LookoutEquipment) ListSensorStatisticsRequest(input *ListSensorStatisti // Processing of the request has failed because of an unknown error, exception // or failure. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics -func (c *LookoutEquipment) ListSensorStatistics(input *ListSensorStatisticsInput) (*ListSensorStatisticsOutput, error) { - req, out := c.ListSensorStatisticsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListRetrainingSchedulers +func (c *LookoutEquipment) ListRetrainingSchedulers(input *ListRetrainingSchedulersInput) (*ListRetrainingSchedulersOutput, error) { + req, out := c.ListRetrainingSchedulersRequest(input) return out, req.Send() } -// ListSensorStatisticsWithContext is the same as ListSensorStatistics with the addition of +// ListRetrainingSchedulersWithContext is the same as ListRetrainingSchedulers with the addition of // the ability to pass a context and additional request options. // -// See ListSensorStatistics for details on how to use this API operation. +// See ListRetrainingSchedulers for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) ListRetrainingSchedulersWithContext(ctx aws.Context, input *ListRetrainingSchedulersInput, opts ...request.Option) (*ListRetrainingSchedulersOutput, error) { + req, out := c.ListRetrainingSchedulersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListRetrainingSchedulersPages iterates over the pages of a ListRetrainingSchedulers operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRetrainingSchedulers method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListRetrainingSchedulers operation. +// pageNum := 0 +// err := client.ListRetrainingSchedulersPages(params, +// func(page *lookoutequipment.ListRetrainingSchedulersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *LookoutEquipment) ListRetrainingSchedulersPages(input *ListRetrainingSchedulersInput, fn func(*ListRetrainingSchedulersOutput, bool) bool) error { + return c.ListRetrainingSchedulersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListRetrainingSchedulersPagesWithContext same as ListRetrainingSchedulersPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) ListRetrainingSchedulersPagesWithContext(ctx aws.Context, input *ListRetrainingSchedulersInput, fn func(*ListRetrainingSchedulersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRetrainingSchedulersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRetrainingSchedulersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRetrainingSchedulersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSensorStatistics = "ListSensorStatistics" + +// ListSensorStatisticsRequest generates a "aws/request.Request" representing the +// client's request for the ListSensorStatistics operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListSensorStatistics for more information on using the ListSensorStatistics +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListSensorStatisticsRequest method. +// req, resp := client.ListSensorStatisticsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics +func (c *LookoutEquipment) ListSensorStatisticsRequest(input *ListSensorStatisticsInput) (req *request.Request, output *ListSensorStatisticsOutput) { + op := &request.Operation{ + Name: opListSensorStatistics, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSensorStatisticsInput{} + } + + output = &ListSensorStatisticsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSensorStatistics API operation for Amazon Lookout for Equipment. +// +// Lists statistics about the data collected for each of the sensors that have +// been successfully ingested in the particular dataset. Can also be used to +// retreive Sensor Statistics for a previous ingestion job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation ListSensorStatistics for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics +func (c *LookoutEquipment) ListSensorStatistics(input *ListSensorStatisticsInput) (*ListSensorStatisticsOutput, error) { + req, out := c.ListSensorStatisticsRequest(input) + return out, req.Send() +} + +// ListSensorStatisticsWithContext is the same as ListSensorStatistics with the addition of +// the ability to pass a context and additional request options. +// +// See ListSensorStatistics for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create @@ -4016,6 +4461,105 @@ func (c *LookoutEquipment) StartInferenceSchedulerWithContext(ctx aws.Context, i return out, req.Send() } +const opStartRetrainingScheduler = "StartRetrainingScheduler" + +// StartRetrainingSchedulerRequest generates a "aws/request.Request" representing the +// client's request for the StartRetrainingScheduler operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartRetrainingScheduler for more information on using the StartRetrainingScheduler +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the StartRetrainingSchedulerRequest method. +// req, resp := client.StartRetrainingSchedulerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartRetrainingScheduler +func (c *LookoutEquipment) StartRetrainingSchedulerRequest(input *StartRetrainingSchedulerInput) (req *request.Request, output *StartRetrainingSchedulerOutput) { + op := &request.Operation{ + Name: opStartRetrainingScheduler, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartRetrainingSchedulerInput{} + } + + output = &StartRetrainingSchedulerOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartRetrainingScheduler API operation for Amazon Lookout for Equipment. +// +// Starts a retraining scheduler. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation StartRetrainingScheduler for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ConflictException +// The request could not be completed due to a conflict with the current state +// of the target resource. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartRetrainingScheduler +func (c *LookoutEquipment) StartRetrainingScheduler(input *StartRetrainingSchedulerInput) (*StartRetrainingSchedulerOutput, error) { + req, out := c.StartRetrainingSchedulerRequest(input) + return out, req.Send() +} + +// StartRetrainingSchedulerWithContext is the same as StartRetrainingScheduler with the addition of +// the ability to pass a context and additional request options. +// +// See StartRetrainingScheduler for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) StartRetrainingSchedulerWithContext(ctx aws.Context, input *StartRetrainingSchedulerInput, opts ...request.Option) (*StartRetrainingSchedulerOutput, error) { + req, out := c.StartRetrainingSchedulerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStopInferenceScheduler = "StopInferenceScheduler" // StopInferenceSchedulerRequest generates a "aws/request.Request" representing the @@ -4115,6 +4659,105 @@ func (c *LookoutEquipment) StopInferenceSchedulerWithContext(ctx aws.Context, in return out, req.Send() } +const opStopRetrainingScheduler = "StopRetrainingScheduler" + +// StopRetrainingSchedulerRequest generates a "aws/request.Request" representing the +// client's request for the StopRetrainingScheduler operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StopRetrainingScheduler for more information on using the StopRetrainingScheduler +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the StopRetrainingSchedulerRequest method. +// req, resp := client.StopRetrainingSchedulerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StopRetrainingScheduler +func (c *LookoutEquipment) StopRetrainingSchedulerRequest(input *StopRetrainingSchedulerInput) (req *request.Request, output *StopRetrainingSchedulerOutput) { + op := &request.Operation{ + Name: opStopRetrainingScheduler, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StopRetrainingSchedulerInput{} + } + + output = &StopRetrainingSchedulerOutput{} + req = c.newRequest(op, input, output) + return +} + +// StopRetrainingScheduler API operation for Amazon Lookout for Equipment. +// +// Stops a retraining scheduler. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation StopRetrainingScheduler for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ConflictException +// The request could not be completed due to a conflict with the current state +// of the target resource. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StopRetrainingScheduler +func (c *LookoutEquipment) StopRetrainingScheduler(input *StopRetrainingSchedulerInput) (*StopRetrainingSchedulerOutput, error) { + req, out := c.StopRetrainingSchedulerRequest(input) + return out, req.Send() +} + +// StopRetrainingSchedulerWithContext is the same as StopRetrainingScheduler with the addition of +// the ability to pass a context and additional request options. +// +// See StopRetrainingScheduler for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) StopRetrainingSchedulerWithContext(ctx aws.Context, input *StopRetrainingSchedulerInput, opts ...request.Option) (*StopRetrainingSchedulerOutput, error) { + req, out := c.StopRetrainingSchedulerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opTagResource = "TagResource" // TagResourceRequest generates a "aws/request.Request" representing the @@ -4498,88 +5141,288 @@ func (c *LookoutEquipment) UpdateInferenceScheduler(input *UpdateInferenceSchedu return out, req.Send() } -// UpdateInferenceSchedulerWithContext is the same as UpdateInferenceScheduler with the addition of +// UpdateInferenceSchedulerWithContext is the same as UpdateInferenceScheduler with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateInferenceScheduler for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) UpdateInferenceSchedulerWithContext(ctx aws.Context, input *UpdateInferenceSchedulerInput, opts ...request.Option) (*UpdateInferenceSchedulerOutput, error) { + req, out := c.UpdateInferenceSchedulerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateLabelGroup = "UpdateLabelGroup" + +// UpdateLabelGroupRequest generates a "aws/request.Request" representing the +// client's request for the UpdateLabelGroup operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateLabelGroup for more information on using the UpdateLabelGroup +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateLabelGroupRequest method. +// req, resp := client.UpdateLabelGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateLabelGroup +func (c *LookoutEquipment) UpdateLabelGroupRequest(input *UpdateLabelGroupInput) (req *request.Request, output *UpdateLabelGroupOutput) { + op := &request.Operation{ + Name: opUpdateLabelGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateLabelGroupInput{} + } + + output = &UpdateLabelGroupOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateLabelGroup API operation for Amazon Lookout for Equipment. +// +// Updates the label group. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation UpdateLabelGroup for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// The request could not be completed due to a conflict with the current state +// of the target resource. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateLabelGroup +func (c *LookoutEquipment) UpdateLabelGroup(input *UpdateLabelGroupInput) (*UpdateLabelGroupOutput, error) { + req, out := c.UpdateLabelGroupRequest(input) + return out, req.Send() +} + +// UpdateLabelGroupWithContext is the same as UpdateLabelGroup with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateLabelGroup for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) UpdateLabelGroupWithContext(ctx aws.Context, input *UpdateLabelGroupInput, opts ...request.Option) (*UpdateLabelGroupOutput, error) { + req, out := c.UpdateLabelGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateModel = "UpdateModel" + +// UpdateModelRequest generates a "aws/request.Request" representing the +// client's request for the UpdateModel operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateModel for more information on using the UpdateModel +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateModelRequest method. +// req, resp := client.UpdateModelRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateModel +func (c *LookoutEquipment) UpdateModelRequest(input *UpdateModelInput) (req *request.Request, output *UpdateModelOutput) { + op := &request.Operation{ + Name: opUpdateModel, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateModelInput{} + } + + output = &UpdateModelOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateModel API operation for Amazon Lookout for Equipment. +// +// Updates a model in the account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation UpdateModel for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// The request could not be completed due to a conflict with the current state +// of the target resource. +// +// - ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// - AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// - InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateModel +func (c *LookoutEquipment) UpdateModel(input *UpdateModelInput) (*UpdateModelOutput, error) { + req, out := c.UpdateModelRequest(input) + return out, req.Send() +} + +// UpdateModelWithContext is the same as UpdateModel with the addition of // the ability to pass a context and additional request options. // -// See UpdateInferenceScheduler for details on how to use this API operation. +// See UpdateModel for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *LookoutEquipment) UpdateInferenceSchedulerWithContext(ctx aws.Context, input *UpdateInferenceSchedulerInput, opts ...request.Option) (*UpdateInferenceSchedulerOutput, error) { - req, out := c.UpdateInferenceSchedulerRequest(input) +func (c *LookoutEquipment) UpdateModelWithContext(ctx aws.Context, input *UpdateModelInput, opts ...request.Option) (*UpdateModelOutput, error) { + req, out := c.UpdateModelRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateLabelGroup = "UpdateLabelGroup" +const opUpdateRetrainingScheduler = "UpdateRetrainingScheduler" -// UpdateLabelGroupRequest generates a "aws/request.Request" representing the -// client's request for the UpdateLabelGroup operation. The "output" return +// UpdateRetrainingSchedulerRequest generates a "aws/request.Request" representing the +// client's request for the UpdateRetrainingScheduler operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateLabelGroup for more information on using the UpdateLabelGroup +// See UpdateRetrainingScheduler for more information on using the UpdateRetrainingScheduler // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the UpdateLabelGroupRequest method. -// req, resp := client.UpdateLabelGroupRequest(params) +// // Example sending a request using the UpdateRetrainingSchedulerRequest method. +// req, resp := client.UpdateRetrainingSchedulerRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateLabelGroup -func (c *LookoutEquipment) UpdateLabelGroupRequest(input *UpdateLabelGroupInput) (req *request.Request, output *UpdateLabelGroupOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateRetrainingScheduler +func (c *LookoutEquipment) UpdateRetrainingSchedulerRequest(input *UpdateRetrainingSchedulerInput) (req *request.Request, output *UpdateRetrainingSchedulerOutput) { op := &request.Operation{ - Name: opUpdateLabelGroup, + Name: opUpdateRetrainingScheduler, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateLabelGroupInput{} + input = &UpdateRetrainingSchedulerInput{} } - output = &UpdateLabelGroupOutput{} + output = &UpdateRetrainingSchedulerOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateLabelGroup API operation for Amazon Lookout for Equipment. +// UpdateRetrainingScheduler API operation for Amazon Lookout for Equipment. // -// Updates the label group. +// Updates a retraining scheduler. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Lookout for Equipment's -// API operation UpdateLabelGroup for usage and error information. +// API operation UpdateRetrainingScheduler for usage and error information. // // Returned Error Types: // -// - ConflictException -// The request could not be completed due to a conflict with the current state -// of the target resource. +// - ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related Amazon Web Services service that's being utilized. // // - ResourceNotFoundException // The resource requested could not be found. Verify the resource ID and retry // your request. // -// - ValidationException -// The input fails to satisfy constraints specified by Amazon Lookout for Equipment -// or a related Amazon Web Services service that's being utilized. +// - ConflictException +// The request could not be completed due to a conflict with the current state +// of the target resource. // // - ThrottlingException // The request was denied due to request throttling. @@ -4592,23 +5435,23 @@ func (c *LookoutEquipment) UpdateLabelGroupRequest(input *UpdateLabelGroupInput) // Processing of the request has failed because of an unknown error, exception // or failure. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateLabelGroup -func (c *LookoutEquipment) UpdateLabelGroup(input *UpdateLabelGroupInput) (*UpdateLabelGroupOutput, error) { - req, out := c.UpdateLabelGroupRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateRetrainingScheduler +func (c *LookoutEquipment) UpdateRetrainingScheduler(input *UpdateRetrainingSchedulerInput) (*UpdateRetrainingSchedulerOutput, error) { + req, out := c.UpdateRetrainingSchedulerRequest(input) return out, req.Send() } -// UpdateLabelGroupWithContext is the same as UpdateLabelGroup with the addition of +// UpdateRetrainingSchedulerWithContext is the same as UpdateRetrainingScheduler with the addition of // the ability to pass a context and additional request options. // -// See UpdateLabelGroup for details on how to use this API operation. +// See UpdateRetrainingScheduler for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *LookoutEquipment) UpdateLabelGroupWithContext(ctx aws.Context, input *UpdateLabelGroupInput, opts ...request.Option) (*UpdateLabelGroupOutput, error) { - req, out := c.UpdateLabelGroupRequest(input) +func (c *LookoutEquipment) UpdateRetrainingSchedulerWithContext(ctx aws.Context, input *UpdateRetrainingSchedulerInput, opts ...request.Option) (*UpdateRetrainingSchedulerOutput, error) { + req, out := c.UpdateRetrainingSchedulerRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() @@ -5033,8 +5876,8 @@ type CreateInferenceSchedulerInput struct { // InferenceSchedulerName is a required field InferenceSchedulerName *string `min:"1" type:"string" required:"true"` - // The name of the previously trained ML model being used to create the inference - // scheduler. + // The name of the previously trained machine learning model being used to create + // the inference scheduler. // // ModelName is a required field ModelName *string `min:"1" type:"string" required:"true"` @@ -5588,27 +6431,27 @@ type CreateModelInput struct { // is PT1H DataPreProcessingConfiguration *DataPreProcessingConfiguration `type:"structure"` - // The name of the dataset for the ML model being created. + // The name of the dataset for the machine learning model being created. // // DatasetName is a required field DatasetName *string `min:"1" type:"string" required:"true"` - // The data schema for the ML model being created. + // The data schema for the machine learning model being created. DatasetSchema *DatasetSchema `type:"structure"` // Indicates the time reference in the dataset that should be used to end the - // subset of evaluation data for the ML model. + // subset of evaluation data for the machine learning model. EvaluationDataEndTime *time.Time `type:"timestamp"` // Indicates the time reference in the dataset that should be used to begin - // the subset of evaluation data for the ML model. + // the subset of evaluation data for the machine learning model. EvaluationDataStartTime *time.Time `type:"timestamp"` - // The input configuration for the labels being used for the ML model that's - // being created. + // The input configuration for the labels being used for the machine learning + // model that's being created. LabelsInputConfiguration *LabelsInputConfiguration `type:"structure"` - // The name for the ML model to be created. + // The name for the machine learning model to be created. // // ModelName is a required field ModelName *string `min:"1" type:"string" required:"true"` @@ -5619,22 +6462,22 @@ type CreateModelInput struct { OffCondition *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of a role with permission to access the data - // source being used to create the ML model. + // source being used to create the machine learning model. RoleArn *string `min:"20" type:"string"` // Provides the identifier of the KMS key used to encrypt model data by Amazon // Lookout for Equipment. ServerSideKmsKeyId *string `min:"1" type:"string"` - // Any tags associated with the ML model being created. + // Any tags associated with the machine learning model being created. Tags []*Tag `type:"list"` // Indicates the time reference in the dataset that should be used to end the - // subset of training data for the ML model. + // subset of training data for the machine learning model. TrainingDataEndTime *time.Time `type:"timestamp"` // Indicates the time reference in the dataset that should be used to begin - // the subset of training data for the ML model. + // the subset of training data for the machine learning model. TrainingDataStartTime *time.Time `type:"timestamp"` } @@ -5829,6 +6672,180 @@ func (s *CreateModelOutput) SetStatus(v string) *CreateModelOutput { return s } +type CreateRetrainingSchedulerInput struct { + _ struct{} `type:"structure"` + + // A unique identifier for the request. If you do not set the client request + // token, Amazon Lookout for Equipment generates one. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The number of past days of data that will be used for retraining. + // + // LookbackWindow is a required field + LookbackWindow *string `type:"string" required:"true"` + + // The name of the model to add the retraining scheduler to. + // + // ModelName is a required field + ModelName *string `min:"1" type:"string" required:"true"` + + // Indicates how the service will use new models. In MANAGED mode, new models + // will automatically be used for inference if they have better performance + // than the current model. In MANUAL mode, the new models will not be used until + // they are manually activated (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation). + PromoteMode *string `type:"string" enum:"ModelPromoteMode"` + + // This parameter uses the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) + // standard to set the frequency at which you want retraining to occur in terms + // of Years, Months, and/or Days (note: other parameters like Time are not currently + // supported). The minimum value is 30 days (P30D) and the maximum value is + // 1 year (P1Y). For example, the following values are valid: + // + // * P3M15D – Every 3 months and 15 days + // + // * P2M – Every 2 months + // + // * P150D – Every 150 days + // + // RetrainingFrequency is a required field + RetrainingFrequency *string `min:"1" type:"string" required:"true"` + + // The start date for the retraining scheduler. Lookout for Equipment truncates + // the time you provide to the nearest UTC day. + RetrainingStartDate *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRetrainingSchedulerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRetrainingSchedulerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateRetrainingSchedulerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRetrainingSchedulerInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.LookbackWindow == nil { + invalidParams.Add(request.NewErrParamRequired("LookbackWindow")) + } + if s.ModelName == nil { + invalidParams.Add(request.NewErrParamRequired("ModelName")) + } + if s.ModelName != nil && len(*s.ModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelName", 1)) + } + if s.RetrainingFrequency == nil { + invalidParams.Add(request.NewErrParamRequired("RetrainingFrequency")) + } + if s.RetrainingFrequency != nil && len(*s.RetrainingFrequency) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RetrainingFrequency", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateRetrainingSchedulerInput) SetClientToken(v string) *CreateRetrainingSchedulerInput { + s.ClientToken = &v + return s +} + +// SetLookbackWindow sets the LookbackWindow field's value. +func (s *CreateRetrainingSchedulerInput) SetLookbackWindow(v string) *CreateRetrainingSchedulerInput { + s.LookbackWindow = &v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *CreateRetrainingSchedulerInput) SetModelName(v string) *CreateRetrainingSchedulerInput { + s.ModelName = &v + return s +} + +// SetPromoteMode sets the PromoteMode field's value. +func (s *CreateRetrainingSchedulerInput) SetPromoteMode(v string) *CreateRetrainingSchedulerInput { + s.PromoteMode = &v + return s +} + +// SetRetrainingFrequency sets the RetrainingFrequency field's value. +func (s *CreateRetrainingSchedulerInput) SetRetrainingFrequency(v string) *CreateRetrainingSchedulerInput { + s.RetrainingFrequency = &v + return s +} + +// SetRetrainingStartDate sets the RetrainingStartDate field's value. +func (s *CreateRetrainingSchedulerInput) SetRetrainingStartDate(v time.Time) *CreateRetrainingSchedulerInput { + s.RetrainingStartDate = &v + return s +} + +type CreateRetrainingSchedulerOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the model that you added the retraining scheduler to. + ModelArn *string `min:"20" type:"string"` + + // The name of the model that you added the retraining scheduler to. + ModelName *string `min:"1" type:"string"` + + // The status of the retraining scheduler. + Status *string `type:"string" enum:"RetrainingSchedulerStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRetrainingSchedulerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRetrainingSchedulerOutput) GoString() string { + return s.String() +} + +// SetModelArn sets the ModelArn field's value. +func (s *CreateRetrainingSchedulerOutput) SetModelArn(v string) *CreateRetrainingSchedulerOutput { + s.ModelArn = &v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *CreateRetrainingSchedulerOutput) SetModelName(v string) *CreateRetrainingSchedulerOutput { + s.ModelName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateRetrainingSchedulerOutput) SetStatus(v string) *CreateRetrainingSchedulerOutput { + s.Status = &v + return s +} + // Provides information about a specified data ingestion job, including dataset // information, data ingestion configuration, and status. type DataIngestionJobSummary struct { @@ -6040,6 +7057,7 @@ func (s *DataQualitySummary) SetUnsupportedTimestamps(v *UnsupportedTimestamps) type DatasetSchema struct { _ struct{} `type:"structure"` + // The data schema used within the given dataset. InlineDataSchema aws.JSONValue `type:"jsonvalue"` } @@ -6432,7 +7450,7 @@ func (s DeleteLabelOutput) GoString() string { type DeleteModelInput struct { _ struct{} `type:"structure"` - // The name of the ML model to be deleted. + // The name of the machine learning model to be deleted. // // ModelName is a required field ModelName *string `min:"1" type:"string" required:"true"` @@ -6572,6 +7590,77 @@ func (s DeleteResourcePolicyOutput) GoString() string { return s.String() } +type DeleteRetrainingSchedulerInput struct { + _ struct{} `type:"structure"` + + // The name of the model whose retraining scheduler you want to delete. + // + // ModelName is a required field + ModelName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRetrainingSchedulerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRetrainingSchedulerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteRetrainingSchedulerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRetrainingSchedulerInput"} + if s.ModelName == nil { + invalidParams.Add(request.NewErrParamRequired("ModelName")) + } + if s.ModelName != nil && len(*s.ModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetModelName sets the ModelName field's value. +func (s *DeleteRetrainingSchedulerInput) SetModelName(v string) *DeleteRetrainingSchedulerInput { + s.ModelName = &v + return s +} + +type DeleteRetrainingSchedulerOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRetrainingSchedulerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRetrainingSchedulerOutput) GoString() string { + return s.String() +} + type DescribeDataIngestionJobInput struct { _ struct{} `type:"structure"` @@ -7074,11 +8163,11 @@ type DescribeInferenceSchedulerOutput struct { // (anomalous events found) or Normal (no anomalous events found). LatestInferenceResult *string `type:"string" enum:"LatestInferenceResult"` - // The Amazon Resource Name (ARN) of the ML model of the inference scheduler - // being described. + // The Amazon Resource Name (ARN) of the machine learning model of the inference + // scheduler being described. ModelArn *string `min:"20" type:"string"` - // The name of the ML model of the inference scheduler being described. + // The name of the machine learning model of the inference scheduler being described. ModelName *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of a role with permission to access the data @@ -7500,7 +8589,7 @@ func (s *DescribeLabelOutput) SetStartTime(v time.Time) *DescribeLabelOutput { type DescribeModelInput struct { _ struct{} `type:"structure"` - // The name of the ML model to be described. + // The name of the machine learning model to be described. // // ModelName is a required field ModelName *string `min:"1" type:"string" required:"true"` @@ -7549,6 +8638,12 @@ func (s *DescribeModelInput) SetModelName(v string) *DescribeModelInput { type DescribeModelOutput struct { _ struct{} `type:"structure"` + // Indicates the end time of the inference data that has been accumulated. + AccumulatedInferenceDataEndTime *time.Time `type:"timestamp"` + + // Indicates the start time of the inference data that has been accumulated. + AccumulatedInferenceDataStartTime *time.Time `type:"timestamp"` + // The name of the model version used by the inference schedular when running // a scheduled inference execution. ActiveModelVersion *int64 `min:"1" type:"long"` @@ -7557,7 +8652,7 @@ type DescribeModelOutput struct { // scheduler when running a scheduled inference execution. ActiveModelVersionArn *string `min:"20" type:"string"` - // Indicates the time and date at which the ML model was created. + // Indicates the time and date at which the machine learning model was created. CreatedAt *time.Time `type:"timestamp"` // The configuration is the TargetSamplingRate, which is the sampling rate of @@ -7572,23 +8667,23 @@ type DescribeModelOutput struct { // is PT1H DataPreProcessingConfiguration *DataPreProcessingConfiguration `type:"structure"` - // The Amazon Resouce Name (ARN) of the dataset used to create the ML model - // being described. + // The Amazon Resouce Name (ARN) of the dataset used to create the machine learning + // model being described. DatasetArn *string `min:"20" type:"string"` - // The name of the dataset being used by the ML being described. + // The name of the dataset being used by the machine learning being described. DatasetName *string `min:"1" type:"string"` // Indicates the time reference in the dataset that was used to end the subset - // of evaluation data for the ML model. + // of evaluation data for the machine learning model. EvaluationDataEndTime *time.Time `type:"timestamp"` // Indicates the time reference in the dataset that was used to begin the subset - // of evaluation data for the ML model. + // of evaluation data for the machine learning model. EvaluationDataStartTime *time.Time `type:"timestamp"` - // If the training of the ML model failed, this indicates the reason for that - // failure. + // If the training of the machine learning model failed, this indicates the + // reason for that failure. FailedReason *string `min:"1" type:"string"` // The date and time when the import job was completed. This field appears if @@ -7603,11 +8698,28 @@ type DescribeModelOutput struct { // S3 location. LabelsInputConfiguration *LabelsInputConfiguration `type:"structure"` - // Indicates the last time the ML model was updated. The type of update is not - // specified. + // Indicates the last time the machine learning model was updated. The type + // of update is not specified. LastUpdatedTime *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the ML model being described. + // Indicates the number of days of data used in the most recent scheduled retraining + // run. + LatestScheduledRetrainingAvailableDataInDays *int64 `type:"integer"` + + // If the model version was generated by retraining and the training failed, + // this indicates the reason for that failure. + LatestScheduledRetrainingFailedReason *string `min:"1" type:"string"` + + // Indicates the most recent model version that was generated by retraining. + LatestScheduledRetrainingModelVersion *int64 `min:"1" type:"long"` + + // Indicates the start time of the most recent scheduled retraining run. + LatestScheduledRetrainingStartTime *time.Time `type:"timestamp"` + + // Indicates the status of the most recent scheduled retraining run. + LatestScheduledRetrainingStatus *string `type:"string" enum:"ModelVersionStatus"` + + // The Amazon Resource Name (ARN) of the machine learning model being described. ModelArn *string `min:"20" type:"string"` // The Model Metrics show an aggregated summary of the model's performance within @@ -7615,12 +8727,17 @@ type DescribeModelOutput struct { // when evaluating the model. ModelMetrics aws.JSONValue `type:"jsonvalue"` - // The name of the ML model being described. + // The name of the machine learning model being described. ModelName *string `min:"1" type:"string"` // The date the active model version was activated. ModelVersionActivatedAt *time.Time `type:"timestamp"` + // Indicates the date and time that the next scheduled retraining run will start + // on. Lookout for Equipment truncates the time you provide to the nearest UTC + // day. + NextScheduledRetrainingStartDate *time.Time `type:"timestamp"` + // Indicates that the asset associated with this sensor has been shut off. As // long as this condition is met, Lookout for Equipment will not use data from // this asset for training, evaluation, or inference. @@ -7637,8 +8754,17 @@ type DescribeModelOutput struct { // The date and time when the previous active model version was activated. PreviousModelVersionActivatedAt *time.Time `type:"timestamp"` + // If the model version was retrained, this field shows a summary of the performance + // of the prior model on the new training range. You can use the information + // in this JSON-formatted object to compare the new model version and the prior + // model version. + PriorModelMetrics *string `min:"1" type:"string"` + + // Indicates the status of the retraining scheduler. + RetrainingSchedulerStatus *string `type:"string" enum:"RetrainingSchedulerStatus"` + // The Amazon Resource Name (ARN) of a role with permission to access the data - // source for the ML model being described. + // source for the machine learning model being described. RoleArn *string `min:"20" type:"string"` // A JSON description of the data that is in each time series dataset, including @@ -7658,17 +8784,18 @@ type DescribeModelOutput struct { Status *string `type:"string" enum:"ModelStatus"` // Indicates the time reference in the dataset that was used to end the subset - // of training data for the ML model. + // of training data for the machine learning model. TrainingDataEndTime *time.Time `type:"timestamp"` // Indicates the time reference in the dataset that was used to begin the subset - // of training data for the ML model. + // of training data for the machine learning model. TrainingDataStartTime *time.Time `type:"timestamp"` - // Indicates the time at which the training of the ML model was completed. + // Indicates the time at which the training of the machine learning model was + // completed. TrainingExecutionEndTime *time.Time `type:"timestamp"` - // Indicates the time at which the training of the ML model began. + // Indicates the time at which the training of the machine learning model began. TrainingExecutionStartTime *time.Time `type:"timestamp"` } @@ -7690,6 +8817,18 @@ func (s DescribeModelOutput) GoString() string { return s.String() } +// SetAccumulatedInferenceDataEndTime sets the AccumulatedInferenceDataEndTime field's value. +func (s *DescribeModelOutput) SetAccumulatedInferenceDataEndTime(v time.Time) *DescribeModelOutput { + s.AccumulatedInferenceDataEndTime = &v + return s +} + +// SetAccumulatedInferenceDataStartTime sets the AccumulatedInferenceDataStartTime field's value. +func (s *DescribeModelOutput) SetAccumulatedInferenceDataStartTime(v time.Time) *DescribeModelOutput { + s.AccumulatedInferenceDataStartTime = &v + return s +} + // SetActiveModelVersion sets the ActiveModelVersion field's value. func (s *DescribeModelOutput) SetActiveModelVersion(v int64) *DescribeModelOutput { s.ActiveModelVersion = &v @@ -7768,6 +8907,36 @@ func (s *DescribeModelOutput) SetLastUpdatedTime(v time.Time) *DescribeModelOutp return s } +// SetLatestScheduledRetrainingAvailableDataInDays sets the LatestScheduledRetrainingAvailableDataInDays field's value. +func (s *DescribeModelOutput) SetLatestScheduledRetrainingAvailableDataInDays(v int64) *DescribeModelOutput { + s.LatestScheduledRetrainingAvailableDataInDays = &v + return s +} + +// SetLatestScheduledRetrainingFailedReason sets the LatestScheduledRetrainingFailedReason field's value. +func (s *DescribeModelOutput) SetLatestScheduledRetrainingFailedReason(v string) *DescribeModelOutput { + s.LatestScheduledRetrainingFailedReason = &v + return s +} + +// SetLatestScheduledRetrainingModelVersion sets the LatestScheduledRetrainingModelVersion field's value. +func (s *DescribeModelOutput) SetLatestScheduledRetrainingModelVersion(v int64) *DescribeModelOutput { + s.LatestScheduledRetrainingModelVersion = &v + return s +} + +// SetLatestScheduledRetrainingStartTime sets the LatestScheduledRetrainingStartTime field's value. +func (s *DescribeModelOutput) SetLatestScheduledRetrainingStartTime(v time.Time) *DescribeModelOutput { + s.LatestScheduledRetrainingStartTime = &v + return s +} + +// SetLatestScheduledRetrainingStatus sets the LatestScheduledRetrainingStatus field's value. +func (s *DescribeModelOutput) SetLatestScheduledRetrainingStatus(v string) *DescribeModelOutput { + s.LatestScheduledRetrainingStatus = &v + return s +} + // SetModelArn sets the ModelArn field's value. func (s *DescribeModelOutput) SetModelArn(v string) *DescribeModelOutput { s.ModelArn = &v @@ -7792,6 +8961,12 @@ func (s *DescribeModelOutput) SetModelVersionActivatedAt(v time.Time) *DescribeM return s } +// SetNextScheduledRetrainingStartDate sets the NextScheduledRetrainingStartDate field's value. +func (s *DescribeModelOutput) SetNextScheduledRetrainingStartDate(v time.Time) *DescribeModelOutput { + s.NextScheduledRetrainingStartDate = &v + return s +} + // SetOffCondition sets the OffCondition field's value. func (s *DescribeModelOutput) SetOffCondition(v string) *DescribeModelOutput { s.OffCondition = &v @@ -7816,6 +8991,18 @@ func (s *DescribeModelOutput) SetPreviousModelVersionActivatedAt(v time.Time) *D return s } +// SetPriorModelMetrics sets the PriorModelMetrics field's value. +func (s *DescribeModelOutput) SetPriorModelMetrics(v string) *DescribeModelOutput { + s.PriorModelMetrics = &v + return s +} + +// SetRetrainingSchedulerStatus sets the RetrainingSchedulerStatus field's value. +func (s *DescribeModelOutput) SetRetrainingSchedulerStatus(v string) *DescribeModelOutput { + s.RetrainingSchedulerStatus = &v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *DescribeModelOutput) SetRoleArn(v string) *DescribeModelOutput { s.RoleArn = &v @@ -7939,6 +9126,17 @@ func (s *DescribeModelVersionInput) SetModelVersion(v int64) *DescribeModelVersi type DescribeModelVersionOutput struct { _ struct{} `type:"structure"` + // Indicates whether the model version was promoted to be the active version + // after retraining or if there was an error with or cancellation of the retraining. + AutoPromotionResult *string `type:"string" enum:"AutoPromotionResult"` + + // Indicates the reason for the AutoPromotionResult. For example, a model might + // not be promoted if its performance was worse than the active version, if + // there was an error during training, or if the retraining scheduler was using + // MANUAL promote mode. The model will be promoted in MANAGED promote mode if + // the performance is better than the previous model. + AutoPromotionResultReason *string `min:"1" type:"string"` + // Indicates the time and date at which the machine learning model version was // created. CreatedAt *time.Time `type:"timestamp"` @@ -8016,6 +9214,16 @@ type DescribeModelVersionOutput struct { // this asset for training, evaluation, or inference. OffCondition *string `min:"1" type:"string"` + // If the model version was retrained, this field shows a summary of the performance + // of the prior model on the new training range. You can use the information + // in this JSON-formatted object to compare the new model version and the prior + // model version. + PriorModelMetrics *string `min:"1" type:"string"` + + // Indicates the number of days of data used in the most recent scheduled retraining + // run. + RetrainingAvailableDataInDays *int64 `type:"integer"` + // The Amazon Resource Name (ARN) of the role that was used to train the model // version. RoleArn *string `min:"20" type:"string"` @@ -8072,6 +9280,18 @@ func (s DescribeModelVersionOutput) GoString() string { return s.String() } +// SetAutoPromotionResult sets the AutoPromotionResult field's value. +func (s *DescribeModelVersionOutput) SetAutoPromotionResult(v string) *DescribeModelVersionOutput { + s.AutoPromotionResult = &v + return s +} + +// SetAutoPromotionResultReason sets the AutoPromotionResultReason field's value. +func (s *DescribeModelVersionOutput) SetAutoPromotionResultReason(v string) *DescribeModelVersionOutput { + s.AutoPromotionResultReason = &v + return s +} + // SetCreatedAt sets the CreatedAt field's value. func (s *DescribeModelVersionOutput) SetCreatedAt(v time.Time) *DescribeModelVersionOutput { s.CreatedAt = &v @@ -8180,6 +9400,18 @@ func (s *DescribeModelVersionOutput) SetOffCondition(v string) *DescribeModelVer return s } +// SetPriorModelMetrics sets the PriorModelMetrics field's value. +func (s *DescribeModelVersionOutput) SetPriorModelMetrics(v string) *DescribeModelVersionOutput { + s.PriorModelMetrics = &v + return s +} + +// SetRetrainingAvailableDataInDays sets the RetrainingAvailableDataInDays field's value. +func (s *DescribeModelVersionOutput) SetRetrainingAvailableDataInDays(v int64) *DescribeModelVersionOutput { + s.RetrainingAvailableDataInDays = &v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *DescribeModelVersionOutput) SetRoleArn(v string) *DescribeModelVersionOutput { s.RoleArn = &v @@ -8348,6 +9580,163 @@ func (s *DescribeResourcePolicyOutput) SetResourcePolicy(v string) *DescribeReso return s } +type DescribeRetrainingSchedulerInput struct { + _ struct{} `type:"structure"` + + // The name of the model that the retraining scheduler is attached to. + // + // ModelName is a required field + ModelName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRetrainingSchedulerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRetrainingSchedulerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeRetrainingSchedulerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeRetrainingSchedulerInput"} + if s.ModelName == nil { + invalidParams.Add(request.NewErrParamRequired("ModelName")) + } + if s.ModelName != nil && len(*s.ModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetModelName sets the ModelName field's value. +func (s *DescribeRetrainingSchedulerInput) SetModelName(v string) *DescribeRetrainingSchedulerInput { + s.ModelName = &v + return s +} + +type DescribeRetrainingSchedulerOutput struct { + _ struct{} `type:"structure"` + + // Indicates the time and date at which the retraining scheduler was created. + CreatedAt *time.Time `type:"timestamp"` + + // The number of past days of data used for retraining. + LookbackWindow *string `type:"string"` + + // The ARN of the model that the retraining scheduler is attached to. + ModelArn *string `min:"20" type:"string"` + + // The name of the model that the retraining scheduler is attached to. + ModelName *string `min:"1" type:"string"` + + // Indicates how the service uses new models. In MANAGED mode, new models are + // used for inference if they have better performance than the current model. + // In MANUAL mode, the new models are not used until they are manually activated + // (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation). + PromoteMode *string `type:"string" enum:"ModelPromoteMode"` + + // The frequency at which the model retraining is set. This follows the ISO + // 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) guidelines. + RetrainingFrequency *string `min:"1" type:"string"` + + // The start date for the retraining scheduler. Lookout for Equipment truncates + // the time you provide to the nearest UTC day. + RetrainingStartDate *time.Time `type:"timestamp"` + + // The status of the retraining scheduler. + Status *string `type:"string" enum:"RetrainingSchedulerStatus"` + + // Indicates the time and date at which the retraining scheduler was updated. + UpdatedAt *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRetrainingSchedulerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRetrainingSchedulerOutput) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeRetrainingSchedulerOutput) SetCreatedAt(v time.Time) *DescribeRetrainingSchedulerOutput { + s.CreatedAt = &v + return s +} + +// SetLookbackWindow sets the LookbackWindow field's value. +func (s *DescribeRetrainingSchedulerOutput) SetLookbackWindow(v string) *DescribeRetrainingSchedulerOutput { + s.LookbackWindow = &v + return s +} + +// SetModelArn sets the ModelArn field's value. +func (s *DescribeRetrainingSchedulerOutput) SetModelArn(v string) *DescribeRetrainingSchedulerOutput { + s.ModelArn = &v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *DescribeRetrainingSchedulerOutput) SetModelName(v string) *DescribeRetrainingSchedulerOutput { + s.ModelName = &v + return s +} + +// SetPromoteMode sets the PromoteMode field's value. +func (s *DescribeRetrainingSchedulerOutput) SetPromoteMode(v string) *DescribeRetrainingSchedulerOutput { + s.PromoteMode = &v + return s +} + +// SetRetrainingFrequency sets the RetrainingFrequency field's value. +func (s *DescribeRetrainingSchedulerOutput) SetRetrainingFrequency(v string) *DescribeRetrainingSchedulerOutput { + s.RetrainingFrequency = &v + return s +} + +// SetRetrainingStartDate sets the RetrainingStartDate field's value. +func (s *DescribeRetrainingSchedulerOutput) SetRetrainingStartDate(v time.Time) *DescribeRetrainingSchedulerOutput { + s.RetrainingStartDate = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeRetrainingSchedulerOutput) SetStatus(v string) *DescribeRetrainingSchedulerOutput { + s.Status = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DescribeRetrainingSchedulerOutput) SetUpdatedAt(v time.Time) *DescribeRetrainingSchedulerOutput { + s.UpdatedAt = &v + return s +} + // Entity that comprises information abount duplicate timestamps in the dataset. type DuplicateTimestamps struct { _ struct{} `type:"structure"` @@ -8560,6 +9949,18 @@ type ImportModelVersionInput struct { // DatasetName is a required field DatasetName *string `min:"1" type:"string" required:"true"` + // Indicates how to import the accumulated inference data when a model version + // is imported. The possible values are as follows: + // + // * NO_IMPORT – Don't import the data. + // + // * ADD_WHEN_EMPTY – Only import the data from the source model if there + // is no existing data in the target model. + // + // * OVERWRITE – Import the data from the source model and overwrite the + // existing data in the target model. + InferenceDataImportStrategy *string `type:"string" enum:"InferenceDataImportStrategy"` + // Contains the configuration information for the S3 location being used to // hold label data. LabelsInputConfiguration *LabelsInputConfiguration `type:"structure"` @@ -8665,6 +10066,12 @@ func (s *ImportModelVersionInput) SetDatasetName(v string) *ImportModelVersionIn return s } +// SetInferenceDataImportStrategy sets the InferenceDataImportStrategy field's value. +func (s *ImportModelVersionInput) SetInferenceDataImportStrategy(v string) *ImportModelVersionInput { + s.InferenceDataImportStrategy = &v + return s +} + // SetLabelsInputConfiguration sets the LabelsInputConfiguration field's value. func (s *ImportModelVersionInput) SetLabelsInputConfiguration(v *LabelsInputConfiguration) *ImportModelVersionInput { s.LabelsInputConfiguration = v @@ -8854,7 +10261,7 @@ func (s *InferenceEventSummary) SetInferenceSchedulerName(v string) *InferenceEv type InferenceExecutionSummary struct { _ struct{} `type:"structure"` - // Contains information about an S3 bucket. + // The S3 object that the inference execution results were uploaded to. CustomerResultObject *S3Object `type:"structure"` // Indicates the time reference in the dataset at which the inference execution @@ -8883,12 +10290,20 @@ type InferenceExecutionSummary struct { // The name of the inference scheduler being used for the inference execution. InferenceSchedulerName *string `min:"1" type:"string"` - // The Amazon Resource Name (ARN) of the ML model used for the inference execution. + // The Amazon Resource Name (ARN) of the machine learning model used for the + // inference execution. ModelArn *string `min:"20" type:"string"` - // The name of the ML model being used for the inference execution. + // The name of the machine learning model being used for the inference execution. ModelName *string `min:"1" type:"string"` + // The model version used for the inference execution. + ModelVersion *int64 `min:"1" type:"long"` + + // The Amazon Resource Number (ARN) of the model version used for the inference + // execution. + ModelVersionArn *string `min:"20" type:"string"` + // Indicates the start time at which the inference scheduler began the specific // inference execution. ScheduledStartTime *time.Time `type:"timestamp"` @@ -8975,6 +10390,18 @@ func (s *InferenceExecutionSummary) SetModelName(v string) *InferenceExecutionSu return s } +// SetModelVersion sets the ModelVersion field's value. +func (s *InferenceExecutionSummary) SetModelVersion(v int64) *InferenceExecutionSummary { + s.ModelVersion = &v + return s +} + +// SetModelVersionArn sets the ModelVersionArn field's value. +func (s *InferenceExecutionSummary) SetModelVersionArn(v string) *InferenceExecutionSummary { + s.ModelVersionArn = &v + return s +} + // SetScheduledStartTime sets the ScheduledStartTime field's value. func (s *InferenceExecutionSummary) SetScheduledStartTime(v time.Time) *InferenceExecutionSummary { s.ScheduledStartTime = &v @@ -9318,10 +10745,11 @@ type InferenceSchedulerSummary struct { // (anomalous events found) or Normal (no anomalous events found). LatestInferenceResult *string `type:"string" enum:"LatestInferenceResult"` - // The Amazon Resource Name (ARN) of the ML model used by the inference scheduler. + // The Amazon Resource Name (ARN) of the machine learning model used by the + // inference scheduler. ModelArn *string `min:"20" type:"string"` - // The name of the ML model used for the inference scheduler. + // The name of the machine learning model used for the inference scheduler. ModelName *string `min:"1" type:"string"` // Indicates the status of the inference scheduler. @@ -10603,7 +12031,8 @@ type ListInferenceSchedulersInput struct { // Specifies the maximum number of inference schedulers to list. MaxResults *int64 `min:"1" type:"integer"` - // The name of the ML model used by the inference scheduler to be listed. + // The name of the machine learning model used by the inference scheduler to + // be listed. ModelName *string `min:"1" type:"string"` // An opaque pagination token indicating where to continue the listing of inference @@ -11165,20 +12594,21 @@ func (s *ListModelVersionsOutput) SetNextToken(v string) *ListModelVersionsOutpu type ListModelsInput struct { _ struct{} `type:"structure"` - // The beginning of the name of the dataset of the ML models to be listed. + // The beginning of the name of the dataset of the machine learning models to + // be listed. DatasetNameBeginsWith *string `min:"1" type:"string"` - // Specifies the maximum number of ML models to list. + // Specifies the maximum number of machine learning models to list. MaxResults *int64 `min:"1" type:"integer"` - // The beginning of the name of the ML models being listed. + // The beginning of the name of the machine learning models being listed. ModelNameBeginsWith *string `min:"1" type:"string"` - // An opaque pagination token indicating where to continue the listing of ML - // models. + // An opaque pagination token indicating where to continue the listing of machine + // learning models. NextToken *string `type:"string"` - // The status of the ML model. + // The status of the machine learning model. Status *string `type:"string" enum:"ModelStatus"` } @@ -11256,8 +12686,8 @@ type ListModelsOutput struct { // and dataset ARNs, and status. ModelSummaries []*ModelSummary `type:"list"` - // An opaque pagination token indicating where to continue the listing of ML - // models. + // An opaque pagination token indicating where to continue the listing of machine + // learning models. NextToken *string `type:"string"` } @@ -11291,6 +12721,125 @@ func (s *ListModelsOutput) SetNextToken(v string) *ListModelsOutput { return s } +type ListRetrainingSchedulersInput struct { + _ struct{} `type:"structure"` + + // Specifies the maximum number of retraining schedulers to list. + MaxResults *int64 `min:"1" type:"integer"` + + // Specify this field to only list retraining schedulers whose machine learning + // models begin with the value you specify. + ModelNameBeginsWith *string `min:"1" type:"string"` + + // If the number of results exceeds the maximum, a pagination token is returned. + // Use the token in the request to show the next page of retraining schedulers. + NextToken *string `type:"string"` + + // Specify this field to only list retraining schedulers whose status matches + // the value you specify. + Status *string `type:"string" enum:"RetrainingSchedulerStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRetrainingSchedulersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRetrainingSchedulersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListRetrainingSchedulersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRetrainingSchedulersInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.ModelNameBeginsWith != nil && len(*s.ModelNameBeginsWith) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelNameBeginsWith", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListRetrainingSchedulersInput) SetMaxResults(v int64) *ListRetrainingSchedulersInput { + s.MaxResults = &v + return s +} + +// SetModelNameBeginsWith sets the ModelNameBeginsWith field's value. +func (s *ListRetrainingSchedulersInput) SetModelNameBeginsWith(v string) *ListRetrainingSchedulersInput { + s.ModelNameBeginsWith = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRetrainingSchedulersInput) SetNextToken(v string) *ListRetrainingSchedulersInput { + s.NextToken = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ListRetrainingSchedulersInput) SetStatus(v string) *ListRetrainingSchedulersInput { + s.Status = &v + return s +} + +type ListRetrainingSchedulersOutput struct { + _ struct{} `type:"structure"` + + // If the number of results exceeds the maximum, this pagination token is returned. + // Use this token in the request to show the next page of retraining schedulers. + NextToken *string `type:"string"` + + // Provides information on the specified retraining scheduler, including the + // model name, model ARN, status, and start date. + RetrainingSchedulerSummaries []*RetrainingSchedulerSummary `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRetrainingSchedulersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRetrainingSchedulersOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRetrainingSchedulersOutput) SetNextToken(v string) *ListRetrainingSchedulersOutput { + s.NextToken = &v + return s +} + +// SetRetrainingSchedulerSummaries sets the RetrainingSchedulerSummaries field's value. +func (s *ListRetrainingSchedulersOutput) SetRetrainingSchedulerSummaries(v []*RetrainingSchedulerSummary) *ListRetrainingSchedulersOutput { + s.RetrainingSchedulerSummaries = v + return s +} + type ListSensorStatisticsInput struct { _ struct{} `type:"structure"` @@ -11578,8 +13127,8 @@ func (s *MissingSensorData) SetTotalNumberOfMissingValues(v int64) *MissingSenso return s } -// Provides information about the specified ML model, including dataset and -// model names and ARNs, as well as status. +// Provides information about the specified machine learning model, including +// dataset and model names and ARNs, as well as status. type ModelSummary struct { _ struct{} `type:"structure"` @@ -11597,16 +13146,33 @@ type ModelSummary struct { // The Amazon Resource Name (ARN) of the dataset used to create the model. DatasetArn *string `min:"20" type:"string"` - // The name of the dataset being used for the ML model. + // The name of the dataset being used for the machine learning model. DatasetName *string `min:"1" type:"string"` - // The Amazon Resource Name (ARN) of the ML model. + // Indicates the most recent model version that was generated by retraining. + LatestScheduledRetrainingModelVersion *int64 `min:"1" type:"long"` + + // Indicates the start time of the most recent scheduled retraining run. + LatestScheduledRetrainingStartTime *time.Time `type:"timestamp"` + + // Indicates the status of the most recent scheduled retraining run. + LatestScheduledRetrainingStatus *string `type:"string" enum:"ModelVersionStatus"` + + // The Amazon Resource Name (ARN) of the machine learning model. ModelArn *string `min:"20" type:"string"` - // The name of the ML model. + // The name of the machine learning model. ModelName *string `min:"1" type:"string"` - // Indicates the status of the ML model. + // Indicates the date that the next scheduled retraining run will start on. + // Lookout for Equipment truncates the time you provide to the nearest UTC day + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp). + NextScheduledRetrainingStartDate *time.Time `type:"timestamp"` + + // Indicates the status of the retraining scheduler. + RetrainingSchedulerStatus *string `type:"string" enum:"RetrainingSchedulerStatus"` + + // Indicates the status of the machine learning model. Status *string `type:"string" enum:"ModelStatus"` } @@ -11652,9 +13218,27 @@ func (s *ModelSummary) SetDatasetArn(v string) *ModelSummary { return s } -// SetDatasetName sets the DatasetName field's value. -func (s *ModelSummary) SetDatasetName(v string) *ModelSummary { - s.DatasetName = &v +// SetDatasetName sets the DatasetName field's value. +func (s *ModelSummary) SetDatasetName(v string) *ModelSummary { + s.DatasetName = &v + return s +} + +// SetLatestScheduledRetrainingModelVersion sets the LatestScheduledRetrainingModelVersion field's value. +func (s *ModelSummary) SetLatestScheduledRetrainingModelVersion(v int64) *ModelSummary { + s.LatestScheduledRetrainingModelVersion = &v + return s +} + +// SetLatestScheduledRetrainingStartTime sets the LatestScheduledRetrainingStartTime field's value. +func (s *ModelSummary) SetLatestScheduledRetrainingStartTime(v time.Time) *ModelSummary { + s.LatestScheduledRetrainingStartTime = &v + return s +} + +// SetLatestScheduledRetrainingStatus sets the LatestScheduledRetrainingStatus field's value. +func (s *ModelSummary) SetLatestScheduledRetrainingStatus(v string) *ModelSummary { + s.LatestScheduledRetrainingStatus = &v return s } @@ -11670,6 +13254,18 @@ func (s *ModelSummary) SetModelName(v string) *ModelSummary { return s } +// SetNextScheduledRetrainingStartDate sets the NextScheduledRetrainingStartDate field's value. +func (s *ModelSummary) SetNextScheduledRetrainingStartDate(v time.Time) *ModelSummary { + s.NextScheduledRetrainingStartDate = &v + return s +} + +// SetRetrainingSchedulerStatus sets the RetrainingSchedulerStatus field's value. +func (s *ModelSummary) SetRetrainingSchedulerStatus(v string) *ModelSummary { + s.RetrainingSchedulerStatus = &v + return s +} + // SetStatus sets the Status field's value. func (s *ModelSummary) SetStatus(v string) *ModelSummary { s.Status = &v @@ -12036,6 +13632,86 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +// Provides information about the specified retraining scheduler, including +// model name, status, start date, frequency, and lookback window. +type RetrainingSchedulerSummary struct { + _ struct{} `type:"structure"` + + // The number of past days of data used for retraining. + LookbackWindow *string `type:"string"` + + // The ARN of the model that the retraining scheduler is attached to. + ModelArn *string `min:"20" type:"string"` + + // The name of the model that the retraining scheduler is attached to. + ModelName *string `min:"1" type:"string"` + + // The frequency at which the model retraining is set. This follows the ISO + // 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) guidelines. + RetrainingFrequency *string `min:"1" type:"string"` + + // The start date for the retraining scheduler. Lookout for Equipment truncates + // the time you provide to the nearest UTC day. + RetrainingStartDate *time.Time `type:"timestamp"` + + // The status of the retraining scheduler. + Status *string `type:"string" enum:"RetrainingSchedulerStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetrainingSchedulerSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetrainingSchedulerSummary) GoString() string { + return s.String() +} + +// SetLookbackWindow sets the LookbackWindow field's value. +func (s *RetrainingSchedulerSummary) SetLookbackWindow(v string) *RetrainingSchedulerSummary { + s.LookbackWindow = &v + return s +} + +// SetModelArn sets the ModelArn field's value. +func (s *RetrainingSchedulerSummary) SetModelArn(v string) *RetrainingSchedulerSummary { + s.ModelArn = &v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *RetrainingSchedulerSummary) SetModelName(v string) *RetrainingSchedulerSummary { + s.ModelName = &v + return s +} + +// SetRetrainingFrequency sets the RetrainingFrequency field's value. +func (s *RetrainingSchedulerSummary) SetRetrainingFrequency(v string) *RetrainingSchedulerSummary { + s.RetrainingFrequency = &v + return s +} + +// SetRetrainingStartDate sets the RetrainingStartDate field's value. +func (s *RetrainingSchedulerSummary) SetRetrainingStartDate(v time.Time) *RetrainingSchedulerSummary { + s.RetrainingStartDate = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *RetrainingSchedulerSummary) SetStatus(v string) *RetrainingSchedulerSummary { + s.Status = &v + return s +} + // Contains information about an S3 bucket. type S3Object struct { _ struct{} `type:"structure"` @@ -12531,11 +14207,11 @@ type StartInferenceSchedulerOutput struct { // The name of the inference scheduler being started. InferenceSchedulerName *string `min:"1" type:"string"` - // The Amazon Resource Name (ARN) of the ML model being used by the inference - // scheduler. + // The Amazon Resource Name (ARN) of the machine learning model being used by + // the inference scheduler. ModelArn *string `min:"20" type:"string"` - // The name of the ML model being used by the inference scheduler. + // The name of the machine learning model being used by the inference scheduler. ModelName *string `min:"1" type:"string"` // Indicates the status of the inference scheduler. @@ -12579,24 +14255,240 @@ func (s *StartInferenceSchedulerOutput) SetModelArn(v string) *StartInferenceSch } // SetModelName sets the ModelName field's value. -func (s *StartInferenceSchedulerOutput) SetModelName(v string) *StartInferenceSchedulerOutput { +func (s *StartInferenceSchedulerOutput) SetModelName(v string) *StartInferenceSchedulerOutput { + s.ModelName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *StartInferenceSchedulerOutput) SetStatus(v string) *StartInferenceSchedulerOutput { + s.Status = &v + return s +} + +type StartRetrainingSchedulerInput struct { + _ struct{} `type:"structure"` + + // The name of the model whose retraining scheduler you want to start. + // + // ModelName is a required field + ModelName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartRetrainingSchedulerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartRetrainingSchedulerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartRetrainingSchedulerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartRetrainingSchedulerInput"} + if s.ModelName == nil { + invalidParams.Add(request.NewErrParamRequired("ModelName")) + } + if s.ModelName != nil && len(*s.ModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetModelName sets the ModelName field's value. +func (s *StartRetrainingSchedulerInput) SetModelName(v string) *StartRetrainingSchedulerInput { + s.ModelName = &v + return s +} + +type StartRetrainingSchedulerOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the model whose retraining scheduler is being started. + ModelArn *string `min:"20" type:"string"` + + // The name of the model whose retraining scheduler is being started. + ModelName *string `min:"1" type:"string"` + + // The status of the retraining scheduler. + Status *string `type:"string" enum:"RetrainingSchedulerStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartRetrainingSchedulerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartRetrainingSchedulerOutput) GoString() string { + return s.String() +} + +// SetModelArn sets the ModelArn field's value. +func (s *StartRetrainingSchedulerOutput) SetModelArn(v string) *StartRetrainingSchedulerOutput { + s.ModelArn = &v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *StartRetrainingSchedulerOutput) SetModelName(v string) *StartRetrainingSchedulerOutput { + s.ModelName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *StartRetrainingSchedulerOutput) SetStatus(v string) *StartRetrainingSchedulerOutput { + s.Status = &v + return s +} + +type StopInferenceSchedulerInput struct { + _ struct{} `type:"structure"` + + // The name of the inference scheduler to be stopped. + // + // InferenceSchedulerName is a required field + InferenceSchedulerName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopInferenceSchedulerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopInferenceSchedulerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StopInferenceSchedulerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopInferenceSchedulerInput"} + if s.InferenceSchedulerName == nil { + invalidParams.Add(request.NewErrParamRequired("InferenceSchedulerName")) + } + if s.InferenceSchedulerName != nil && len(*s.InferenceSchedulerName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InferenceSchedulerName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInferenceSchedulerName sets the InferenceSchedulerName field's value. +func (s *StopInferenceSchedulerInput) SetInferenceSchedulerName(v string) *StopInferenceSchedulerInput { + s.InferenceSchedulerName = &v + return s +} + +type StopInferenceSchedulerOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the inference schedule being stopped. + InferenceSchedulerArn *string `min:"20" type:"string"` + + // The name of the inference scheduler being stopped. + InferenceSchedulerName *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the machine learning model used by the + // inference scheduler being stopped. + ModelArn *string `min:"20" type:"string"` + + // The name of the machine learning model used by the inference scheduler being + // stopped. + ModelName *string `min:"1" type:"string"` + + // Indicates the status of the inference scheduler. + Status *string `type:"string" enum:"InferenceSchedulerStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopInferenceSchedulerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopInferenceSchedulerOutput) GoString() string { + return s.String() +} + +// SetInferenceSchedulerArn sets the InferenceSchedulerArn field's value. +func (s *StopInferenceSchedulerOutput) SetInferenceSchedulerArn(v string) *StopInferenceSchedulerOutput { + s.InferenceSchedulerArn = &v + return s +} + +// SetInferenceSchedulerName sets the InferenceSchedulerName field's value. +func (s *StopInferenceSchedulerOutput) SetInferenceSchedulerName(v string) *StopInferenceSchedulerOutput { + s.InferenceSchedulerName = &v + return s +} + +// SetModelArn sets the ModelArn field's value. +func (s *StopInferenceSchedulerOutput) SetModelArn(v string) *StopInferenceSchedulerOutput { + s.ModelArn = &v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *StopInferenceSchedulerOutput) SetModelName(v string) *StopInferenceSchedulerOutput { s.ModelName = &v return s } // SetStatus sets the Status field's value. -func (s *StartInferenceSchedulerOutput) SetStatus(v string) *StartInferenceSchedulerOutput { +func (s *StopInferenceSchedulerOutput) SetStatus(v string) *StopInferenceSchedulerOutput { s.Status = &v return s } -type StopInferenceSchedulerInput struct { +type StopRetrainingSchedulerInput struct { _ struct{} `type:"structure"` - // The name of the inference scheduler to be stopped. + // The name of the model whose retraining scheduler you want to stop. // - // InferenceSchedulerName is a required field - InferenceSchedulerName *string `min:"1" type:"string" required:"true"` + // ModelName is a required field + ModelName *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -12604,7 +14496,7 @@ type StopInferenceSchedulerInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s StopInferenceSchedulerInput) String() string { +func (s StopRetrainingSchedulerInput) String() string { return awsutil.Prettify(s) } @@ -12613,18 +14505,18 @@ func (s StopInferenceSchedulerInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s StopInferenceSchedulerInput) GoString() string { +func (s StopRetrainingSchedulerInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *StopInferenceSchedulerInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "StopInferenceSchedulerInput"} - if s.InferenceSchedulerName == nil { - invalidParams.Add(request.NewErrParamRequired("InferenceSchedulerName")) +func (s *StopRetrainingSchedulerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopRetrainingSchedulerInput"} + if s.ModelName == nil { + invalidParams.Add(request.NewErrParamRequired("ModelName")) } - if s.InferenceSchedulerName != nil && len(*s.InferenceSchedulerName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("InferenceSchedulerName", 1)) + if s.ModelName != nil && len(*s.ModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelName", 1)) } if invalidParams.Len() > 0 { @@ -12633,30 +14525,23 @@ func (s *StopInferenceSchedulerInput) Validate() error { return nil } -// SetInferenceSchedulerName sets the InferenceSchedulerName field's value. -func (s *StopInferenceSchedulerInput) SetInferenceSchedulerName(v string) *StopInferenceSchedulerInput { - s.InferenceSchedulerName = &v +// SetModelName sets the ModelName field's value. +func (s *StopRetrainingSchedulerInput) SetModelName(v string) *StopRetrainingSchedulerInput { + s.ModelName = &v return s } -type StopInferenceSchedulerOutput struct { +type StopRetrainingSchedulerOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the inference schedule being stopped. - InferenceSchedulerArn *string `min:"20" type:"string"` - - // The name of the inference scheduler being stopped. - InferenceSchedulerName *string `min:"1" type:"string"` - - // The Amazon Resource Name (ARN) of the ML model used by the inference scheduler - // being stopped. + // The ARN of the model whose retraining scheduler is being stopped. ModelArn *string `min:"20" type:"string"` - // The name of the ML model used by the inference scheduler being stopped. + // The name of the model whose retraining scheduler is being stopped. ModelName *string `min:"1" type:"string"` - // Indicates the status of the inference scheduler. - Status *string `type:"string" enum:"InferenceSchedulerStatus"` + // The status of the retraining scheduler. + Status *string `type:"string" enum:"RetrainingSchedulerStatus"` } // String returns the string representation. @@ -12664,7 +14549,7 @@ type StopInferenceSchedulerOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s StopInferenceSchedulerOutput) String() string { +func (s StopRetrainingSchedulerOutput) String() string { return awsutil.Prettify(s) } @@ -12673,36 +14558,24 @@ func (s StopInferenceSchedulerOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s StopInferenceSchedulerOutput) GoString() string { +func (s StopRetrainingSchedulerOutput) GoString() string { return s.String() } -// SetInferenceSchedulerArn sets the InferenceSchedulerArn field's value. -func (s *StopInferenceSchedulerOutput) SetInferenceSchedulerArn(v string) *StopInferenceSchedulerOutput { - s.InferenceSchedulerArn = &v - return s -} - -// SetInferenceSchedulerName sets the InferenceSchedulerName field's value. -func (s *StopInferenceSchedulerOutput) SetInferenceSchedulerName(v string) *StopInferenceSchedulerOutput { - s.InferenceSchedulerName = &v - return s -} - // SetModelArn sets the ModelArn field's value. -func (s *StopInferenceSchedulerOutput) SetModelArn(v string) *StopInferenceSchedulerOutput { +func (s *StopRetrainingSchedulerOutput) SetModelArn(v string) *StopRetrainingSchedulerOutput { s.ModelArn = &v return s } // SetModelName sets the ModelName field's value. -func (s *StopInferenceSchedulerOutput) SetModelName(v string) *StopInferenceSchedulerOutput { +func (s *StopRetrainingSchedulerOutput) SetModelName(v string) *StopRetrainingSchedulerOutput { s.ModelName = &v return s } // SetStatus sets the Status field's value. -func (s *StopInferenceSchedulerOutput) SetStatus(v string) *StopInferenceSchedulerOutput { +func (s *StopRetrainingSchedulerOutput) SetStatus(v string) *StopRetrainingSchedulerOutput { s.Status = &v return s } @@ -13430,6 +15303,228 @@ func (s UpdateLabelGroupOutput) GoString() string { return s.String() } +type UpdateModelInput struct { + _ struct{} `type:"structure"` + + // Contains the configuration information for the S3 location being used to + // hold label data. + LabelsInputConfiguration *LabelsInputConfiguration `type:"structure"` + + // The name of the model to update. + // + // ModelName is a required field + ModelName *string `min:"1" type:"string" required:"true"` + + // The ARN of the model to update. + RoleArn *string `min:"20" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateModelInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateModelInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateModelInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateModelInput"} + if s.ModelName == nil { + invalidParams.Add(request.NewErrParamRequired("ModelName")) + } + if s.ModelName != nil && len(*s.ModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelName", 1)) + } + if s.RoleArn != nil && len(*s.RoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("RoleArn", 20)) + } + if s.LabelsInputConfiguration != nil { + if err := s.LabelsInputConfiguration.Validate(); err != nil { + invalidParams.AddNested("LabelsInputConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLabelsInputConfiguration sets the LabelsInputConfiguration field's value. +func (s *UpdateModelInput) SetLabelsInputConfiguration(v *LabelsInputConfiguration) *UpdateModelInput { + s.LabelsInputConfiguration = v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *UpdateModelInput) SetModelName(v string) *UpdateModelInput { + s.ModelName = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *UpdateModelInput) SetRoleArn(v string) *UpdateModelInput { + s.RoleArn = &v + return s +} + +type UpdateModelOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateModelOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateModelOutput) GoString() string { + return s.String() +} + +type UpdateRetrainingSchedulerInput struct { + _ struct{} `type:"structure"` + + // The number of past days of data that will be used for retraining. + LookbackWindow *string `type:"string"` + + // The name of the model whose retraining scheduler you want to update. + // + // ModelName is a required field + ModelName *string `min:"1" type:"string" required:"true"` + + // Indicates how the service will use new models. In MANAGED mode, new models + // will automatically be used for inference if they have better performance + // than the current model. In MANUAL mode, the new models will not be used until + // they are manually activated (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation). + PromoteMode *string `type:"string" enum:"ModelPromoteMode"` + + // This parameter uses the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) + // standard to set the frequency at which you want retraining to occur in terms + // of Years, Months, and/or Days (note: other parameters like Time are not currently + // supported). The minimum value is 30 days (P30D) and the maximum value is + // 1 year (P1Y). For example, the following values are valid: + // + // * P3M15D – Every 3 months and 15 days + // + // * P2M – Every 2 months + // + // * P150D – Every 150 days + RetrainingFrequency *string `min:"1" type:"string"` + + // The start date for the retraining scheduler. Lookout for Equipment truncates + // the time you provide to the nearest UTC day. + RetrainingStartDate *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRetrainingSchedulerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRetrainingSchedulerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateRetrainingSchedulerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateRetrainingSchedulerInput"} + if s.ModelName == nil { + invalidParams.Add(request.NewErrParamRequired("ModelName")) + } + if s.ModelName != nil && len(*s.ModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelName", 1)) + } + if s.RetrainingFrequency != nil && len(*s.RetrainingFrequency) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RetrainingFrequency", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLookbackWindow sets the LookbackWindow field's value. +func (s *UpdateRetrainingSchedulerInput) SetLookbackWindow(v string) *UpdateRetrainingSchedulerInput { + s.LookbackWindow = &v + return s +} + +// SetModelName sets the ModelName field's value. +func (s *UpdateRetrainingSchedulerInput) SetModelName(v string) *UpdateRetrainingSchedulerInput { + s.ModelName = &v + return s +} + +// SetPromoteMode sets the PromoteMode field's value. +func (s *UpdateRetrainingSchedulerInput) SetPromoteMode(v string) *UpdateRetrainingSchedulerInput { + s.PromoteMode = &v + return s +} + +// SetRetrainingFrequency sets the RetrainingFrequency field's value. +func (s *UpdateRetrainingSchedulerInput) SetRetrainingFrequency(v string) *UpdateRetrainingSchedulerInput { + s.RetrainingFrequency = &v + return s +} + +// SetRetrainingStartDate sets the RetrainingStartDate field's value. +func (s *UpdateRetrainingSchedulerInput) SetRetrainingStartDate(v time.Time) *UpdateRetrainingSchedulerInput { + s.RetrainingStartDate = &v + return s +} + +type UpdateRetrainingSchedulerOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRetrainingSchedulerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRetrainingSchedulerOutput) GoString() string { + return s.String() +} + // The input fails to satisfy constraints specified by Amazon Lookout for Equipment // or a related Amazon Web Services service that's being utilized. type ValidationException struct { @@ -13495,6 +15590,34 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } +const ( + // AutoPromotionResultModelPromoted is a AutoPromotionResult enum value + AutoPromotionResultModelPromoted = "MODEL_PROMOTED" + + // AutoPromotionResultModelNotPromoted is a AutoPromotionResult enum value + AutoPromotionResultModelNotPromoted = "MODEL_NOT_PROMOTED" + + // AutoPromotionResultRetrainingInternalError is a AutoPromotionResult enum value + AutoPromotionResultRetrainingInternalError = "RETRAINING_INTERNAL_ERROR" + + // AutoPromotionResultRetrainingCustomerError is a AutoPromotionResult enum value + AutoPromotionResultRetrainingCustomerError = "RETRAINING_CUSTOMER_ERROR" + + // AutoPromotionResultRetrainingCancelled is a AutoPromotionResult enum value + AutoPromotionResultRetrainingCancelled = "RETRAINING_CANCELLED" +) + +// AutoPromotionResult_Values returns all elements of the AutoPromotionResult enum +func AutoPromotionResult_Values() []string { + return []string{ + AutoPromotionResultModelPromoted, + AutoPromotionResultModelNotPromoted, + AutoPromotionResultRetrainingInternalError, + AutoPromotionResultRetrainingCustomerError, + AutoPromotionResultRetrainingCancelled, + } +} + const ( // DataUploadFrequencyPt5m is a DataUploadFrequency enum value DataUploadFrequencyPt5m = "PT5M" @@ -13547,6 +15670,26 @@ func DatasetStatus_Values() []string { } } +const ( + // InferenceDataImportStrategyNoImport is a InferenceDataImportStrategy enum value + InferenceDataImportStrategyNoImport = "NO_IMPORT" + + // InferenceDataImportStrategyAddWhenEmpty is a InferenceDataImportStrategy enum value + InferenceDataImportStrategyAddWhenEmpty = "ADD_WHEN_EMPTY" + + // InferenceDataImportStrategyOverwrite is a InferenceDataImportStrategy enum value + InferenceDataImportStrategyOverwrite = "OVERWRITE" +) + +// InferenceDataImportStrategy_Values returns all elements of the InferenceDataImportStrategy enum +func InferenceDataImportStrategy_Values() []string { + return []string{ + InferenceDataImportStrategyNoImport, + InferenceDataImportStrategyAddWhenEmpty, + InferenceDataImportStrategyOverwrite, + } +} + const ( // InferenceExecutionStatusInProgress is a InferenceExecutionStatus enum value InferenceExecutionStatusInProgress = "IN_PROGRESS" @@ -13651,6 +15794,22 @@ func LatestInferenceResult_Values() []string { } } +const ( + // ModelPromoteModeManaged is a ModelPromoteMode enum value + ModelPromoteModeManaged = "MANAGED" + + // ModelPromoteModeManual is a ModelPromoteMode enum value + ModelPromoteModeManual = "MANUAL" +) + +// ModelPromoteMode_Values returns all elements of the ModelPromoteMode enum +func ModelPromoteMode_Values() []string { + return []string{ + ModelPromoteModeManaged, + ModelPromoteModeManual, + } +} + const ( // ModelStatusInProgress is a ModelStatus enum value ModelStatusInProgress = "IN_PROGRESS" @@ -13743,6 +15902,30 @@ func Monotonicity_Values() []string { } } +const ( + // RetrainingSchedulerStatusPending is a RetrainingSchedulerStatus enum value + RetrainingSchedulerStatusPending = "PENDING" + + // RetrainingSchedulerStatusRunning is a RetrainingSchedulerStatus enum value + RetrainingSchedulerStatusRunning = "RUNNING" + + // RetrainingSchedulerStatusStopping is a RetrainingSchedulerStatus enum value + RetrainingSchedulerStatusStopping = "STOPPING" + + // RetrainingSchedulerStatusStopped is a RetrainingSchedulerStatus enum value + RetrainingSchedulerStatusStopped = "STOPPED" +) + +// RetrainingSchedulerStatus_Values returns all elements of the RetrainingSchedulerStatus enum +func RetrainingSchedulerStatus_Values() []string { + return []string{ + RetrainingSchedulerStatusPending, + RetrainingSchedulerStatusRunning, + RetrainingSchedulerStatusStopping, + RetrainingSchedulerStatusStopped, + } +} + const ( // StatisticalIssueStatusPotentialIssueDetected is a StatisticalIssueStatus enum value StatisticalIssueStatusPotentialIssueDetected = "POTENTIAL_ISSUE_DETECTED" diff --git a/service/lookoutequipment/examples_test.go b/service/lookoutequipment/examples_test.go new file mode 100644 index 00000000000..db8cc25820b --- /dev/null +++ b/service/lookoutequipment/examples_test.go @@ -0,0 +1,384 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package lookoutequipment_test + +import ( + "fmt" + "strings" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awserr" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/aws/aws-sdk-go/service/lookoutequipment" +) + +var _ time.Duration +var _ strings.Reader +var _ aws.Config + +func parseTime(layout, value string) *time.Time { + t, err := time.Parse(layout, value) + if err != nil { + panic(err) + } + return &t +} + +// Creates a retraining scheduler with manual promote mode +// + +func ExampleLookoutEquipment_CreateRetrainingScheduler_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.CreateRetrainingSchedulerInput{ + ClientToken: aws.String("sample-client-token"), + LookbackWindow: aws.String("P360D"), + ModelName: aws.String("sample-model"), + PromoteMode: aws.String("MANUAL"), + RetrainingFrequency: aws.String("P1M"), + } + + result, err := svc.CreateRetrainingScheduler(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeConflictException: + fmt.Println(lookoutequipment.ErrCodeConflictException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Creates a retraining scheduler with a specific start date +// + +func ExampleLookoutEquipment_CreateRetrainingScheduler_shared01() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.CreateRetrainingSchedulerInput{ + ClientToken: aws.String("sample-client-token"), + LookbackWindow: aws.String("P360D"), + ModelName: aws.String("sample-model"), + RetrainingFrequency: aws.String("P1M"), + RetrainingStartDate: parseTime("2006-01-02T15:04:05.999999999Z", "2024-01-01T00:00:00Z"), + } + + result, err := svc.CreateRetrainingScheduler(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeConflictException: + fmt.Println(lookoutequipment.ErrCodeConflictException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Deletes a retraining scheduler +// + +func ExampleLookoutEquipment_DeleteRetrainingScheduler_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.DeleteRetrainingSchedulerInput{ + ModelName: aws.String("sample-model"), + } + + result, err := svc.DeleteRetrainingScheduler(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeConflictException: + fmt.Println(lookoutequipment.ErrCodeConflictException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Describes a retraining scheduler +// + +func ExampleLookoutEquipment_DescribeRetrainingScheduler_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.DescribeRetrainingSchedulerInput{ + ModelName: aws.String("sample-model"), + } + + result, err := svc.DescribeRetrainingScheduler(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Listing retraining schedulers +// + +func ExampleLookoutEquipment_ListRetrainingSchedulers_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.ListRetrainingSchedulersInput{ + MaxResults: aws.Int64(50), + } + + result, err := svc.ListRetrainingSchedulers(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Starts a retraining scheduler +// + +func ExampleLookoutEquipment_StartRetrainingScheduler_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.StartRetrainingSchedulerInput{ + ModelName: aws.String("sample-model"), + } + + result, err := svc.StartRetrainingScheduler(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeConflictException: + fmt.Println(lookoutequipment.ErrCodeConflictException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Stops a retraining scheduler +// + +func ExampleLookoutEquipment_StopRetrainingScheduler_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.StopRetrainingSchedulerInput{ + ModelName: aws.String("sample-model"), + } + + result, err := svc.StopRetrainingScheduler(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeConflictException: + fmt.Println(lookoutequipment.ErrCodeConflictException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Updates a model +// + +func ExampleLookoutEquipment_UpdateModel_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.UpdateModelInput{ + LabelsInputConfiguration: &lookoutequipment.LabelsInputConfiguration{ + LabelGroupName: aws.String("sample-label-group"), + }, + ModelName: aws.String("sample-model"), + } + + result, err := svc.UpdateModel(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeConflictException: + fmt.Println(lookoutequipment.ErrCodeConflictException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// Updates a retraining scheduler +// + +func ExampleLookoutEquipment_UpdateRetrainingScheduler_shared00() { + svc := lookoutequipment.New(session.New()) + input := &lookoutequipment.UpdateRetrainingSchedulerInput{ + ModelName: aws.String("sample-model"), + RetrainingFrequency: aws.String("P1Y"), + RetrainingStartDate: parseTime("2006-01-02T15:04:05.999999999Z", "2024-01-01T00:00:00Z"), + } + + result, err := svc.UpdateRetrainingScheduler(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case lookoutequipment.ErrCodeValidationException: + fmt.Println(lookoutequipment.ErrCodeValidationException, aerr.Error()) + case lookoutequipment.ErrCodeResourceNotFoundException: + fmt.Println(lookoutequipment.ErrCodeResourceNotFoundException, aerr.Error()) + case lookoutequipment.ErrCodeConflictException: + fmt.Println(lookoutequipment.ErrCodeConflictException, aerr.Error()) + case lookoutequipment.ErrCodeThrottlingException: + fmt.Println(lookoutequipment.ErrCodeThrottlingException, aerr.Error()) + case lookoutequipment.ErrCodeAccessDeniedException: + fmt.Println(lookoutequipment.ErrCodeAccessDeniedException, aerr.Error()) + case lookoutequipment.ErrCodeInternalServerException: + fmt.Println(lookoutequipment.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} diff --git a/service/lookoutequipment/lookoutequipmentiface/interface.go b/service/lookoutequipment/lookoutequipmentiface/interface.go index 1268d2ea6aa..bc8cc9a44f2 100644 --- a/service/lookoutequipment/lookoutequipmentiface/interface.go +++ b/service/lookoutequipment/lookoutequipmentiface/interface.go @@ -80,6 +80,10 @@ type LookoutEquipmentAPI interface { CreateModelWithContext(aws.Context, *lookoutequipment.CreateModelInput, ...request.Option) (*lookoutequipment.CreateModelOutput, error) CreateModelRequest(*lookoutequipment.CreateModelInput) (*request.Request, *lookoutequipment.CreateModelOutput) + CreateRetrainingScheduler(*lookoutequipment.CreateRetrainingSchedulerInput) (*lookoutequipment.CreateRetrainingSchedulerOutput, error) + CreateRetrainingSchedulerWithContext(aws.Context, *lookoutequipment.CreateRetrainingSchedulerInput, ...request.Option) (*lookoutequipment.CreateRetrainingSchedulerOutput, error) + CreateRetrainingSchedulerRequest(*lookoutequipment.CreateRetrainingSchedulerInput) (*request.Request, *lookoutequipment.CreateRetrainingSchedulerOutput) + DeleteDataset(*lookoutequipment.DeleteDatasetInput) (*lookoutequipment.DeleteDatasetOutput, error) DeleteDatasetWithContext(aws.Context, *lookoutequipment.DeleteDatasetInput, ...request.Option) (*lookoutequipment.DeleteDatasetOutput, error) DeleteDatasetRequest(*lookoutequipment.DeleteDatasetInput) (*request.Request, *lookoutequipment.DeleteDatasetOutput) @@ -104,6 +108,10 @@ type LookoutEquipmentAPI interface { DeleteResourcePolicyWithContext(aws.Context, *lookoutequipment.DeleteResourcePolicyInput, ...request.Option) (*lookoutequipment.DeleteResourcePolicyOutput, error) DeleteResourcePolicyRequest(*lookoutequipment.DeleteResourcePolicyInput) (*request.Request, *lookoutequipment.DeleteResourcePolicyOutput) + DeleteRetrainingScheduler(*lookoutequipment.DeleteRetrainingSchedulerInput) (*lookoutequipment.DeleteRetrainingSchedulerOutput, error) + DeleteRetrainingSchedulerWithContext(aws.Context, *lookoutequipment.DeleteRetrainingSchedulerInput, ...request.Option) (*lookoutequipment.DeleteRetrainingSchedulerOutput, error) + DeleteRetrainingSchedulerRequest(*lookoutequipment.DeleteRetrainingSchedulerInput) (*request.Request, *lookoutequipment.DeleteRetrainingSchedulerOutput) + DescribeDataIngestionJob(*lookoutequipment.DescribeDataIngestionJobInput) (*lookoutequipment.DescribeDataIngestionJobOutput, error) DescribeDataIngestionJobWithContext(aws.Context, *lookoutequipment.DescribeDataIngestionJobInput, ...request.Option) (*lookoutequipment.DescribeDataIngestionJobOutput, error) DescribeDataIngestionJobRequest(*lookoutequipment.DescribeDataIngestionJobInput) (*request.Request, *lookoutequipment.DescribeDataIngestionJobOutput) @@ -136,6 +144,10 @@ type LookoutEquipmentAPI interface { DescribeResourcePolicyWithContext(aws.Context, *lookoutequipment.DescribeResourcePolicyInput, ...request.Option) (*lookoutequipment.DescribeResourcePolicyOutput, error) DescribeResourcePolicyRequest(*lookoutequipment.DescribeResourcePolicyInput) (*request.Request, *lookoutequipment.DescribeResourcePolicyOutput) + DescribeRetrainingScheduler(*lookoutequipment.DescribeRetrainingSchedulerInput) (*lookoutequipment.DescribeRetrainingSchedulerOutput, error) + DescribeRetrainingSchedulerWithContext(aws.Context, *lookoutequipment.DescribeRetrainingSchedulerInput, ...request.Option) (*lookoutequipment.DescribeRetrainingSchedulerOutput, error) + DescribeRetrainingSchedulerRequest(*lookoutequipment.DescribeRetrainingSchedulerInput) (*request.Request, *lookoutequipment.DescribeRetrainingSchedulerOutput) + ImportDataset(*lookoutequipment.ImportDatasetInput) (*lookoutequipment.ImportDatasetOutput, error) ImportDatasetWithContext(aws.Context, *lookoutequipment.ImportDatasetInput, ...request.Option) (*lookoutequipment.ImportDatasetOutput, error) ImportDatasetRequest(*lookoutequipment.ImportDatasetInput) (*request.Request, *lookoutequipment.ImportDatasetOutput) @@ -207,6 +219,13 @@ type LookoutEquipmentAPI interface { ListModelsPages(*lookoutequipment.ListModelsInput, func(*lookoutequipment.ListModelsOutput, bool) bool) error ListModelsPagesWithContext(aws.Context, *lookoutequipment.ListModelsInput, func(*lookoutequipment.ListModelsOutput, bool) bool, ...request.Option) error + ListRetrainingSchedulers(*lookoutequipment.ListRetrainingSchedulersInput) (*lookoutequipment.ListRetrainingSchedulersOutput, error) + ListRetrainingSchedulersWithContext(aws.Context, *lookoutequipment.ListRetrainingSchedulersInput, ...request.Option) (*lookoutequipment.ListRetrainingSchedulersOutput, error) + ListRetrainingSchedulersRequest(*lookoutequipment.ListRetrainingSchedulersInput) (*request.Request, *lookoutequipment.ListRetrainingSchedulersOutput) + + ListRetrainingSchedulersPages(*lookoutequipment.ListRetrainingSchedulersInput, func(*lookoutequipment.ListRetrainingSchedulersOutput, bool) bool) error + ListRetrainingSchedulersPagesWithContext(aws.Context, *lookoutequipment.ListRetrainingSchedulersInput, func(*lookoutequipment.ListRetrainingSchedulersOutput, bool) bool, ...request.Option) error + ListSensorStatistics(*lookoutequipment.ListSensorStatisticsInput) (*lookoutequipment.ListSensorStatisticsOutput, error) ListSensorStatisticsWithContext(aws.Context, *lookoutequipment.ListSensorStatisticsInput, ...request.Option) (*lookoutequipment.ListSensorStatisticsOutput, error) ListSensorStatisticsRequest(*lookoutequipment.ListSensorStatisticsInput) (*request.Request, *lookoutequipment.ListSensorStatisticsOutput) @@ -230,10 +249,18 @@ type LookoutEquipmentAPI interface { StartInferenceSchedulerWithContext(aws.Context, *lookoutequipment.StartInferenceSchedulerInput, ...request.Option) (*lookoutequipment.StartInferenceSchedulerOutput, error) StartInferenceSchedulerRequest(*lookoutequipment.StartInferenceSchedulerInput) (*request.Request, *lookoutequipment.StartInferenceSchedulerOutput) + StartRetrainingScheduler(*lookoutequipment.StartRetrainingSchedulerInput) (*lookoutequipment.StartRetrainingSchedulerOutput, error) + StartRetrainingSchedulerWithContext(aws.Context, *lookoutequipment.StartRetrainingSchedulerInput, ...request.Option) (*lookoutequipment.StartRetrainingSchedulerOutput, error) + StartRetrainingSchedulerRequest(*lookoutequipment.StartRetrainingSchedulerInput) (*request.Request, *lookoutequipment.StartRetrainingSchedulerOutput) + StopInferenceScheduler(*lookoutequipment.StopInferenceSchedulerInput) (*lookoutequipment.StopInferenceSchedulerOutput, error) StopInferenceSchedulerWithContext(aws.Context, *lookoutequipment.StopInferenceSchedulerInput, ...request.Option) (*lookoutequipment.StopInferenceSchedulerOutput, error) StopInferenceSchedulerRequest(*lookoutequipment.StopInferenceSchedulerInput) (*request.Request, *lookoutequipment.StopInferenceSchedulerOutput) + StopRetrainingScheduler(*lookoutequipment.StopRetrainingSchedulerInput) (*lookoutequipment.StopRetrainingSchedulerOutput, error) + StopRetrainingSchedulerWithContext(aws.Context, *lookoutequipment.StopRetrainingSchedulerInput, ...request.Option) (*lookoutequipment.StopRetrainingSchedulerOutput, error) + StopRetrainingSchedulerRequest(*lookoutequipment.StopRetrainingSchedulerInput) (*request.Request, *lookoutequipment.StopRetrainingSchedulerOutput) + TagResource(*lookoutequipment.TagResourceInput) (*lookoutequipment.TagResourceOutput, error) TagResourceWithContext(aws.Context, *lookoutequipment.TagResourceInput, ...request.Option) (*lookoutequipment.TagResourceOutput, error) TagResourceRequest(*lookoutequipment.TagResourceInput) (*request.Request, *lookoutequipment.TagResourceOutput) @@ -253,6 +280,14 @@ type LookoutEquipmentAPI interface { UpdateLabelGroup(*lookoutequipment.UpdateLabelGroupInput) (*lookoutequipment.UpdateLabelGroupOutput, error) UpdateLabelGroupWithContext(aws.Context, *lookoutequipment.UpdateLabelGroupInput, ...request.Option) (*lookoutequipment.UpdateLabelGroupOutput, error) UpdateLabelGroupRequest(*lookoutequipment.UpdateLabelGroupInput) (*request.Request, *lookoutequipment.UpdateLabelGroupOutput) + + UpdateModel(*lookoutequipment.UpdateModelInput) (*lookoutequipment.UpdateModelOutput, error) + UpdateModelWithContext(aws.Context, *lookoutequipment.UpdateModelInput, ...request.Option) (*lookoutequipment.UpdateModelOutput, error) + UpdateModelRequest(*lookoutequipment.UpdateModelInput) (*request.Request, *lookoutequipment.UpdateModelOutput) + + UpdateRetrainingScheduler(*lookoutequipment.UpdateRetrainingSchedulerInput) (*lookoutequipment.UpdateRetrainingSchedulerOutput, error) + UpdateRetrainingSchedulerWithContext(aws.Context, *lookoutequipment.UpdateRetrainingSchedulerInput, ...request.Option) (*lookoutequipment.UpdateRetrainingSchedulerOutput, error) + UpdateRetrainingSchedulerRequest(*lookoutequipment.UpdateRetrainingSchedulerInput) (*request.Request, *lookoutequipment.UpdateRetrainingSchedulerOutput) } var _ LookoutEquipmentAPI = (*lookoutequipment.LookoutEquipment)(nil)