The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\n To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)\n path.
\nThe default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned\n a value in the request. Because Amazon Linux AMI has ended standard support as of December 31,\n 2020, we recommend you choose Amazon Linux 2, which includes long term support through\n 2023.
\nFrom December 31, 2023, the parameter for Amazon Linux will no longer be available when\n you specify an AMI for your instance. Amazon Linux 2 will then become the default AMI, which\n is used to launch your instance if no parameter is explicitly defined.
\n\n AMI aliases \n
\n\n Amazon Linux (default):\n amazonlinux-1-x86_64\n \n
Amazon Linux 2: amazonlinux-2-x86_64\n
Ubuntu 18.04: ubuntu-18.04-x86_64\n
Ubuntu 22.04: ubuntu-22.04-x86_64\n
\n SSM paths\n
\n\n Amazon Linux (default):\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64\n \n
Amazon Linux 2:\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64\n
Ubuntu 18.04:\n resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64\n
Ubuntu 22.04:\n resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64\n
The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\n To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)\n path.
\nThe default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned\n a value in the request. Because Amazon Linux AMI has ended standard support as of December 31,\n 2020, we recommend you choose Amazon Linux 2, which includes long term support through\n 2023.
\nFrom December 31, 2023, the parameter for Amazon Linux will no longer be available when\n you specify an AMI for your instance. Amazon Linux 2 will then become the default AMI, which\n is used to launch your instance if no parameter is explicitly defined.
\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.
\n\n AMI aliases \n
\n\n Amazon Linux (default):\n amazonlinux-1-x86_64\n \n
Amazon Linux 2: amazonlinux-2-x86_64\n
Ubuntu 18.04: ubuntu-18.04-x86_64\n
Ubuntu 22.04: ubuntu-22.04-x86_64\n
\n SSM paths\n
\n\n Amazon Linux (default):\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64\n \n
Amazon Linux 2:\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64\n
Ubuntu 18.04:\n resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64\n
Ubuntu 22.04:\n resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64\n
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nThe Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -4777,7 +4777,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account. This requires ListStacks and DescribeStacks permissions.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.
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\n resource-level permissions and avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -5505,7 +5505,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations\n in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations\n in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -11075,7 +11075,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple Administrators in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple Administrators in the\n CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -12715,7 +12715,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nThe Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" } }, "ExecutionRoleName": { diff --git a/codegen/sdk/aws-models/drs.json b/codegen/sdk/aws-models/drs.json index 2d7e4c44717..ad8c7eb8216 100644 --- a/codegen/sdk/aws-models/drs.json +++ b/codegen/sdk/aws-models/drs.json @@ -181,7 +181,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z]$" + "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me|il)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z]$" } }, "com.amazonaws.drs#AwsRegion": { @@ -191,7 +191,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]$" + "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me|il)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]$" } }, "com.amazonaws.drs#BoundedString": { @@ -472,6 +472,12 @@ "traits": { "smithy.api#documentation": "S3 bucket ARN to export Source Network templates.
" } + }, + "postLaunchEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we want to activate post-launch actions.
" + } } } }, @@ -1139,6 +1145,67 @@ "type": "structure", "members": {} }, + "com.amazonaws.drs#DeleteLaunchAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteLaunchActionRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteLaunchActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a resource launch action.
", + "smithy.api#http": { + "uri": "/DeleteLaunchAction", + "method": "POST", + "code": 204 + } + } + }, + "com.amazonaws.drs#DeleteLaunchActionRequest": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.drs#LaunchActionResourceId", + "traits": { + "smithy.api#required": {} + } + }, + "actionId": { + "target": "com.amazonaws.drs#LaunchActionId", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#DeleteLaunchActionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#DeleteLaunchConfigurationTemplate": { "type": "operation", "input": { @@ -2431,18 +2498,27 @@ { "target": "com.amazonaws.drs#CreateExtendedSourceServer" }, + { + "target": "com.amazonaws.drs#DeleteLaunchAction" + }, { "target": "com.amazonaws.drs#InitializeService" }, { "target": "com.amazonaws.drs#ListExtensibleSourceServers" }, + { + "target": "com.amazonaws.drs#ListLaunchActions" + }, { "target": "com.amazonaws.drs#ListStagingAccounts" }, { "target": "com.amazonaws.drs#ListTagsForResource" }, + { + "target": "com.amazonaws.drs#PutLaunchAction" + }, { "target": "com.amazonaws.drs#TagResource" }, @@ -3641,6 +3717,16 @@ ] } }, + "com.amazonaws.drs#FailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[0-9a-zA-Z ():/.,'-_#*;]*$" + } + }, "com.amazonaws.drs#GetFailbackReplicationConfiguration": { "type": "operation", "input": { @@ -4350,19 +4436,376 @@ ] } }, - "com.amazonaws.drs#LastLaunchType": { - "type": "string", + "com.amazonaws.drs#LastLaunchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "RECOVERY", + "value": "RECOVERY" + }, + { + "name": "DRILL", + "value": "DRILL" + } + ] + } + }, + "com.amazonaws.drs#LaunchAction": { + "type": "structure", + "members": { + "actionId": { + "target": "com.amazonaws.drs#LaunchActionId" + }, + "actionCode": { + "target": "com.amazonaws.drs#SsmDocumentName", + "traits": { + "smithy.api#documentation": "Launch action code.
" + } + }, + "type": { + "target": "com.amazonaws.drs#LaunchActionType", + "traits": { + "smithy.api#documentation": "Launch action type.
" + } + }, + "name": { + "target": "com.amazonaws.drs#LaunchActionName" + }, + "active": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the launch action is active.
" + } + }, + "order": { + "target": "com.amazonaws.drs#LaunchActionOrder", + "traits": { + "smithy.api#default": 0 + } + }, + "actionVersion": { + "target": "com.amazonaws.drs#LaunchActionVersion" + }, + "optional": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the launch will not be marked as failed if this action fails.
" + } + }, + "parameters": { + "target": "com.amazonaws.drs#LaunchActionParameters" + }, + "description": { + "target": "com.amazonaws.drs#LaunchActionDescription" + }, + "category": { + "target": "com.amazonaws.drs#LaunchActionCategory" + } + }, + "traits": { + "smithy.api#documentation": "Launch action.
" + } + }, + "com.amazonaws.drs#LaunchActionCategory": { + "type": "string", + "traits": { + "smithy.api#documentation": "Launch action category.
", + "smithy.api#enum": [ + { + "value": "MONITORING", + "name": "MONITORING" + }, + { + "value": "VALIDATION", + "name": "VALIDATION" + }, + { + "value": "CONFIGURATION", + "name": "CONFIGURATION" + }, + { + "value": "SECURITY", + "name": "SECURITY" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.drs#LaunchActionDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "Launch action description.
", + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9a-zA-Z ():/.,'-_#*;\n]*$" + } + }, + "com.amazonaws.drs#LaunchActionId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Launch action Id.
", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.drs#LaunchActionIds": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#LaunchActionId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.drs#LaunchActionName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Launch action name.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9 /_-]*$" + } + }, + "com.amazonaws.drs#LaunchActionOrder": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Launch action order.
", + "smithy.api#range": { + "min": 2, + "max": 10000 + } + } + }, + "com.amazonaws.drs#LaunchActionParameter": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.drs#LaunchActionParameterValue", + "traits": { + "smithy.api#documentation": "Value.
" + } + }, + "type": { + "target": "com.amazonaws.drs#LaunchActionParameterType", + "traits": { + "smithy.api#documentation": "Type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Launch action parameter.
" + } + }, + "com.amazonaws.drs#LaunchActionParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^([A-Za-z0-9])+$" + } + }, + "com.amazonaws.drs#LaunchActionParameterType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSM_STORE", + "name": "SSM_STORE" + }, + { + "value": "DYNAMIC", + "name": "DYNAMIC" + } + ] + } + }, + "com.amazonaws.drs#LaunchActionParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^[A-Za-z0-9.-]+$" + } + }, + "com.amazonaws.drs#LaunchActionParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#LaunchActionParameterName" + }, + "value": { + "target": "com.amazonaws.drs#LaunchActionParameter" + }, + "traits": { + "smithy.api#documentation": "Launch action parameters.
", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.drs#LaunchActionResourceId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Launch configuration template Id or Source Server Id
", + "smithy.api#pattern": "^(s-[0-9a-zA-Z]{17}$|lct-[0-9a-zA-Z]{17})$" + } + }, + "com.amazonaws.drs#LaunchActionRun": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.drs#LaunchAction", + "traits": { + "smithy.api#documentation": "Action.
" + } + }, + "runId": { + "target": "com.amazonaws.drs#LaunchActionRunId", + "traits": { + "smithy.api#documentation": "Run Id.
" + } + }, + "status": { + "target": "com.amazonaws.drs#LaunchActionRunStatus", + "traits": { + "smithy.api#documentation": "Run status.
" + } + }, + "failureReason": { + "target": "com.amazonaws.drs#FailureReason", + "traits": { + "smithy.api#documentation": "Failure reason.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Launch action run.
" + } + }, + "com.amazonaws.drs#LaunchActionRunId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.drs#LaunchActionRunStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.drs#LaunchActionRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#LaunchActionRun" + } + }, + "com.amazonaws.drs#LaunchActionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSM_AUTOMATION", + "name": "SSM_AUTOMATION" + }, + { + "value": "SSM_COMMAND", + "name": "SSM_COMMAND" + } + ] + } + }, + "com.amazonaws.drs#LaunchActionVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Launch action version.
", + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#pattern": "^(\\$DEFAULT|\\$LATEST|[0-9]+)$" + } + }, + "com.amazonaws.drs#LaunchActions": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#LaunchAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#LaunchActionsRequestFilters": { + "type": "structure", + "members": { + "actionIds": { + "target": "com.amazonaws.drs#LaunchActionIds", + "traits": { + "smithy.api#documentation": "Launch actions Ids.
" + } + } + }, "traits": { - "smithy.api#enum": [ - { - "name": "RECOVERY", - "value": "RECOVERY" - }, - { - "name": "DRILL", - "value": "DRILL" + "smithy.api#documentation": "Resource launch actions filter.
" + } + }, + "com.amazonaws.drs#LaunchActionsStatus": { + "type": "structure", + "members": { + "ssmAgentDiscoveryDatetime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "Time where the AWS Systems Manager was detected as running on the launched instance.
" } - ] + }, + "runs": { + "target": "com.amazonaws.drs#LaunchActionRuns", + "traits": { + "smithy.api#documentation": "List of post launch action status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Launch actions status.
" } }, "com.amazonaws.drs#LaunchConfiguration": { @@ -4415,6 +4858,12 @@ "traits": { "smithy.api#documentation": "The licensing configuration to be used for this launch configuration.
" } + }, + "postLaunchEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we want to activate post-launch actions for the Source Server.
" + } } } }, @@ -4474,6 +4923,12 @@ "traits": { "smithy.api#documentation": "S3 bucket ARN to export Source Network templates.
" } + }, + "postLaunchEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Post-launch actions activated.
" + } } }, "traits": { @@ -4762,6 +5217,100 @@ } } }, + "com.amazonaws.drs#ListLaunchActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ListLaunchActionsRequest" + }, + "output": { + "target": "com.amazonaws.drs#ListLaunchActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Lists resource launch actions.
", + "smithy.api#http": { + "uri": "/ListLaunchActions", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#ListLaunchActionsRequest": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.drs#LaunchActionResourceId", + "traits": { + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.drs#LaunchActionsRequestFilters", + "traits": { + "smithy.api#documentation": "Filters to apply when listing resource launch actions.
" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#MaxResultsType", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Maximum amount of items to return when listing resource launch actions.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "Next token to use when listing resource launch actions.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#ListLaunchActionsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#LaunchActions", + "traits": { + "smithy.api#documentation": "List of resource launch actions.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "Next token returned when listing resource launch actions.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#ListStagingAccounts": { "type": "operation", "input": { @@ -5132,6 +5681,12 @@ "traits": { "smithy.api#documentation": "The launch status of a participating server.
" } + }, + "launchActionsStatus": { + "target": "com.amazonaws.drs#LaunchActionsStatus", + "traits": { + "smithy.api#documentation": "The post-launch action runs of a participating server.
" + } } }, "traits": { @@ -5153,6 +5708,174 @@ } } }, + "com.amazonaws.drs#PutLaunchAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#PutLaunchActionRequest" + }, + "output": { + "target": "com.amazonaws.drs#PutLaunchActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Puts a resource launch action.
", + "smithy.api#http": { + "uri": "/PutLaunchAction", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#PutLaunchActionRequest": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.drs#LaunchActionResourceId", + "traits": { + "smithy.api#required": {} + } + }, + "actionCode": { + "target": "com.amazonaws.drs#SsmDocumentName", + "traits": { + "smithy.api#documentation": "Launch action code.
", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.drs#LaunchActionOrder", + "traits": { + "smithy.api#default": 0, + "smithy.api#required": {} + } + }, + "actionId": { + "target": "com.amazonaws.drs#LaunchActionId", + "traits": { + "smithy.api#required": {} + } + }, + "optional": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the launch will not be marked as failed if this action fails.
", + "smithy.api#required": {} + } + }, + "active": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the launch action is active.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#LaunchActionName", + "traits": { + "smithy.api#required": {} + } + }, + "actionVersion": { + "target": "com.amazonaws.drs#LaunchActionVersion", + "traits": { + "smithy.api#required": {} + } + }, + "category": { + "target": "com.amazonaws.drs#LaunchActionCategory", + "traits": { + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.drs#LaunchActionParameters" + }, + "description": { + "target": "com.amazonaws.drs#LaunchActionDescription" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#PutLaunchActionResponse": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.drs#LaunchActionResourceId" + }, + "actionId": { + "target": "com.amazonaws.drs#LaunchActionId" + }, + "actionCode": { + "target": "com.amazonaws.drs#SsmDocumentName", + "traits": { + "smithy.api#documentation": "Launch action code.
" + } + }, + "type": { + "target": "com.amazonaws.drs#LaunchActionType", + "traits": { + "smithy.api#documentation": "Launch action type.
" + } + }, + "name": { + "target": "com.amazonaws.drs#LaunchActionName" + }, + "active": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the launch action is active.
" + } + }, + "order": { + "target": "com.amazonaws.drs#LaunchActionOrder", + "traits": { + "smithy.api#default": 0 + } + }, + "actionVersion": { + "target": "com.amazonaws.drs#LaunchActionVersion" + }, + "optional": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the launch will not be marked as failed if this action fails.
" + } + }, + "parameters": { + "target": "com.amazonaws.drs#LaunchActionParameters" + }, + "description": { + "target": "com.amazonaws.drs#LaunchActionDescription" + }, + "category": { + "target": "com.amazonaws.drs#LaunchActionCategory" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#RecoveryInstance": { "type": "structure", "members": { @@ -7085,6 +7808,16 @@ "target": "com.amazonaws.drs#SourceServer" } }, + "com.amazonaws.drs#SsmDocumentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^([A-Za-z0-9-])+$" + } + }, "com.amazonaws.drs#StagingArea": { "type": "structure", "members": { @@ -8233,6 +8966,12 @@ "traits": { "smithy.api#documentation": "The licensing configuration to be used for this launch configuration.
" } + }, + "postLaunchEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we want to enable post-launch actions for the Source Server.
" + } } } }, @@ -8318,6 +9057,12 @@ "traits": { "smithy.api#documentation": "S3 bucket ARN to export Source Network templates.
" } + }, + "postLaunchEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we want to activate post-launch actions.
" + } } } }, diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 54cb71b85a9..bcd11511cd0 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -3254,6 +3254,9 @@ { "target": "com.amazonaws.ec2#DisableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccess" + }, { "target": "com.amazonaws.ec2#DisableImageDeprecation" }, @@ -3332,6 +3335,9 @@ { "target": "com.amazonaws.ec2#EnableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#EnableImageBlockPublicAccess" + }, { "target": "com.amazonaws.ec2#EnableImageDeprecation" }, @@ -3410,6 +3416,9 @@ { "target": "com.amazonaws.ec2#GetHostReservationPurchasePreview" }, + { + "target": "com.amazonaws.ec2#GetImageBlockPublicAccessState" + }, { "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements" }, @@ -42750,6 +42759,50 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisableImageBlockPublicAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessResult" + }, + "traits": { + "smithy.api#documentation": "Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.
\nThe API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.
For more information, see Block public access to your AMIs in\n the Amazon EC2 User Guide.
" + } + }, + "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns unblocked if the request succeeds; otherwise, it returns an\n error.
Enables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already\n have public AMIs, they will remain publicly available.
\nThe API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be unblocked. When\n the API has completed the configuration, the response will be\n block-new-sharing.
For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.
" + } + }, + "com.amazonaws.ec2#EnableImageBlockPublicAccessRequest": { + "type": "structure", + "members": { + "ImageBlockPublicAccessState": { + "target": "com.amazonaws.ec2#ImageBlockPublicAccessEnabledState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specify block-new-sharing to enable block public access for AMIs at the\n account level in the specified Region. This will block any attempt to publicly share your AMIs\n in the specified Region.
Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns block-new-sharing if the request succeeds; otherwise, it returns an\n error.
Gets the current state of block public access for AMIs at the account\n level in the specified Amazon Web Services Region.
\nFor more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.
" + } + }, + "com.amazonaws.ec2#GetImageBlockPublicAccessStateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.
The current state of block public access for AMIs at the account level in the specified\n Amazon Web Services Region.
\nPossible values:
\n\n block-new-sharing - Any attempt to publicly share your AMIs in the\n specified Region is blocked.
\n unblocked - Your AMIs in the specified Region can be publicly\n shared.
The name to use for the repository. The repository name may be specified on its own\n (such as nginx-web-app) or it can be prepended with a namespace to group\n the repository into a category (such as project-a/nginx-web-app).
The name to use for the repository. The repository name may be specified on its own\n (such as nginx-web-app) or it can be prepended with a namespace to group\n the repository into a category (such as project-a/nginx-web-app).
The repository name must start with a letter and can only contain lowercase letters,\n numbers, hyphens, underscores, and forward slashes.
", "smithy.api#required": {} } }, @@ -2171,6 +2171,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -3505,6 +3508,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -3531,6 +3537,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -5669,6 +5678,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -6006,7 +6018,7 @@ "scanFrequency": { "target": "com.amazonaws.ecr#ScanFrequency", "traits": { - "smithy.api#documentation": "The frequency that scans are performed at for a private registry. When the\n ENHANCED scan type is specified, the supported scan frequencies are\n CONTINUOUS_SCAN and SCAN_ON_PUSH. When the\n BASIC scan type is specified, the SCAN_ON_PUSH and\n MANUAL scan frequencies are supported.
The frequency that scans are performed at for a private registry. When the\n ENHANCED scan type is specified, the supported scan frequencies are\n CONTINUOUS_SCAN and SCAN_ON_PUSH. When the\n BASIC scan type is specified, the SCAN_ON_PUSH scan\n frequency is supported. If scan on push is not specified, then the MANUAL\n scan frequency is set by default.
The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the\n repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name.\n For example, arn:aws:ecr:region:012345678910:repository/test.
The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the\n repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name.\n For example, arn:aws:ecr:region:012345678910:repository-namespace/repository-name.
The filter settings used with image replication. Specifying a repository filter to a\n replication rule provides a method for controlling which repositories in a private\n registry are replicated. If no repository filter is specified, all images in the\n repository are replicated.
" + "smithy.api#documentation": "The filter settings used with image replication. Specifying a repository filter to a\n replication rule provides a method for controlling which repositories in a private\n registry are replicated. If no filters are added, the contents of all repositories are\n replicated.
" } }, "com.amazonaws.ecr#RepositoryFilterList": { @@ -6956,6 +6968,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -7030,13 +7045,15 @@ "Key": { "target": "com.amazonaws.ecr#TagKey", "traits": { - "smithy.api#documentation": "One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.
One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.
A value acts as a descriptor within a tag category (key).
A value acts as a descriptor within a tag category (key).
Welcome to the AWS Entity Resolution API Reference.
\nAWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities \n that enable developers and analysts at advertising and marketing companies to build an accurate and \n complete view of their consumers.
\n\n With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, \n such as name, email address, and phone number. This holds true even when these records have incomplete or \n conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a \n customer relationship management (CRM) system, which includes account information like first name, last name, \n postal address, phone number, and email address, with a source record from a marketing system containing \n campaign information, such as username and email address.
\nTo learn more about AWS Entity Resolution concepts, procedures, and best practices, see the\n AWS Entity Resolution \n User Guide.
", + "smithy.api#documentation": "Welcome to the Entity Resolution API Reference.
\nEntity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities \n that enable developers and analysts at advertising and marketing companies to build an accurate and \n complete view of their consumers.
\n\n With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, \n and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, \n Entity Resolution can effectively match a source record from a customer relationship management (CRM) system \n with a source record from a marketing system containing campaign information.
\nTo learn more about Entity Resolution concepts, procedures, and best practices, see the\n Entity Resolution \n User Guide.
", "smithy.api#title": "AWS EntityResolution", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -870,7 +870,7 @@ "resolutionTechniques": { "target": "com.amazonaws.entityresolution#ResolutionTechniques", "traits": { - "smithy.api#documentation": "An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines the resolutionType and the\n ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", "smithy.api#required": {} } }, @@ -938,7 +938,7 @@ "resolutionTechniques": { "target": "com.amazonaws.entityresolution#ResolutionTechniques", "traits": { - "smithy.api#documentation": "An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines the resolutionType and the\n ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", "smithy.api#required": {} } } @@ -1016,7 +1016,8 @@ "mappedInputFields": { "target": "com.amazonaws.entityresolution#SchemaInputAttributes", "traits": { - "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
The name of the quota that has been breached.
" + } + }, + "quotaValue": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The current quota value for the customers.
" + } } }, "traits": { - "smithy.api#documentation": "The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. \n The error message describes the limit exceeded. HTTP Status Code: 402\n
The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. \n The error message describes the limit exceeded. HTTP Status Code: 402\n
The current status of the job. Either running, succeeded, \n queued, or failed.
The current status of the job.
", "smithy.api#required": {} } }, @@ -1517,7 +1530,7 @@ "resolutionTechniques": { "target": "com.amazonaws.entityresolution#ResolutionTechniques", "traits": { - "smithy.api#documentation": "An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines the resolutionType and the\n ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access \n resources on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access \n resources on your behalf.
", "smithy.api#required": {} } }, @@ -1739,7 +1752,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500\n
This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500\n
The total number of records processed.
" } }, - "matchIDs": { + "recordsNotProcessed": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The total number of matchIDs generated.
The total number of records that did not get processed.
" } }, - "recordsNotProcessed": { + "matchIDs": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The total number of records that did not get processed,
" + "smithy.api#documentation": "The total number of matchIDs generated.
The current status of the job. Either running, succeeded, \n queued, or failed.
The current status of the job.
", "smithy.api#required": {} } }, @@ -1940,7 +1953,7 @@ "jobs": { "target": "com.amazonaws.entityresolution#JobList", "traits": { - "smithy.api#documentation": "A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
" + "smithy.api#documentation": "A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
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 AWS account.
Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
Displays the tags associated with an AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
Displays the tags associated with an Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.
The S3 path to which Entity Resolution will write the output table.
", - "smithy.api#pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", "smithy.api#required": {} } }, + "KMSArn": { + "target": "com.amazonaws.entityresolution#KMSArn", + "traits": { + "smithy.api#documentation": "Customer KMS ARN for encryption at rest. If not provided, system will use an \n Entity Resolution managed KMS key.
" + } + }, "output": { "target": "com.amazonaws.entityresolution#OutputAttributes", "traits": { - "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.
Customer KMS ARN for encryption at rest. If not provided, system will use an \n Entity Resolution managed KMS key.
" - } - }, "applyNormalization": { "target": "smithy.api#Boolean", "traits": { @@ -2305,7 +2317,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.
There are two types of matching, RULE_MATCHING and ML_MATCHING\n
The type of matching. There are two types of matching: RULE_MATCHING and\n ML_MATCHING.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines the resolutionType and the\n ruleBasedProperties.
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\n MatchingKeys.
You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When \n choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For \n example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, \n the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if \n the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of \n the Email field of Profile B matches, the two profiles are matched on the Email type.
The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When \n choosing MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For \n example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, \n the two profiles are matched on the Email type. When choosing ONE_TO_ONE ,the system can only match if \n the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of \n the Email field of Profile B matches, the two profiles are matched on the Email type.
A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the MatchKey\n Address' to both attributes, Entity Resolution will match records\n across these fields to create a consolidated matching group. If no MatchKey is\n specified for a column, it won't be utilized for matching purposes but will still be\n included in the output table.
A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the MatchKey\n Address to both attributes, Entity Resolution will match records across these\n fields to create a consolidated matching group. If no MatchKey is specified\n for a column, it won't be utilized for matching purposes but will still be included in the\n output table.
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution\n resource. Tags can help you organize and categorize your resources. You can also use them\n to scope user permissions by granting a user permission to access or change only resources\n with certain tag values. In Entity Resolution, SchemaMapping, and\n MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS\n and are interpreted strictly as strings of characters. You can use the\n TagResource action with a resource that already has tags. If you specify a\n new tag key, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you\n specify replaces the previous value for that tag.
Assigns one or more tags (key-value pairs) to the specified Entity Resolution\n resource. Tags can help you organize and categorize your resources. You can also use them\n to scope user permissions by granting a user permission to access or change only resources\n with certain tag values. In Entity Resolution, SchemaMapping and\n MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services\n and are interpreted strictly as strings of characters. You can use the\n TagResource action with a resource that already has tags. If you specify a\n new tag key, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you\n specify replaces the previous value for that tag.
Removes one or more tags from the specified AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
Removes one or more tags from the specified Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines the resolutionType and the ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", "smithy.api#required": {} } } @@ -3051,7 +3070,7 @@ "roleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", "smithy.api#required": {} } } @@ -3068,7 +3087,7 @@ } }, "traits": { - "smithy.api#documentation": "The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400\n
The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400\n
The value associated with the key.
" } @@ -2493,7 +2504,7 @@ } }, "Value": { - "target": "com.amazonaws.eventbridge#HeaderValue", + "target": "com.amazonaws.eventbridge#HeaderValueSensitive", "traits": { "smithy.api#documentation": "The value associated with the key.
" } @@ -2637,7 +2648,7 @@ } }, "Value": { - "target": "com.amazonaws.eventbridge#QueryStringValue", + "target": "com.amazonaws.eventbridge#QueryStringValueSensitive", "traits": { "smithy.api#documentation": "The value associated with the key for the query string parameter.
" } @@ -2973,7 +2984,7 @@ } }, "ApiKeyValue": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The value for the API key to use for authorization.
", "smithy.api#required": {} @@ -3027,7 +3038,7 @@ } }, "Password": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The password associated with the user name to use for Basic authorization.
", "smithy.api#required": {} @@ -3049,7 +3060,7 @@ } }, "ClientSecret": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The client secret associated with the client ID to use for OAuth authorization for the\n connection.
", "smithy.api#required": {} @@ -5461,6 +5472,17 @@ "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$" } }, + "com.amazonaws.eventbridge#HeaderValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.eventbridge#HealthCheck": { "type": "string", "traits": { @@ -7556,6 +7578,17 @@ "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$" } }, + "com.amazonaws.eventbridge#QueryStringValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.eventbridge#RedshiftDataParameters": { "type": "structure", "members": { @@ -8394,6 +8427,12 @@ "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]|\\d|\\-)*:([0-9]{12})?:secret:[\\/_+=\\.@\\-A-Za-z0-9]+$" } }, + "com.amazonaws.eventbridge#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.eventbridge#Sql": { "type": "string", "traits": { @@ -9236,7 +9275,7 @@ } }, "ApiKeyValue": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The value associated with teh API key to use for authorization.
" } @@ -9288,7 +9327,7 @@ } }, "Password": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The password associated with the user name to use for Basic authorization.
" } @@ -9308,7 +9347,7 @@ } }, "ClientSecret": { - "target": "com.amazonaws.eventbridge#AuthHeaderParameters", + "target": "com.amazonaws.eventbridge#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The client secret assciated with the client ID to use for OAuth authorization.
" } diff --git a/codegen/sdk/aws-models/firehose.json b/codegen/sdk/aws-models/firehose.json index cf412056a4a..53befa1a513 100644 --- a/codegen/sdk/aws-models/firehose.json +++ b/codegen/sdk/aws-models/firehose.json @@ -154,7 +154,7 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
" } }, "CollectionEndpoint": { @@ -422,6 +422,12 @@ }, "VpcConfiguration": { "target": "com.amazonaws.firehose#VpcConfiguration" + }, + "DocumentIdOptions": { + "target": "com.amazonaws.firehose#DocumentIdOptions", + "traits": { + "smithy.api#documentation": "Indicates the method for setting up document ID. The supported methods are Kinesis Data\n Firehose generated document ID and OpenSearch Service generated document ID.
" + } } }, "traits": { @@ -496,6 +502,12 @@ }, "VpcConfigurationDescription": { "target": "com.amazonaws.firehose#VpcConfigurationDescription" + }, + "DocumentIdOptions": { + "target": "com.amazonaws.firehose#DocumentIdOptions", + "traits": { + "smithy.api#documentation": "Indicates the method for setting up document ID. The supported methods are Kinesis Data\n Firehose generated document ID and OpenSearch Service generated document ID.
" + } } }, "traits": { @@ -561,6 +573,12 @@ }, "CloudWatchLoggingOptions": { "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "DocumentIdOptions": { + "target": "com.amazonaws.firehose#DocumentIdOptions", + "traits": { + "smithy.api#documentation": "Indicates the method for setting up document ID. The supported methods are Kinesis Data\n Firehose generated document ID and OpenSearch Service generated document ID.
" + } } }, "traits": { @@ -885,7 +903,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Kinesis Data Firehose delivery stream.
\nBy default, you can create up to 50 delivery streams per Amazon Web Services\n Region.
\nThis is an asynchronous operation that immediately returns. The initial status of the\n delivery stream is CREATING. After the delivery stream is created, its status\n is ACTIVE and it now accepts data. If the delivery stream creation fails, the\n status transitions to CREATING_FAILED. Attempts to send data to a delivery\n stream that is not in the ACTIVE state cause an exception. To check the state\n of a delivery stream, use DescribeDeliveryStream.
If the status of a delivery stream is CREATING_FAILED, this status\n doesn't change, and you can't invoke CreateDeliveryStream again on it.\n However, you can invoke the DeleteDeliveryStream operation to delete\n it.
A Kinesis Data Firehose delivery stream can be configured to receive records directly\n from providers using PutRecord or PutRecordBatch, or it\n can be configured to use an existing Kinesis stream as its source. To specify a Kinesis\n data stream as input, set the DeliveryStreamType parameter to\n KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name\n (ARN) and role ARN in the KinesisStreamSourceConfiguration\n parameter.
To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is\n optional. You can also invoke StartDeliveryStreamEncryption to turn on\n SSE for an existing delivery stream that doesn't have SSE enabled.
\nA delivery stream is configured with a single destination: Amazon S3, Amazon ES,\n Amazon Redshift, or Splunk. You must specify only one of the following destination\n configuration parameters: ExtendedS3DestinationConfiguration,\n S3DestinationConfiguration,\n ElasticsearchDestinationConfiguration,\n RedshiftDestinationConfiguration, or\n SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the\n following optional values: BufferingHints, EncryptionConfiguration, and\n CompressionFormat. By default, if no BufferingHints value is\n provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever\n condition is satisfied first. BufferingHints is a hint, so there are some\n cases where the service cannot adhere to these conditions strictly. For example, record\n boundaries might be such that the size is a little over or under the configured buffering\n size. By default, no encryption is performed. We strongly recommend that you enable\n encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
\nAn Amazon Redshift destination requires an S3 bucket as intermediate location.\n Kinesis Data Firehose first delivers data to Amazon S3 and then uses\n COPY syntax to load data into an Amazon Redshift table. This is\n specified in the RedshiftDestinationConfiguration.S3Configuration\n parameter.
The compression formats SNAPPY or ZIP cannot be\n specified in RedshiftDestinationConfiguration.S3Configuration because\n the Amazon Redshift COPY operation that reads from the S3 bucket doesn't\n support these compression formats.
We strongly recommend that you use the user name and password you provide\n exclusively with Kinesis Data Firehose, and that the permissions for the account are\n restricted for Amazon Redshift INSERT permissions.
Kinesis Data Firehose assumes the IAM role that is configured as part of the\n destination. The role should allow the Kinesis Data Firehose principal to assume the role,\n and the role should have permissions that allow the service to deliver the data. For more\n information, see Grant Kinesis Data\n Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data\n Firehose Developer Guide.
" + "smithy.api#documentation": "Creates a Kinesis Data Firehose delivery stream.
\nBy default, you can create up to 50 delivery streams per Amazon Web Services\n Region.
\nThis is an asynchronous operation that immediately returns. The initial status of the\n delivery stream is CREATING. After the delivery stream is created, its status\n is ACTIVE and it now accepts data. If the delivery stream creation fails, the\n status transitions to CREATING_FAILED. Attempts to send data to a delivery\n stream that is not in the ACTIVE state cause an exception. To check the state\n of a delivery stream, use DescribeDeliveryStream.
If the status of a delivery stream is CREATING_FAILED, this status\n doesn't change, and you can't invoke CreateDeliveryStream again on it.\n However, you can invoke the DeleteDeliveryStream operation to delete\n it.
A Kinesis Data Firehose delivery stream can be configured to receive records directly\n from providers using PutRecord or PutRecordBatch, or it\n can be configured to use an existing Kinesis stream as its source. To specify a Kinesis\n data stream as input, set the DeliveryStreamType parameter to\n KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name\n (ARN) and role ARN in the KinesisStreamSourceConfiguration\n parameter.
To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is\n optional. You can also invoke StartDeliveryStreamEncryption to turn on\n SSE for an existing delivery stream that doesn't have SSE enabled.
\nA delivery stream is configured with a single destination, such as Amazon Simple\n Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch\n Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by\n third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New\n Relic, and Sumo Logic. You must specify only one of the following destination configuration\n parameters: ExtendedS3DestinationConfiguration,\n S3DestinationConfiguration,\n ElasticsearchDestinationConfiguration,\n RedshiftDestinationConfiguration, or\n SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the\n following optional values: BufferingHints, EncryptionConfiguration, and\n CompressionFormat. By default, if no BufferingHints value is\n provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever\n condition is satisfied first. BufferingHints is a hint, so there are some\n cases where the service cannot adhere to these conditions strictly. For example, record\n boundaries might be such that the size is a little over or under the configured buffering\n size. By default, no encryption is performed. We strongly recommend that you enable\n encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
\nAn Amazon Redshift destination requires an S3 bucket as intermediate location.\n Kinesis Data Firehose first delivers data to Amazon S3 and then uses\n COPY syntax to load data into an Amazon Redshift table. This is\n specified in the RedshiftDestinationConfiguration.S3Configuration\n parameter.
The compression formats SNAPPY or ZIP cannot be\n specified in RedshiftDestinationConfiguration.S3Configuration because\n the Amazon Redshift COPY operation that reads from the S3 bucket doesn't\n support these compression formats.
We strongly recommend that you use the user name and password you provide\n exclusively with Kinesis Data Firehose, and that the permissions for the account are\n restricted for Amazon Redshift INSERT permissions.
Kinesis Data Firehose assumes the IAM role that is configured as part of the\n destination. The role should allow the Kinesis Data Firehose principal to assume the role,\n and the role should have permissions that allow the service to deliver the data. For more\n information, see Grant Kinesis Data\n Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data\n Firehose Developer Guide.
" } }, "com.amazonaws.firehose#CreateDeliveryStreamInput": { @@ -1051,6 +1069,23 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.firehose#DefaultDocumentIdFormat": { + "type": "enum", + "members": { + "FIREHOSE_DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIREHOSE_DEFAULT" + } + }, + "NO_DOCUMENT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_DOCUMENT_ID" + } + } + } + }, "com.amazonaws.firehose#DeleteDeliveryStream": { "type": "operation", "input": { @@ -1633,6 +1668,21 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, + "com.amazonaws.firehose#DocumentIdOptions": { + "type": "structure", + "members": { + "DefaultDocumentIdFormat": { + "target": "com.amazonaws.firehose#DefaultDocumentIdFormat", + "traits": { + "smithy.api#documentation": "When the FIREHOSE_DEFAULT option is chosen, Kinesis Data Firehose generates\n a unique document ID for each record based on a unique internal identifier. The generated\n document ID is stable across multiple delivery attempts, which helps prevent the same\n record from being indexed multiple times with different document IDs.
When the NO_DOCUMENT_ID option is chosen, Kinesis Data Firehose does not\n include any document IDs in the requests it sends to the Amazon OpenSearch Service. This\n causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple\n delivery attempts, this may cause the same record to be indexed more than once with\n different document IDs. This option enables write-heavy operations, such as the ingestion\n of logs and observability data, to consume less resources in the Amazon OpenSearch Service\n domain, resulting in improved performance.
Indicates the method for setting up document ID. The supported methods are Kinesis Data\n Firehose generated document ID and OpenSearch Service generated document ID.
\n " + } + }, "com.amazonaws.firehose#DynamicPartitioningConfiguration": { "type": "structure", "members": { @@ -1782,7 +1832,13 @@ "VpcConfiguration": { "target": "com.amazonaws.firehose#VpcConfiguration", "traits": { - "smithy.api#documentation": "The details of the VPC of the Amazon ES destination.
" + "smithy.api#documentation": "The details of the VPC of the Amazon destination.
" + } + }, + "DocumentIdOptions": { + "target": "com.amazonaws.firehose#DocumentIdOptions", + "traits": { + "smithy.api#documentation": "Indicates the method for setting up document ID. The supported methods are Kinesis Data\n Firehose generated document ID and OpenSearch Service generated document ID.
" } } }, @@ -1868,7 +1924,13 @@ "VpcConfigurationDescription": { "target": "com.amazonaws.firehose#VpcConfigurationDescription", "traits": { - "smithy.api#documentation": "The details of the VPC of the Amazon ES destination.
" + "smithy.api#documentation": "The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless\n destination.
" + } + }, + "DocumentIdOptions": { + "target": "com.amazonaws.firehose#DocumentIdOptions", + "traits": { + "smithy.api#documentation": "Indicates the method for setting up document ID. The supported methods are Kinesis Data\n Firehose generated document ID and OpenSearch Service generated document ID.
" } } }, @@ -1944,6 +2006,12 @@ "traits": { "smithy.api#documentation": "The CloudWatch logging options for your delivery stream.
" } + }, + "DocumentIdOptions": { + "target": "com.amazonaws.firehose#DocumentIdOptions", + "traits": { + "smithy.api#documentation": "Indicates the method for setting up document ID. The supported methods are Kinesis Data\n Firehose generated document ID and OpenSearch Service generated document ID.
" + } } }, "traits": { @@ -6126,7 +6194,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified destination of the specified delivery stream.
\nUse this operation to change the destination type (for example, to replace the Amazon\n S3 destination with Amazon Redshift) or change the parameters associated with a destination\n (for example, to change the bucket name of the Amazon S3 destination). The update might not\n occur immediately. The target delivery stream remains active while the configurations are\n updated, so data writes to the delivery stream can continue during this process. The\n updated configurations are usually effective within a few minutes.
\nSwitching between Amazon ES and other services is not supported. For an Amazon ES\n destination, you can only update to another Amazon ES destination.
\nIf the destination type is the same, Kinesis Data Firehose merges the configuration\n parameters specified with the destination configuration that already exists on the delivery\n stream. If any of the parameters are not specified in the call, the existing values are\n retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing\n EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from\n Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this\n case, all parameters must be specified.
\nKinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race\n conditions and conflicting merges. This is a required field, and the service updates the\n configuration only if the existing configuration has a version ID that matches. After the\n update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set\n CurrentDeliveryStreamVersionId in the next call.
Updates the specified destination of the specified delivery stream.
\nUse this operation to change the destination type (for example, to replace the Amazon\n S3 destination with Amazon Redshift) or change the parameters associated with a destination\n (for example, to change the bucket name of the Amazon S3 destination). The update might not\n occur immediately. The target delivery stream remains active while the configurations are\n updated, so data writes to the delivery stream can continue during this process. The\n updated configurations are usually effective within a few minutes.
\nSwitching between Amazon OpenSearch Service and other services is not supported. For\n an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch\n Service destination.
\nIf the destination type is the same, Kinesis Data Firehose merges the configuration\n parameters specified with the destination configuration that already exists on the delivery\n stream. If any of the parameters are not specified in the call, the existing values are\n retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing\n EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from\n Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this\n case, all parameters must be specified.
\nKinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race\n conditions and conflicting merges. This is a required field, and the service updates the\n configuration only if the existing configuration has a version ID that matches. After the\n update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set\n CurrentDeliveryStreamVersionId in the next call.
The details of the VPC of the Amazon ES destination.
" + "smithy.api#documentation": "The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless\n destination.
" } }, "com.amazonaws.firehose#VpcConfigurationDescription": { diff --git a/codegen/sdk/aws-models/guardduty.json b/codegen/sdk/aws-models/guardduty.json index 6db7ff394fe..66de646c0e7 100644 --- a/codegen/sdk/aws-models/guardduty.json +++ b/codegen/sdk/aws-models/guardduty.json @@ -1131,6 +1131,13 @@ "smithy.api#documentation": "Information about the installed EKS add-on.
", "smithy.api#jsonName": "addonDetails" } + }, + "ManagementType": { + "target": "com.amazonaws.guardduty#ManagementType", + "traits": { + "smithy.api#documentation": "Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS cluster.
\n\n AUTO_MANAGED indicates GuardDuty deploys and manages updates for this resource.
\n MANUAL indicates that you are responsible to deploy, update, and manage \n the Amazon EKS add-on GuardDuty agent for this resource.
Represents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]\n
\n Medium: [\"4\", \"5\", \"6\"]\n
\n High: [\"7\", \"8\", \"9\"]\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nRepresents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]\n
\n Medium: [\"4\", \"5\", \"6\"]\n
\n High: [\"7\", \"8\", \"9\"]\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nCreates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nAs a delegated administrator, using CreateMembers will enable GuardDuty in\n the added member accounts, with the exception of the organization delegated administrator\n account. A delegated administrator must enable GuardDuty prior to being added as a\n member.
If you are adding accounts by invitation, before using InviteMembers, use\n CreateMembers after GuardDuty has been enabled in potential member accounts.
If you disassociate a member from a GuardDuty delegated administrator, the member account\n details obtained from this API, including the associated email addresses, will be retained.\n This is done so that the delegated administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.\n
", + "smithy.api#documentation": "Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nAs a delegated administrator, using CreateMembers will enable GuardDuty in \n the added member accounts, with the exception of the\n organization delegated administrator account. A delegated administrator must enable GuardDuty \n prior to being added as a member.
If you are adding accounts by invitation, before using InviteMembers, use \n CreateMembers after GuardDuty has been enabled in potential member accounts.
If you disassociate a member from a GuardDuty \n delegated administrator, the member account details \n obtained from this API, including the associated email addresses, will be retained. \n This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member", @@ -3071,7 +3084,7 @@ "AutoEnableOrganizationMembers": { "target": "com.amazonaws.guardduty#AutoEnableMembers", "traits": { - "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the Amazon Web Services Organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n accounts in the organization. GuardDuty must be managed for each account individually by the\n administrator.
Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in \n the organization individually.
Disables an Amazon Web Services account within the Organization as the GuardDuty delegated\n administrator.
", + "smithy.api#documentation": "Removes the existing GuardDuty delegated\n administrator of the organization. Only the organization's management account can run this \n API operation.
", "smithy.api#http": { "method": "POST", "uri": "/admin/disable", @@ -3606,7 +3619,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you disassociate an invited member from a GuardDuty delegated administrator, the member\n account details obtained from the CreateMembers API,\n including the associated email addresses, are retained. This is done so that the delegated\n administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
Disassociates the current GuardDuty member account from its administrator account.
\nWhen you disassociate an invited member from a GuardDuty delegated administrator, the member\n account details obtained from the CreateMembers API,\n including the associated email addresses, are retained. This is done so that the delegated\n administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.
", + "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/master/disassociate", @@ -3713,7 +3726,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates GuardDuty member accounts (from the current administrator account)\n specified by the account IDs.
\nWhen you disassociate an invited member from a GuardDuty delegated administrator, the member\n account details obtained from the CreateMembers API,\n including the associated email addresses, are retained. This is done so that the delegated\n administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.
Disassociates GuardDuty member accounts (from the current administrator account) specified\n by the account IDs.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your organization.
Enables an Amazon Web Services account within the organization as the GuardDuty delegated\n administrator.
", + "smithy.api#documentation": "Designates an Amazon Web Services account within the organization as your GuardDuty delegated\n administrator. Only the organization's management account can run this \n API operation.
", "smithy.api#http": { "method": "POST", "uri": "/admin/enable", @@ -4808,7 +4821,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides the details for the GuardDuty administrator account associated with the current\n GuardDuty member account.
", + "smithy.api#documentation": "Provides the details of the GuardDuty administrator account associated with the current\n GuardDuty member account.
\nIf the organization's management account or a delegated administrator runs this API, \n it will return success (HTTP 200) but no content.
Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, DNS logs, and Amazon EBS volume data.\n It uses threat intelligence\n feeds, such as lists of malicious IPs and domains, and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances\n and container workloads. For example, GuardDuty can detect compromised EC2 instances and\n container workloads serving malware, or mining bitcoin.
\nGuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as\n unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never\n been used, or unusual API calls like a password policy change to reduce password strength.
\nGuardDuty informs you about the status of your Amazon Web Services environment by producing security\n findings that you can view in the GuardDuty console or through Amazon EventBridge. For more\n information, see the \n Amazon GuardDuty User\n Guide\n .
", + "smithy.api#documentation": "Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, DNS logs, and Amazon EBS volume data.\n It uses threat intelligence\n feeds, such as lists of malicious IPs and domains, and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances\n and container workloads. For example, GuardDuty can detect compromised EC2 instances and\n container workloads serving malware, or mining bitcoin.
\nGuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as\n unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never\n been used, or unusual API calls like a password policy change to reduce password strength.
\nGuardDuty informs you about the status of your Amazon Web Services environment by producing security\n findings that you can view in the GuardDuty console or through Amazon EventBridge. For more\n information, see the \n Amazon\n GuardDuty User Guide\n .
", "smithy.api#title": "Amazon GuardDuty", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -7502,7 +7515,7 @@ } ], "traits": { - "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services\n account that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty\n environment, this step is not needed. For more information, see Managing accounts with Amazon Web Services\n Organizations.
\nTo invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the\n potential member accounts. You can now invoke this API to add accounts by invitation. The\n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each\n invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For\n more information, see Managing GuardDuty accounts by\n invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account (by\n using DisassociateMembers) from your account, the details of the member account obtained by\n invoking CreateMembers, including\n the associated email addresses, will be retained. This is done so that you can invoke\n InviteMembers without the need to invoke CreateMembers again. To\n remove the details associated with a member account, you must also invoke DeleteMembers.
", + "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using organizations to manager your GuardDuty environment, this step is not \n needed. For more information, see Managing accounts with organizations.
\nTo invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/invite", @@ -7870,7 +7883,7 @@ "SessionName": { "target": "com.amazonaws.guardduty#SessionNameList", "traits": { - "smithy.api#documentation": "Entity that assumes the IAM role when Kubernetes RBAC permissions are assigned to that\n role.
", + "smithy.api#documentation": "Entity that assumes the IAM role \n when Kubernetes RBAC permissions are assigned to that role.
", "smithy.api#jsonName": "sessionName" } } @@ -7964,7 +7977,7 @@ "LastModifiedAt": { "target": "com.amazonaws.guardduty#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp when the Lambda function was last modified. This field is in the UTC date\n string format (2023-03-22T19:37:20.168Z).
The timestamp when the Lambda function was last modified. This field is in the UTC date string \n format (2023-03-22T19:37:20.168Z).
A list of tags attached to this resource, listed in the format of\n key:value pair.
A list of tags attached to this resource, listed in the format of \n key:value pair.
Lists the accounts configured as GuardDuty delegated administrators.
", + "smithy.api#documentation": "Lists the accounts configured as GuardDuty delegated administrators. \n Only the organization's management account can run this \n API operation.
", "smithy.api#http": { "method": "GET", "uri": "/admin", @@ -8902,7 +8915,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per each\n resource. When invoked, this operation returns all assigned tags for a given resource.
", + "smithy.api#documentation": "Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. \n When invoked, this\n operation returns all assigned tags for a given resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -9185,6 +9198,23 @@ "smithy.api#documentation": "Provides details about Malware Protection when it is enabled as a data source.
" } }, + "com.amazonaws.guardduty#ManagementType": { + "type": "enum", + "members": { + "AUTO_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_MANAGED" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, "com.amazonaws.guardduty#MapEquals": { "type": "list", "member": { @@ -9822,13 +9852,13 @@ "AutoEnable": { "target": "com.amazonaws.guardduty#OrgFeatureStatus", "traits": { - "smithy.api#documentation": "The status of the additional configuration that will be configured for the\n organization.
", + "smithy.api#documentation": "The status of the additional configuration that will be configured for the\n organization. Use one of the following \n values to configure the feature status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the additional configuration enabled automatically.
\n ALL: Indicates that all accounts in the organization have \n the additional configuration\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the additional configuration will not be \n automatically enabled for any\n account in the organization. The administrator must manage the additional configuration \n for each account individually.
A list of additional configurations which will be configured for the organization.
" + "smithy.api#documentation": "A list of additional configurations which will be configured for the organization.
" } }, "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult": { @@ -9844,7 +9874,7 @@ "AutoEnable": { "target": "com.amazonaws.guardduty#OrgFeatureStatus", "traits": { - "smithy.api#documentation": "Describes how The status of the additional configuration that are configured for the\n member accounts within the organization.
\nIf you set AutoEnable to NEW, a feature will be configured for\n only the new accounts when they join the organization.
If you set AutoEnable to NONE, no feature will be configured for\n the accounts when they join the organization.
Describes the status of the additional configuration that is configured for the\n member accounts within the organization. One of the following \n values is the status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the additional configuration enabled automatically.
\n ALL: Indicates that all accounts in the organization have \n the additional configuration\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the additional configuration will not be \n automatically enabled for any\n account in the organization. The administrator must manage the additional configuration \n for each account individually.
The status of the feature that will be configured for the organization.
", + "smithy.api#documentation": "The status of the feature that will be configured for the organization. Use one of the following \n values to configure the feature status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the feature will not be automatically enabled for any\n account in the organization. The administrator must manage the feature for each account \n individually.
Describes how The status of the feature that are configured for the member accounts within\n the organization.
\nIf you set AutoEnable to NEW, a feature will be configured for\n only the new accounts when they join the organization.
If you set AutoEnable to NONE, no feature will be configured for\n the accounts when they join the organization.
Describes the status of the feature that is configured for the member accounts within\n the organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature \n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that the feature will not be automatically enabled for any\n account in the organization. In this case, each account will be managed individually \n by the\n administrator.
The timestamp at which the process modified the current process. The timestamp is in UTC\n date string format.
", + "smithy.api#documentation": "The timestamp at which the process modified the current process. The timestamp is in UTC date string\n format.
", "smithy.api#jsonName": "modifiedAt" } }, @@ -10955,14 +10985,14 @@ "TargetProcess": { "target": "com.amazonaws.guardduty#ProcessDetails", "traits": { - "smithy.api#documentation": "Information about the process that had its memory overwritten by the current\n process.
", + "smithy.api#documentation": "Information about the process that had its memory overwritten by the current process.
", "smithy.api#jsonName": "targetProcess" } }, "AddressFamily": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "Represents the communication protocol associated with the address. For example, the\n address family AF_INET is used for IP version of 4 protocol.
Represents the communication protocol associated with the address. For example, the address\n family AF_INET is used for IP version of 4 protocol.
Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account.
", + "smithy.api#documentation": "Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.
", "smithy.api#http": { "method": "POST", "uri": "/malware-scan/start", @@ -11839,7 +11869,7 @@ "ScanId": { "target": "com.amazonaws.guardduty#NonEmptyString", "traits": { - "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each\n malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of\n your malware scan.
", + "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each malware scan has \n a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", "smithy.api#jsonName": "scanId" } } @@ -13031,7 +13061,7 @@ } ], "traits": { - "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide\n the value for either autoEnableOrganizationMembers or autoEnable.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not \n both.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/admin", @@ -13058,7 +13088,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use AutoEnableOrganizationMembers instead" }, - "smithy.api#documentation": "Indicates whether to automatically enable member accounts in the organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results.
Indicates whether to automatically enable member accounts in the organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results. You must provide the \n value for either autoEnableOrganizationMembers or autoEnable.
Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the Amazon Web Services Organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n accounts in the organization. GuardDuty must be managed for each account individually by the\n administrator.
Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a \n value for either autoEnableOrganizationMembers or autoEnable.
Use one of the \n following configuration values for autoEnableOrganizationMembers:
\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in the organization\n individually.
If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the\n participant’s token is not allowed to do. For more information about participant\n capabilities, see the capabilities field in CreateParticipantToken. \n\t\t QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a \n\t\t stage exceeds the quota; for more information, see Service Quotas.\n\t\t PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher\n\t\t that doesn’t exist. \n
If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an\n action that the participant’s token is not allowed to do. For more information about\n participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see Service Quotas.\n PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a\n publisher that doesn’t exist.
Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
" + "smithy.api#documentation": "Duration (in minutes), after which the participant token expires. Default: 720 (12\n hours).
" } }, "capabilities": { @@ -1972,7 +1972,7 @@ } }, "traits": { - "smithy.api#documentation": "Object specifying a participant token in a stage.
" + "smithy.api#documentation": "Object specifying a participant token in a stage.
\n\n Important: Treat tokens as opaque; i.e., do not build functionality\n based on token contents. The format of tokens could change in the future.
" } }, "com.amazonaws.ivsrealtime#ParticipantTokenAttributes": { diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index 05675474536..e7d54f2362a 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -1453,66 +1453,66 @@ "AndAllFilters": { "target": "com.amazonaws.kendra#AttributeFilterList", "traits": { - "smithy.api#documentation": "Performs a logical AND operation on all supplied filters.
Performs a logical AND operation on all filters that you specify.
Performs a logical OR operation on all supplied filters.
Performs a logical OR operation on all filters that you specify.
Performs a logical NOT operation on all supplied filters.
Performs a logical NOT operation on all filters that you specify.
Performs an equals operation on two document attributes or metadata fields.
" + "smithy.api#documentation": "Performs an equals operation on document attributes/fields and their values.
" } }, "ContainsAll": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "Returns true when a document contains all of the specified document attributes or\n metadata fields. This filter is only applicable to StringListValue\n metadata.
Returns true when a document contains all of the specified document attributes/fields. \n This filter is only applicable to StringListValue.
" } }, "ContainsAny": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "Returns true when a document contains any of the specified document attributes or\n metadata fields. This filter is only applicable to StringListValue\n metadata.
Returns true when a document contains any of the specified document attributes/fields. \n This filter is only applicable to StringListValue.
" } }, "GreaterThan": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "Performs a greater than operation on two document attributes or metadata fields. Use\n with a document attribute of type Date or Long.
Performs a greater than operation on document attributes/fields and their \n values. Use with the document attribute \n type\n Date or Long.
Performs a greater or equals than operation on two document attributes or metadata\n fields. Use with a document attribute of type Date or\n Long.
Performs a greater or equals than operation on document attributes/fields and \n their values. Use with the document attribute \n type\n Date or Long.
Performs a less than operation on two document attributes or metadata fields. Use with a\n document attribute of type Date or Long.
Performs a less than operation on document attributes/fields and their values. \n Use with the document attribute \n type\n Date or Long.
Performs a less than or equals operation on two document attributes or metadata fields.\n Use with a document attribute of type Date or Long.
Performs a less than or equals operation on document attributes/fields and \n their values. Use with the document attribute \n type\n Date or Long.
Provides filtering the query results based on document attributes or metadata\n fields.
\nWhen you use the AndAllFilters or OrAllFilters, filters you\n can use 2 layers under the first attribute filter. For example, you can use:
\n
\n \n
\n \n
If you use more than 2 layers, you receive a ValidationException exception\n with the message \"AttributeFilter cannot have a depth of more than 2.\"
If you use more than 10 attribute filters in a given list for AndAllFilters\n or OrAllFilters, you receive a ValidationException with the\n message \"AttributeFilter cannot have a length of more than 10\".
Filters the search results based on document attributes or fields.
\nYou can filter results using attributes for your particular documents. \n The attributes must exist in your index. For example, if your documents \n include the custom attribute \"Department\", you can filter documents that \n belong to the \"HR\" department. You would use the EqualsTo \n operation to filter results or documents with \"Department\" equals to \"HR\".
You can use AndAllFilters and AndOrFilters in \n combination with each other or with other operations such as EqualsTo. \n For example:
\n AndAllFilters\n
\n EqualsTo: \"Department\", \"HR\"
\n AndOrFilters\n
\n ContainsAny: \"Project Name\", [\"new hires\", \"new hiring\"]
This example filters results or documents that belong to the HR department \n and belong to projects that contain \"new hires\" \n or \"new hiring\" in the project name (must use \n ContainAny with StringListValue). This example is \n filtering with a depth of 2.
You cannot filter more than a depth of 2, otherwise you receive a \n ValidationException exception with the message \"AttributeFilter \n cannot have a depth of more than 2.\" Also, if you use more than 10 attribute \n filters in a given list for AndAllFilters or OrAllFilters, \n you receive a ValidationException with the message \"AttributeFilter \n cannot have a length of more than 10\".
For examples of using AttributeFilter, see Using \n document attributes to filter search results.
Removes one or more documents from an index. The documents must have been added with\n the BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by\n using Amazon Web Services CloudWatch. Any error messages related to the processing of the\n batch are sent to you CloudWatch log.
" + "smithy.api#documentation": "Removes one or more documents from an index. The documents must have been added with\n the BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by\n using Amazon Web Services CloudWatch. Any error messages related to the processing of the\n batch are sent to your Amazon Web Services CloudWatch log. You can also use the \n BatchGetDocumentStatus API to monitor the progress of deleting your documents.
Deleting documents from an index using BatchDeleteDocument could take up \n to an hour or more, depending on the number of documents you want to delete.
Adds one or more documents to an index.
\nThe BatchPutDocument API enables you to ingest inline documents or a set\n of documents stored in an Amazon S3 bucket. Use this API to ingest your text and\n unstructured text into an index, add custom attributes to the documents, and to attach\n an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using\n Amazon Web Services\n CloudWatch. Any error messages related to processing the batch are sent to your\n Amazon Web Services\n CloudWatch log.
\nFor an example of ingesting inline documents using Python and Java SDKs, see Adding files\n directly to an index.
" + "smithy.api#documentation": "Adds one or more documents to an index.
\nThe BatchPutDocument API enables you to ingest inline documents or a set\n of documents stored in an Amazon S3 bucket. Use this API to ingest your text and\n unstructured text into an index, add custom attributes to the documents, and to attach\n an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using \n Amazon Web Services CloudWatch. Any error messages related to processing the batch \n are sent to your Amazon Web Services CloudWatch log. You can also use the \n BatchGetDocumentStatus API to monitor the progress of indexing your documents.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files\n directly to an index.
" } }, "com.amazonaws.kendra#BatchPutDocumentRequest": { @@ -2050,7 +2050,7 @@ "FailedDocuments": { "target": "com.amazonaws.kendra#BatchPutDocumentResponseFailedDocuments", "traits": { - "smithy.api#documentation": "A list of documents that were not added to the index because the document failed a\n validation check. Each document contains an error message that indicates why the\n document couldn't be added to the index.
\nIf there was an error adding a document to an index the error is reported in your\n Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon\n Kendra with Amazon CloudWatch Logs\n
" + "smithy.api#documentation": "A list of documents that were not added to the index because the document failed a\n validation check. Each document contains an error message that indicates why the\n document couldn't be added to the index.
\nIf there was an error adding a document to an index the error is reported in your\n Amazon Web Services CloudWatch log. For more information, see Monitoring \n Amazon Kendra with Amazon CloudWatch logs.
" } } }, @@ -3884,7 +3884,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine\n if index creation has completed, check the Status field returned from a call to\n DescribeIndex. The Status field is set to ACTIVE when\n the index is ready to use.
Once the index is active you can index your documents using the\n BatchPutDocument API or using one of the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python\n SDK. For an example of creating an index and data source using the Java SDK, see\n Getting started with Java\n SDK.
" + "smithy.api#documentation": "Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine\n if index creation has completed, check the Status field returned from a call to\n DescribeIndex. The Status field is set to ACTIVE when\n the index is ready to use.
Once the index is active, you can index your documents using the\n BatchPutDocument API or using one of the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python\n SDK. For an example of creating an index and data source using the Java SDK, see\n Getting started with Java\n SDK.
" } }, "com.amazonaws.kendra#CreateIndexRequest": { @@ -4710,26 +4710,26 @@ "DataSourceFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "The name of the column or attribute in the data source.
", + "smithy.api#documentation": "The name of the field in the data source. You must first create the index field \n using the UpdateIndex API.
The type of data stored in the column or attribute.
" + "smithy.api#documentation": "The format for date fields in the data source. If the field specified in \n DataSourceFieldName is a date field, you must specify the date \n format. If the field is not a date field, an exception is thrown.
The name of the field in the index.
", + "smithy.api#documentation": "The name of the index field to map to the data source field. The index field type \n must match the data source field type.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Maps a column or attribute in the data source to an index field. You must first create the\n fields in the index using the UpdateIndex API.
Maps attributes or field names of the documents synced from the data source \n to Amazon Kendra index field names. You can set up field mappings for each \n data source when calling CreateDataSource \n or UpdateDataSource API. To create custom fields, use the UpdateIndex \n API to first create an index field and then map to the data source field. For more \n information, see Mapping data source fields.
Provides the configuration information to connect to a index.
" + "smithy.api#documentation": "Provides the configuration information to an Amazon Kendra supported \n database.
" } }, "com.amazonaws.kendra#DatabaseEngineType": { @@ -5076,7 +5076,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Amazon Kendra data source connector. An exception is not thrown if the\n data source is already being deleted. While the data source is being deleted, the\n Status field returned by a call to the DescribeDataSource API is\n set to DELETING. For more information, see Deleting Data Sources.
Deletes an Amazon Kendra data source connector. An exception is not thrown if the\n data source is already being deleted. While the data source is being deleted, the\n Status field returned by a call to the DescribeDataSource API is\n set to DELETING. For more information, see Deleting Data Sources.
Deleting an entire data source or re-syncing your index after deleting specific documents \n from a data source could take up to an hour or more, depending on the number of documents you \n want to delete.
" } }, "com.amazonaws.kendra#DeleteDataSourceRequest": { @@ -7040,24 +7040,24 @@ "DocumentAttributeValue": { "target": "com.amazonaws.kendra#DocumentAttributeValue", "traits": { - "smithy.api#documentation": "The value of the attribute. For example, \"HR\".
" + "smithy.api#documentation": "The value of the attribute/field. For example, \"HR\".
" } }, "Count": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "The number of documents in the response that have the attribute value for the\n key.
" + "smithy.api#documentation": "The number of documents in the response that have the attribute/field value for \n the key.
" } }, "FacetResults": { "target": "com.amazonaws.kendra#FacetResultList", "traits": { - "smithy.api#documentation": "Contains the results of a document attribute that is a nested facet. A\n FacetResult contains the counts for each facet nested within a\n facet.
For example, the document attribute or facet \"Department\" includes a value called\n \"Engineering\". In addition, the document attribute or facet \"SubDepartment\" includes the\n values \"Frontend\" and \"Backend\" for documents assigned to \"Engineering\". You can display\n nested facets in the search results so that documents can be searched not only by\n department but also by a sub department within a department. The counts for documents that\n belong to \"Frontend\" and \"Backend\" within \"Engineering\" are returned for a query.
\n \n " + "smithy.api#documentation": "Contains the results of a document attribute/field that is a nested facet. A\n FacetResult contains the counts for each facet nested within a\n facet.
For example, the document attribute or facet \"Department\" includes a value called\n \"Engineering\". In addition, the document attribute or facet \"SubDepartment\" includes the\n values \"Frontend\" and \"Backend\" for documents assigned to \"Engineering\". You can display\n nested facets in the search results so that documents can be searched not only by\n department but also by a sub department within a department. The counts for documents that\n belong to \"Frontend\" and \"Backend\" within \"Engineering\" are returned for a query.
\n \n " } } }, "traits": { - "smithy.api#documentation": "Provides the count of documents that match a particular attribute when doing a faceted\n search.
" + "smithy.api#documentation": "Provides the count of documents that match a particular document attribute or \n field when doing a faceted search.
" } }, "com.amazonaws.kendra#DocumentAttributeValueCountPairList": { @@ -7777,7 +7777,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a document attribute. You can use document attributes as\n facets.
\nFor example, the document attribute or facet \"Department\" includes the values \"HR\",\n \"Engineering\", and \"Accounting\". You can display these values in the search results so that\n documents can be searched by department.
\nYou can display up to 10 facet values per facet for a query. If you want to increase\n this limit, contact Support.
" + "smithy.api#documentation": "Information about a document attribute or field. You can use document attributes as\n facets.
\nFor example, the document attribute or facet \"Department\" includes the values \"HR\",\n \"Engineering\", and \"Accounting\". You can display these values in the search results so that\n documents can be searched by department.
\nYou can display up to 10 facet values per facet for a query. If you want to increase\n this limit, contact Support.
" } }, "com.amazonaws.kendra#FacetList": { @@ -12369,7 +12369,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves relevant passages or text excerpts given an input query.
\nThis API is similar to the Query \n API. However, by default, the Query API only \n returns excerpt passages of up to 100 token words. With the \n Retrieve API, you can retrieve longer passages of up to \n 200 token words and up to 100 semantically relevant passages. This doesn't \n include question-answer or FAQ type responses from your index. The passages \n are text excerpts that can be semantically extracted from multiple documents \n and multiple parts of the same document. If in extreme cases your documents \n produce no relevant passages using the Retrieve API, you can \n alternatively use the Query API.
You can also do the following:
\nOverride boosting at the index level
\nFilter based on document fields or attributes
\nFilter based on the user or their group access to documents
\nYou can also include certain fields in the response that might provide useful\n additional information.
" + "smithy.api#documentation": "Retrieves relevant passages or text excerpts given an input query.
\nThis API is similar to the Query \n API. However, by default, the Query API only \n returns excerpt passages of up to 100 token words. With the \n Retrieve API, you can retrieve longer passages of up to \n 200 token words and up to 100 semantically relevant passages. This doesn't \n include question-answer or FAQ type responses from your index. The passages \n are text excerpts that can be semantically extracted from multiple documents \n and multiple parts of the same document. If in extreme cases your documents \n produce zero passages using the Retrieve API, you can alternatively \n use the Query API and its types of responses.
You can also do the following:
\nOverride boosting at the index level
\nFilter based on document fields or attributes
\nFilter based on the user or their group access to documents
\nYou can also include certain fields in the response that might provide useful\n additional information.
\nThe Retrieve API shares the number of query capacity \n units that you set for your index. For more information on what's included in \n a single capacity unit and the default base capacity for an index, see Adjusting \n capacity.
An array of document fields/attributes assigned to a document in the \n search results. For example, the document author (_author) \n or the source URI (_source_uri) of the document.
The confidence score bucket for a retrieved passage result. The confidence \n bucket provides a relative ranking that indicates how confident Amazon Kendra \n is that the response is relevant to the query.
" + } } }, "traits": { @@ -13992,7 +13998,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a synchronization job for a data source connector. If a synchronization job is\n already in progress, Amazon Kendra returns a ResourceInUseException\n exception.
Starts a synchronization job for a data source connector. If a synchronization job is\n already in progress, Amazon Kendra returns a ResourceInUseException\n exception.
Re-syncing your data source with your index after modifying, adding, or deleting \n documents from your data source respository could take up to an hour or more, depending on \n the number of documents to sync.
" } }, "com.amazonaws.kendra#StartDataSourceSyncJobRequest": { diff --git a/codegen/sdk/aws-models/lookoutequipment.json b/codegen/sdk/aws-models/lookoutequipment.json index 54cccb29df8..f545f4a0287 100644 --- a/codegen/sdk/aws-models/lookoutequipment.json +++ b/codegen/sdk/aws-models/lookoutequipment.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.lookoutequipment#CreateModel" }, + { + "target": "com.amazonaws.lookoutequipment#CreateRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#DeleteDataset" }, @@ -66,6 +69,9 @@ { "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicy" }, + { + "target": "com.amazonaws.lookoutequipment#DeleteRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJob" }, @@ -90,6 +96,9 @@ { "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicy" }, + { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#ImportDataset" }, @@ -123,6 +132,9 @@ { "target": "com.amazonaws.lookoutequipment#ListModelVersions" }, + { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulers" + }, { "target": "com.amazonaws.lookoutequipment#ListSensorStatistics" }, @@ -138,9 +150,15 @@ { "target": "com.amazonaws.lookoutequipment#StartInferenceScheduler" }, + { + "target": "com.amazonaws.lookoutequipment#StartRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#StopInferenceScheduler" }, + { + "target": "com.amazonaws.lookoutequipment#StopRetrainingScheduler" + }, { "target": "com.amazonaws.lookoutequipment#TagResource" }, @@ -155,6 +173,12 @@ }, { "target": "com.amazonaws.lookoutequipment#UpdateLabelGroup" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateModel" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateRetrainingScheduler" } ], "traits": { @@ -852,6 +876,50 @@ } } }, + "com.amazonaws.lookoutequipment#AutoPromotionResult": { + "type": "enum", + "members": { + "MODEL_PROMOTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_PROMOTED" + } + }, + "MODEL_NOT_PROMOTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_NOT_PROMOTED" + } + }, + "RETRAINING_INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_INTERNAL_ERROR" + } + }, + "RETRAINING_CUSTOMER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_CUSTOMER_ERROR" + } + }, + "RETRAINING_CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_CANCELLED" + } + } + } + }, + "com.amazonaws.lookoutequipment#AutoPromotionResultReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.lookoutequipment#Boolean": { "type": "boolean", "traits": { @@ -1098,7 +1166,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the previously trained ML model being used to create the inference\n scheduler.
", + "smithy.api#documentation": "The name of the previously trained machine learning model being used to create the\n inference scheduler.
", "smithy.api#required": {} } }, @@ -1112,13 +1180,13 @@ "DataDelayOffsetInMinutes": { "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", "traits": { - "smithy.api#documentation": "The interval (in minutes) of planned delay at the start of each inference segment. For\n example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the\n configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3\n bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and\n restart the scheduler when uploading new data.
\nFor more information, see Understanding the inference process.
" + "smithy.api#documentation": "The interval (in minutes) of planned delay at the start of each inference segment. For\n example, if inference is set to run every ten minutes, the delay is set to five minutes and\n the time is 09:08. The inference scheduler will wake up at the configured interval (which,\n without a delay configured, would be 09:10) plus the additional five minute delay time (so\n 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the\n same frequency, so that you don't have to stop and restart the scheduler when uploading new\n data.
\nFor more information, see Understanding\n the inference process.
" } }, "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.
\nFor more information, see Understanding the inference process.
", + "smithy.api#documentation": "How often data is uploaded to the source Amazon S3 bucket for the input data. The value\n chosen is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This\n frequency also determines how often Amazon Lookout for Equipment runs inference on your data.
\nFor more information, see Understanding\n the inference process.
", "smithy.api#required": {} } }, @@ -1226,7 +1294,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates a label for an event.\n
" + "smithy.api#documentation": "Creates a label for an event.
" } }, "com.amazonaws.lookoutequipment#CreateLabelGroup": { @@ -1258,7 +1326,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates a group of labels.\n
" + "smithy.api#documentation": "Creates a group of labels.
" } }, "com.amazonaws.lookoutequipment#CreateLabelGroupRequest": { @@ -1267,20 +1335,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n Names a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.\n
", + "smithy.api#documentation": "Names a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
", "smithy.api#required": {} } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "\n The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "The acceptable fault codes (indicating the type of anomaly associated with the label)\n that can be used with this label group.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "\n A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.\n
", + "smithy.api#documentation": "A unique identifier for the request to create a label group. If you do not set the\n client request token, Lookout for Equipment generates one.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1288,7 +1356,7 @@ "Tags": { "target": "com.amazonaws.lookoutequipment#TagList", "traits": { - "smithy.api#documentation": "\n Tags that provide metadata about the label group you are creating.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "Tags that provide metadata about the label group you are creating.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } } }, @@ -1302,13 +1370,13 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n
" + "smithy.api#documentation": "The name of the label group that you have created. Data in this field will be retained\n for service usage. Follow best practices for the security of your data.
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group that you have created.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group that you have created.
" } } }, @@ -1322,53 +1390,53 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.\n
", + "smithy.api#documentation": "The name of a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The start time of the labeled event.\n
", + "smithy.api#documentation": "The start time of the labeled event.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The end time of the labeled event.\n
", + "smithy.api#documentation": "The end time of the labeled event.
", "smithy.api#required": {} } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
", + "smithy.api#documentation": "Indicates whether a labeled event represents an anomaly.
", "smithy.api#required": {} } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\n Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.\n
" + "smithy.api#documentation": "Provides additional information about the label. The fault code must be defined in the\n FaultCodes attribute of the label group.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } }, "Notes": { "target": "com.amazonaws.lookoutequipment#Comments", "traits": { - "smithy.api#documentation": "\n Metadata providing additional information about the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "Metadata providing additional information about the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "Indicates that a label pertains to a particular piece of equipment.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "\n A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.\n
", + "smithy.api#documentation": "A unique identifier for the request to create a label. If you do not set the client\n request token, Lookout for Equipment generates one.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1384,7 +1452,7 @@ "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\n The ID of the label that you have created.\n
" + "smithy.api#documentation": "The ID of the label that you have created.
" } } }, @@ -1424,7 +1492,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an ML model for data inference.
\nA machine-learning (ML) model is a mathematical model that finds patterns in your data.\n In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and\n detects abnormal behavior that could be potential equipment failure (or maintenance\n events). The models are made by analyzing normal data and abnormalities in machine behavior\n that have already occurred.
\nYour model is trained using a portion of the data from your dataset and uses that data\n to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.\n Another portion of the data is used to evaluate the model's accuracy.
" + "smithy.api#documentation": "Creates a machine learning model for data inference.
\nA machine-learning (ML) model is a mathematical model that finds patterns in your data.\n In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal\n behavior that could be potential equipment failure (or maintenance events). The models are\n made by analyzing normal data and abnormalities in machine behavior that have already\n occurred.
\nYour model is trained using a portion of the data from your dataset and uses that data\n to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.\n Another portion of the data is used to evaluate the model's accuracy.
" } }, "com.amazonaws.lookoutequipment#CreateModelRequest": { @@ -1433,27 +1501,27 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name for the ML model to be created.
", + "smithy.api#documentation": "The name for the machine learning model to be created.
", "smithy.api#required": {} } }, "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", "traits": { - "smithy.api#documentation": "The name of the dataset for the ML model being created.
", + "smithy.api#documentation": "The name of the dataset for the machine learning model being created.
", "smithy.api#required": {} } }, "DatasetSchema": { "target": "com.amazonaws.lookoutequipment#DatasetSchema", "traits": { - "smithy.api#documentation": "The data schema for the ML model being created.
" + "smithy.api#documentation": "The data schema for the machine learning model being created.
" } }, "LabelsInputConfiguration": { "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration", "traits": { - "smithy.api#documentation": "The input configuration for the labels being used for the ML model that's being created.\n
" + "smithy.api#documentation": "The input configuration for the labels being used for the machine learning model that's\n being created.
" } }, "ClientToken": { @@ -1467,37 +1535,37 @@ "TrainingDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n training data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n training data for the machine learning model.
" } }, "TrainingDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n training data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n training data for the machine learning model.
" } }, "EvaluationDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n evaluation data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n evaluation data for the machine learning model.
" } }, "EvaluationDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n evaluation data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n evaluation data for the machine learning model.
" } }, "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source\n being used to create the ML model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source\n being used to create the machine learning model.
" } }, "DataPreProcessingConfiguration": { "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", "traits": { - "smithy.api#documentation": "The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Any tags associated with the ML model being created.
" + "smithy.api#documentation": "Any tags associated with the machine learning model being created.
" } }, "OffCondition": { @@ -1543,6 +1611,131 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#CreateRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a retraining scheduler on the specified model.
", + "smithy.api#examples": [ + { + "title": "Creates a retraining scheduler with manual promote mode", + "documentation": "", + "input": { + "ModelName": "sample-model", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D", + "PromoteMode": "MANUAL", + "ClientToken": "sample-client-token" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "PENDING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model to add the retraining scheduler to.
", + "smithy.api#required": {} + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in\n terms of Years, Months, and/or Days (note: other parameters like Time are not currently\n supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For\n example, the following values are valid:
\nP3M15D – Every 3 months and 15 days
\nP2M – Every 2 months
\nP150D – Every 150 days
\nThe number of past days of data that will be used for retraining.
", + "smithy.api#required": {} + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "Indicates how the service will use new models. In MANAGED mode, new models\n will automatically be used for inference if they have better performance than the current\n model. In MANUAL mode, the new models will not be used until they\n are manually activated.
A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that you added the retraining scheduler to.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model that you added the retraining scheduler to.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes": { "type": "long", "traits": { @@ -1602,12 +1795,12 @@ "TargetSamplingRate": { "target": "com.amazonaws.lookoutequipment#TargetSamplingRate", "traits": { - "smithy.api#documentation": "The sampling rate of the data after post processing by Amazon Lookout for Equipment. For\n example, if you provide data that has been collected at a 1 second level and you want the\n system to resample the data at a 1 minute rate before training, the\n TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you\n provide data that has been collected at a 1 second level and you want the system to\n resample the data at a 1 minute rate before training, the TargetSamplingRate\n is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
\n
" + "smithy.api#documentation": "The data schema used within the given dataset.
" } } }, @@ -1883,7 +2076,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an inference scheduler that has been set up. Already processed output results\n are not affected.
" + "smithy.api#documentation": "Deletes an inference scheduler that has been set up. Prior inference results will not be\n deleted.
" } }, "com.amazonaws.lookoutequipment#DeleteInferenceSchedulerRequest": { @@ -1930,7 +2123,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes a label.\n
" + "smithy.api#documentation": "Deletes a label.
" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroup": { @@ -1962,7 +2155,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes a group of labels.\n
" + "smithy.api#documentation": "Deletes a group of labels.
" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest": { @@ -1971,7 +2164,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n
", + "smithy.api#documentation": "The name of the label group that you want to delete. Data in this field will be\n retained for service usage. Follow best practices for the security of your data.
", "smithy.api#required": {} } } @@ -1986,14 +2179,14 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n
", + "smithy.api#documentation": "The name of the label group that contains the label that you want to delete. Data in\n this field will be retained for service usage. Follow best practices for the security of\n your data.
", "smithy.api#required": {} } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\n The ID of the label that you want to delete.\n
", + "smithy.api#documentation": "The ID of the label that you want to delete.
", "smithy.api#required": {} } } @@ -2031,7 +2224,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an ML model currently available for Amazon Lookout for Equipment. This will\n prevent it from being used with an inference scheduler, even one that is already set up.\n
" + "smithy.api#documentation": "Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it\n from being used with an inference scheduler, even one that is already set up.
" } }, "com.amazonaws.lookoutequipment#DeleteModelRequest": { @@ -2040,7 +2233,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model to be deleted.
", + "smithy.api#documentation": "The name of the machine learning model to be deleted.
", "smithy.api#required": {} } } @@ -2087,7 +2280,63 @@ "ResourceArn": { "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the resource policy should be\n deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteRetrainingSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a retraining scheduler from a model. The retraining scheduler must be in the\n STOPPED status.
The name of the model whose retraining scheduler you want to delete.
", "smithy.api#required": {} } } @@ -2221,7 +2470,7 @@ "SourceDatasetArn": { "target": "com.amazonaws.lookoutequipment#DatasetArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the data \n used for the data ingestion job was imported from.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the data used for the\n data ingestion job was imported from.
" } } }, @@ -2357,7 +2606,7 @@ "SourceDatasetArn": { "target": "com.amazonaws.lookoutequipment#DatasetArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the \n current data being described was imported from.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the current data being\n described was imported from.
" } } }, @@ -2415,13 +2664,13 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model of the inference scheduler being\n described.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler\n being described.
" } }, "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model of the inference scheduler being described.
" + "smithy.api#documentation": "The name of the machine learning model of the inference scheduler being described.\n
" } }, "InferenceSchedulerName": { @@ -2451,7 +2700,7 @@ "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "Specifies how often data is uploaded to the source S3 bucket for the input data. This\n value is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every\n 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a\n scheduled inference on your data. In this example, it starts once every 5 minutes.
" + "smithy.api#documentation": "Specifies how often data is uploaded to the source S3 bucket for the input data. This\n value is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This\n frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In\n this example, it starts once every 5 minutes.
" } }, "CreatedAt": { @@ -2527,7 +2776,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns the name of the label.\n
" + "smithy.api#documentation": "Returns the name of the label.
" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroup": { @@ -2556,7 +2805,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns information about the label group.\n
" + "smithy.api#documentation": "Returns information about the label group.
" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest": { @@ -2565,7 +2814,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n Returns the name of the label group.\n
", + "smithy.api#documentation": "Returns the name of the label group.
", "smithy.api#required": {} } } @@ -2580,31 +2829,31 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group.\n
" + "smithy.api#documentation": "The name of the label group.
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group.
" } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "\n Codes indicating the type of anomaly associated with the labels in the lagbel group.\n
" + "smithy.api#documentation": "Codes indicating the type of anomaly associated with the labels in the lagbel group.\n
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The time at which the label group was created.\n
" + "smithy.api#documentation": "The time at which the label group was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The time at which the label group was updated.\n
" + "smithy.api#documentation": "The time at which the label group was updated.
" } } }, @@ -2618,14 +2867,14 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n Returns the name of the group containing the label.\n
", + "smithy.api#documentation": "Returns the name of the group containing the label.
", "smithy.api#required": {} } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\n Returns the ID of the label.\n
", + "smithy.api#documentation": "Returns the ID of the label.
", "smithy.api#required": {} } } @@ -2640,61 +2889,61 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the requested label group.\n
" + "smithy.api#documentation": "The name of the requested label group.
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the requested label group.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the requested label group.
" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\n The ID of the requested label.\n
" + "smithy.api#documentation": "The ID of the requested label.
" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The start time of the requested label.\n
" + "smithy.api#documentation": "The start time of the requested label.
" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The end time of the requested label.\n
" + "smithy.api#documentation": "The end time of the requested label.
" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
" + "smithy.api#documentation": "Indicates whether a labeled event represents an anomaly.
" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\n Indicates the type of anomaly associated with the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "Indicates the type of anomaly associated with the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } }, "Notes": { "target": "com.amazonaws.lookoutequipment#Comments", "traits": { - "smithy.api#documentation": "Metadata providing additional information about the label.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "Metadata providing additional information about the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
" + "smithy.api#documentation": "Indicates that a label pertains to a particular piece of equipment.
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The time at which the label was created.\n
" + "smithy.api#documentation": "The time at which the label was created.
" } } }, @@ -2728,7 +2977,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a JSON containing the overall information about a specific ML model, including\n model name and ARN, dataset, training and evaluation information, status, and so on.\n
" + "smithy.api#documentation": "Provides a JSON containing the overall information about a specific machine learning\n model, including model name and ARN, dataset, training and evaluation information, status,\n and so on.
" } }, "com.amazonaws.lookoutequipment#DescribeModelRequest": { @@ -2737,7 +2986,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model to be described.
", + "smithy.api#documentation": "The name of the machine learning model to be described.
", "smithy.api#required": {} } } @@ -2752,25 +3001,25 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model being described.
" + "smithy.api#documentation": "The name of the machine learning model being described.
" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model being described.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model being described.
" } }, "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "The name of the dataset being used by the ML being described.
" + "smithy.api#documentation": "The name of the dataset being used by the machine learning being described.
" } }, "DatasetArn": { "target": "com.amazonaws.lookoutequipment#DatasetArn", "traits": { - "smithy.api#documentation": "The Amazon Resouce Name (ARN) of the dataset used to create the ML model being\n described.
" + "smithy.api#documentation": "The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model\n being described.
" } }, "Schema": { @@ -2788,37 +3037,37 @@ "TrainingDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n training data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n training data for the machine learning model.
" } }, "TrainingDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of training\n data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of training\n data for the machine learning model.
" } }, "EvaluationDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n evaluation data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n evaluation data for the machine learning model.
" } }, "EvaluationDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of\n evaluation data for the ML model.
" + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of\n evaluation data for the machine learning model.
" } }, "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the ML model being described.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the machine learning model being described.
" } }, "DataPreProcessingConfiguration": { "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", "traits": { - "smithy.api#documentation": "The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Indicates the time at which the training of the ML model began.
" + "smithy.api#documentation": "Indicates the time at which the training of the machine learning model began.
" } }, "TrainingExecutionEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time at which the training of the ML model was completed.
" + "smithy.api#documentation": "Indicates the time at which the training of the machine learning model was completed.\n
" } }, "FailedReason": { "target": "com.amazonaws.lookoutequipment#BoundedLengthString", "traits": { - "smithy.api#documentation": "If the training of the ML model failed, this indicates the reason for that failure.\n
" + "smithy.api#documentation": "If the training of the machine learning model failed, this indicates the reason for that\n failure.
" } }, "ModelMetrics": { @@ -2854,13 +3103,13 @@ "LastUpdatedTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the last time the ML model was updated. The type of update is not specified.\n
" + "smithy.api#documentation": "Indicates the last time the machine learning model was updated. The type of update is\n not specified.
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time and date at which the ML model was created.
" + "smithy.api#documentation": "Indicates the time and date at which the machine learning model was created.
" } }, "ServerSideKmsKeyId": { @@ -2872,37 +3121,37 @@ "OffCondition": { "target": "com.amazonaws.lookoutequipment#OffCondition", "traits": { - "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.
" + "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or\n inference.
" } }, "SourceModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version \n was imported.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model version. This field appears if the\n active model version was imported.
" } }, "ImportJobStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date and time when the import job was started. \n This field appears if the active model version was imported.
" + "smithy.api#documentation": "The date and time when the import job was started. This field appears if the active\n model version was imported.
" } }, "ImportJobEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date and time when the import job was completed. \n This field appears if the active model version was imported.
" + "smithy.api#documentation": "The date and time when the import job was completed. This field appears if the active\n model version was imported.
" } }, "ActiveModelVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "The name of the model version used by the inference schedular when running a\n scheduled inference execution.
" + "smithy.api#documentation": "The name of the model version used by the inference schedular when running a scheduled\n inference execution.
" } }, "ActiveModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version used by the\n inference scheduler when running a scheduled inference execution.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version used by the inference scheduler when\n running a scheduled inference execution.
" } }, "ModelVersionActivatedAt": { @@ -2914,13 +3163,13 @@ "PreviousActiveModelVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "The model version that was set as the active model version prior to the \n current active model version.
" + "smithy.api#documentation": "The model version that was set as the active model version prior to the current active\n model version.
" } }, "PreviousActiveModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "The ARN of the model version that was set as the active model version prior to the \n current active model version.
" + "smithy.api#documentation": "The ARN of the model version that was set as the active model version prior to the\n current active model version.
" } }, "PreviousModelVersionActivatedAt": { @@ -2928,6 +3177,66 @@ "traits": { "smithy.api#documentation": "The date and time when the previous active model version was activated.
" } + }, + "PriorModelMetrics": { + "target": "com.amazonaws.lookoutequipment#SynthesizedJsonModelMetrics", + "traits": { + "smithy.api#documentation": "If the model version was retrained, this field shows a summary of the performance of the\n prior model on the new training range. You can use the information in this JSON-formatted\n object to compare the new model version and the prior model version.
" + } + }, + "LatestScheduledRetrainingFailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "If the model version was generated by retraining and the training failed, this indicates\n the reason for that failure.
" + } + }, + "LatestScheduledRetrainingStatus": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the most recent scheduled retraining run.
" + } + }, + "LatestScheduledRetrainingModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Indicates the most recent model version that was generated by retraining.
" + } + }, + "LatestScheduledRetrainingStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the start time of the most recent scheduled retraining run.
" + } + }, + "LatestScheduledRetrainingAvailableDataInDays": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of days of data used in the most recent scheduled retraining run.\n
" + } + }, + "NextScheduledRetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment\n truncates the time you provide to the nearest UTC day.
" + } + }, + "AccumulatedInferenceDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the start time of the inference data that has been accumulated.
" + } + }, + "AccumulatedInferenceDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the end time of the inference data that has been accumulated.
" + } + }, + "RetrainingSchedulerStatus": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the retraining scheduler.
" + } } }, "traits": { @@ -2997,7 +3306,7 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the parent machine learning model that this version\n belong to.
" } }, "ModelVersion": { @@ -3048,31 +3357,31 @@ "TrainingDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date on which the training data began being gathered. If you imported\n the version, this is the date that the training data in the source \n version began being gathered.
" + "smithy.api#documentation": "The date on which the training data began being gathered. If you imported the version,\n this is the date that the training data in the source version began being gathered.
" } }, "TrainingDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date on which the training data finished being gathered. \n If you imported the version, this is the date that the training data in the\n source version finished being gathered.
" + "smithy.api#documentation": "The date on which the training data finished being gathered. If you imported the\n version, this is the date that the training data in the source version finished being\n gathered.
" } }, "EvaluationDataStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in \n the source version began being gathered.
" + "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. If you imported\n the version, this is the date that the evaluation set data in the source version began\n being gathered.
" } }, "EvaluationDataEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in the\n source version finished being gathered.
" + "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. If you imported\n the version, this is the date that the evaluation set data in the source version finished\n being gathered.
" } }, "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that was used to train the model version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that was used to train the model\n version.
" } }, "DataPreProcessingConfiguration": { @@ -3099,7 +3408,7 @@ "ModelMetrics": { "target": "com.amazonaws.lookoutequipment#ModelMetrics", "traits": { - "smithy.api#documentation": "Shows an aggregated summary, in JSON format, of the model's \n performance within the evaluation time range. These metrics \n are created when evaluating the model.
" + "smithy.api#documentation": "Shows an aggregated summary, in JSON format, of the model's performance within the\n evaluation time range. These metrics are created when evaluating the model.
" } }, "LastUpdatedTime": { @@ -3111,43 +3420,67 @@ "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the time and date at which the machine learning model version was created.
" + "smithy.api#documentation": "Indicates the time and date at which the machine learning model version was\n created.
" } }, "ServerSideKmsKeyId": { "target": "com.amazonaws.lookoutequipment#KmsKeyArn", "traits": { - "smithy.api#documentation": "The identifier of the KMS key key used to encrypt model version data by \n Amazon Lookout for Equipment.
" + "smithy.api#documentation": "The identifier of the KMS key key used to encrypt model version data by\n Amazon Lookout for Equipment.
" } }, "OffCondition": { "target": "com.amazonaws.lookoutequipment#OffCondition", "traits": { - "smithy.api#documentation": "Indicates that the asset associated with this sensor has been \n shut off. As long as this condition is met, Lookout for Equipment \n will not use data from this asset for training, evaluation, or inference.
" + "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.
" } }, "SourceModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "If model version was imported, then this field is the arn\n of the source model version.
" + "smithy.api#documentation": "If model version was imported, then this field is the arn of the source model\n version.
" } }, "ImportJobStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date and time when the import job began. \n This field appears if the model version was imported.
" + "smithy.api#documentation": "The date and time when the import job began. This field appears if the model version was\n imported.
" } }, "ImportJobEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The date and time when the import job completed. \n This field appears if the model version was imported.
" + "smithy.api#documentation": "The date and time when the import job completed. This field appears if the model version\n was imported.
" } }, "ImportedDataSizeInBytes": { "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", "traits": { - "smithy.api#documentation": "The size in bytes of the imported data. \n This field appears if the model version was imported.
" + "smithy.api#documentation": "The size in bytes of the imported data. This field appears if the model version was\n imported.
" + } + }, + "PriorModelMetrics": { + "target": "com.amazonaws.lookoutequipment#ModelMetrics", + "traits": { + "smithy.api#documentation": "If the model version was retrained, this field shows a summary of the performance of the\n prior model on the new training range. You can use the information in this JSON-formatted\n object to compare the new model version and the prior model version.
" + } + }, + "RetrainingAvailableDataInDays": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of days of data used in the most recent scheduled retraining run.\n
" + } + }, + "AutoPromotionResult": { + "target": "com.amazonaws.lookoutequipment#AutoPromotionResult", + "traits": { + "smithy.api#documentation": "Indicates whether the model version was promoted to be the active version after\n retraining or if there was an error with or cancellation of the retraining.
" + } + }, + "AutoPromotionResultReason": { + "target": "com.amazonaws.lookoutequipment#AutoPromotionResultReason", + "traits": { + "smithy.api#documentation": "Indicates the reason for the AutoPromotionResult. For example, a model\n might not be promoted if its performance was worse than the active version, if there was an\n error during training, or if the retraining scheduler was using MANUAL promote\n mode. The model will be promoted in MANAGED promote mode if the performance is\n better than the previous model.
The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that is associated with the resource\n policy.
", "smithy.api#required": {} } } @@ -3231,26 +3564,152 @@ "smithy.api#output": {} } }, - "com.amazonaws.lookoutequipment#DuplicateTimestamps": { - "type": "structure", - "members": { - "TotalNumberOfDuplicateTimestamps": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the total number of duplicate timestamps.
", - "smithy.api#required": {} - } - } + "com.amazonaws.lookoutequipment#DescribeRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerRequest" }, - "traits": { - "smithy.api#documentation": "Entity that comprises information abount duplicate timestamps in the dataset.
" - } - }, - "com.amazonaws.lookoutequipment#Equipment": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a description of the retraining scheduler, including information such as the\n model name and retraining parameters.
", + "smithy.api#examples": [ + { + "title": "Describes a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "RetrainingStartDate": "2023-11-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D", + "Status": "RUNNING", + "PromoteMode": "MANAGED", + "CreatedAt": "2023-10-01T15:00:00Z", + "UpdatedAt": "2023-10-01T15:00:00Z" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that the retraining scheduler is attached to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that the retraining scheduler is attached to.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model that the retraining scheduler is attached to.
" + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "The frequency at which the model retraining is set. This follows the ISO 8601\n guidelines.
" + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "The number of past days of data used for retraining.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "Indicates how the service uses new models. In MANAGED mode, new models are\n used for inference if they have better performance than the current model. In\n MANUAL mode, the new models are not used until they are manually\n activated.
Indicates the time and date at which the retraining scheduler was created.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time and date at which the retraining scheduler was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DuplicateTimestamps": { + "type": "structure", + "members": { + "TotalNumberOfDuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the total number of duplicate timestamps.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information abount duplicate timestamps in the dataset.
" + } + }, + "com.amazonaws.lookoutequipment#Equipment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, "max": 200 }, "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,200}$" @@ -3366,13 +3825,13 @@ "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.
" + "smithy.api#documentation": "The name of the machine learning dataset to be created. If the dataset already exists,\n Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled\n with the name of the source dataset.
" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "A unique identifier for the request. \n If you do not set the client request token, \n Amazon Lookout for Equipment generates one.
", + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -3380,7 +3839,7 @@ "ServerSideKmsKeyId": { "target": "com.amazonaws.lookoutequipment#NameOrArn", "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key key used to \n encrypt model data by Amazon Lookout for Equipment.
" + "smithy.api#documentation": "Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.\n
" } }, "Tags": { @@ -3474,7 +3933,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name for the machine learning model to be created.\n If the model already exists, Amazon Lookout for Equipment creates a new version. \n If you do not specify this field, it is filled with the name of the source model.
" + "smithy.api#documentation": "The name for the machine learning model to be created. If the model already exists,\n Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the\n name of the source model.
" } }, "DatasetName": { @@ -3490,7 +3949,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request\n token, Amazon Lookout for Equipment generates one.
", + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -3498,13 +3957,13 @@ "RoleArn": { "target": "com.amazonaws.lookoutequipment#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to \n access the data source being used to create the machine learning model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source being\n used to create the machine learning model.
" } }, "ServerSideKmsKeyId": { "target": "com.amazonaws.lookoutequipment#NameOrArn", "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key key used to encrypt \n model data by Amazon Lookout for Equipment.
" + "smithy.api#documentation": "Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.\n
" } }, "Tags": { @@ -3512,6 +3971,12 @@ "traits": { "smithy.api#documentation": "The tags associated with the machine learning model to be created.
" } + }, + "InferenceDataImportStrategy": { + "target": "com.amazonaws.lookoutequipment#InferenceDataImportStrategy", + "traits": { + "smithy.api#documentation": "Indicates how to import the accumulated inference data when a model version is imported.\n The possible values are as follows:
\nNO_IMPORT – Don't import the data.
\nADD_WHEN_EMPTY – Only import the data from the source model if there is no\n existing data in the target model.
\nOVERWRITE – Import the data from the source model and overwrite the\n existing data in the target model.
\nThe name of the ML model being used for the inference execution.
" + "smithy.api#documentation": "The name of the machine learning model being used for the inference execution.
" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model used for the inference execution.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model used for the inference\n execution.
" } }, "InferenceSchedulerName": { @@ -3695,7 +4183,7 @@ "CustomerResultObject": { "target": "com.amazonaws.lookoutequipment#S3Object", "traits": { - "smithy.api#documentation": "\n
" + "smithy.api#documentation": "The S3 object that the inference execution results were uploaded to.
" } }, "Status": { @@ -3709,6 +4197,18 @@ "traits": { "smithy.api#documentation": "Specifies the reason for failure when an inference execution has failed.
" } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The model version used for the inference execution.
" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model version used for the inference\n execution.
" + } } }, "traits": { @@ -3895,13 +4395,13 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model used for the inference scheduler.
" + "smithy.api#documentation": "The name of the machine learning model used for the inference scheduler.
" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model used by the inference\n scheduler.
" } }, "InferenceSchedulerName": { @@ -3931,7 +4431,7 @@ "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. This value is the\n length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout\n for Equipment will upload the real-time data to the source bucket once every 5 minutes.\n This frequency also determines how often Amazon Lookout for Equipment starts a scheduled\n inference on your data. In this example, it starts once every 5 minutes.
" + "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. This value is the\n length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout\n for Equipment will upload the real-time data to the source bucket once every 5 minutes.\n This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your\n data. In this example, it starts once every 5 minutes.
" } }, "LatestInferenceResult": { @@ -4046,7 +4546,7 @@ "KeyPattern": { "target": "com.amazonaws.lookoutequipment#KeyPattern", "traits": { - "smithy.api#documentation": "\n\t\t\t The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.
\nValid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)
" + "smithy.api#documentation": "The pattern for matching the Amazon S3 files that will be used for ingestion.\n If the schema was created previously without any KeyPattern, then the default KeyPattern\n {prefix}/{component_name}/* is used to download files from Amazon S3 according to\n the schema. This field is required when ingestion is being done for the first time.
\nValid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* |\n {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore,\n hyphen)
" } } }, @@ -4177,30 +4677,30 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group.\n
" + "smithy.api#documentation": "The name of the label group.
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group.
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The time at which the label group was created.\n
" + "smithy.api#documentation": "The time at which the label group was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The time at which the label group was updated.\n
" + "smithy.api#documentation": "The time at which the label group was updated.
" } } }, "traits": { - "smithy.api#documentation": "\n Contains information about the label group.\n
" + "smithy.api#documentation": "Contains information about the label group.
" } }, "com.amazonaws.lookoutequipment#LabelId": { @@ -4248,60 +4748,60 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group.\n
" + "smithy.api#documentation": "The name of the label group.
" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\n The ID of the label.\n
" + "smithy.api#documentation": "The ID of the label.
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group.
" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The timestamp indicating the start of the label.\n
" + "smithy.api#documentation": "The timestamp indicating the start of the label.
" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The timestamp indicating the end of the label.\n
" + "smithy.api#documentation": "The timestamp indicating the end of the label.
" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
" + "smithy.api#documentation": "Indicates whether a labeled event represents an anomaly.
" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\n Indicates the type of anomaly associated with the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "Indicates the type of anomaly associated with the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
" + "smithy.api#documentation": "Indicates that a label pertains to a particular piece of equipment.
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n The time at which the label was created.\n
" + "smithy.api#documentation": "The time at which the label was created.
" } } }, "traits": { - "smithy.api#documentation": "\n Information about the label.\n
" + "smithy.api#documentation": "Information about the label.
" } }, "com.amazonaws.lookoutequipment#LabelsInputConfiguration": { @@ -4316,7 +4816,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group to be used for label data.\n
" + "smithy.api#documentation": "The name of the label group to be used for label data.
" } } }, @@ -4608,14 +5108,14 @@ "IntervalStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Lookout for Equipment will return all the inference events with an end time equal to or greater than the\n start time given.
", + "smithy.api#documentation": "Lookout for Equipment will return all the inference events with an end time equal to or greater than\n the start time given.
", "smithy.api#required": {} } }, "IntervalEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "Returns all the inference events with an end start time equal to or greater than less than the end time given.
", + "smithy.api#documentation": "Returns all the inference events with an end start time equal to or greater than less\n than the end time given.
", "smithy.api#required": {} } } @@ -4703,13 +5203,13 @@ "DataStartTimeAfter": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The time reference in the inferenced dataset after which Amazon Lookout for Equipment\n started the inference execution.
" + "smithy.api#documentation": "The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference\n execution.
" } }, "DataEndTimeBefore": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "The time reference in the inferenced dataset before which Amazon Lookout for Equipment\n stopped the inference execution.
" + "smithy.api#documentation": "The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the\n inference execution.
" } }, "Status": { @@ -4798,7 +5298,7 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model used by the inference scheduler to be listed.
" + "smithy.api#documentation": "The name of the machine learning model used by the inference scheduler to be listed.\n
" } }, "Status": { @@ -4855,7 +5355,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of the label groups.\n
", + "smithy.api#documentation": "Returns a list of the label groups.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4869,19 +5369,19 @@ "LabelGroupNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The beginning of the name of the label groups to be listed.\n
" + "smithy.api#documentation": "The beginning of the name of the label groups to be listed.
" } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of label groups.\n
" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "\n Specifies the maximum number of label groups to list.\n
" + "smithy.api#documentation": "Specifies the maximum number of label groups to list.
" } } }, @@ -4895,13 +5395,13 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of label groups.\n
" } }, "LabelGroupSummaries": { "target": "com.amazonaws.lookoutequipment#LabelGroupSummaries", "traits": { - "smithy.api#documentation": "\n A summary of the label groups.\n
" + "smithy.api#documentation": "A summary of the label groups.
" } } }, @@ -4932,7 +5432,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Provides a list of labels.\n
", + "smithy.api#documentation": "Provides a list of labels.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4946,44 +5446,44 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n Retruns the name of the label group.\n
", + "smithy.api#documentation": "Retruns the name of the label group.
", "smithy.api#required": {} } }, "IntervalStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n Returns all the labels with a end time equal to or later than the start time given.\n
" + "smithy.api#documentation": "Returns all the labels with a end time equal to or later than the start time given.\n
" } }, "IntervalEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\n Returns all labels with a start time earlier than the end time given.\n
" + "smithy.api#documentation": "Returns all labels with a start time earlier than the end time given.
" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\n Returns labels with a particular fault code.\n
" + "smithy.api#documentation": "Returns labels with a particular fault code.
" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\n Lists the labels that pertain to a particular piece of equipment.\n
" + "smithy.api#documentation": "Lists the labels that pertain to a particular piece of equipment.
" } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of label groups.\n
" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "\n Specifies the maximum number of labels to list.\n
" + "smithy.api#documentation": "Specifies the maximum number of labels to list.
" } } }, @@ -4997,13 +5497,13 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of datasets.\n
" + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of datasets.\n
" } }, "LabelSummaries": { "target": "com.amazonaws.lookoutequipment#LabelSummaries", "traits": { - "smithy.api#documentation": "\n A summary of the items in the label group.\n
" + "smithy.api#documentation": "A summary of the items in the label group.
" } } }, @@ -5037,7 +5537,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates a list of all model versions for a given model, \n including the model version, model version ARN, and status. To list a \n subset of versions, use the MaxModelVersion and MinModelVersion fields.
Generates a list of all model versions for a given model, including the model version,\n model version ARN, and status. To list a subset of versions, use the\n MaxModelVersion and MinModelVersion fields.
Then name of the machine learning model for which the \n model versions are to be listed.
", + "smithy.api#documentation": "Then name of the machine learning model for which the model versions are to be\n listed.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.
If the total number of results exceeds the limit that the response can display, the\n response returns an opaque pagination token indicating where to continue the listing of\n machine learning model versions. Use this token in the NextToken field in the\n request to list the next page of results.
If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.
If the total number of results exceeds the limit that the response can display, the\n response returns an opaque pagination token indicating where to continue the listing of\n machine learning model versions. Use this token in the NextToken field in the\n request to list the next page of results.
Provides information on the specified model version, \n including the created time, model and dataset ARNs, and status.
" + "smithy.api#documentation": "Provides information on the specified model version, including the created time, model\n and dataset ARNs, and status.
" } } }, @@ -5165,31 +5665,31 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of ML models.\n
" + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of machine learning\n models.
" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "Specifies the maximum number of ML models to list.
" + "smithy.api#documentation": "Specifies the maximum number of machine learning models to list.
" } }, "Status": { "target": "com.amazonaws.lookoutequipment#ModelStatus", "traits": { - "smithy.api#documentation": "The status of the ML model.
" + "smithy.api#documentation": "The status of the machine learning model.
" } }, "ModelNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The beginning of the name of the ML models being listed.
" + "smithy.api#documentation": "The beginning of the name of the machine learning models being listed.
" } }, "DatasetNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "The beginning of the name of the dataset of the ML models to be listed.
" + "smithy.api#documentation": "The beginning of the name of the dataset of the machine learning models to be listed.\n
" } } }, @@ -5203,7 +5703,7 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of ML models.\n
" + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of machine learning\n models.
" } }, "ModelSummaries": { @@ -5228,6 +5728,126 @@ } } }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulersRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all retraining schedulers in your account, filtering by model name prefix and\n status.
", + "smithy.api#examples": [ + { + "title": "Listing retraining schedulers", + "documentation": "", + "input": { + "MaxResults": 50 + }, + "output": { + "RetrainingSchedulerSummaries": [ + { + "ModelName": "sample-model-1", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "RUNNING", + "RetrainingStartDate": "2023-06-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P180D" + }, + { + "ModelName": "sample-model-2", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Status": "RUNNING", + "RetrainingStartDate": "2023-08-15T00:00:00Z", + "RetrainingFrequency": "P30D", + "LookbackWindow": "P180D" + }, + { + "ModelName": "sample-model-3", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "Status": "STOPPED", + "RetrainingStartDate": "2023-09-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulersRequest": { + "type": "structure", + "members": { + "ModelNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "Specify this field to only list retraining schedulers whose machine learning models\n begin with the value you specify.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "Specify this field to only list retraining schedulers whose status matches the value you\n specify.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "If the number of results exceeds the maximum, a pagination token is returned. Use the\n token in the request to show the next page of retraining schedulers.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of retraining schedulers to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulersResponse": { + "type": "structure", + "members": { + "RetrainingSchedulerSummaries": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerSummaries", + "traits": { + "smithy.api#documentation": "Provides information on the specified retraining scheduler, including the model name,\n model ARN, status, and start date.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "If the number of results exceeds the maximum, this pagination token is returned. Use\n this token in the request to show the next page of retraining schedulers.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#ListSensorStatistics": { "type": "operation", "input": { @@ -5373,6 +5993,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#LookbackWindow": { + "type": "string", + "traits": { + "smithy.api#pattern": "^P180D$|^P360D$|^P540D$|^P720D$" + } + }, "com.amazonaws.lookoutequipment#MaxResults": { "type": "integer", "traits": { @@ -5448,6 +6074,23 @@ "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" } }, + "com.amazonaws.lookoutequipment#ModelPromoteMode": { + "type": "enum", + "members": { + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, "com.amazonaws.lookoutequipment#ModelStatus": { "type": "enum", "members": { @@ -5489,19 +6132,19 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model.
" + "smithy.api#documentation": "The name of the machine learning model.
" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model.
" } }, "DatasetName": { "target": "com.amazonaws.lookoutequipment#DatasetName", "traits": { - "smithy.api#documentation": "The name of the dataset being used for the ML model.
" + "smithy.api#documentation": "The name of the dataset being used for the machine learning model.
" } }, "DatasetArn": { @@ -5513,7 +6156,7 @@ "Status": { "target": "com.amazonaws.lookoutequipment#ModelStatus", "traits": { - "smithy.api#documentation": "Indicates the status of the ML model.
" + "smithy.api#documentation": "Indicates the status of the machine learning model.
" } }, "CreatedAt": { @@ -5531,12 +6174,42 @@ "ActiveModelVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version that is set as active. The active model version \n is the model version that the inference scheduler uses to run an inference\n execution.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version that is set as active. The active\n model version is the model version that the inference scheduler uses to run an inference\n execution.
" + } + }, + "LatestScheduledRetrainingStatus": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the most recent scheduled retraining run.
" + } + }, + "LatestScheduledRetrainingModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Indicates the most recent model version that was generated by retraining.
" + } + }, + "LatestScheduledRetrainingStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the start time of the most recent scheduled retraining run.
" + } + }, + "NextScheduledRetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates\n the time you provide to the nearest UTC day.
" + } + }, + "RetrainingSchedulerStatus": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the retraining scheduler.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status.
" + "smithy.api#documentation": "Provides information about the specified machine learning model, including dataset and\n model names and ARNs, as well as status.
" } }, "com.amazonaws.lookoutequipment#ModelVersion": { @@ -5633,7 +6306,7 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model that this model version is a version of.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model that this model version is a version\n of.
" } }, "ModelVersion": { @@ -5820,7 +6493,7 @@ "ResourceArn": { "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the \n policy is being created.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the policy is being\n created.
", "smithy.api#required": {} } }, @@ -5840,7 +6513,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "A unique identifier for the request. \n If you do not set the client request token, Amazon Lookout for Equipment \n generates one.
", + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -5856,7 +6529,7 @@ "ResourceArn": { "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the \n policy was created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the policy was created.
" } }, "PolicyRevisionId": { @@ -5896,22 +6569,111 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.lookoutequipment#S3Bucket": { + "com.amazonaws.lookoutequipment#RetrainingFrequency": { "type": "string", "traits": { "smithy.api#length": { - "min": 3, - "max": 63 + "min": 1, + "max": 10 }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + "smithy.api#pattern": "^P(\\dY)?(\\d{1,2}M)?(\\d{1,3}D)?$" } }, - "com.amazonaws.lookoutequipment#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 + "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.lookoutequipment#RetrainingSchedulerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerSummary" + } + }, + "com.amazonaws.lookoutequipment#RetrainingSchedulerSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that the retraining scheduler is attached to.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model that the retraining scheduler is attached to.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "The frequency at which the model retraining is set. This follows the ISO 8601\n guidelines.
" + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "The number of past days of data used for retraining.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the specified retraining scheduler, including model name,\n status, start date, frequency, and lookback window.
" + } + }, + "com.amazonaws.lookoutequipment#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.lookoutequipment#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 }, "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,1024}[^/]$" } @@ -6114,7 +6876,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.\n
" + "smithy.api#documentation": "Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
" } }, "com.amazonaws.lookoutequipment#StartDataIngestionJobRequest": { @@ -6227,13 +6989,13 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model being used by the inference\n scheduler.
" } }, "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model being used by the inference scheduler.
" + "smithy.api#documentation": "The name of the machine learning model being used by the inference scheduler.
" } }, "InferenceSchedulerName": { @@ -6259,6 +7021,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#StartRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StartRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StartRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a retraining scheduler.
", + "smithy.api#examples": [ + { + "title": "Starts a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "PENDING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#StartRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler you want to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StartRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler is being started.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model whose retraining scheduler is being started.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { "type": "enum", "members": { @@ -6329,13 +7178,13 @@ "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being\n stopped.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model used by the inference\n scheduler being stopped.
" } }, "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model used by the inference scheduler being stopped.
" + "smithy.api#documentation": "The name of the machine learning model used by the inference scheduler being stopped.\n
" } }, "InferenceSchedulerName": { @@ -6361,6 +7210,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.lookoutequipment#StopRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StopRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StopRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a retraining scheduler.
", + "smithy.api#examples": [ + { + "title": "Stops a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "STOPPING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#StopRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler you want to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StopRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler is being stopped.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model whose retraining scheduler is being stopped.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema": { "type": "string", "traits": { @@ -6466,7 +7402,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates a given tag to a resource in your account. A tag is a key-value pair which\n can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for\n organizing your resources as well as helping you to search and filter by tag. Multiple tags\n can be added to a resource, either when you create it, or later. Up to 50 tags can be\n associated with each resource.
" + "smithy.api#documentation": "Associates a given tag to a resource in your account. A tag is a key-value pair which\n can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your\n resources as well as helping you to search and filter by tag. Multiple tags can be added to\n a resource, either when you create it, or later. Up to 50 tags can be associated with each\n resource.
" } }, "com.amazonaws.lookoutequipment#TagResourceRequest": { @@ -6715,14 +7651,14 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the machine learning model for which the active model version \n is being set.
", + "smithy.api#documentation": "The name of the machine learning model for which the active model version is being\n set.
", "smithy.api#required": {} } }, "ModelVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "The version of the machine learning model for which the active model version \n is being set.
", + "smithy.api#documentation": "The version of the machine learning model for which the active model version is being\n set.
", "smithy.api#required": {} } } @@ -6737,37 +7673,37 @@ "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the machine learning model for which the active model version was set.
" + "smithy.api#documentation": "The name of the machine learning model for which the active model version was\n set.
" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model for which \n the active model version was set.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model for which the active model\n version was set.
" } }, "CurrentActiveVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "The version that is currently active of the machine learning model \n for which the active model version was set.
" + "smithy.api#documentation": "The version that is currently active of the machine learning model for which the active\n model version was set.
" } }, "PreviousActiveVersion": { "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "The previous version that was active of the machine learning model \n for which the active model version was set.
" + "smithy.api#documentation": "The previous version that was active of the machine learning model for which the active\n model version was set.
" } }, "CurrentActiveVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that is the\n current active model version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that is the current\n active model version.
" } }, "PreviousActiveVersionArn": { "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that was the\n previous active model version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that was the\n previous active model version.
" } } }, @@ -6826,7 +7762,7 @@ "DataUploadFrequency": { "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", "traits": { - "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon\n Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment starts a\n scheduled inference on your data. In this example, it starts once every 5 minutes.
" + "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon\n Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on\n your data. In this example, it starts once every 5 minutes.
" } }, "DataInputConfiguration": { @@ -6881,7 +7817,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Updates the label group.\n
" + "smithy.api#documentation": "Updates the label group.
" } }, "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest": { @@ -6890,14 +7826,164 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\n The name of the label group to be updated.\n
", + "smithy.api#documentation": "The name of the label group to be updated.
", "smithy.api#required": {} } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "\n Updates the code indicating the type of anomaly associated with the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" + "smithy.api#documentation": "Updates the code indicating the type of anomaly associated with the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a model in the account.
", + "smithy.api#examples": [ + { + "title": "Updates a model", + "documentation": "", + "input": { + "ModelName": "sample-model", + "LabelsInputConfiguration": { + "LabelGroupName": "sample-label-group" + } + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#UpdateModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model to update.
", + "smithy.api#required": {} + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the model to update.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateRetrainingSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a retraining scheduler.
", + "smithy.api#examples": [ + { + "title": "Updates a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model", + "RetrainingStartDate": "2024-01-01T00:00:00Z", + "RetrainingFrequency": "P1Y" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#UpdateRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler you want to update.
", + "smithy.api#required": {} + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in\n terms of Years, Months, and/or Days (note: other parameters like Time are not currently\n supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For\n example, the following values are valid:
\nP3M15D – Every 3 months and 15 days
\nP2M – Every 2 months
\nP150D – Every 150 days
\nThe number of past days of data that will be used for retraining.
" + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "Indicates how the service will use new models. In MANAGED mode, new models\n will automatically be used for inference if they have better performance than the current\n model. In MANUAL mode, the new models will not be used until they\n are manually activated.
The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a\n related Amazon Web Services service that's being utilized.
", + "smithy.api#documentation": "The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services\n service that's being utilized.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk/aws-models/medialive.json b/codegen/sdk/aws-models/medialive.json index d4e1950df06..7095f31906f 100644 --- a/codegen/sdk/aws-models/medialive.json +++ b/codegen/sdk/aws-models/medialive.json @@ -5671,6 +5671,20 @@ "smithy.api#documentation": "The Availability Zone associated with this input device.", "smithy.api#jsonName": "availabilityZone" } + }, + "MedialiveInputArns": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.", + "smithy.api#jsonName": "medialiveInputArns" + } + }, + "OutputType": { + "target": "com.amazonaws.medialive#InputDeviceOutputType", + "traits": { + "smithy.api#documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.", + "smithy.api#jsonName": "outputType" + } } }, "traits": { @@ -12505,6 +12519,26 @@ "smithy.api#documentation": "The source at the input device that is currently active." } }, + "com.amazonaws.medialive#InputDeviceCodec": { + "type": "enum", + "members": { + "HEVC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEVC" + } + }, + "AVC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVC" + } + } + }, + "traits": { + "smithy.api#documentation": "The codec to use on the video that the device produces." + } + }, "com.amazonaws.medialive#InputDeviceConfigurableSettings": { "type": "structure", "members": { @@ -12528,6 +12562,20 @@ "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms).", "smithy.api#jsonName": "latencyMs" } + }, + "Codec": { + "target": "com.amazonaws.medialive#InputDeviceCodec", + "traits": { + "smithy.api#documentation": "Choose the codec for the video that the device produces. Only UHD devices can specify this parameter.", + "smithy.api#jsonName": "codec" + } + }, + "MediaconnectSettings": { + "target": "com.amazonaws.medialive#InputDeviceMediaConnectConfigurableSettings", + "traits": { + "smithy.api#documentation": "To attach this device to a MediaConnect flow, specify these parameters. To detach an existing flow, enter {} for the value of mediaconnectSettings. Only UHD devices can specify this parameter.", + "smithy.api#jsonName": "mediaconnectSettings" + } } }, "traits": { @@ -12671,6 +12719,78 @@ "smithy.api#documentation": "Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address." } }, + "com.amazonaws.medialive#InputDeviceMediaConnectConfigurableSettings": { + "type": "structure", + "members": { + "FlowArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN of the MediaConnect flow to attach this device to.", + "smithy.api#jsonName": "flowArn" + } + }, + "RoleArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret. For more information about how to create this role, see the MediaLive user guide.", + "smithy.api#jsonName": "roleArn" + } + }, + "SecretArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN for the secret that holds the encryption key to encrypt the content output by the device.", + "smithy.api#jsonName": "secretArn" + } + }, + "SourceName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the MediaConnect Flow source to stream to.", + "smithy.api#jsonName": "sourceName" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters required to attach a MediaConnect flow to the device." + } + }, + "com.amazonaws.medialive#InputDeviceMediaConnectSettings": { + "type": "structure", + "members": { + "FlowArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN of the MediaConnect flow.", + "smithy.api#jsonName": "flowArn" + } + }, + "RoleArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN for the role that MediaLive assumes to access the attached flow and secret.", + "smithy.api#jsonName": "roleArn" + } + }, + "SecretArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN of the secret used to encrypt the stream.", + "smithy.api#jsonName": "secretArn" + } + }, + "SourceName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the MediaConnect flow source.", + "smithy.api#jsonName": "sourceName" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the MediaConnect flow attached to the device." + } + }, "com.amazonaws.medialive#InputDeviceNetworkSettings": { "type": "structure", "members": { @@ -12714,6 +12834,32 @@ "smithy.api#documentation": "The network settings for the input device." } }, + "com.amazonaws.medialive#InputDeviceOutputType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "MEDIALIVE_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIALIVE_INPUT" + } + }, + "MEDIACONNECT_FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIACONNECT_FLOW" + } + } + }, + "traits": { + "smithy.api#documentation": "The output attachment type of the input device." + } + }, "com.amazonaws.medialive#InputDeviceRequest": { "type": "structure", "members": { @@ -12884,6 +13030,20 @@ "smithy.api#documentation": "The Availability Zone associated with this input device.", "smithy.api#jsonName": "availabilityZone" } + }, + "MedialiveInputArns": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.", + "smithy.api#jsonName": "medialiveInputArns" + } + }, + "OutputType": { + "target": "com.amazonaws.medialive#InputDeviceOutputType", + "traits": { + "smithy.api#documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.", + "smithy.api#jsonName": "outputType" + } } }, "traits": { @@ -13002,6 +13162,20 @@ "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.", "smithy.api#jsonName": "latencyMs" } + }, + "Codec": { + "target": "com.amazonaws.medialive#InputDeviceCodec", + "traits": { + "smithy.api#documentation": "The codec for the video that the device produces.", + "smithy.api#jsonName": "codec" + } + }, + "MediaconnectSettings": { + "target": "com.amazonaws.medialive#InputDeviceMediaConnectSettings", + "traits": { + "smithy.api#documentation": "Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW.", + "smithy.api#jsonName": "mediaconnectSettings" + } } }, "traits": { @@ -16225,6 +16399,9 @@ { "target": "com.amazonaws.medialive#StartChannel" }, + { + "target": "com.amazonaws.medialive#StartInputDevice" + }, { "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow" }, @@ -16234,6 +16411,9 @@ { "target": "com.amazonaws.medialive#StopChannel" }, + { + "target": "com.amazonaws.medialive#StopInputDevice" + }, { "target": "com.amazonaws.medialive#StopMultiplex" }, @@ -21510,6 +21690,49 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#StartInputDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartInputDeviceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartInputDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Start an input device that is attached to a MediaConnect flow. (There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/start", + "code": 200 + } + } + }, "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow": { "type": "operation", "input": { @@ -21578,6 +21801,31 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#StartInputDeviceRequest": { + "type": "structure", + "members": { + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#StartInputDeviceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceResponse", + "smithy.api#output": {} + } + }, "com.amazonaws.medialive#StartMultiplex": { "type": "operation", "input": { @@ -22049,6 +22297,74 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#StopInputDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StopInputDeviceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StopInputDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/stop", + "code": 200 + } + } + }, + "com.amazonaws.medialive#StopInputDeviceRequest": { + "type": "structure", + "members": { + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StopInputDeviceRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#StopInputDeviceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StopInputDeviceResponse", + "smithy.api#output": {} + } + }, "com.amazonaws.medialive#StopMultiplex": { "type": "operation", "input": { @@ -23531,6 +23847,20 @@ "smithy.api#documentation": "The Availability Zone associated with this input device.", "smithy.api#jsonName": "availabilityZone" } + }, + "MedialiveInputArns": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.", + "smithy.api#jsonName": "medialiveInputArns" + } + }, + "OutputType": { + "target": "com.amazonaws.medialive#InputDeviceOutputType", + "traits": { + "smithy.api#documentation": "The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.", + "smithy.api#jsonName": "outputType" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index 1fc65ee85d9..0a51d1c1556 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -176,7 +176,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 16 + "max": 20 } } }, @@ -25463,6 +25463,46 @@ } } }, + "com.amazonaws.quicksight#KPIActualValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "The conditional formatting of the actual value's text color.
" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "The conditional formatting of the actual value's icon.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The conditional formatting for the actual value of a KPI visual.
" + } + }, + "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "The conditional formatting of the comparison value's text color.
" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "The conditional formatting of the comparison value's icon.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The conditional formatting for the comparison value of a KPI visual.
" + } + }, "com.amazonaws.quicksight#KPIConditionalFormatting": { "type": "structure", "members": { @@ -25491,6 +25531,18 @@ "traits": { "smithy.api#documentation": "The conditional formatting for the progress bar of a KPI visual.
" } + }, + "ActualValue": { + "target": "com.amazonaws.quicksight#KPIActualValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "The conditional formatting for the actual value of a KPI visual.
" + } + }, + "ComparisonValue": { + "target": "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "The conditional formatting for the comparison value of a KPI visual.
" + } } }, "traits": { @@ -25605,6 +25657,18 @@ "traits": { "smithy.api#documentation": "The options that determine the secondary value font configuration.
" } + }, + "Sparkline": { + "target": "com.amazonaws.quicksight#KPISparklineOptions", + "traits": { + "smithy.api#documentation": "The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
" + } + }, + "VisualLayoutOptions": { + "target": "com.amazonaws.quicksight#KPIVisualLayoutOptions", + "traits": { + "smithy.api#documentation": "The options that determine the layout a KPI visual.
" + } } }, "traits": { @@ -25659,6 +25723,56 @@ "smithy.api#documentation": "The sort configuration of a KPI visual.
" } }, + "com.amazonaws.quicksight#KPISparklineOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "The visibility of the sparkline.
" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#KPISparklineType", + "traits": { + "smithy.api#documentation": "The type of the sparkline.
", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "The color of the sparkline.
" + } + }, + "TooltipVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "The tooltip visibility of the sparkline.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
" + } + }, + "com.amazonaws.quicksight#KPISparklineType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AREA" + } + } + } + }, "com.amazonaws.quicksight#KPIVisual": { "type": "structure", "members": { @@ -25710,6 +25824,52 @@ "smithy.api#documentation": "A key performance indicator (KPI).
\nFor more information, see Using KPIs in the Amazon QuickSight User Guide.
" } }, + "com.amazonaws.quicksight#KPIVisualLayoutOptions": { + "type": "structure", + "members": { + "StandardLayout": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayout", + "traits": { + "smithy.api#documentation": "The standard layout of the KPI visual.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The options that determine the layout a KPI visual.
" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayout": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayoutType", + "traits": { + "smithy.api#documentation": "The standard layout type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The standard layout of the KPI visual.
" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayoutType": { + "type": "enum", + "members": { + "CLASSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIC" + } + }, + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + } + } + }, "com.amazonaws.quicksight#LabelOptions": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/simspaceweaver.json b/codegen/sdk/aws-models/simspaceweaver.json index d7c775bf1ff..70c160cba0d 100644 --- a/codegen/sdk/aws-models/simspaceweaver.json +++ b/codegen/sdk/aws-models/simspaceweaver.json @@ -1113,7 +1113,7 @@ "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" ] }, - "smithy.api#documentation": "SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale \n spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city,\n crowd simulations with millions of people and objects, and massively multiplayer games with\n hundreds of thousands of connected players.\n For more information about SimSpace Weaver, see the \n SimSpace Weaver User Guide\n .
\nThis API reference describes the API operations and data types that you can use to\n communicate directly with SimSpace Weaver.
\nSimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The\n SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This\n documentation is part of the SimSpace Weaver app SDK distributable package.
", + "smithy.api#documentation": "SimSpace Weaver (SimSpace Weaver) is a service that you can use to build and run \n large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create\n crowd simulations, large real-world environments, and immersive and interactive experiences.\n For more information about SimSpace Weaver, see the \n SimSpace Weaver User Guide\n .
\nThis API reference describes the API operations and data types that you can use to\n communicate directly with SimSpace Weaver.
\nSimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The\n SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This\n documentation is part of the SimSpace Weaver app SDK distributable package.
", "smithy.api#title": "AWS SimSpace Weaver", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk/aws-models/xray.json b/codegen/sdk/aws-models/xray.json index db47cc4ad77..523984de176 100644 --- a/codegen/sdk/aws-models/xray.json +++ b/codegen/sdk/aws-models/xray.json @@ -5716,6 +5716,12 @@ "smithy.api#documentation": "The unique identifier for the request that generated the trace's segments and\n subsegments.
" } }, + "StartTime": { + "target": "com.amazonaws.xray#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of a trace, based on the earliest trace segment start time.
" + } + }, "Duration": { "target": "com.amazonaws.xray#NullableDouble", "traits": { diff --git a/gradle.properties b/gradle.properties index 9833eabd3cd..337e2997aa2 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,7 +12,7 @@ sdkVersion=0.32.2-SNAPSHOT smithyVersion=1.29.0 smithyGradleVersion=0.6.0 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.27.3 +smithyKotlinVersion=0.27.4 # kotlin kotlinVersion=1.8.22 @@ -37,4 +37,4 @@ mockkVersion=1.13.3 slf4jVersion=2.0.6 # dokka config (values specified at build-time as needed) -smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinVersion/ \ No newline at end of file +smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinVersion/