The configuration for an application using GraphQL APIs.
" + } + }, + "dataStoreConfig": { + "target": "com.amazonaws.amplifyuibuilder#DataStoreRenderConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application using DataStore APIs.
" + } + }, + "noApiConfig": { + "target": "com.amazonaws.amplifyuibuilder#NoApiRenderConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application with no API being used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the API configuration for a code generation job.
" + } + }, "com.amazonaws.amplifyuibuilder#AppId": { "type": "string", "traits": { @@ -1545,7 +1535,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the configuration information for rendering the UI component associated the code generation job.
" + "smithy.api#documentation": "Describes the configuration information for rendering the UI component associated with the code generation job.
" } }, "com.amazonaws.amplifyuibuilder#CodegenJobResource": { @@ -2579,7 +2569,7 @@ "aws.iam#requiredActions": [ "amplify:GetApp" ], - "smithy.api#documentation": "Creates a new form for an Amplify.
", + "smithy.api#documentation": "Creates a new form for an Amplify app.
", "smithy.api#http": { "uri": "/app/{appId}/environment/{environmentName}/forms", "method": "POST" @@ -2836,6 +2826,13 @@ } } }, + "com.amazonaws.amplifyuibuilder#DataStoreRenderConfig": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Describes the DataStore configuration for an API for a code generation job.
" + } + }, "com.amazonaws.amplifyuibuilder#DeleteComponent": { "type": "operation", "input": { @@ -4524,6 +4521,49 @@ } } }, + "com.amazonaws.amplifyuibuilder#GraphQLRenderConfig": { + "type": "structure", + "members": { + "typesFilePath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the GraphQL types file, relative to the component output directory.
", + "smithy.api#required": {} + } + }, + "queriesFilePath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the GraphQL queries file, relative to the component output directory.
", + "smithy.api#required": {} + } + }, + "mutationsFilePath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the GraphQL mutations file, relative to the component output directory.
", + "smithy.api#required": {} + } + }, + "subscriptionsFilePath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the GraphQL subscriptions file, relative to the component output directory.
", + "smithy.api#required": {} + } + }, + "fragmentsFilePath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the GraphQL fragments file, relative to the component output directory.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the GraphQL configuration for an API for a code generation job.
" + } + }, "com.amazonaws.amplifyuibuilder#IdentifierList": { "type": "list", "member": { @@ -5061,6 +5101,13 @@ "smithy.api#documentation": "Represents the state configuration when an action modifies a property of another element\n within the same component.
" } }, + "com.amazonaws.amplifyuibuilder#NoApiRenderConfig": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Describes the configuration for an application with no API being used.
" + } + }, "com.amazonaws.amplifyuibuilder#NumValues": { "type": "list", "member": { @@ -5233,6 +5280,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the code generation job should render inline source maps.
" } + }, + "apiConfiguration": { + "target": "com.amazonaws.amplifyuibuilder#ApiConfiguration", + "traits": { + "smithy.api#documentation": "The API configuration for the code generation job.
" + } } }, "traits": { @@ -5490,7 +5543,7 @@ "aws.iam#requiredActions": [ "amplify:GetApp" ], - "smithy.api#documentation": "Starts a code generation job for for a specified Amplify app and backend environment.
", + "smithy.api#documentation": "Starts a code generation job for a specified Amplify app and backend environment.
", "smithy.api#http": { "uri": "/app/{appId}/environment/{environmentName}/codegen-jobs", "method": "POST" diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.json b/codegen/sdk-codegen/aws-models/auto-scaling.json index 777555eba93..73ef8b5ea16 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.json @@ -370,6 +370,26 @@ "smithy.api#documentation": "Describes an alarm.
" } }, + "com.amazonaws.autoscaling#AlarmList": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#AlarmSpecification": { + "type": "structure", + "members": { + "Alarms": { + "target": "com.amazonaws.autoscaling#AlarmList", + "traits": { + "smithy.api#documentation": "The names of one or more CloudWatch alarms to monitor for the instance refresh.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the CloudWatch alarm specification to use in an instance refresh.
" + } + }, "com.amazonaws.autoscaling#Alarms": { "type": "list", "member": { @@ -448,7 +468,19 @@ } ], "traits": { - "smithy.api#documentation": "Attaches one or more EC2 instances to the specified Auto Scaling group.
\nWhen you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.
\nIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.
\nFor more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Attaches one or more EC2 instances to the specified Auto Scaling group.
\nWhen you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.
\nIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.
\nFor more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To attach an instance to an Auto Scaling group", + "documentation": "This example attaches the specified instance to the specified Auto Scaling group.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group" + } + } + ] } }, "com.amazonaws.autoscaling#AttachInstancesQuery": { @@ -486,7 +518,19 @@ } ], "traits": { - "smithy.api#documentation": "This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.
Attaches one or more target groups to the specified Auto Scaling group.
\nThis operation is used with the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and supports HTTP and\n HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and\n UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nThis operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.
Attaches one or more target groups to the specified Auto Scaling group.
\nThis operation is used with the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and supports HTTP and\n HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and\n UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nThis operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To attach a target group to an Auto Scaling group", + "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + } + } + ] } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { @@ -529,7 +573,19 @@ } ], "traits": { - "smithy.api#documentation": "This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nThis operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nThis operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To attach a load balancer to an Auto Scaling group", + "documentation": "This example attaches the specified load balancer to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + } + } + ] } }, "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { @@ -572,7 +628,22 @@ } ], "traits": { - "smithy.api#documentation": "Attaches one or more traffic sources to the specified Auto Scaling group.
\nYou can use any of the following as traffic sources for an Auto Scaling group:
\nApplication Load Balancer
\nClassic Load Balancer
\nGateway Load Balancer
\nNetwork Load Balancer
\nVPC Lattice
\nThis operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.
\nAfter the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
" + "smithy.api#documentation": "Attaches one or more traffic sources to the specified Auto Scaling group.
\nYou can use any of the following as traffic sources for an Auto Scaling group:
\nApplication Load Balancer
\nClassic Load Balancer
\nGateway Load Balancer
\nNetwork Load Balancer
\nVPC Lattice
\nThis operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.
\nAfter the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
", + "smithy.api#examples": [ + { + "title": "To attach a target group to an Auto Scaling group", + "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TrafficSources": [ + { + "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.autoscaling#AttachTrafficSourcesResultType": { @@ -1281,52 +1352,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -1334,13 +1409,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1350,92 +1434,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -1444,155 +1519,115 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://autoscaling.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://autoscaling.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -2497,7 +2532,19 @@ } ], "traits": { - "smithy.api#documentation": "Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.
This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.
\nWhen you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.
" + "smithy.api#documentation": "Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.
This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.
\nWhen you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.
", + "smithy.api#examples": [ + { + "title": "To cancel an instance refresh", + "documentation": "This example cancels an instance refresh operation in progress.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" + } + } + ] } }, "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer": { @@ -2583,7 +2630,19 @@ } ], "traits": { - "smithy.api#documentation": "Completes the lifecycle action for the specified token or instance with the specified\n result.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.
\n\n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n
\nFor more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Completes the lifecycle action for the specified token or instance with the specified\n result.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.
\n\n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n
\nFor more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To complete the lifecycle action", + "documentation": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", + "LifecycleActionResult": "CONTINUE" + } + } + ] } }, "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { @@ -2686,7 +2745,25 @@ } ], "traits": { - "smithy.api#documentation": "\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
\nCreates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
\nCreates or updates tags for the specified Auto Scaling group.
\nWhen you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.
\nFor more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Creates or updates tags for the specified Auto Scaling group.
\nWhen you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.
\nFor more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To create or update tags for an Auto Scaling group", + "documentation": "This example adds two tags to the specified Auto Scaling group.", + "input": { + "Tags": [ + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Role", + "Value": "WebServer", + "PropagateAtLaunch": true + }, + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Dept", + "Value": "Research", + "PropagateAtLaunch": true + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { @@ -3107,7 +3223,16 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified Auto Scaling group.
\nIf the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.
\nTo remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.
\nTo terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.
\nIf the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.
\nFor more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Deletes the specified Auto Scaling group.
\nIf the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.
\nTo remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.
\nTo terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.
\nIf the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.
\nFor more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling group", + "documentation": "This example deletes the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteAutoScalingGroupType": { @@ -3145,7 +3270,16 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified launch configuration.
\nThe launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.
" + "smithy.api#documentation": "Deletes the specified launch configuration.
\nThe launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.
", + "smithy.api#examples": [ + { + "title": "To delete a launch configuration", + "documentation": "This example deletes the specified launch configuration.", + "input": { + "LaunchConfigurationName": "my-launch-config" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteLifecycleHook": { @@ -3162,7 +3296,17 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified lifecycle hook.
\nIf there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).
Deletes the specified lifecycle hook.
\nIf there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).
Deletes the specified notification.
" + "smithy.api#documentation": "Deletes the specified notification.
", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling notification", + "documentation": "This example deletes the specified notification from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteNotificationConfigurationType": { @@ -3241,7 +3395,17 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified scaling policy.
\nDeleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.
\nFor more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Deletes the specified scaling policy.
\nDeleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.
\nFor more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling policy", + "documentation": "This example deletes the specified Auto Scaling policy.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "my-step-scale-out-policy" + } + } + ] } }, "com.amazonaws.autoscaling#DeletePolicyType": { @@ -3276,7 +3440,17 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified scheduled action.
" + "smithy.api#documentation": "Deletes the specified scheduled action.
", + "smithy.api#examples": [ + { + "title": "To delete a scheduled action from an Auto Scaling group", + "documentation": "This example deletes the specified scheduled action from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteScheduledActionType": { @@ -3315,7 +3489,23 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified tags.
" + "smithy.api#documentation": "Deletes the specified tags.
", + "smithy.api#examples": [ + { + "title": "To delete a tag from an Auto Scaling group", + "documentation": "This example deletes the specified tag from the specified Auto Scaling group.", + "input": { + "Tags": [ + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Dept", + "Value": "Research" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DeleteTagsType": { @@ -3392,7 +3582,19 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe your Auto Scaling account limits", + "documentation": "This example describes the Amazon EC2 Auto Scaling service quotas for your account.", + "output": { + "MaxNumberOfAutoScalingGroups": 20, + "MaxNumberOfLaunchConfigurations": 100, + "NumberOfAutoScalingGroups": 3, + "NumberOfLaunchConfigurations": 5 + } + } + ] } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { @@ -3438,7 +3640,26 @@ } ], "traits": { - "smithy.api#documentation": "Describes the available adjustment types for step scaling and simple scaling\n policies.
\nThe following adjustment types are supported:
\n\n ChangeInCapacity\n
\n ExactCapacity\n
\n PercentChangeInCapacity\n
Describes the available adjustment types for step scaling and simple scaling\n policies.
\nThe following adjustment types are supported:
\n\n ChangeInCapacity\n
\n ExactCapacity\n
\n PercentChangeInCapacity\n
Gets information about the Auto Scaling groups in the account and Region.
\nIf you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.
\nThis operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.
", + "smithy.api#examples": [ + { + "title": "To describe an Auto Scaling group", + "documentation": "This example describes the specified Auto Scaling group.", + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "AutoScalingGroups": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group", + "LaunchConfigurationName": "my-launch-config", + "MinSize": 1, + "MaxSize": 5, + "DesiredCapacity": 2, + "DefaultCooldown": 300, + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c" + ], + "LoadBalancerNames": [], + "TargetGroupARNs": [], + "HealthCheckType": "EC2", + "HealthCheckGracePeriod": 300, + "Instances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-05b4f7d5be44822a6", + "InstanceType": "t3.micro", + "HealthStatus": "Healthy", + "LifecycleState": "InService" + }, + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2b", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-0c20ac468fa3049e8", + "InstanceType": "t3.micro", + "HealthStatus": "Healthy", + "LifecycleState": "InService" + } + ], + "CreatedTime": "2023-03-09T22:15:11.611Z", + "SuspendedProcesses": [], + "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", + "EnabledMetrics": [], + "Tags": [], + "TerminationPolicies": [ + "Default" + ], + "NewInstancesProtectedFromScaleIn": false, + "ServiceLinkedRoleARN": "arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling", + "TrafficSources": [] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3573,6 +3858,31 @@ ], "traits": { "smithy.api#documentation": "Gets information about the Auto Scaling instances in the account and Region.
", + "smithy.api#examples": [ + { + "title": "To describe one or more Auto Scaling instances", + "documentation": "This example describes the specified Auto Scaling instance.", + "input": { + "InstanceIds": [ + "i-05b4f7d5be44822a6" + ] + }, + "output": { + "AutoScalingInstances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-05b4f7d5be44822a6", + "InstanceType": "t3.micro", + "AutoScalingGroupName": "my-auto-scaling-group", + "HealthStatus": "HEALTHY", + "LifecycleState": "InService" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3618,7 +3928,22 @@ } ], "traits": { - "smithy.api#documentation": "Describes the notification types that are supported by Amazon EC2 Auto Scaling.
" + "smithy.api#documentation": "Describes the notification types that are supported by Amazon EC2 Auto Scaling.
", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling notification types", + "documentation": "This example describes the available notification types.", + "output": { + "AutoScalingNotificationTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCH", + "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", + "autoscaling:EC2_INSTANCE_TERMINATE", + "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", + "autoscaling:TEST_NOTIFICATION" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer": { @@ -3717,6 +4042,37 @@ ], "traits": { "smithy.api#documentation": "Gets information about the launch configurations in the account and Region.
", + "smithy.api#examples": [ + { + "title": "To describe Auto Scaling launch configurations", + "documentation": "This example describes the specified launch configuration.", + "input": { + "LaunchConfigurationNames": [ + "my-launch-config" + ] + }, + "output": { + "LaunchConfigurations": [ + { + "EbsOptimized": false, + "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", + "InstanceMonitoring": { + "Enabled": true + }, + "ImageId": "ami-043a5034", + "CreatedTime": "2014-05-07T17:39:28.599Z", + "BlockDeviceMappings": [], + "SecurityGroups": [ + "sg-67ef0308" + ], + "LaunchConfigurationName": "my-launch-config", + "InstanceType": "t1.micro", + "AssociatePublicIpAddress": true + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3739,7 +4095,19 @@ } ], "traits": { - "smithy.api#documentation": "Describes the available types of lifecycle hooks.
\nThe following hook types are supported:
\n\n autoscaling:EC2_INSTANCE_LAUNCHING\n
\n autoscaling:EC2_INSTANCE_TERMINATING\n
Describes the available types of lifecycle hooks.
\nThe following hook types are supported:
\n\n autoscaling:EC2_INSTANCE_LAUNCHING\n
\n autoscaling:EC2_INSTANCE_TERMINATING\n
Gets information about the lifecycle hooks for the specified Auto Scaling group.
" + "smithy.api#documentation": "Gets information about the lifecycle hooks for the specified Auto Scaling group.
", + "smithy.api#examples": [ + { + "title": "To describe your lifecycle hooks", + "documentation": "This example describes the lifecycle hooks for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LifecycleHooks": [ + { + "GlobalTimeout": 172800, + "HeartbeatTimeout": 3600, + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook", + "DefaultResult": "ABANDON", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer": { @@ -3816,7 +4207,24 @@ } ], "traits": { - "smithy.api#documentation": "This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
\nTo determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.
Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.
\nThis API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
\nTo determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.
Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.
\nThis API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.
Gets information about the load balancers for the specified Auto Scaling group.
\nThis operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.
\nTo determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.
Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.
Gets information about the load balancers for the specified Auto Scaling group.
\nThis operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.
\nTo determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.
Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe the load balancers for an Auto Scaling group", + "documentation": "This example describes the load balancers attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancers": [ + { + "State": "Added", + "LoadBalancerName": "my-load-balancer" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { @@ -3947,7 +4372,46 @@ } ], "traits": { - "smithy.api#documentation": "Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
" + "smithy.api#documentation": "Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling metric collection types", + "documentation": "This example describes the available metric collection types.", + "output": { + "Metrics": [ + { + "Metric": "GroupMinSize" + }, + { + "Metric": "GroupMaxSize" + }, + { + "Metric": "GroupDesiredCapacity" + }, + { + "Metric": "GroupInServiceInstances" + }, + { + "Metric": "GroupPendingInstances" + }, + { + "Metric": "GroupTerminatingInstances" + }, + { + "Metric": "GroupStandbyInstances" + }, + { + "Metric": "GroupTotalInstances" + } + ], + "Granularities": [ + { + "Granularity": "1Minute" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer": { @@ -3985,6 +4449,31 @@ ], "traits": { "smithy.api#documentation": "Gets information about the Amazon SNS notifications that are configured for one or more\n Auto Scaling groups.
", + "smithy.api#examples": [ + { + "title": "To describe Auto Scaling notification configurations", + "documentation": "This example describes the notification configurations for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "NotificationConfigurations": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + }, + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4055,6 +4544,37 @@ ], "traits": { "smithy.api#documentation": "Gets information about the scaling policies in the account and Region.
", + "smithy.api#examples": [ + { + "title": "To describe scaling policies", + "documentation": "This example describes the policies for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScalingPolicies": [ + { + "PolicyName": "ScaleIn", + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", + "AdjustmentType": "ChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": -1 + }, + { + "PolicyName": "ScalePercentChange", + "MinAdjustmentStep": 2, + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", + "Cooldown": 60, + "AdjustmentType": "PercentChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": 25 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4116,6 +4636,31 @@ ], "traits": { "smithy.api#documentation": "Gets information about the scaling activities in the account and Region.
\nWhen scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verifying a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
\nIf the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Describes the scaling process types for use with the ResumeProcesses\n and SuspendProcesses APIs.
" + "smithy.api#documentation": "Describes the scaling process types for use with the ResumeProcesses\n and SuspendProcesses APIs.
", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling process types", + "documentation": "This example describes the Auto Scaling process types.", + "output": { + "Processes": [ + { + "ProcessName": "AZRebalance" + }, + { + "ProcessName": "AddToLoadBalancer" + }, + { + "ProcessName": "AlarmNotification" + }, + { + "ProcessName": "HealthCheck" + }, + { + "ProcessName": "Launch" + }, + { + "ProcessName": "ReplaceUnhealthy" + }, + { + "ProcessName": "ScheduledActions" + }, + { + "ProcessName": "Terminate" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeScheduledActions": { @@ -4194,6 +4773,30 @@ ], "traits": { "smithy.api#documentation": "Gets information about the scheduled actions that haven't run or that have not reached\n their end time.
\nTo describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.
", + "smithy.api#examples": [ + { + "title": "To describe scheduled actions", + "documentation": "This example describes the scheduled actions for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScheduledUpdateGroupActions": [ + { + "MinSize": 2, + "DesiredCapacity": 4, + "AutoScalingGroupName": "my-auto-scaling-group", + "MaxSize": 6, + "Recurrence": "30 0 1 12 0", + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2016-12-01T00:30:00Z", + "Time": "2016-12-01T00:30:00Z" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4261,6 +4864,40 @@ ], "traits": { "smithy.api#documentation": "Describes the specified tags.
\nYou can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.
\nYou can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.
\nFor more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe tags", + "documentation": "This example describes the tags for the specified Auto Scaling group.", + "input": { + "Filters": [ + { + "Values": [ + "my-auto-scaling-group" + ], + "Name": "auto-scaling-group" + } + ] + }, + "output": { + "Tags": [ + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "Research", + "Key": "Dept" + }, + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "WebServer", + "Key": "Role" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4306,7 +4943,22 @@ } ], "traits": { - "smithy.api#documentation": "Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe termination policy types", + "documentation": "This example describes the available termination policy types.", + "output": { + "TerminationPolicyTypes": [ + "ClosestToNextInstanceHour", + "Default", + "NewestInstance", + "OldestInstance", + "OldestLaunchConfiguration" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { @@ -4338,6 +4990,25 @@ ], "traits": { "smithy.api#documentation": "Gets information about the traffic sources for the specified Auto Scaling group.
\nYou can optionally provide a traffic source type. If you provide a traffic source\n type, then the results only include that traffic source type.
\nIf you do not provide a traffic source type, then the results include all the traffic\n sources for the specified Auto Scaling group.
", + "smithy.api#examples": [ + { + "title": "To describe the target groups for an Auto Scaling group", + "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "TrafficSources": [ + { + "Identifier": "arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE", + "State": "InService", + "Type": "vpc-lattice" + } + ], + "NextToken": "" + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4508,7 +5179,34 @@ } ], "traits": { - "smithy.api#documentation": "Removes one or more instances from the specified Auto Scaling group.
\nAfter the instances are detached, you can manage them independent of the Auto Scaling\n group.
\nIf you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.
\nIf there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.
\nFor more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Removes one or more instances from the specified Auto Scaling group.
\nAfter the instances are detached, you can manage them independent of the Auto Scaling\n group.
\nIf you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.
\nIf there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.
\nFor more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To detach an instance from an Auto Scaling group", + "documentation": "This example detaches the specified instance from the specified Auto Scaling group.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "Description": "Detaching EC2 instance: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", + "Details": "details", + "StartTime": "2015-04-12T15:02:16.179Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DetachInstancesAnswer": { @@ -4561,7 +5259,19 @@ } ], "traits": { - "smithy.api#documentation": "This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.
Detaches one or more target groups from the specified Auto Scaling group.
\nWhen you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.
You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.
\nThis API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.
Detaches one or more target groups from the specified Auto Scaling group.
\nWhen you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.
You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.
\nThis API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
\nThis operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
\nWhen you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
\nThis operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
\nWhen you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
Detaches one or more traffic sources from the specified Auto Scaling group.
\nWhen you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.
Detaches one or more traffic sources from the specified Auto Scaling group.
\nWhen you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.
Disables group metrics collection for the specified Auto Scaling group.
" + "smithy.api#documentation": "Disables group metrics collection for the specified Auto Scaling group.
", + "smithy.api#examples": [ + { + "title": "To disable metrics collection for an Auto Scaling group", + "documentation": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Metrics": [ + "GroupDesiredCapacity" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DisableMetricsCollectionQuery": { @@ -4772,7 +5521,17 @@ } ], "traits": { - "smithy.api#documentation": "Enables group metrics collection for the specified Auto Scaling group.
\nYou can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Enables group metrics collection for the specified Auto Scaling group.
\nYou can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To enable metrics collection for an Auto Scaling group", + "documentation": "This example enables data collection for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Granularity": "1Minute" + } + } + ] } }, "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { @@ -4840,7 +5599,34 @@ } ], "traits": { - "smithy.api#documentation": "Moves the specified instances into the standby state.
\nIf you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.
\nIf you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Moves the specified instances into the standby state.
\nIf you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.
\nIf you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To move instances into standby mode", + "documentation": "This example puts the specified instance into standby mode.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "Description": "Moving EC2 instance to Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", + "Details": "details", + "StartTime": "2015-04-12T15:10:23.640Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#EnterStandbyAnswer": { @@ -4921,7 +5707,19 @@ } ], "traits": { - "smithy.api#documentation": "Executes the specified policy. This can be useful for testing the design of your\n scaling policy.
" + "smithy.api#documentation": "Executes the specified policy. This can be useful for testing the design of your\n scaling policy.
", + "smithy.api#examples": [ + { + "title": "To execute a scaling policy", + "documentation": "This example executes the specified policy.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "my-step-scale-out-policy", + "BreachThreshold": 50.0, + "MetricValue": 59.0 + } + } + ] } }, "com.amazonaws.autoscaling#ExecutePolicyType": { @@ -4974,7 +5772,33 @@ } ], "traits": { - "smithy.api#documentation": "Moves the specified instances out of the standby state.
\nAfter you put the instances back in service, the desired capacity is\n incremented.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Moves the specified instances out of the standby state.
\nAfter you put the instances back in service, the desired capacity is\n incremented.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To move instances out of standby mode", + "documentation": "This example moves the specified instance out of standby mode.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "Activities": [ + { + "Description": "Moving EC2 instance out of Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", + "Details": "details", + "StartTime": "2015-04-12T15:14:29.886Z", + "Progress": 30, + "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", + "StatusCode": "PreInService" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#ExitStandbyAnswer": { @@ -7559,7 +8383,20 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a lifecycle hook for the specified Auto Scaling group.
\nLifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.
\nYou can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.
" + "smithy.api#documentation": "Creates or updates a lifecycle hook for the specified Auto Scaling group.
\nLifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.
\nYou can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.
", + "smithy.api#examples": [ + { + "title": "To create a launch lifecycle hook", + "documentation": "This example creates a lifecycle hook for instance launch.", + "input": { + "LifecycleHookName": "my-launch-lifecycle-hook", + "HeartbeatTimeout": 300, + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", + "DefaultResult": "CONTINUE" + } + } + ] } }, "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { @@ -7641,7 +8478,20 @@ } ], "traits": { - "smithy.api#documentation": "Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.
\nThis configuration overwrites any existing configuration.
\nFor more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.
" + "smithy.api#documentation": "Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.
\nThis configuration overwrites any existing configuration.
\nFor more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.
", + "smithy.api#examples": [ + { + "title": "To add an Auto Scaling notification", + "documentation": "This example adds the specified notification to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "NotificationTypes": [ + "autoscaling:TEST_NOTIFICATION" + ] + } + } + ] } }, "com.amazonaws.autoscaling#PutNotificationConfigurationType": { @@ -7690,7 +8540,38 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.
\nFor more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
\nFor more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nYou can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.
" + "smithy.api#documentation": "Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.
\nFor more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
\nFor more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nYou can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.
", + "smithy.api#examples": [ + { + "title": "To add a scaling policy to an Auto Scaling group", + "documentation": "This example adds the specified policy to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "alb1000-target-tracking-scaling-policy", + "PolicyType": "TargetTrackingScaling", + "TargetTrackingConfiguration": { + "TargetValue": 1000.0, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ALBRequestCountPerTarget", + "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" + } + } + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", + "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e" + }, + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", + "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#PutScalingPolicyType": { @@ -7804,7 +8685,22 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a scheduled scaling action for an Auto Scaling group.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.
\nIf you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" + "smithy.api#documentation": "Creates or updates a scheduled scaling action for an Auto Scaling group.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.
\nIf you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
", + "smithy.api#examples": [ + { + "title": "To add a scheduled action to an Auto Scaling group", + "documentation": "This example adds the specified scheduled action to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2014-05-12T08:00:00Z", + "EndTime": "2014-05-12T08:00:00Z", + "MinSize": 2, + "MaxSize": 6, + "DesiredCapacity": 4 + } + } + ] } }, "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { @@ -7891,7 +8787,21 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity. For more information and example configurations, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nThis operation must be called from the Region in which the Auto Scaling group was created.\n This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a\n launch template or launch configuration that requests Spot Instances.
\nYou can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.
" + "smithy.api#documentation": "Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity. For more information and example configurations, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nThis operation must be called from the Region in which the Auto Scaling group was created.\n This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a\n launch template or launch configuration that requests Spot Instances.
\nYou can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.
", + "smithy.api#examples": [ + { + "title": "To create a warm pool for an Auto Scaling group", + "documentation": "This example creates a warm pool for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "MinSize": 30, + "PoolState": "Hibernated", + "InstanceReusePolicy": { + "ReuseOnScaleIn": true + } + } + } + ] } }, "com.amazonaws.autoscaling#PutWarmPoolAnswer": { @@ -7948,7 +8858,18 @@ } ], "traits": { - "smithy.api#documentation": "Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\n\n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\n\n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To record a lifecycle action heartbeat", + "documentation": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635" + } + } + ] } }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { @@ -8030,7 +8951,7 @@ "AutoRollback": { "target": "com.amazonaws.autoscaling#AutoRollback", "traits": { - "smithy.api#documentation": "(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration\n if the instance refresh fails. The default is false.
A rollback is not supported in the following situations:
\nThere is no desired configuration specified for the instance refresh.
\nThe Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager\n parameter instead of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or\n $Default version.
(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration\n if the instance refresh fails or a CloudWatch alarm threshold is met. The default is\n false.
A rollback is not supported in the following situations:
\nThere is no desired configuration specified for the instance refresh.
\nThe Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager\n parameter instead of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or\n $Default version.
For more information, see Undo changes with a\n rollback in the Amazon EC2 Auto Scaling User Guide.
" } }, "ScaleInProtectedInstances": { @@ -8044,6 +8965,12 @@ "traits": { "smithy.api#documentation": "Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby\n state are found.
The following lists the valid values:
\nAmazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues\n to replace instances that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service.\n Otherwise, the instance refresh will fail.
\n(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any\n issues and fail the operation if an alarm threshold is met.
" + } } }, "traits": { @@ -8128,7 +9055,19 @@ } ], "traits": { - "smithy.api#documentation": "Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.
\nFor more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.
\nFor more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To resume Auto Scaling processes", + "documentation": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + } + } + ] } }, "com.amazonaws.autoscaling#ReturnData": { @@ -8687,7 +9626,18 @@ } ], "traits": { - "smithy.api#documentation": "Sets the size of the specified Auto Scaling group.
\nIf a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.
For more information, see Manual scaling in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Sets the size of the specified Auto Scaling group.
\nIf a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.
For more information, see Manual scaling in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To set the desired capacity for an Auto Scaling group", + "documentation": "This example sets the desired capacity for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 2, + "HonorCooldown": true + } + } + ] } }, "com.amazonaws.autoscaling#SetDesiredCapacityType": { @@ -8729,7 +9679,17 @@ } ], "traits": { - "smithy.api#documentation": "Sets the health status of the specified instance.
\nFor more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Sets the health status of the specified instance.
\nFor more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To set the health status of an instance", + "documentation": "This example sets the health status of the specified instance to Unhealthy.", + "input": { + "InstanceId": "i-93633f9b", + "HealthStatus": "Unhealthy" + } + } + ] } }, "com.amazonaws.autoscaling#SetInstanceHealthQuery": { @@ -8774,7 +9734,20 @@ } ], "traits": { - "smithy.api#documentation": "Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.
\nFor more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
" + "smithy.api#documentation": "Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.
\nFor more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
", + "smithy.api#examples": [ + { + "title": "To enable instance protection for an instance", + "documentation": "This example enables instance protection for the specified instance.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ProtectedFromScaleIn": true + } + } + ] } }, "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { @@ -8871,7 +9844,35 @@ } ], "traits": { - "smithy.api#documentation": "Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling\n update of instances in an Auto Scaling group. Instances are terminated first and then replaced,\n which temporarily reduces the capacity available within your Auto Scaling group.
\nThis operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.
\nIf successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.
\nAn instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.
Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling\n update of instances in an Auto Scaling group. Instances are terminated first and then replaced,\n which temporarily reduces the capacity available within your Auto Scaling group.
\nThis operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.
\nIf successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.
\nAn instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.
Sets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum healthy percentage, and the\n behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby\n state or protected from scale in are found. You can also choose to enable additional\n features, such as the following:
Auto rollback
\nCheckpoints
\nSkip matching
\nSets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum healthy percentage, and the\n behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby\n state or protected from scale in are found. You can also choose to enable additional\n features, such as the following:
Auto rollback
\nCheckpoints
\nCloudWatch alarms
\nSkip matching
\nThe amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity. For exact capacity, you must specify a non-negative value.
", + "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.
", "smithy.api#required": {} } } @@ -8965,7 +9966,19 @@ } ], "traits": { - "smithy.api#documentation": "Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.
\nIf you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
" + "smithy.api#documentation": "Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.
\nIf you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
", + "smithy.api#examples": [ + { + "title": "To suspend Auto Scaling processes", + "documentation": "This example suspends the specified scaling process for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + } + } + ] } }, "com.amazonaws.autoscaling#SuspendedProcess": { @@ -9249,7 +10262,17 @@ } ], "traits": { - "smithy.api#documentation": "Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.
\nThis call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.
\nBy default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.
\nThis call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.
\nBy default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#examples": [ + { + "title": "To terminate an instance in an Auto Scaling group", + "documentation": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.", + "input": { + "InstanceId": "i-93633f9b", + "ShouldDecrementDesiredCapacity": false + } + } + ] } }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType": { @@ -9388,7 +10411,23 @@ } ], "traits": { - "smithy.api#documentation": "\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nUpdates the configuration for the specified Auto Scaling group.
\nTo update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n
\nIf you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.
\nNote the following about changing DesiredCapacity, MaxSize,\n or MinSize:
If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.
If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.
" + "smithy.api#documentation": "\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nUpdates the configuration for the specified Auto Scaling group.
\nTo update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n
\nIf you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.
\nNote the following about changing DesiredCapacity, MaxSize,\n or MinSize:
If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.
If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.
", + "smithy.api#examples": [ + { + "title": "To update an Auto Scaling group", + "documentation": "This example updates multiple properties at the same time.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "2" + }, + "MinSize": 1, + "MaxSize": 5, + "NewInstancesProtectedFromScaleIn": true + } + } + ] } }, "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.json b/codegen/sdk-codegen/aws-models/cleanrooms.json index 96d5043232d..dec49448b2c 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.json @@ -16,6 +16,9 @@ } ], "resources": [ + { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateResource" + }, { "target": "com.amazonaws.cleanrooms#CollaborationResource" }, @@ -428,9 +431,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -441,9 +444,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -454,9 +457,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -467,9 +470,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -480,9 +483,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -493,9 +496,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -506,9 +509,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -519,9 +522,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -530,9 +533,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -543,9 +546,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -554,9 +557,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -567,9 +570,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -580,9 +583,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -593,9 +596,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -606,9 +609,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -619,9 +622,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -630,9 +633,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "Region": "us-isob-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -643,9 +646,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -654,9 +657,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "Region": "us-isob-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -667,9 +670,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -680,9 +683,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -692,9 +695,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -704,9 +707,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -868,6 +871,18 @@ ] } }, + "com.amazonaws.cleanrooms#AllowedAnalysesList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArnOrQueryWildcard" + } + }, + "com.amazonaws.cleanrooms#AllowedAnalysisProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AccountId" + } + }, "com.amazonaws.cleanrooms#AllowedColumnList": { "type": "list", "member": { @@ -880,6 +895,17 @@ } } }, + "com.amazonaws.cleanrooms#AnalysisFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SQL", + "value": "SQL" + } + ] + } + }, "com.amazonaws.cleanrooms#AnalysisMethod": { "type": "string", "traits": { @@ -891,6 +917,47 @@ ] } }, + "com.amazonaws.cleanrooms#AnalysisParameter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanrooms#ParameterName", + "traits": { + "smithy.api#documentation": "The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-)\n characters but cannot start or end with a hyphen.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cleanrooms#ParameterType", + "traits": { + "smithy.api#documentation": "The type of parameter.
", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.cleanrooms#ParameterValue", + "traits": { + "smithy.api#documentation": "Optional. The default value that is applied in the analysis template. The member who can\n query can override this value in the query editor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Optional. The member who can query can provide this placeholder for a literal data value\n in an analysis template.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.cleanrooms#AnalysisParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.cleanrooms#AnalysisRule": { "type": "structure", "members": { @@ -904,7 +971,7 @@ "type": { "target": "com.amazonaws.cleanrooms#AnalysisRuleType", "traits": { - "smithy.api#documentation": "The type of analysis rule. Valid values are `AGGREGATION` and `LIST`.
", + "smithy.api#documentation": "The type of analysis rule.
", "smithy.api#required": {} } }, @@ -996,7 +1063,7 @@ } }, "traits": { - "smithy.api#documentation": "Enables query structure and specified queries that produce aggregate statistics.
" + "smithy.api#documentation": "A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.
" } }, "com.amazonaws.cleanrooms#AnalysisRuleColumnList": { @@ -1021,6 +1088,33 @@ "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnName" } }, + "com.amazonaws.cleanrooms#AnalysisRuleCustom": { + "type": "structure", + "members": { + "allowedAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAnalysesList", + "traits": { + "smithy.api#documentation": "The analysis templates that are allowed by the custom analysis rule.
", + "smithy.api#length": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "allowedAnalysisProviders": { + "target": "com.amazonaws.cleanrooms#AllowedAnalysisProviderList", + "traits": { + "smithy.api#documentation": "The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when\n allowedAnalyses is ANY_QUERY.
A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.
" + } + }, "com.amazonaws.cleanrooms#AnalysisRuleList": { "type": "structure", "members": { @@ -1037,7 +1131,7 @@ "allowedJoinOperators": { "target": "com.amazonaws.cleanrooms#JoinOperatorsList", "traits": { - "smithy.api#documentation": "Which logical operators (if any) are to be used in an INNER JOIN match condition.\n Default is AND.
The logical operators (if any) that are to be used in an INNER JOIN match condition.\n Default is AND.
Controls on the query specifications that can be run on configured table..
" + "smithy.api#documentation": "Controls on the query specifications that can be run on configured table.
" } } }, "traits": { - "smithy.api#documentation": "Controls on the query specifications that can be run on configured table..
" + "smithy.api#documentation": "Controls on the query specifications that can be run on configured table.
" } }, "com.amazonaws.cleanrooms#AnalysisRulePolicyV1": { @@ -1080,10 +1174,16 @@ "traits": { "smithy.api#documentation": "Analysis rule type that enables only aggregation queries on a configured table.
" } + }, + "custom": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleCustom", + "traits": { + "smithy.api#documentation": "Analysis rule type that enables custom SQL queries on a configured table.
" + } } }, "traits": { - "smithy.api#documentation": "Controls on the query specifications that can be run on configured table..
" + "smithy.api#documentation": "Controls on the query specifications that can be run on configured table.
" } }, "com.amazonaws.cleanrooms#AnalysisRuleType": { @@ -1100,6 +1200,12 @@ "traits": { "smithy.api#enumValue": "LIST" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } } }, @@ -1109,225 +1215,828 @@ "target": "com.amazonaws.cleanrooms#AnalysisRuleType" } }, - "com.amazonaws.cleanrooms#BatchGetSchema": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" - }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view details of schemas", - "smithy.api#documentation": "Retrieves multiple schemas by their identifiers.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/collaborations/{collaborationIdentifier}/batch-schema" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.cleanrooms#BatchGetSchemaError": { + "com.amazonaws.cleanrooms#AnalysisSchema": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", - "traits": { - "smithy.api#documentation": "An error name for the error.
", - "smithy.api#required": {} - } - }, - "code": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "An error code for the error.
", - "smithy.api#required": {} - } - }, - "message": { - "target": "smithy.api#String", + "referencedTables": { + "target": "com.amazonaws.cleanrooms#QueryTables", "traits": { - "smithy.api#documentation": "An error message for the error.
", - "smithy.api#required": {} + "smithy.api#documentation": "The tables referenced in the analysis schema.
" } } }, "traits": { - "smithy.api#documentation": "An error describing why a schema could not be fetched.
" - } - }, - "com.amazonaws.cleanrooms#BatchGetSchemaErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaError" - }, - "traits": { - "smithy.api#length": { - "max": 25 - } + "smithy.api#documentation": "A relation within an analysis.
" } }, - "com.amazonaws.cleanrooms#BatchGetSchemaInput": { - "type": "structure", + "com.amazonaws.cleanrooms#AnalysisSource": { + "type": "union", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "text": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateText", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the schemas belong to. Currently accepts\n collaboration ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" - } - }, - "names": { - "target": "com.amazonaws.cleanrooms#TableAliasList", - "traits": { - "smithy.api#documentation": "The names for the schema objects to retrieve.>
", - "smithy.api#required": {} + "smithy.api#documentation": "The query text.
" } } + }, + "traits": { + "smithy.api#documentation": "The structure that defines the body of the analysis template.
", + "smithy.api#sensitive": {} } }, - "com.amazonaws.cleanrooms#BatchGetSchemaOutput": { + "com.amazonaws.cleanrooms#AnalysisTemplate": { "type": "structure", "members": { - "schemas": { - "target": "com.amazonaws.cleanrooms#SchemaList", + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", "traits": { - "smithy.api#documentation": "The retrieved list of schemas.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier for the analysis template.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" } }, - "errors": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaErrorList", + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "Error reasons for schemas that could not be retrieved. One error is returned for every\n schema that could not be retrieved.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis template.
", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#CleanroomsArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 100 }, - "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:[\\d\\w/-]+$" - } - }, - "com.amazonaws.cleanrooms#Collaboration": { - "type": "structure", - "members": { - "id": { + "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "The unique ID for the collaboration.
", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#documentation": "The unique ID for the associated collaboration of the analysis template.
", + "smithy.api#required": {} } }, - "arn": { + "collaborationArn": { "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "The unique ARN for the collaboration.
", + "smithy.api#documentation": "The unique ARN for the analysis template’s associated collaboration.
", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanrooms#CollaborationName", + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "A human-readable identifier provided by the collaboration owner. Display names are not unique.
", + "smithy.api#documentation": "The identifier of a member who created the analysis template.
", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanrooms#CollaborationDescription", + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "A description of the collaboration provided by the collaboration owner.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the member who created the analysis template.
", + "smithy.api#required": {} } }, - "creatorAccountId": { - "target": "com.amazonaws.cleanrooms#AccountId", + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the analysis template.
" } }, - "creatorDisplayName": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", "traits": { - "smithy.api#documentation": "A display name of the collaboration creator.
", + "smithy.api#documentation": "The name of the analysis template.
", "smithy.api#required": {} } }, "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the collaboration was created.
", + "smithy.api#documentation": "The time that the analysis template was created.
", "smithy.api#required": {} } }, "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time the collaboration metadata was last updated.
", + "smithy.api#documentation": "The time that the analysis template was last updated.
", "smithy.api#required": {} } }, - "memberStatus": { - "target": "com.amazonaws.cleanrooms#MemberStatus", + "schema": { + "target": "com.amazonaws.cleanrooms#AnalysisSchema", "traits": { - "smithy.api#documentation": "The status of a member in a collaboration.
", + "smithy.api#documentation": "The entire schema object.
", "smithy.api#required": {} } }, - "membershipId": { - "target": "com.amazonaws.cleanrooms#UUID", + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", "traits": { - "smithy.api#documentation": "The unique ID for your membership within the collaboration.
" + "smithy.api#documentation": "The format of the analysis template.
", + "smithy.api#required": {} } }, - "membershipArn": { + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "The source of the analysis template.
", + "smithy.api#required": {} + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "The parameters of the analysis template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The analysis template.
" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateArnOrQueryWildcard": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^(ANY_QUERY|arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)$" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" + }, + "AnalysisTemplateId": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplate" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplate" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateAnalysisTemplate" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplate" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplates" + }, + "traits": { + "aws.api#arn": { + "template": "membership/{MembershipId}/analysistemplate/{AnalysisTemplateId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "analysistemplate" + }, + "smithy.api#documentation": "Represents a query that can be stored within a collaboration" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis template.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the analysis template summary was created.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the analysis template.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "The name of the analysis template.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the analysis template summary was last updated.
", + "smithy.api#required": {} + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the member who created the analysis template.
", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The identifier for a membership resource.
", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The unique ARN for the analysis template summary’s associated collaboration.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the analysis template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata of the analysis template.
" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateSummary" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15000 + } + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of multiple analysis tempaltes within a collaboration", + "smithy.api#documentation": "Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/collaborations/{collaborationIdentifier}/batch-analysistemplates" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateError": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis template.
", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An error code for the error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of why the call failed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.
" + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateError" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "analysisTemplateArns": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateOutput": { + "type": "structure", + "members": { + "collaborationAnalysisTemplates": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateList", + "traits": { + "smithy.api#documentation": "The retrieved list of analysis templates within a collaboration.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList", + "traits": { + "smithy.api#documentation": "Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#BatchGetSchema": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of schemas", + "smithy.api#documentation": "Retrieves multiple schemas by their identifiers.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/collaborations/{collaborationIdentifier}/batch-schema" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaError": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "An error name for the error.
", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An error code for the error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An error message for the error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An error describing why a schema could not be fetched.
" + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaError" + }, + "traits": { + "smithy.api#length": { + "max": 25 + } + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the collaboration that the schemas belong to. Currently accepts\n collaboration ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "names": { + "target": "com.amazonaws.cleanrooms#TableAliasList", + "traits": { + "smithy.api#documentation": "The names for the schema objects to retrieve.>
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaOutput": { + "type": "structure", + "members": { + "schemas": { + "target": "com.amazonaws.cleanrooms#SchemaList", + "traits": { + "smithy.api#documentation": "The retrieved list of schemas.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaErrorList", + "traits": { + "smithy.api#documentation": "Error reasons for schemas that could not be retrieved. One error is returned for every\n schema that could not be retrieved.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CleanroomsArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:[\\d\\w/-]+$" + } + }, + "com.amazonaws.cleanrooms#Collaboration": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique ID for the collaboration.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The unique ARN for the collaboration.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#CollaborationName", + "traits": { + "smithy.api#documentation": "A human-readable identifier provided by the collaboration owner. Display names are not unique.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#CollaborationDescription", + "traits": { + "smithy.api#documentation": "A description of the collaboration provided by the collaboration owner.
" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", + "smithy.api#required": {} + } + }, + "creatorDisplayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "A display name of the collaboration creator.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the collaboration was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time the collaboration metadata was last updated.
", + "smithy.api#required": {} + } + }, + "memberStatus": { + "target": "com.amazonaws.cleanrooms#MemberStatus", + "traits": { + "smithy.api#documentation": "The status of a member in a collaboration.
", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "The unique ID for your membership within the collaboration.
" + } + }, + "membershipArn": { "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "The unique ARN for your membership within the collaboration.
" + "smithy.api#documentation": "The unique ARN for your membership within the collaboration.
" + } + }, + "dataEncryptionMetadata": { + "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", + "traits": { + "smithy.api#documentation": "The settings for client-side encryption for cryptographic computing.
" + } + }, + "queryLogStatus": { + "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", + "traits": { + "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n collaboration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the analysis template.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis template.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The unique ARN for the analysis template’s associated collaboration.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the analysis template.
" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "The name of the analysis template.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the analysis template within a collaboration was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the analysis template in the collaboration was last updated.
", + "smithy.api#required": {} + } + }, + "schema": { + "target": "com.amazonaws.cleanrooms#AnalysisSchema", + "traits": { + "smithy.api#documentation": "The entire schema object.
", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "traits": { + "smithy.api#documentation": "The format of the analysis template in the collaboration.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "The source of the analysis template within a collaboration.
", + "smithy.api#required": {} + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "The analysis parameters that have been specified in the analysis template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The analysis template within a collaboration.
" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis template.
", + "smithy.api#required": {} } }, - "dataEncryptionMetadata": { - "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The settings for client-side encryption for cryptographic computing.
" + "smithy.api#documentation": "The time that the summary of the analysis template in a collaboration was created.
", + "smithy.api#required": {} } }, - "queryLogStatus": { - "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", "traits": { - "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n collaboration.
", + "smithy.api#documentation": "The identifier of the analysis template.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "The name of the analysis template.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the summary of the analysis template in the collaboration was last updated.
", "smithy.api#required": {} } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "The unique ARN for the analysis template’s associated collaboration.
", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the analysis template.
" + } } }, "traits": { - "smithy.api#documentation": "The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
" + "smithy.api#documentation": "The metadata of the analysis template within a collaboration.
" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary" } }, "com.amazonaws.cleanrooms#CollaborationArn": { @@ -1407,18 +2116,27 @@ "target": "com.amazonaws.cleanrooms#ListCollaborations" }, "operations": [ + { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate" + }, { "target": "com.amazonaws.cleanrooms#BatchGetSchema" }, { "target": "com.amazonaws.cleanrooms#DeleteMember" }, + { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate" + }, { "target": "com.amazonaws.cleanrooms#GetSchema" }, { "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRule" }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates" + }, { "target": "com.amazonaws.cleanrooms#ListMembers" }, @@ -1432,7 +2150,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "Collaboration" + "name": "collaboration" }, "smithy.api#documentation": "Represents a collaboration between AWS accounts that allows for secure data collaboration" } @@ -1621,7 +2339,7 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "The types of analysis rules associated with this configured table. Valid values are `AGGREGATION` and `LIST`. Currently, only one analysis rule may be associated with a configured table.
", + "smithy.api#documentation": "The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
", "smithy.api#required": {} } }, @@ -1672,7 +2390,7 @@ "type": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "The type of configured table analysis rule. Valid values are `AGGREGATION` and `LIST`.
", + "smithy.api#documentation": "The type of configured table analysis rule.
", "smithy.api#required": {} } }, @@ -1723,6 +2441,9 @@ "traits": { "smithy.api#documentation": "Analysis rule type that enables only aggregation queries on a configured table.
" } + }, + "custom": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleCustom" } }, "traits": { @@ -1743,6 +2464,12 @@ "traits": { "smithy.api#enumValue": "LIST" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } } }, @@ -1758,7 +2485,7 @@ "smithy.api#length": { "max": 100 }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredTable/[\\d\\w-]+$" + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtable/[\\d\\w-]+$" } }, "com.amazonaws.cleanrooms#ConfiguredTableAssociation": { @@ -1853,7 +2580,7 @@ "smithy.api#length": { "max": 100 }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredTableAssociation/[\\d\\w-]+/[\\d\\w-]+$" + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+$" } }, "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier": { @@ -1897,7 +2624,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "ConfiguredTableAssociation" + "name": "configuredtableassociation" }, "smithy.api#documentation": "Represents a table that can be queried within a collaboration" } @@ -2026,7 +2753,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "ConfiguredTable" + "name": "configuredtable" }, "smithy.api#documentation": "Represents a table that can be associated with collaborations" } @@ -2148,6 +2875,112 @@ ] } }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a new analysis template", + "smithy.api#documentation": "Creates a new analysis template.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/analysistemplates" + } + } + }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the analysis template.
" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for a membership resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "The name of the analysis template.
", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "traits": { + "smithy.api#documentation": "The format of the analysis template.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "The information in the analysis template. Currently supports text, the\n query text for the analysis template.
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "The parameters of the analysis template.
" + } + } + } + }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "The analysis template.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.cleanrooms#CreateCollaboration": { "type": "operation", "input": { @@ -2350,7 +3183,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "The type of analysis rule. Valid values are AGGREGATION and LIST.
", + "smithy.api#documentation": "The type of analysis rule.
", "smithy.api#required": {} } }, @@ -2649,6 +3482,69 @@ "smithy.api#documentation": "The settings for client-side encryption for cryptographic computing.
" } }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove an analysis template from a collaboration", + "smithy.api#documentation": "Deletes an analysis template.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for a membership resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the analysis template resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.cleanrooms#DeleteCollaboration": { "type": "operation", "input": { @@ -3038,7 +3934,78 @@ "name": "ACTIVE", "value": "ACTIVE" } - ] + ] + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template", + "smithy.api#documentation": "Retrieves an analysis template.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for a membership resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the analysis template resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + } + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "The analysis template.
", + "smithy.api#required": {} + } + } } }, "com.amazonaws.cleanrooms#GetCollaboration": { @@ -3074,6 +4041,77 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template within a collaboration", + "smithy.api#documentation": "Retrieves an analysis template within a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "analysisTemplateArn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateArn" + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput": { + "type": "structure", + "members": { + "collaborationAnalysisTemplate": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate", + "traits": { + "smithy.api#documentation": "The analysis template within a collaboration.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.cleanrooms#GetCollaborationInput": { "type": "structure", "members": { @@ -3598,85 +4636,254 @@ "smithy.api#length": { "max": 128 }, - "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" - } - }, - "com.amazonaws.cleanrooms#GlueTableReference": { - "type": "structure", - "members": { - "tableName": { - "target": "com.amazonaws.cleanrooms#GlueTableName", + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanrooms#GlueTableReference": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.cleanrooms#GlueTableName", + "traits": { + "smithy.api#documentation": "The name of the Glue table.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database the Glue table belongs to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a table within an Glue data catalog.
" + } + }, + "com.amazonaws.cleanrooms#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "Unexpected error during processing of request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.cleanrooms#JoinOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "OR", + "value": "OR" + }, + { + "name": "AND", + "value": "AND" + } + ] + } + }, + "com.amazonaws.cleanrooms#JoinOperatorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#JoinOperator" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.cleanrooms#JoinRequiredOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "QUERY_RUNNER", + "value": "QUERY_RUNNER" + } + ] + } + }, + "com.amazonaws.cleanrooms#KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\w!.*/-]*$" + } + }, + "com.amazonaws.cleanrooms#ListAnalysisTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates", + "smithy.api#documentation": "Lists analysis templates that the caller owns.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/analysistemplates" + }, + "smithy.api#paginated": { + "items": "analysisTemplateSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for a membership resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
" + } + }, + "analysisTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateSummaryList", + "traits": { + "smithy.api#documentation": "Lists analysis template metadata.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates within a collaboration", + "smithy.api#documentation": "Lists analysis templates within a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/analysistemplates" + }, + "smithy.api#paginated": { + "items": "collaborationAnalysisTemplateSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "The name of the Glue table.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" } }, - "databaseName": { - "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The name of the database the Glue table belongs to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" } } - }, - "traits": { - "smithy.api#documentation": "A reference to a table within an Glue data catalog.
" } }, - "com.amazonaws.cleanrooms#InternalServerException": { + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput": { "type": "structure", "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "Unexpected error during processing of request.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.cleanrooms#JoinOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "OR", - "value": "OR" - }, - { - "name": "AND", - "value": "AND" + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
" } - ] - } - }, - "com.amazonaws.cleanrooms#JoinOperatorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#JoinOperator" - }, - "traits": { - "smithy.api#length": { - "max": 2 - } - } - }, - "com.amazonaws.cleanrooms#JoinRequiredOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "QUERY_RUNNER", - "value": "QUERY_RUNNER" + }, + "collaborationAnalysisTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList", + "traits": { + "smithy.api#documentation": "The metadata of the analysis template within a collaboration.
", + "smithy.api#required": {} } - ] - } - }, - "com.amazonaws.cleanrooms#KeyPrefix": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\w!.*/-]*$" + } } }, "com.amazonaws.cleanrooms#ListCollaborations": { @@ -4659,7 +5866,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "Membership" + "name": "membership" }, "smithy.api#documentation": "Represents an AWS account that is a part of a collaboration" } @@ -4783,6 +5990,129 @@ } } }, + "com.amazonaws.cleanrooms#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cleanrooms#ParameterName" + }, + "value": { + "target": "com.amazonaws.cleanrooms#ParameterValue" + } + }, + "com.amazonaws.cleanrooms#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_]+$" + } + }, + "com.amazonaws.cleanrooms#ParameterType": { + "type": "enum", + "members": { + "SMALLINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALLINT" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGER" + } + }, + "BIGINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGINT" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "REAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REAL" + } + }, + "DOUBLE_PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE_PRECISION" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "CHAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAR" + } + }, + "VARCHAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARCHAR" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "TIMESTAMPTZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMPTZ" + } + }, + "TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME" + } + }, + "TIMETZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMETZ" + } + }, + "VARBYTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARBYTE" + } + } + } + }, + "com.amazonaws.cleanrooms#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, "com.amazonaws.cleanrooms#ProtectedQuery": { "type": "structure", "members": { @@ -5008,6 +6338,18 @@ "max": 15000 } } + }, + "analysisTemplateArn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
" + } + }, + "parameters": { + "target": "com.amazonaws.cleanrooms#ParameterMap", + "traits": { + "smithy.api#documentation": "The protected query SQL parameters.
" + } } }, "traits": { @@ -5125,6 +6467,30 @@ ] } }, + "com.amazonaws.cleanrooms#QueryTables": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#TableAlias" + } + }, + "com.amazonaws.cleanrooms#ResourceAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanrooms#ResourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" + } + }, "com.amazonaws.cleanrooms#ResourceNotFoundException": { "type": "structure", "members": { @@ -5288,7 +6654,7 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#AnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "The analysis rule types associated with the schema. Valued values are LIST and\n AGGREGATION. Currently, only one entry is present.
", + "smithy.api#documentation": "The analysis rule types associated with the schema. Currently, only one entry is present.
", "smithy.api#required": {} } }, @@ -5809,6 +7175,82 @@ "smithy.api#output": {} } }, + "com.amazonaws.cleanrooms#UpdateAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#UpdateAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#UpdateAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update an analysis template", + "smithy.api#documentation": "Updates the analysis template metadata.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + } + } + }, + "com.amazonaws.cleanrooms#UpdateAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for a membership resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the analysis template resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "A new description for the analysis template.
" + } + } + } + }, + "com.amazonaws.cleanrooms#UpdateAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "The analysis template.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.cleanrooms#UpdateCollaboration": { "type": "operation", "input": { @@ -6339,6 +7781,10 @@ { "value": "INVALID_QUERY", "name": "INVALID_QUERY" + }, + { + "value": "IAM_SYNCHRONIZATION_DELAY", + "name": "IAM_SYNCHRONIZATION_DELAY" } ] } diff --git a/codegen/sdk-codegen/aws-models/codestar-connections.json b/codegen/sdk-codegen/aws-models/codestar-connections.json index a44447f58e3..ec4ec621caf 100644 --- a/codegen/sdk-codegen/aws-models/codestar-connections.json +++ b/codegen/sdk-codegen/aws-models/codestar-connections.json @@ -36,7 +36,7 @@ "min": 12, "max": 12 }, - "smithy.api#pattern": "[0-9]{12}" + "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.codestarconnections#AmazonResourceName": { @@ -46,7 +46,7 @@ "min": 1, "max": 1011 }, - "smithy.api#pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+" + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" } }, "com.amazonaws.codestarconnections#CodeStar_connections_20191201": { @@ -102,7 +102,7 @@ "name": "codestar-connections" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "This AWS CodeStar Connections API Reference provides descriptions and usage examples of\n the operations and data types for the AWS CodeStar Connections API. You can use the\n connections API to work with connections and installations.
\n\n Connections are configurations that you use to connect AWS\n resources to external code repositories. Each connection is a resource that can be given to\n services such as CodePipeline to connect to a third-party repository such as Bitbucket. For\n example, you can add the connection in CodePipeline so that it triggers your pipeline when a\n code change is made to your third-party code repository. Each connection is named and\n associated with a unique ARN that is used to reference the connection.
\nWhen you create a connection, the console initiates a third-party connection handshake.\n Installations are the apps that are used to conduct this handshake. For\n example, the installation for the Bitbucket provider type is the Bitbucket app. When you\n create a connection, you can choose an existing installation or create one.
\nWhen you want to create a connection to an installed provider type such as GitHub\n Enterprise Server, you create a host for your connections.
\nYou can work with connections by calling:
\n\n CreateConnection, which creates a uniquely named connection that can be\n referenced by services such as CodePipeline.
\n\n DeleteConnection, which deletes the specified connection.
\n\n GetConnection, which returns information about the connection, including\n the connection status.
\n\n ListConnections, which lists the connections associated with your\n account.
\nYou can work with hosts by calling:
\n\n CreateHost, which creates a host that represents the infrastructure where your provider is installed.
\n\n DeleteHost, which deletes the specified host.
\n\n GetHost, which returns information about the host, including\n the setup status.
\n\n ListHosts, which lists the hosts associated with your\n account.
\nYou can work with tags in AWS CodeStar Connections by calling the following:
\n\n ListTagsForResource, which gets information about AWS tags for a\n specified Amazon Resource Name (ARN) in AWS CodeStar Connections.
\n\n TagResource, which adds or updates tags for a resource in AWS CodeStar\n Connections.
\n\n UntagResource, which removes tags for a resource in AWS CodeStar\n Connections.
\nFor information about how to use AWS CodeStar Connections, see the Developer Tools User\n Guide.
", + "smithy.api#documentation": "This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of\n the operations and data types for the Amazon Web Services CodeStar Connections API. You can use the\n connections API to work with connections and installations.
\n\n Connections are configurations that you use to connect Amazon Web Services\n resources to external code repositories. Each connection is a resource that can be given to\n services such as CodePipeline to connect to a third-party repository such as Bitbucket. For\n example, you can add the connection in CodePipeline so that it triggers your pipeline when a\n code change is made to your third-party code repository. Each connection is named and\n associated with a unique ARN that is used to reference the connection.
\nWhen you create a connection, the console initiates a third-party connection handshake.\n Installations are the apps that are used to conduct this handshake. For\n example, the installation for the Bitbucket provider type is the Bitbucket app. When you\n create a connection, you can choose an existing installation or create one.
\nWhen you want to create a connection to an installed provider type such as GitHub\n Enterprise Server, you create a host for your connections.
\nYou can work with connections by calling:
\n\n CreateConnection, which creates a uniquely named connection that can be\n referenced by services such as CodePipeline.
\n\n DeleteConnection, which deletes the specified connection.
\n\n GetConnection, which returns information about the connection, including\n the connection status.
\n\n ListConnections, which lists the connections associated with your\n account.
\nYou can work with hosts by calling:
\n\n CreateHost, which creates a host that represents the infrastructure where your provider is installed.
\n\n DeleteHost, which deletes the specified host.
\n\n GetHost, which returns information about the host, including\n the setup status.
\n\n ListHosts, which lists the hosts associated with your\n account.
\nYou can work with tags in Amazon Web Services CodeStar Connections by calling the following:
\n\n ListTagsForResource, which gets information about Amazon Web Services tags for a\n specified Amazon Resource Name (ARN) in Amazon Web Services CodeStar Connections.
\n\n TagResource, which adds or updates tags for a resource in Amazon Web Services CodeStar\n Connections.
\n\n UntagResource, which removes tags for a resource in Amazon Web Services CodeStar\n Connections.
\nFor information about how to use Amazon Web Services CodeStar Connections, see the Developer Tools User\n Guide.
", "smithy.api#title": "AWS CodeStar connections", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -465,8 +465,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -478,8 +478,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -491,8 +491,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -504,8 +504,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -517,8 +517,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -530,8 +530,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -543,8 +543,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -556,8 +556,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -569,8 +569,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -582,8 +582,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -595,8 +595,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -608,8 +608,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -621,8 +621,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -634,8 +634,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -647,8 +647,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -660,8 +660,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -673,8 +673,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -686,8 +686,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -699,8 +699,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -712,8 +712,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -725,8 +725,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -738,8 +738,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -751,8 +751,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -764,8 +764,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -777,8 +777,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -790,8 +790,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -803,8 +803,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -816,8 +827,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -829,8 +851,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -842,8 +875,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -855,8 +899,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -868,8 +912,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -881,8 +925,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -893,8 +937,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -905,10 +949,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -934,13 +984,13 @@ "ConnectionName": { "target": "com.amazonaws.codestarconnections#ConnectionName", "traits": { - "smithy.api#documentation": "The name of the connection. Connection names must be unique in an AWS user account.
" + "smithy.api#documentation": "The name of the connection. Connection names must be unique in an Amazon Web Services account.
" } }, "ConnectionArn": { "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between AWS services.
\nThe ARN is never reused if the connection is deleted.
\nThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between Amazon Web Services.
\nThe ARN is never reused if the connection is deleted.
\nA resource that is used to connect third-party source providers with services like AWS CodePipeline.
\nNote: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the \n connection in the console.
" + "smithy.api#documentation": "A resource that is used to connect third-party source providers with services like CodePipeline.
\nNote: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the \n connection in the console.
" } }, "com.amazonaws.codestarconnections#ConnectionArn": { @@ -979,7 +1029,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+" + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" } }, "com.amazonaws.codestarconnections#ConnectionList": { @@ -995,26 +1045,30 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.codestarconnections#ConnectionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "ERROR", - "name": "ERROR" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" } - ] + } } }, "com.amazonaws.codestarconnections#CreateConnection": { @@ -1037,7 +1091,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a connection that can then be given to other AWS services like CodePipeline so\n that it can access third-party code repositories. The connection is in pending status until\n the third-party connection handshake is completed from the console.
" + "smithy.api#documentation": "Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so\n that it can access third-party code repositories. The connection is in pending status until\n the third-party connection handshake is completed from the console.
" } }, "com.amazonaws.codestarconnections#CreateConnectionInput": { @@ -1052,7 +1106,7 @@ "ConnectionName": { "target": "com.amazonaws.codestarconnections#ConnectionName", "traits": { - "smithy.api#documentation": "The name of the connection to be created. The name must be unique in the calling AWS\n account.
", + "smithy.api#documentation": "The name of the connection to be created.
", "smithy.api#required": {} } }, @@ -1068,6 +1122,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the host associated with the connection to be created.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#CreateConnectionOutput": { @@ -1076,7 +1133,7 @@ "ConnectionArn": { "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the\n connection reference when the connection is shared between AWS services.
\nThe ARN is never reused if the connection is deleted.
\nThe Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the\n connection reference when the connection is shared between Amazon Web Services services.
\nThe ARN is never reused if the connection is deleted.
\nSpecifies the tags applied to the resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#CreateHost": { @@ -1111,7 +1171,7 @@ "Name": { "target": "com.amazonaws.codestarconnections#HostName", "traits": { - "smithy.api#documentation": "The name of the host to be created. The name must be unique in the calling AWS\n account.
", + "smithy.api#documentation": "The name of the host to be created.
", "smithy.api#required": {} } }, @@ -1138,6 +1198,9 @@ "Tags": { "target": "com.amazonaws.codestarconnections#TagList" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#CreateHostOutput": { @@ -1152,6 +1215,9 @@ "Tags": { "target": "com.amazonaws.codestarconnections#TagList" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#DeleteConnection": { @@ -1181,11 +1247,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#DeleteConnectionOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#DeleteHost": { "type": "operation", @@ -1217,11 +1289,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#DeleteHostOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#ErrorMessage": { "type": "string", @@ -1262,6 +1340,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#GetConnectionOutput": { @@ -1273,6 +1354,9 @@ "smithy.api#documentation": "The connection details, such as status, owner, and provider type.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#GetHost": { @@ -1305,6 +1389,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#GetHostOutput": { @@ -1340,6 +1427,9 @@ "smithy.api#documentation": "The VPC configuration of the requested host.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#Host": { @@ -1399,7 +1489,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+" + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+$" } }, "com.amazonaws.codestarconnections#HostList": { @@ -1452,6 +1542,11 @@ "output": { "target": "com.amazonaws.codestarconnections#ListConnectionsOutput" }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + } + ], "traits": { "smithy.api#documentation": "Lists the connections associated with your account.
", "smithy.api#paginated": { @@ -1489,6 +1584,9 @@ "smithy.api#documentation": "The token that was returned from the previous ListConnections call, which\n can be used to return the next set of connections in the list.
A token that can be used in the next ListConnections call. To view all\n items in the list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.
The token that was returned from the previous ListHosts call, which can be\n used to return the next set of hosts in the list.
A token that can be used in the next ListHosts call. To view all items in the\n list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.
A list of tag key and value pairs associated with the specified resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#MaxResults": { @@ -1621,22 +1734,32 @@ } }, "com.amazonaws.codestarconnections#ProviderType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Bitbucket", - "name": "BITBUCKET" - }, - { - "value": "GitHub", - "name": "GITHUB" - }, - { - "value": "GitHubEnterpriseServer", - "name": "GITHUB_ENTERPRISE_SERVER" + "type": "enum", + "members": { + "BITBUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bitbucket" + } + }, + "GITHUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHub" + } + }, + "GITHUB_ENTERPRISE_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHubEnterpriseServer" + } + }, + "GITLAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitLab" } - ] + } } }, "com.amazonaws.codestarconnections#ResourceNotFoundException": { @@ -1672,7 +1795,7 @@ "min": 11, "max": 20 }, - "smithy.api#pattern": "sg-\\w{8}(\\w{9})?" + "smithy.api#pattern": "^sg-\\w{8}(\\w{9})?$" } }, "com.amazonaws.codestarconnections#SecurityGroupIds": { @@ -1694,7 +1817,7 @@ "min": 15, "max": 24 }, - "smithy.api#pattern": "subnet-\\w{8}(\\w{9})?" + "smithy.api#pattern": "^subnet-\\w{8}(\\w{9})?$" } }, "com.amazonaws.codestarconnections#SubnetIds": { @@ -1728,7 +1851,7 @@ } }, "traits": { - "smithy.api#documentation": "A tag is a key-value pair that is used to manage the resource.
\nThis tag is available for use by AWS services that support tags.
" + "smithy.api#documentation": "A tag is a key-value pair that is used to manage the resource.
\nThis tag is available for use by Amazon Web Services services that support tags.
" } }, "com.amazonaws.codestarconnections#TagKey": { @@ -1802,11 +1925,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#TagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#TagValue": { "type": "string", @@ -1825,7 +1954,7 @@ "min": 1, "max": 16384 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.codestarconnections#UnsupportedOperationException": { @@ -1855,7 +1984,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes tags from an AWS resource.
" + "smithy.api#documentation": "Removes tags from an Amazon Web Services resource.
" } }, "com.amazonaws.codestarconnections#UntagResourceInput": { @@ -1875,11 +2004,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#UntagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#UpdateHost": { "type": "operation", @@ -1929,11 +2064,17 @@ "smithy.api#documentation": "The VPC configuration of the host to be updated. A VPC must be configured and the\n infrastructure to be represented by the host must already be connected to the VPC.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#UpdateHostOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#Url": { "type": "string", @@ -1987,7 +2128,7 @@ "min": 12, "max": 21 }, - "smithy.api#pattern": "vpc-\\w{8}(\\w{9})?" + "smithy.api#pattern": "^vpc-\\w{8}(\\w{9})?$" } } } diff --git a/codegen/sdk-codegen/aws-models/drs.json b/codegen/sdk-codegen/aws-models/drs.json index bab16cabee2..2c7b97c6f5c 100644 --- a/codegen/sdk-codegen/aws-models/drs.json +++ b/codegen/sdk-codegen/aws-models/drs.json @@ -7943,6 +7943,10 @@ { "name": "BASIC", "value": "BASIC" + }, + { + "name": "IN_AWS", + "value": "IN_AWS" } ] } diff --git a/codegen/sdk-codegen/aws-models/inspector2.json b/codegen/sdk-codegen/aws-models/inspector2.json index 151eb6e4916..7e294dda22d 100644 --- a/codegen/sdk-codegen/aws-models/inspector2.json +++ b/codegen/sdk-codegen/aws-models/inspector2.json @@ -1150,6 +1150,128 @@ "smithy.api#output": {} } }, + "com.amazonaws.inspector2#BatchGetFindingDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetFindingDetailsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetFindingDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets vulnerability details for findings.
", + "smithy.api#examples": [ + { + "title": "Sample BatchGetFindingDetails Call", + "input": { + "findingArns": [ + "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", + "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7" + ] + }, + "output": { + "findingDetails": [ + { + "findingArn": "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", + "cisaData": { + "dateAdded": 1688580990, + "dateDue": 1688580999, + "action": "For all affected software assets for which updates exist, the only acceptable remediation actions are: 1) Apply updates; OR 2) remove affected assets from agency networks." + }, + "riskScore": 66, + "evidences": [ + { + "evidenceRule": "Historically Linked to Penetration Testing Tools", + "evidenceDetail": "2 sightings on 1 source", + "severity": "Low" + } + ], + "ttps": [ + "TA0001", + "TA0002" + ], + "tools": [ + "Metasploit" + ], + "exploitObserved": { + "lastSeen": 1688580990, + "firstSeen": 1688580800 + }, + "referenceUrls": [ + "https://nvd.nist.gov/vuln/detail/CVE-2019-20367" + ], + "cwes": [ + "cwe-1234" + ], + "epssScore": 0.85 + } + ], + "errors": [ + { + "findingArn": "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7", + "errorCode": "ACCESS_DENIED", + "errorMessage": "You don't have permission to access this finding" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/findings/details/batch/get" + } + } + }, + "com.amazonaws.inspector2#BatchGetFindingDetailsRequest": { + "type": "structure", + "members": { + "findingArns": { + "target": "com.amazonaws.inspector2#FindingArnList", + "traits": { + "smithy.api#documentation": "A list of finding ARNs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#BatchGetFindingDetailsResponse": { + "type": "structure", + "members": { + "findingDetails": { + "target": "com.amazonaws.inspector2#FindingDetails", + "traits": { + "smithy.api#documentation": "A finding's vulnerability details.
" + } + }, + "errors": { + "target": "com.amazonaws.inspector2#FindingDetailsErrorList", + "traits": { + "smithy.api#documentation": "Error information for findings that details could not be returned for.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.inspector2#BatchGetFreeTrialInfo": { "type": "operation", "input": { @@ -2829,7 +2951,7 @@ "keyPrefix": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The prefix of the Amazon S3 bucket used to export findings.
" + "smithy.api#documentation": "The prefix that the findings will be written under.
" } }, "kmsKeyArn": { @@ -3666,6 +3788,62 @@ "com.amazonaws.inspector2#ErrorMessage": { "type": "string" }, + "com.amazonaws.inspector2#Evidence": { + "type": "structure", + "members": { + "evidenceRule": { + "target": "com.amazonaws.inspector2#EvidenceRule", + "traits": { + "smithy.api#documentation": "The evidence rule.
" + } + }, + "evidenceDetail": { + "target": "com.amazonaws.inspector2#EvidenceDetail", + "traits": { + "smithy.api#documentation": "The evidence details.
" + } + }, + "severity": { + "target": "com.amazonaws.inspector2#EvidenceSeverity", + "traits": { + "smithy.api#documentation": "The evidence severity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the evidence for a vulnerability identified in a finding.
" + } + }, + "com.amazonaws.inspector2#EvidenceDetail": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#EvidenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Evidence" + } + }, + "com.amazonaws.inspector2#EvidenceRule": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#EvidenceSeverity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, "com.amazonaws.inspector2#ExecutionRoleArn": { "type": "string", "traits": { @@ -4094,7 +4272,7 @@ "networkProtocol": { "target": "com.amazonaws.inspector2#StringFilterList", "traits": { - "smithy.api#documentation": "Details on the ingress source addresses used to filter findings.
" + "smithy.api#documentation": "Details on network protocol used to filter findings.
" } }, "componentId": { @@ -4397,6 +4575,18 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:finding/[a-f0-9]{32}$" } }, + "com.amazonaws.inspector2#FindingArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.inspector2#FindingArns": { "type": "list", "member": { @@ -4412,6 +4602,137 @@ } } }, + "com.amazonaws.inspector2#FindingDetail": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "The finding ARN that the vulnerability details are associated with.
" + } + }, + "cisaData": { + "target": "com.amazonaws.inspector2#CisaData" + }, + "riskScore": { + "target": "com.amazonaws.inspector2#RiskScore", + "traits": { + "smithy.api#documentation": "The risk score of the vulnerability.
" + } + }, + "evidences": { + "target": "com.amazonaws.inspector2#EvidenceList", + "traits": { + "smithy.api#documentation": "Information on the evidence of the vulnerability.
" + } + }, + "ttps": { + "target": "com.amazonaws.inspector2#Ttps", + "traits": { + "smithy.api#documentation": "The MITRE adversary tactics, techniques, or procedures (TTPs) associated with the vulnerability.
" + } + }, + "tools": { + "target": "com.amazonaws.inspector2#Tools", + "traits": { + "smithy.api#documentation": "The known malware tools or kits that can exploit the vulnerability.
" + } + }, + "exploitObserved": { + "target": "com.amazonaws.inspector2#ExploitObserved" + }, + "referenceUrls": { + "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrls", + "traits": { + "smithy.api#documentation": "The reference URLs for the vulnerability data.
" + } + }, + "cwes": { + "target": "com.amazonaws.inspector2#Cwes", + "traits": { + "smithy.api#documentation": "The Common Weakness Enumerations (CWEs) associated with the vulnerability.
" + } + }, + "epssScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The Exploit Prediction Scoring System (EPSS) score of the vulnerability.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the vulnerability identified in a finding.
" + } + }, + "com.amazonaws.inspector2#FindingDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingDetail" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#FindingDetailsError": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "The finding ARN that returned an error.
", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#FindingDetailsErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an error encountered when trying to return vulnerability data for a finding.
" + } + }, + "com.amazonaws.inspector2#FindingDetailsErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "FINDING_DETAILS_NOT_FOUND", + "name": "FINDING_DETAILS_NOT_FOUND" + }, + { + "value": "INVALID_INPUT", + "name": "INVALID_INPUT" + } + ] + } + }, + "com.amazonaws.inspector2#FindingDetailsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingDetailsError" + } + }, "com.amazonaws.inspector2#FindingList": { "type": "list", "member": { @@ -5358,6 +5679,9 @@ { "target": "com.amazonaws.inspector2#BatchGetCodeSnippet" }, + { + "target": "com.amazonaws.inspector2#BatchGetFindingDetails" + }, { "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfo" }, @@ -5563,52 +5887,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -5616,13 +5944,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -5632,224 +5969,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://inspector2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://inspector2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://inspector2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://inspector2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://inspector2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://inspector2.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://inspector2.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://inspector2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -9171,6 +9459,9 @@ ] } }, + "com.amazonaws.inspector2#RiskScore": { + "type": "integer" + }, "com.amazonaws.inspector2#Runtime": { "type": "string", "traits": { @@ -10205,6 +10496,20 @@ ] } }, + "com.amazonaws.inspector2#Tool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#Tools": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Tool" + } + }, "com.amazonaws.inspector2#Ttp": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/lookoutequipment.json b/codegen/sdk-codegen/aws-models/lookoutequipment.json index 85835b6a1b8..54cccb29df8 100644 --- a/codegen/sdk-codegen/aws-models/lookoutequipment.json +++ b/codegen/sdk-codegen/aws-models/lookoutequipment.json @@ -63,6 +63,9 @@ { "target": "com.amazonaws.lookoutequipment#DeleteModel" }, + { + "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicy" + }, { "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJob" }, @@ -81,6 +84,18 @@ { "target": "com.amazonaws.lookoutequipment#DescribeModel" }, + { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersion" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicy" + }, + { + "target": "com.amazonaws.lookoutequipment#ImportDataset" + }, + { + "target": "com.amazonaws.lookoutequipment#ImportModelVersion" + }, { "target": "com.amazonaws.lookoutequipment#ListDataIngestionJobs" }, @@ -105,12 +120,18 @@ { "target": "com.amazonaws.lookoutequipment#ListModels" }, + { + "target": "com.amazonaws.lookoutequipment#ListModelVersions" + }, { "target": "com.amazonaws.lookoutequipment#ListSensorStatistics" }, { "target": "com.amazonaws.lookoutequipment#ListTagsForResource" }, + { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicy" + }, { "target": "com.amazonaws.lookoutequipment#StartDataIngestionJob" }, @@ -126,6 +147,9 @@ { "target": "com.amazonaws.lookoutequipment#UntagResource" }, + { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersion" + }, { "target": "com.amazonaws.lookoutequipment#UpdateInferenceScheduler" }, @@ -207,52 +231,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -260,13 +288,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -276,224 +313,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://lookoutequipment.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://lookoutequipment.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://lookoutequipment.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -508,8 +496,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -521,8 +509,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -534,8 +522,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -547,8 +535,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -560,8 +548,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -573,8 +561,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -586,8 +574,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -599,8 +587,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -612,8 +600,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -625,8 +613,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -638,8 +626,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -651,8 +639,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -664,8 +652,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -677,8 +665,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -690,8 +689,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -703,25 +713,47 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://lookoutequipment-fips.us-isob-east-1.sc2s.sgov.gov" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lookoutequipment.us-isob-east-1.sc2s.sgov.gov" @@ -729,8 +761,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -742,8 +774,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -755,8 +787,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -767,8 +799,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -779,10 +811,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -949,7 +987,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a container for a collection of data being ingested for analysis. The dataset\n contains the metadata describing where the data is and what the data actually looks like.\n In other words, it contains the location of the data source, the data schema, and other\n information. A dataset also contains any tags associated with the ingested data.
" + "smithy.api#documentation": "Creates a container for a collection of data being ingested for analysis. The dataset\n contains the metadata describing where the data is and what the data actually looks like.\n For example, it contains the location of the data source, the data schema, and other\n information. A dataset also contains any tags associated with the ingested data.
" } }, "com.amazonaws.lookoutequipment#CreateDatasetRequest": { @@ -988,6 +1026,9 @@ "smithy.api#documentation": "Any tags associated with the ingested data described in the dataset.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateDatasetResponse": { @@ -1011,6 +1052,9 @@ "smithy.api#documentation": "Indicates the status of the CreateDataset operation.
Any tags associated with the inference scheduler.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateInferenceSchedulerResponse": { @@ -1142,6 +1189,9 @@ "smithy.api#documentation": "Indicates the status of the CreateInferenceScheduler operation.
\nCreates a label for an event.\n
" + "smithy.api#documentation": "\n Creates a label for an event.\n
" } }, "com.amazonaws.lookoutequipment#CreateLabelGroup": { @@ -1208,7 +1258,7 @@ } ], "traits": { - "smithy.api#documentation": "\nCreates a group of labels.\n
" + "smithy.api#documentation": "\n Creates a group of labels.\n
" } }, "com.amazonaws.lookoutequipment#CreateLabelGroupRequest": { @@ -1217,20 +1267,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nNames 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": "\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#required": {} } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "\nThe 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": "\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.
" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "\nA 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": "\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#idempotencyToken": {}, "smithy.api#required": {} } @@ -1238,9 +1288,12 @@ "Tags": { "target": "com.amazonaws.lookoutequipment#TagList", "traits": { - "smithy.api#documentation": "\nTags 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": "\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.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateLabelGroupResponse": { @@ -1249,15 +1302,18 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe 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": "\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
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\nThe ARN of the label group that you have created.\n
" + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group that you have created.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#CreateLabelRequest": { @@ -1266,57 +1322,60 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe 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": "\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#required": {} } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe start time of the labeled event.\n
", + "smithy.api#documentation": "\n The start time of the labeled event.\n
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe end time of the labeled event.\n
", + "smithy.api#documentation": "\n The end time of the labeled event.\n
", "smithy.api#required": {} } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "\nIndicates whether a labeled event represents an anomaly.\n
", + "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
", "smithy.api#required": {} } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\nProvides 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": "\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
" } }, "Notes": { "target": "com.amazonaws.lookoutequipment#Comments", "traits": { - "smithy.api#documentation": "\nMetadata 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": "\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.
" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\nIndicates 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": "\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.
" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "\nA 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": "\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#idempotencyToken": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateLabelResponse": { @@ -1325,9 +1384,12 @@ "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\nThe ID of the label that you have created.\n
" + "smithy.api#documentation": "\n The ID of the label that you have created.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#CreateModel": { @@ -1456,6 +1518,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateModelResponse": { @@ -1473,6 +1538,9 @@ "smithy.api#documentation": "Indicates the status of the CreateModel operation.
\nDeletes a label.\n
" + "smithy.api#documentation": "\n Deletes a label.\n
" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroup": { @@ -1882,7 +1962,7 @@ } ], "traits": { - "smithy.api#documentation": "\nDeletes a group of labels.\n
" + "smithy.api#documentation": "\n Deletes a group of labels.\n
" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest": { @@ -1891,10 +1971,13 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe 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": "\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#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DeleteLabelRequest": { @@ -1903,17 +1986,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe 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": "\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#required": {} } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\nThe ID of the label that you want to delete.\n
", + "smithy.api#documentation": "\n The ID of the label that you want to delete.\n
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DeleteModel": { @@ -1958,6 +2044,56 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest" + }, + "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 the resource policy attached to the resource.
" + } + }, + "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "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#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeDataIngestionJob": { @@ -1999,6 +2135,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse": { @@ -2078,7 +2217,16 @@ "traits": { "smithy.api#documentation": "Indicates the latest timestamp corresponding to data that was successfully ingested\n during this specific ingestion job.
" } + }, + "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.
" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeDataset": { @@ -2120,6 +2268,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeDatasetResponse": { @@ -2202,7 +2353,16 @@ "traits": { "smithy.api#documentation": "Indicates the latest timestamp corresponding to data that was successfully ingested\n during the most recent ingestion of this particular dataset.
" } + }, + "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.
" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeInferenceScheduler": { @@ -2244,6 +2404,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerResponse": { @@ -2333,6 +2496,9 @@ "smithy.api#documentation": "Indicates whether the latest execution for the inference scheduler was Anomalous\n (anomalous events found) or Normal (no anomalous events found).
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeLabel": { @@ -2361,7 +2527,7 @@ } ], "traits": { - "smithy.api#documentation": "\nReturns the name of the label.\n
" + "smithy.api#documentation": "\n Returns the name of the label.\n
" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroup": { @@ -2390,7 +2556,7 @@ } ], "traits": { - "smithy.api#documentation": "\nReturns information about the label group.\n
" + "smithy.api#documentation": "\n Returns information about the label group.\n
" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest": { @@ -2399,10 +2565,13 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nReturns the name of the label group.\n
", + "smithy.api#documentation": "\n Returns the name of the label group.\n
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeLabelGroupResponse": { @@ -2411,33 +2580,36 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe name of the label group.\n
" + "smithy.api#documentation": "\n The name of the label group.\n
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\nThe ARN of the label group.\n
" + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "\nCodes indicating the type of anomaly associated with the labels in the lagbel group.\n
" + "smithy.api#documentation": "\n 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": "\nThe time at which the label group was created.\n
" + "smithy.api#documentation": "\n The time at which the label group was created.\n
" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe time at which the label group was updated.\n
" + "smithy.api#documentation": "\n The time at which the label group was updated.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeLabelRequest": { @@ -2446,17 +2618,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nReturns the name of the group containing the label.\n
", + "smithy.api#documentation": "\n Returns the name of the group containing the label.\n
", "smithy.api#required": {} } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\nReturns the ID of the label.\n
", + "smithy.api#documentation": "\n Returns the ID of the label.\n
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeLabelResponse": { @@ -2465,43 +2640,43 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe name of the requested label group.\n
" + "smithy.api#documentation": "\n The name of the requested label group.\n
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\nThe ARN of the requested label group.\n
" + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the requested label group.\n
" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\nThe ID of the requested label.\n
" + "smithy.api#documentation": "\n The ID of the requested label.\n
" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe start time of the requested label.\n
" + "smithy.api#documentation": "\n The start time of the requested label.\n
" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe end time of the requested label.\n
" + "smithy.api#documentation": "\n The end time of the requested label.\n
" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "\nIndicates whether a labeled event represents an anomaly.\n
" + "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\nIndicates 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": "\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.
" } }, "Notes": { @@ -2513,15 +2688,18 @@ "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\nIndicates that a label pertains to a particular piece of equipment.\n
" + "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe time at which the label was created.\n
" + "smithy.api#documentation": "\n The time at which the label was created.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeModel": { @@ -2563,6 +2741,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeModelResponse": { @@ -2693,78 +2874,432 @@ "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.
" } - } - } - }, - "com.amazonaws.lookoutequipment#DuplicateTimestamps": { - "type": "structure", - "members": { - "TotalNumberOfDuplicateTimestamps": { - "target": "com.amazonaws.lookoutequipment#Integer", + }, + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "Indicates the total number of duplicate timestamps.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version \n 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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "ModelVersionActivatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date the active model version was activated.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "PreviousModelVersionActivatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the previous active model version was activated.
" } } }, "traits": { - "smithy.api#documentation": "Entity that comprises information abount duplicate timestamps in the dataset.
" + "smithy.api#output": {} } }, - "com.amazonaws.lookoutequipment#Equipment": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 + "com.amazonaws.lookoutequipment#DescribeModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#EventDurationInSeconds": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.lookoutequipment#FaultCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,100}$" - } - }, - "com.amazonaws.lookoutequipment#FaultCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#FaultCode" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } - } - }, - "com.amazonaws.lookoutequipment#FileNameTimestampFormat": { - "type": "string", + ], "traits": { - "smithy.api#pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" + "smithy.api#documentation": "Retrieves information about a specific machine learning model version.
" } }, - "com.amazonaws.lookoutequipment#Float": { - "type": "float", + "com.amazonaws.lookoutequipment#DescribeModelVersionRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model that this version belongs to.
", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the machine learning model.
", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#default": 0 + "smithy.api#input": {} } }, - "com.amazonaws.lookoutequipment#IamRoleArn": { - "type": "string", + "com.amazonaws.lookoutequipment#DescribeModelVersionResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model that this version belongs to.
" + } + }, + "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.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the machine learning model.
" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "The current status of the model version.
" + } + }, + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", + "traits": { + "smithy.api#documentation": "Indicates whether this model version was created by training or by importing.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset used to train the model version.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used to train the model version.
" + } + }, + "Schema": { + "target": "com.amazonaws.lookoutequipment#InlineDataSchema", + "traits": { + "smithy.api#documentation": "The schema of the data used to train the model version.
" + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "DataPreProcessingConfiguration": { + "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration" + }, + "TrainingExecutionStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the training of the version began.
" + } + }, + "TrainingExecutionEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the training of the version completed.
" + } + }, + "FailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "The failure message if the training of the model version failed.
" + } + }, + "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.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the last time the machine learning model version was updated.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time and date at which the machine learning model version was 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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicyResponse" + }, + "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 the details of a resource policy attached to a resource.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicyResponse": { + "type": "structure", + "members": { + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.lookoutequipment#Policy", + "traits": { + "smithy.api#documentation": "The resource policy in a JSON-formatted string.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the resource policy was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the resource policy was last modified.
" + } + } + }, + "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}$" + } + }, + "com.amazonaws.lookoutequipment#EventDurationInSeconds": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.lookoutequipment#FaultCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,100}$" + } + }, + "com.amazonaws.lookoutequipment#FaultCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#FaultCode" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.lookoutequipment#FileNameTimestampFormat": { + "type": "string", + "traits": { + "smithy.api#pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" + } + }, + "com.amazonaws.lookoutequipment#Float": { + "type": "float", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lookoutequipment#IamRoleArn": { + "type": "string", "traits": { "smithy.api#length": { "min": 20, @@ -2783,6 +3318,244 @@ "smithy.api#pattern": "^\\p{ASCII}{1,256}$" } }, + "com.amazonaws.lookoutequipment#ImportDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ImportDatasetRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ImportDatasetResponse" + }, + "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#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Imports a dataset.
" + } + }, + "com.amazonaws.lookoutequipment#ImportDatasetRequest": { + "type": "structure", + "members": { + "SourceDatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset to import.
", + "smithy.api#required": {} + } + }, + "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.
" + } + }, + "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#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "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.
" + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "Any tags associated with the dataset to be created.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ImportDatasetResponse": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the created machine learning dataset.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset that was imported.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#DatasetStatus", + "traits": { + "smithy.api#documentation": "The status of the ImportDataset operation.
A unique identifier for the job of importing the dataset.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ImportModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ImportModelVersionResponse" + }, + "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#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Imports a model that has been trained successfully.
" + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersionRequest": { + "type": "structure", + "members": { + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version to import.
", + "smithy.api#required": {} + } + }, + "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.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "The name of the dataset for the machine learning model being imported.
", + "smithy.api#required": {} + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "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#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "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.
" + } + }, + "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.
" + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with the machine learning model to be created.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersionResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name for the machine learning model.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model being created.
" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version being created.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the model being created.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the ImportModelVersion operation.
The ID number for the AWS KMS key used to encrypt the inference output.
" + "smithy.api#documentation": "The ID number for the KMS key key used to encrypt the inference output.
" } } }, @@ -3245,6 +4018,12 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } } } }, @@ -3267,7 +4046,7 @@ "KeyPattern": { "target": "com.amazonaws.lookoutequipment#KeyPattern", "traits": { - "smithy.api#documentation": "Pattern for matching the Amazon S3 files which will be used for ingestion. If\n no KeyPattern is provided, we will use the default hierarchy file structure, which is same\n as KeyPattern {prefix}/{component_name}/*
" + "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)
" } } }, @@ -3275,6 +4054,15 @@ "smithy.api#documentation": "Specifies S3 configuration information for the input data for the data ingestion job.\n
" } }, + "com.amazonaws.lookoutequipment#InlineDataSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000000 + } + } + }, "com.amazonaws.lookoutequipment#InsufficientSensorData": { "type": "structure", "members": { @@ -3389,30 +4177,30 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe name of the label group.\n
" + "smithy.api#documentation": "\n The name of the label group.\n
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\nThe ARN of the label group.\n
" + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe time at which the label group was created.\n
" + "smithy.api#documentation": "\n The time at which the label group was created.\n
" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe time at which the label group was updated.\n
" + "smithy.api#documentation": "\n The time at which the label group was updated.\n
" } } }, "traits": { - "smithy.api#documentation": "\nContains information about the label group.\n
" + "smithy.api#documentation": "\n Contains information about the label group.\n
" } }, "com.amazonaws.lookoutequipment#LabelId": { @@ -3460,60 +4248,60 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe name of the label group.\n
" + "smithy.api#documentation": "\n The name of the label group.\n
" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "\nThe ID of the label.\n
" + "smithy.api#documentation": "\n The ID of the label.\n
" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "\nThe ARN of the label group.\n
" + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe timestamp indicating the start of the label.\n
" + "smithy.api#documentation": "\n The timestamp indicating the start of the label.\n
" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe timestamp indicating the end of the label.\n
" + "smithy.api#documentation": "\n The timestamp indicating the end of the label.\n
" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "\nIndicates whether a labeled event represents an anomaly.\n
" + "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\nIndicates 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": "\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.
" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\nIndicates that a label pertains to a particular piece of equipment.\n
" + "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nThe time at which the label was created.\n
" + "smithy.api#documentation": "\n The time at which the label was created.\n
" } } }, "traits": { - "smithy.api#documentation": "\nInformation about the label.\n
" + "smithy.api#documentation": "\n Information about the label.\n
" } }, "com.amazonaws.lookoutequipment#LabelsInputConfiguration": { @@ -3528,7 +4316,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe name of the label group to be used for label data.\n
" + "smithy.api#documentation": "\n The name of the label group to be used for label data.\n
" } } }, @@ -3659,6 +4447,9 @@ "smithy.api#documentation": "Indicates the status of the data ingestion job.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListDataIngestionJobsResponse": { @@ -3676,6 +4467,9 @@ "smithy.api#documentation": "Specifies information about the specific data ingestion job, including dataset name and\n status.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListDatasets": { @@ -3730,6 +4524,9 @@ "smithy.api#documentation": "The beginning of the name of the datasets to be listed.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListDatasetsResponse": { @@ -3747,6 +4544,9 @@ "smithy.api#documentation": "Provides information about the specified dataset, including creation time, dataset ARN,\n and status.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListInferenceEvents": { @@ -3815,10 +4615,13 @@ "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 than the end time given.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListInferenceEventsResponse": { @@ -3836,6 +4639,9 @@ "smithy.api#documentation": "Provides an array of information about the individual inference events returned from the\n ListInferenceEvents operation, including scheduler used, event start time,\n event end time, diagnostics, and so on.
The status of the inference execution.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListInferenceExecutionsResponse": { @@ -3929,6 +4738,9 @@ "smithy.api#documentation": "Provides an array of information about the individual inference executions returned from\n the ListInferenceExecutions operation, including model used, inference\n scheduler, data configuration, and so on.
Specifies the current status of the inference schedulers to list.
" + "smithy.api#documentation": "Specifies the current status of the inference schedulers.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListInferenceSchedulersResponse": { @@ -4012,6 +4827,9 @@ "smithy.api#documentation": "Provides information about the specified inference scheduler, including data upload\n frequency, model name and ARN, and status.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListLabelGroups": { @@ -4037,7 +4855,7 @@ } ], "traits": { - "smithy.api#documentation": "\nReturns a list of the label groups.\n
", + "smithy.api#documentation": "\n Returns a list of the label groups.\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4051,21 +4869,24 @@ "LabelGroupNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe beginning of the name of the label groups to be listed.\n
" + "smithy.api#documentation": "\n The beginning of the name of the label groups to be listed.\n
" } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\nAn opaque pagination token indicating where to continue the listing of label groups.\n
" + "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "\nSpecifies the maximum number of label groups to list.\n
" + "smithy.api#documentation": "\n Specifies the maximum number of label groups to list.\n
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListLabelGroupsResponse": { @@ -4074,15 +4895,18 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\nAn opaque pagination token indicating where to continue the listing of label groups.\n
" + "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" } }, "LabelGroupSummaries": { "target": "com.amazonaws.lookoutequipment#LabelGroupSummaries", "traits": { - "smithy.api#documentation": "\nA summary of the label groups.\n
" + "smithy.api#documentation": "\n A summary of the label groups.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListLabels": { @@ -4108,7 +4932,7 @@ } ], "traits": { - "smithy.api#documentation": "\nProvides a list of labels.\n
", + "smithy.api#documentation": "\n Provides a list of labels.\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4122,46 +4946,49 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nRetruns the name of the label group.\n
", + "smithy.api#documentation": "\n Retruns the name of the label group.\n
", "smithy.api#required": {} } }, "IntervalStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "\nReturns all the labels with a end time equal to or later than the start time given.\n
" + "smithy.api#documentation": "\n 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": "\nReturns all labels with a start time earlier than the end time given.\n
" + "smithy.api#documentation": "\n Returns all labels with a start time earlier than the end time given.\n
" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "\nReturns labels with a particular fault code.\n
" + "smithy.api#documentation": "\n Returns labels with a particular fault code.\n
" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "\nLists the labels that pertain to a particular piece of equipment.\n
" + "smithy.api#documentation": "\n Lists the labels that pertain to a particular piece of equipment.\n
" } }, "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\nAn opaque pagination token indicating where to continue the listing of label groups.\n
" + "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "\nSpecifies the maximum number of labels to list.\n
" + "smithy.api#documentation": "\n Specifies the maximum number of labels to list.\n
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListLabelsResponse": { @@ -4170,15 +4997,135 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "\nAn opaque pagination token indicating where to continue the listing of datasets.\n
" + "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of datasets.\n
" } }, "LabelSummaries": { "target": "com.amazonaws.lookoutequipment#LabelSummaries", "traits": { - "smithy.api#documentation": "\nA summary of the items in the label group.\n
" + "smithy.api#documentation": "\n A summary of the items in the label group.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListModelVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListModelVersionsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListModelVersionsResponse" + }, + "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": "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.
Then name of the machine learning model for which the \n model versions are to be 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.
Specifies the maximum number of machine learning model versions to list.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "Filter the results based on the current status of the model version.
" + } + }, + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", + "traits": { + "smithy.api#documentation": "Filter the results based on the way the model version was generated.
" + } + }, + "CreatedAtEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Filter results to return all the model versions created before this time.
" + } + }, + "CreatedAtStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Filter results to return all the model versions created after this time.
" + } + }, + "MaxModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Specifies the highest version of the model to return in the list.
" + } + }, + "MinModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Specifies the lowest version of the model to return in the list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListModelVersionsResponse": { + "type": "structure", + "members": { + "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.
Provides information on the specified model version, \n including the created time, model and dataset ARNs, and status.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListModels": { @@ -4245,6 +5192,9 @@ "smithy.api#documentation": "The beginning of the name of the dataset of the ML models to be listed.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListModelsResponse": { @@ -4262,6 +5212,9 @@ "smithy.api#documentation": "Provides information on the specified model, including created time, model and dataset\n ARNs, and status.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListOfDiscardedFiles": { @@ -4337,6 +5290,9 @@ "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of sensor\n statistics.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse": { @@ -4354,6 +5310,9 @@ "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of sensor\n statistics.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListTagsForResource": { @@ -4395,6 +5354,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListTagsForResourceResponse": { @@ -4406,6 +5368,9 @@ "smithy.api#documentation": "Any tags associated with the resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#MaxResults": { @@ -4451,39 +5416,171 @@ } }, "traits": { - "smithy.api#documentation": "Entity that comprises aggregated information on sensors having missing data.
" + "smithy.api#documentation": "Entity that comprises aggregated information on sensors having missing data.
" + } + }, + "com.amazonaws.lookoutequipment#ModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+$" + } + }, + "com.amazonaws.lookoutequipment#ModelMetrics": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50000 + } + } + }, + "com.amazonaws.lookoutequipment#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#ModelStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.lookoutequipment#ModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#ModelSummary" + } + }, + "com.amazonaws.lookoutequipment#ModelSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the ML model.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset being used for the ML model.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used to create the model.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the ML model.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the specific model was created.
" + } + }, + "ActiveModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The model version that the inference scheduler uses to run an inference\n execution.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status.
" + } + }, + "com.amazonaws.lookoutequipment#ModelVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } } }, - "com.amazonaws.lookoutequipment#ModelArn": { + "com.amazonaws.lookoutequipment#ModelVersionArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+$" - } - }, - "com.amazonaws.lookoutequipment#ModelMetrics": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50000 - } + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+\\/.+\\/model-version\\/[0-9]{1,}$" } }, - "com.amazonaws.lookoutequipment#ModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 + "com.amazonaws.lookoutequipment#ModelVersionSourceType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + "RETRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING" + } + }, + "IMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT" + } + } } }, - "com.amazonaws.lookoutequipment#ModelStatus": { + "com.amazonaws.lookoutequipment#ModelVersionStatus": { "type": "enum", "members": { "IN_PROGRESS": { @@ -4503,57 +5600,75 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + }, + "CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELED" + } } } }, - "com.amazonaws.lookoutequipment#ModelSummaries": { + "com.amazonaws.lookoutequipment#ModelVersionSummaries": { "type": "list", "member": { - "target": "com.amazonaws.lookoutequipment#ModelSummary" + "target": "com.amazonaws.lookoutequipment#ModelVersionSummary" } }, - "com.amazonaws.lookoutequipment#ModelSummary": { + "com.amazonaws.lookoutequipment#ModelVersionSummary": { "type": "structure", "members": { "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "The name of the ML model.
" + "smithy.api#documentation": "The name of the model that this model version is a version of.
" } }, "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 model that this model version is a version of.
" } }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "The name of the dataset being used for the ML model.
" + "smithy.api#documentation": "The version of the model.
" } }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used to create the model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when this model version was created.
" } }, "Status": { - "target": "com.amazonaws.lookoutequipment#ModelStatus", + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", "traits": { - "smithy.api#documentation": "Indicates the status of the ML model.
" + "smithy.api#documentation": "The current status of the model version.
" } }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", "traits": { - "smithy.api#documentation": "The time at which the specific model was created.
" + "smithy.api#documentation": "Indicates how this model version was generated.
" } } }, "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": "Contains information about the specific model version.
" } }, "com.amazonaws.lookoutequipment#MonotonicValues": { @@ -4644,6 +5759,127 @@ } } }, + "com.amazonaws.lookoutequipment#Policy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.lookoutequipment#PolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^[0-9A-Fa-f]+$" + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicyResponse" + }, + "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#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a resource control policy for a given resource.
" + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "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#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.lookoutequipment#Policy", + "traits": { + "smithy.api#documentation": "The JSON-formatted resource policy to create.
", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" + } + }, + "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#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "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.
" + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:.+$" + } + }, "com.amazonaws.lookoutequipment#ResourceNotFoundException": { "type": "structure", "members": { @@ -4693,7 +5929,7 @@ "Key": { "target": "com.amazonaws.lookoutequipment#S3Key", "traits": { - "smithy.api#documentation": "The AWS Key Management Service (AWS KMS) key being used to encrypt the S3 object.\n Without this key, data in the bucket is not accessible.
", + "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object.\n Without this key, data in the bucket is not accessible.
", "smithy.api#required": {} } } @@ -4913,6 +6149,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#StartDataIngestionJobResponse": { @@ -4930,6 +6169,9 @@ "smithy.api#documentation": "Indicates the status of the StartDataIngestionJob operation.
Indicates the status of the inference scheduler.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { @@ -5070,6 +6318,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#StopInferenceSchedulerResponse": { @@ -5105,6 +6356,9 @@ "smithy.api#documentation": "Indicates the status of the inference scheduler.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema": { @@ -5232,11 +6486,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lookoutequipment#TagValue": { "type": "string", @@ -5405,11 +6665,115 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse" + }, + "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": "Sets the active model version for a given machine learning model.
" + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest": { + "type": "structure", + "members": { + "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#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#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse": { + "type": "structure", + "members": { + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lookoutequipment#UpdateInferenceScheduler": { "type": "operation", @@ -5483,6 +6847,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the inference scheduler.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#UpdateLabelGroup": { @@ -5514,7 +6881,7 @@ } ], "traits": { - "smithy.api#documentation": "\nUpdates the label group.\n
" + "smithy.api#documentation": "\n Updates the label group.\n
" } }, "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest": { @@ -5523,16 +6890,19 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "\nThe name of the label group to be updated.\n
", + "smithy.api#documentation": "\n The name of the label group to be updated.\n
", "smithy.api#required": {} } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "\nUpdates 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": "\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.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ValidationException": { @@ -5546,7 +6916,7 @@ } }, "traits": { - "smithy.api#documentation": "The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a\n related AWS service that's being utilized.
", + "smithy.api#documentation": "The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a\n related Amazon Web Services service that's being utilized.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/omics.json b/codegen/sdk-codegen/aws-models/omics.json index 63cf9bdbd79..c934b4ecacd 100644 --- a/codegen/sdk-codegen/aws-models/omics.json +++ b/codegen/sdk-codegen/aws-models/omics.json @@ -2064,6 +2064,21 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.omics#CreationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IMPORT", + "name": "IMPORT" + }, + { + "value": "UPLOAD", + "name": "UPLOAD" + } + ] + } + }, "com.amazonaws.omics#DeleteAnnotationStore": { "type": "operation", "input": { @@ -4201,6 +4216,12 @@ "traits": { "smithy.api#documentation": "\n The status message for a read set. It provides more detail as to why the read set has a status. \n
" } + }, + "creationType": { + "target": "com.amazonaws.omics#CreationType", + "traits": { + "smithy.api#documentation": "\n The creation type of the read set.\n
" + } } }, "traits": { @@ -9440,55 +9461,55 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-gov-east-1.api.aws" + "url": "https://omics-fips.us-east-1.api.aws" } }, "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-gov-east-1.amazonaws.com" + "url": "https://omics-fips.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://omics.us-gov-east-1.api.aws" + "url": "https://omics.us-east-1.api.aws" } }, "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics.us-gov-east-1.amazonaws.com" + "url": "https://omics.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -9499,9 +9520,9 @@ } }, "params": { - "UseDualStack": true, "Region": "cn-north-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -9512,9 +9533,9 @@ } }, "params": { - "UseDualStack": false, "Region": "cn-north-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -9525,9 +9546,9 @@ } }, "params": { - "UseDualStack": true, "Region": "cn-north-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -9538,109 +9559,109 @@ } }, "params": { - "UseDualStack": false, "Region": "cn-north-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://omics-fips.us-gov-east-1.api.aws" + } }, "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://omics-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://omics.us-gov-east-1.api.aws" + } }, "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics.us-iso-east-1.c2s.ic.gov" + "url": "https://omics.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://omics-fips.us-east-1.api.aws" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-east-1.amazonaws.com" + "url": "https://omics-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://omics.us-east-1.api.aws" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics.us-east-1.amazonaws.com" + "url": "https://omics.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -9649,9 +9670,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "Region": "us-isob-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -9662,9 +9683,9 @@ } }, "params": { - "UseDualStack": false, "Region": "us-isob-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -9673,9 +9694,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "Region": "us-isob-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -9686,22 +9707,35 @@ } }, "params": { - "UseDualStack": false, "Region": "us-isob-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseDualStack": false, "Region": "us-east-1", "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -9711,9 +9745,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "Region": "us-east-1", "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -9723,11 +9757,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "Region": "us-east-1", "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -10109,6 +10149,12 @@ "traits": { "smithy.api#documentation": "\n Where the source originated.\n
" } + }, + "creationType": { + "target": "com.amazonaws.omics#CreationType", + "traits": { + "smithy.api#documentation": "\n The creation type of the read set.\n
" + } } }, "traits": { @@ -10285,6 +10331,12 @@ "traits": { "smithy.api#documentation": "\n The status for a read set. It provides more detail as to why the read set has a status. \n
" } + }, + "creationType": { + "target": "com.amazonaws.omics#CreationType", + "traits": { + "smithy.api#documentation": "\n The creation type of the read set.\n
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 5aa63f6cbf2..93043a61c22 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -3882,6 +3882,12 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.
\nThis setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } + }, + "EnableLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" + } } }, "traits": { @@ -6122,6 +6128,12 @@ "traits": { "smithy.api#documentation": "The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
" } + }, + "LocalWriteForwardingStatus": { + "target": "com.amazonaws.rds#LocalWriteForwardingStatus", + "traits": { + "smithy.api#documentation": "Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.
" + } } }, "traits": { @@ -7213,6 +7225,12 @@ "traits": { "smithy.api#documentation": "A list of the supported CA certificate identifiers.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" } + }, + "SupportsLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" + } } }, "traits": { @@ -15520,6 +15538,41 @@ "smithy.api#documentation": "" } }, + "com.amazonaws.rds#LocalWriteForwardingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "requested" + } + } + } + }, "com.amazonaws.rds#LogTypeList": { "type": "list", "member": { @@ -16199,6 +16252,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Specifies whether engine mode changes from serverless to provisioned \n are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
\nConstraints:
\nYou must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" + } } }, "traits": { @@ -23545,6 +23604,12 @@ "traits": { "smithy.api#documentation": "A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
" } + }, + "SupportsLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
\nValid for: Aurora DB clusters only
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/route-53.json b/codegen/sdk-codegen/aws-models/route-53.json index 5d050f8b589..388346dd5b7 100644 --- a/codegen/sdk-codegen/aws-models/route-53.json +++ b/codegen/sdk-codegen/aws-models/route-53.json @@ -2718,6 +2718,12 @@ "traits": { "smithy.api#enumValue": "ap-southeast-4" } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } } }, "traits": { @@ -3480,7 +3486,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.
After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.
Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.
Gets information about a specified traffic policy instance.
\n\n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.
In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nGets information about a specified traffic policy instance.
\nAfter you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.
In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nAfter you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.
Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.
\nWhen you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:
\nRoute 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t
\nWhen all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.
\nRoute 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.
\nUpdates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.
\nWhen you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:
\nRoute 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t
\nWhen all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.
\nRoute 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.
\n\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at expression - at(yyyy-mm-ddThh:mm:ss)\n
\n rate expression - rate(unit value)\n
\n cron expression - cron(fields)\n
\n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n
\n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
", + "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at expression - at(yyyy-mm-ddThh:mm:ss)\n
\n rate expression - rate(value unit)\n
\n cron expression - cron(fields)\n
\n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n
\n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
", "smithy.api#required": {} } }, @@ -1010,6 +1025,12 @@ "smithy.api#documentation": "\n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n
", "smithy.api#idempotencyToken": {} } + }, + "ActionAfterCompletion": { + "target": "com.amazonaws.scheduler#ActionAfterCompletion", + "traits": { + "smithy.api#documentation": "Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
" + } } } }, @@ -1505,7 +1526,7 @@ "ScheduleExpression": { "target": "com.amazonaws.scheduler#ScheduleExpression", "traits": { - "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at expression - at(yyyy-mm-ddThh:mm:ss)\n
\n rate expression - rate(unit value)\n
\n cron expression - cron(fields)\n
\n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n
\n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
" + "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at expression - at(yyyy-mm-ddThh:mm:ss)\n
\n rate expression - rate(value unit)\n
\n cron expression - cron(fields)\n
\n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n
\n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
" } }, "StartDate": { @@ -1575,6 +1596,12 @@ "traits": { "smithy.api#documentation": "Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
" } + }, + "ActionAfterCompletion": { + "target": "com.amazonaws.scheduler#ActionAfterCompletion", + "traits": { + "smithy.api#documentation": "Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
" + } } } }, @@ -2978,7 +3005,7 @@ "ScheduleExpression": { "target": "com.amazonaws.scheduler#ScheduleExpression", "traits": { - "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at expression - at(yyyy-mm-ddThh:mm:ss)\n
\n rate expression - rate(unit value)\n
\n cron expression - cron(fields)\n
\n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n
\n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
", + "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at expression - at(yyyy-mm-ddThh:mm:ss)\n
\n rate expression - rate(value unit)\n
\n cron expression - cron(fields)\n
\n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n
\n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
", "smithy.api#required": {} } }, @@ -3038,6 +3065,12 @@ "smithy.api#documentation": "\n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n
", "smithy.api#idempotencyToken": {} } + }, + "ActionAfterCompletion": { + "target": "com.amazonaws.scheduler#ActionAfterCompletion", + "traits": { + "smithy.api#documentation": "Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
" + } } } }, @@ -3070,4 +3103,4 @@ } } } -} +} \ No newline at end of file