The type of the content. Supported types are text/plain,\n text/markdown, and application/json.
The type of the content. Supported types are text/plain,\n text/markdown, application/json, and \n application/vnd.amazonaws.connect.message.interactive.response.
The content of the chat message.
\nFor text/plain and text/markdown, the Length Constraints are\n Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of\n 12000.
The content of the chat message.
\nFor text/plain and text/markdown, the Length Constraints are\n Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of\n 12000.
For application/vnd.amazonaws.connect.message.interactive.response, the Length\n Constraints are Minimum of 1, Maximum of 12288.
Contains credentials to use for federation.
" } }, + "com.amazonaws.connect#CrossChannelBehavior": { + "type": "structure", + "members": { + "BehaviorType": { + "target": "com.amazonaws.connect#BehaviorType", + "traits": { + "smithy.api#documentation": "Specifies the other channels that can be routed to an agent handling their current channel.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the cross-channel routing behavior that allows an agent working on a contact in \n one channel to be offered a contact from a different channel.
" + } + }, "com.amazonaws.connect#CurrentMetric": { "type": "structure", "members": { @@ -9729,7 +9761,7 @@ "EndTime": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be later than the start time\n timestamp.
\nThe time range between the start and end time must be less than 24 hours.
", + "smithy.api#documentation": "The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be later than the start time\n timestamp. It cannot be later than the current timestamp.
\nThe time range between the start and end time must be less than 24 hours.
", "smithy.api#required": {} } }, @@ -9749,7 +9781,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nValid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Valid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe number of contacts an agent can have on a channel simultaneously.
\nValid Range for VOICE: Minimum value of 1. Maximum value of 1.
Valid Range for CHAT: Minimum value of 1. Maximum value of 10.
Valid Range for TASK: Minimum value of 1. Maximum value of 10.
Defines the cross-channel routing behavior for each channel that is enabled for this Routing \n Profile. For example, this allows you to offer an agent a different contact from another channel \n when they are currently working with a contact from a Voice channel.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/ecs.json b/codegen/sdk-codegen/aws-models/ecs.json index 93b522c70f6..f4c3aec04aa 100644 --- a/codegen/sdk-codegen/aws-models/ecs.json +++ b/codegen/sdk-codegen/aws-models/ecs.json @@ -632,8 +632,8 @@ } }, "params": { - "UseFIPS": false, "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -645,8 +645,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -658,8 +658,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -671,8 +671,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -684,8 +684,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -697,8 +697,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -710,8 +710,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -723,8 +723,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -736,8 +736,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -749,8 +749,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -762,8 +762,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -775,8 +775,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -788,8 +788,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -801,8 +801,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -814,8 +814,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -827,8 +827,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -840,8 +840,8 @@ } }, "params": { - "UseFIPS": false, "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -853,8 +853,8 @@ } }, "params": { - "UseFIPS": false, "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -866,8 +866,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -879,8 +879,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -892,8 +892,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -905,8 +905,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -918,8 +918,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -931,8 +931,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -944,8 +944,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -957,8 +957,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -970,8 +970,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -983,8 +983,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -996,8 +996,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1009,8 +1009,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-northwest-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1022,8 +1022,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1035,8 +1035,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1048,8 +1048,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1061,8 +1061,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1074,8 +1074,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1087,8 +1087,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1100,8 +1100,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1113,8 +1113,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1126,8 +1126,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1139,8 +1139,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1152,8 +1152,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-iso-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1163,8 +1163,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1176,8 +1176,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1187,8 +1187,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1200,8 +1200,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1211,8 +1211,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1224,8 +1224,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1235,8 +1235,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1248,8 +1248,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -1273,8 +1273,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -1285,8 +1285,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } @@ -1484,7 +1484,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is off.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto\n\t\t\tScaling group that contain tasks from being terminated during a scale-in action. The\n\t\t\tAuto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" + "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is off.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto\n\t\t\tScaling group that contain tasks from being terminated during a scale-in action. The\n\t\t\tAuto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" } } }, @@ -2009,7 +2009,7 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than\n\t\t\t(>), less than (<), or slash (/).
\nIf you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.
\nIf you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.
\nIf you update the service with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.
For more information about Cloud Map, see Working\n\t\t\t\twith Services in the Cloud Map Developer Guide.
", + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than\n\t\t\t(>), less than (<), or slash (/).
\nIf you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.
\nIf you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.
\nIf you update the service with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.
For more information about Cloud Map, see Working\n\t\t\t\twith Services in the Cloud Map Developer Guide.
", "smithy.api#required": {} } } @@ -2024,13 +2024,13 @@ "name": { "target": "com.amazonaws.ecs#ClusterSettingName", "traits": { - "smithy.api#documentation": "The name of the cluster setting. The only supported value is\n\t\t\t\tcontainerInsights.
The name of the cluster setting. The value is containerInsights .
The value to set for the cluster setting. The supported values are enabled and\n\t\t\t\tdisabled. If enabled is specified, CloudWatch Container Insights\n\t\t\twill be enabled for the cluster, otherwise it will be off unless the\n\t\t\t\tcontainerInsights account setting is turned on. If a cluster value is\n\t\t\tspecified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The value to set for the cluster setting. The supported values are enabled and\n\t\t\t\tdisabled.
If you set name to containerInsights and value\n\t\t\tto enabled, CloudWatch Container Insights will be on for the cluster, otherwise\n\t\t\tit will be off unless the containerInsights account setting is turned on.\n\t\t\tIf a cluster value is specified, it will override the containerInsights\n\t\t\tvalue set with PutAccountSetting or PutAccountSettingDefault.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
" } }, "loadBalancers": { @@ -3185,7 +3185,7 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether the execute command functionality is enabled for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.
Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.
The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is enabled, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.
The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is turned on, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.
The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If it is turned on, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#DeploymentConfiguration": { @@ -5065,13 +5065,13 @@ "accessPointId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration must either be omitted or set\n\t\t\tto / which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. For more information, see Working with Amazon\n\t\t\t\tEFS access points in the Amazon Elastic File System User Guide.
The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration must either be omitted or set\n\t\t\tto / which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be on in the\n\t\t\t\tEFSVolumeConfiguration. For more information, see Working with Amazon\n\t\t\t\tEFS access points in the Amazon Elastic File System User Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. If this parameter is omitted, the default value\n\t\t\tof DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS access points in the Amazon Elastic Container Service Developer Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the\n\t\t\t\tEFSVolumeConfiguration. If this parameter is omitted, the default value\n\t\t\tof DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS access points in the Amazon Elastic Container Service Developer Guide.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n\t\t\tused. If this parameter is omitted, the default value of DISABLED is used.\n\t\t\tFor more information, see Encrypting data in transit in\n\t\t\tthe Amazon Elastic File System User Guide.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is\n\t\t\tused. If this parameter is omitted, the default value of DISABLED is used.\n\t\t\tFor more information, see Encrypting data in transit in\n\t\t\tthe Amazon Elastic File System User Guide.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.
\nThis parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tLinux platform version 1.4.0 or later. This parameter is not supported\n\t\t\t\tfor Windows containers on Fargate.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.
\nFor tasks using the Fargate launch type, the task requires\n\t\t\t\tthe following platforms:
\nLinux platform version 1.4.0 or later.
Runs a command remotely on a container within a task.
\nIf you use a condition key in your IAM policy to refine the conditions for the policy\n\t\t\tstatement, for example limit the actions to a specific cluster, you receive an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS Exec for\n\t\t\tdebugging in the Amazon ECS Developer Guide.
" + "smithy.api#documentation": "Runs a command remotely on a container within a task.
\nIf you use a condition key in your IAM policy to refine the conditions for the policy\n\t\t\tstatement, for example limit the actions to a specific cluster, you receive an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS Exec for\n\t\t\tdebugging in the Amazon ECS Developer Guide.
" } }, "com.amazonaws.ecs#ExecuteCommandConfiguration": { @@ -5613,7 +5613,7 @@ "protectedTasks": { "target": "com.amazonaws.ecs#ProtectedTasks", "traits": { - "smithy.api#documentation": "A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is enabled for a task, the value is true. Otherwise, it\n\t\t\t\t\tis false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise, it\n\t\t\t\t\tis false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
The name of the managed agent. When the execute command feature is enabled, the\n\t\t\tmanaged agent name is ExecuteCommandAgent.
The name of the managed agent. When the execute command feature is turned on, the\n\t\t\tmanaged agent name is ExecuteCommandAgent.
The managed scaling settings for the Auto Scaling group capacity provider.
\nWhen managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is off, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.
" + "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
\nWhen managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is off, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.
" } }, "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { @@ -7641,7 +7641,7 @@ "hostPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value of\n\t\t\tthe hostPort is set as follows:
For containers in a task with the awsvpc network mode, the\n\t\t\t\t\t\thostPort is set to the same value as the\n\t\t\t\t\t\tcontainerPort. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS\n\t\t\t\t\tagent finds open ports on the host and automaticaly binds them to the container\n\t\t\t\t\tports. This is a dynamic mapping strategy.
If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.
If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time. This number\n\t\t\tincludes the default reserved ports. Automatically assigned ports aren't included in the\n\t\t\t100 reserved ports quota.
The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value of\n\t\t\tthe hostPort is set as follows:
For containers in a task with the awsvpc network mode, the\n\t\t\t\t\t\thostPort is set to the same value as the\n\t\t\t\t\t\tcontainerPort. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds\n\t\t\t\t\topen ports on the host and automatically binds them to the container ports. This\n\t\t\t\t\tis a dynamic mapping strategy.
If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.
If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time. This number\n\t\t\tincludes the default reserved ports. Automatically assigned ports aren't included in the\n\t\t\t100 reserved ports quota.
Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the account setting for the root user, the default settings for all of\n\t\t\tthe users and roles that no individual account setting was specified are reset for.\n\t\t\tFor more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
\nWhen serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\tis defined by the opt-in status of the user or role that created the resource. You\n\t\t\tmust turn on this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.
Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the root user account setting, the default settings are reset for users\n\t\t\tand roles that do not have specified individual account settings. For more information,\n\t\t\tsee Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
\nWhen serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\tis defined by the opt-in status of the user or role that created the resource. You\n\t\t\tmust turn on this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is turned on, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether\n\t\t\tAmazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If\n\t\t\t\tcontainerInsights is turned on, any new clusters that are created will\n\t\t\thave Container Insights turned on unless you disable it during cluster creation. For\n\t\t\tmore information, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.
The resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.
Fargate is transitioning from task count-based quotas to vCPU-based quotas. You can\n\t\t\tset the name to fargateVCPULimit to opt in or opt out of the vCPU-based\n\t\t\tquotas. For information about the opt in timeline, see Fargate vCPU-based quotas timeline in the\n\t\t\t\tAmazon ECS Developer Guide.
The resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights is specified, the default\n\t\t\tsetting for Amazon Web Services CloudWatch Container Insights for your clusters is affected.
When you specify fargateFIPSMode for the name and\n\t\t\t\tenabled for the value, Fargate uses FIPS-140 compliant\n\t\t\tcryptographic algorithms on your tasks. For more information about FIPS-140 compliance\n\t\t\twith Fargate, see Amazon Web Services Fargate Federal Information Processing Standard (FIPS) 140-2\n\t\t\t\tcompliance in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the elastic network interface (ENI) limit\n\t\t\tfor your Amazon ECS container instances is affected. If containerInsights is\n\t\t\tspecified, the default setting for CloudWatch Container Insights for your clusters is\n\t\t\taffected.
The Amazon ECS resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the elastic network interface (ENI) limit\n\t\t\tfor your Amazon ECS container instances is affected. If containerInsights is\n\t\t\tspecified, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is\n\t\t\taffected. If fargateFIPSMode is specified, Fargate FIPS 140 compliance is\n\t\t\taffected.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.
\nThis parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tthe following platform versions:
\nLinux platform version 1.4.0 or later.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.
\nFor tasks using the Fargate launch type, the task requires\n\t\t\t\tthe following platforms:
\nLinux platform version 1.4.0 or later.
The type and amount of a resource to assign to a container. The supported resource types are\n\t\t\tGPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide\n
" + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resource types are\n\t\t\tGPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide\n
" } }, "com.amazonaws.ecs#ResourceRequirements": { @@ -8942,7 +8942,7 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether the execute command functionality is enabled for the service. If\n\t\t\t\ttrue, the execute command functionality is enabled for all containers\n\t\t\tin tasks as part of the service.
Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, the execute command functionality is turned on for all containers\n\t\t\tin tasks as part of the service.
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in\n\t\t\tthe same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't\n\t\t\taffect Service Connect. For more information about Cloud Map, see Working with Services in the\n\t\t\tCloud Map Developer Guide.
" + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in\n\t\t\tthe same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't\n\t\t\taffect Service Connect. For more information about Cloud Map, see Working with Services in the\n\t\t\tCloud Map Developer Guide.
" } }, "services": { @@ -9274,6 +9274,12 @@ "traits": { "smithy.api#enumValue": "containerInsights" } + }, + "FARGATE_FIPS_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fargateFIPSMode" + } } } }, @@ -9370,7 +9376,7 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether or not the execute command functionality is enabled for the task. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe task.
Whether or not the execute command functionality is turned on for the task. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe task.
The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:
\nIncorrect IAM permissions
\nThe SSM agent is not installed or is not running
\nThere is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for\n\t\t\t\t\tfor Systems Manager Session Manager
\nFor information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#documentation": "The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:
\nIncorrect IAM permissions
\nThe SSM agent is not installed or is not running
\nThere is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems\n\t\t\t\t\tManager Session Manager
\nFor information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.
", "smithy.api#error": "client" } }, @@ -10056,7 +10062,7 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether execute command functionality is enabled for this task. If\n\t\t\t\ttrue, execute command functionality is enabled on all the containers in\n\t\t\tthe task.
Determines whether execute command functionality is turned on for this task. If\n\t\t\t\ttrue, execute command functionality is turned on all the containers in\n\t\t\tthe task.
An object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nTask placement constraints aren't supported for tasks run on Fargate.
\nThe constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nTask placement constraints aren't supported for tasks run on Fargate.
\nUpdates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.
If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.
\nUpdates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.
If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.
\nA list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is enabled for a task, the value is true. Otherwise, it\n\t\t\t\t\tis false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise, it\n\t\t\t\t\tis false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
Catalog API actions allow you to manage your entities through list, describe, and\n update capabilities. An entity can be a product or an offer on AWS Marketplace.
\nYou can automate your entity update process by integrating the AWS Marketplace Catalog\n API with your AWS Marketplace product build or deployment pipelines. You can also create\n your own applications on top of the Catalog API to manage your products on AWS\n Marketplace.
", + "smithy.api#documentation": "Catalog API actions allow you to manage your entities through list, describe, and\n update capabilities. An entity can be a product or an offer on AWS Marketplace.
\nYou can automate your entity update process by integrating the AWS Marketplace Catalog\n API with your AWS Marketplace product build or deployment pipelines. You can also create\n your own applications on top of the Catalog API to manage your products on AWS\n Marketplace.
", "smithy.api#title": "AWS Marketplace Catalog Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -446,8 +455,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -459,8 +468,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -472,8 +481,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -485,8 +494,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -498,8 +507,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -511,8 +520,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -524,8 +533,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -537,8 +546,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -550,8 +559,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -563,8 +572,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -576,8 +585,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -589,8 +598,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 } }, { @@ -602,8 +622,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 } }, { @@ -615,8 +646,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 } }, { @@ -628,8 +670,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 } }, { @@ -641,8 +694,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -654,8 +707,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -667,8 +720,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -679,8 +732,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -691,10 +744,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" @@ -709,7 +768,7 @@ } }, "traits": { - "smithy.api#documentation": "Access is denied.
", + "smithy.api#documentation": "Access is denied.
\nHTTP status code: 403
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -770,6 +829,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#CancelChangeSetResponse": { @@ -787,6 +849,9 @@ "smithy.api#documentation": "The ARN associated with the change set referenced in this request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#Catalog": { @@ -805,7 +870,7 @@ "ChangeType": { "target": "com.amazonaws.marketplacecatalog#ChangeType", "traits": { - "smithy.api#documentation": "Change types are single string values that describe your intention for the change.\n Each change type is unique for each EntityType provided in the change's\n scope.
Change types are single string values that describe your intention for the change.\n Each change type is unique for each EntityType provided in the change's\n scope. For more information on change types available for single-AMI products, see\n Working with single-AMI products. Also, for more information on change\n types available for container-based products, see Working with container products.
This object contains details specific to the change type of the requested\n change.
", + "smithy.api#documentation": "This object contains details specific to the change type of the requested\n change. For more\n information on change types available for single-AMI products, see Working with single-AMI products. Also, for more information on change\n types available for container-based products, see Working with container products.
", "smithy.api#required": {} } }, @@ -1031,6 +1096,63 @@ "smithy.api#pattern": "^([\\d]{4})\\-(1[0-2]|0[1-9])\\-(3[01]|0[1-9]|[12][\\d])T(2[0-3]|[01][\\d]):([0-5][\\d]):([0-5][\\d])Z$" } }, + "com.amazonaws.marketplacecatalog#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.marketplacecatalog#InternalServiceException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a resource-based policy on an Entity that is identified by its resource\n ARN.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteResourcePolicy", + "code": 200 + } + } + }, + "com.amazonaws.marketplacecatalog#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Entity resource that is associated with the\n resource policy.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.marketplacecatalog#DescribeChangeSet": { "type": "operation", "input": { @@ -1084,6 +1206,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#DescribeChangeSetResponse": { @@ -1143,6 +1268,9 @@ "smithy.api#documentation": "An array of ChangeSummary objects.
This stringified JSON object includes the details of the entity.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#Entity": { @@ -1398,13 +1532,13 @@ "Name": { "target": "com.amazonaws.marketplacecatalog#FilterName", "traits": { - "smithy.api#documentation": "For ListEntities, the supported value for this is an\n EntityId.
For ListChangeSets, the supported values are as follows:
For ListEntities, the supported value for this is an\n EntityId.
For ListChangeSets, the supported values are as follows:
\n ListEntities - This is a list of unique EntityIds.
\n ListChangeSets - The supported filter names and associated\n ValueLists is as follows:
\n ChangeSetName - The supported ValueList is a list of\n non-unique ChangeSetNames. These are defined when you call the\n StartChangeSet action.
\n Status - The supported ValueList is a list of\n statuses for all change set requests.
\n EntityId - The supported ValueList is a list of\n unique EntityIds.
\n BeforeStartTime - The supported ValueList is a list\n of all change sets that started before the filter value.
\n AfterStartTime - The supported ValueList is a list\n of all change sets that started after the filter value.
\n BeforeEndTime - The supported ValueList is a list of\n all change sets that ended before the filter value.
\n AfterEndTime - The supported ValueList is a list of\n all change sets that ended after the filter value.
\n ListEntities - This is a list of unique EntityIds.
\n ListChangeSets - The supported filter names and associated\n ValueLists is as follows:
\n ChangeSetName - The supported ValueList is a list of\n non-unique ChangeSetNames. These are defined when you call the\n StartChangeSet action.
\n Status - The supported ValueList is a list of\n statuses for all change set requests.
\n EntityId - The supported ValueList is a list of\n unique EntityIds.
\n BeforeStartTime - The supported ValueList is a list\n of all change sets that started before the filter value.
\n AfterStartTime - The supported ValueList is a list\n of all change sets that started after the filter value.
\n BeforeEndTime - The supported ValueList is a list of\n all change sets that ended before the filter value.
\n AfterEndTime - The supported ValueList is a list of\n all change sets that ended after the filter value.
Gets a resource-based policy of an Entity that is identified by its resource\n ARN.
", + "smithy.api#http": { + "method": "GET", + "uri": "/GetResourcePolicy", + "code": 200 + } + } + }, + "com.amazonaws.marketplacecatalog#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Entity resource that is associated with the\n resource policy.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.marketplacecatalog#ResourcePolicyJson", + "traits": { + "smithy.api#documentation": "The policy document to set; formatted in JSON.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.marketplacecatalog#Identifier": { "type": "string", "traits": { @@ -1462,7 +1660,7 @@ } }, "traits": { - "smithy.api#documentation": "There was an internal service exception.
", + "smithy.api#documentation": "There was an internal service exception.
\nHTTP status code: 500
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1500,7 +1698,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the list of change sets owned by the account being used to make the call. You\n can filter this list by providing any combination of entityId,\n ChangeSetName, and status. If you provide more than one filter, the API\n operation applies a logical AND between the filters.
You can describe a change during the 60-day request history retention period for API\n calls.
", + "smithy.api#documentation": "Returns the list of change sets owned by the account being used to make the call. You\n can filter this list by providing any combination of entityId,\n ChangeSetName, and status. If you provide more than one filter, the API\n operation applies a logical AND between the filters.
You can describe a change during the 60-day request history retention period for API\n calls.
", "smithy.api#http": { "method": "POST", "uri": "/ListChangeSets", @@ -1513,6 +1711,15 @@ } } }, + "com.amazonaws.marketplacecatalog#ListChangeSetsMaxResultInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.marketplacecatalog#ListChangeSetsRequest": { "type": "structure", "members": { @@ -1536,7 +1743,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.marketplacecatalog#MaxResultInteger", + "target": "com.amazonaws.marketplacecatalog#ListChangeSetsMaxResultInteger", "traits": { "smithy.api#documentation": "The maximum number of results returned by a single call. This value must be provided\n in the next call to retrieve the next set of results. By default, this value is\n 20.
" } @@ -1547,6 +1754,9 @@ "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#ListChangeSetsResponse": { @@ -1564,6 +1774,9 @@ "smithy.api#documentation": "The value of the next token, if it exists. Null if there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#ListEntities": { @@ -1605,6 +1818,15 @@ } } }, + "com.amazonaws.marketplacecatalog#ListEntitiesMaxResultInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.marketplacecatalog#ListEntitiesRequest": { "type": "structure", "members": { @@ -1641,11 +1863,17 @@ } }, "MaxResults": { - "target": "com.amazonaws.marketplacecatalog#MaxResultInteger", + "target": "com.amazonaws.marketplacecatalog#ListEntitiesMaxResultInteger", "traits": { "smithy.api#documentation": "Specifies the upper limit of the elements on a single page. If a value isn't provided,\n the default value is 20.
" } + }, + "OwnershipType": { + "target": "com.amazonaws.marketplacecatalog#OwnershipType" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#ListEntitiesResponse": { @@ -1663,6 +1891,9 @@ "smithy.api#documentation": "The value of the next token if it exists. Null if there is no more result.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#ListTagsForResource": { @@ -1709,6 +1940,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#ListTagsForResourceResponse": { @@ -1726,15 +1960,9 @@ "smithy.api#documentation": "Required. A list of objects specifying each key name and value. Number of objects\n allowed: 1-50.
" } } - } - }, - "com.amazonaws.marketplacecatalog#MaxResultInteger": { - "type": "integer", + }, "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } + "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#NextToken": { @@ -1747,6 +1975,86 @@ "smithy.api#pattern": "^[\\w+=.:@\\-\\/]$" } }, + "com.amazonaws.marketplacecatalog#OwnershipType": { + "type": "enum", + "members": { + "SELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELF" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } + } + }, + "com.amazonaws.marketplacecatalog#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.marketplacecatalog#InternalServiceException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Attaches a resource-based policy to an Entity. Examples of an entity include:\n AmiProduct and ContainerProduct.
The Amazon Resource Name (ARN) of the Entity resource you want to associate with a\n resource policy.
", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.marketplacecatalog#ResourcePolicyJson", + "traits": { + "smithy.api#documentation": "The policy document to set; formatted in JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#PutResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.marketplacecatalog#RequestedChangeList": { "type": "list", "member": { @@ -1806,7 +2114,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified resource wasn't found.
", + "smithy.api#documentation": "The specified resource wasn't found.
\nHTTP status code: 404
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1824,6 +2132,16 @@ "smithy.api#httpError": 415 } }, + "com.amazonaws.marketplacecatalog#ResourcePolicyJson": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, "com.amazonaws.marketplacecatalog#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -1843,7 +2161,7 @@ "SortBy": { "target": "com.amazonaws.marketplacecatalog#SortBy", "traits": { - "smithy.api#documentation": "For ListEntities, supported attributes include\n LastModifiedDate (default), Visibility,\n EntityId, and Name.
For ListChangeSets, supported attributes include StartTime\n and EndTime.
For ListEntities, supported attributes include\n LastModifiedDate (default), Visibility,\n EntityId, and Name.
For ListChangeSets, supported attributes include StartTime\n and EndTime.
Allows you to request changes for your entities. Within a single\n ChangeSet, you can't start the same change type against the same entity\n multiple times. Additionally, when a ChangeSet is running, all the entities\n targeted by the different changes are locked until the change set has completed (either\n succeeded, cancelled, or failed). If you try to start a change set containing a change\n against an entity that is already locked, you will receive a\n ResourceInUseException error.
For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same\n change type (AddRevisions) against the same entity\n (entity-id@1).
For more information about working with change sets, see Working with change sets.
", + "smithy.api#documentation": "Allows you to request changes for your entities. Within a single\n ChangeSet, you can't start the same change type against the same entity\n multiple times. Additionally, when a ChangeSet is running, all the entities\n targeted by the different changes are locked until the change set has completed (either\n succeeded, cancelled, or failed). If you try to start a change set containing a change\n against an entity that is already locked, you will receive a\n ResourceInUseException error.
For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same\n change type (AddRevisions) against the same entity\n (entity-id@1).
For more information about working with change sets, see Working with change sets. For information on change types for single-AMI\n products, see Working with single-AMI products. Als, for more information on change types\n available for container-based products, see Working with container products.
", "smithy.api#http": { "method": "POST", "uri": "/StartChangeSet", @@ -1960,6 +2278,9 @@ "smithy.api#documentation": "A list of objects specifying each key name and value for the\n ChangeSetTags property.
The ARN associated to the unique identifier generated for the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#Tag": { @@ -2019,7 +2343,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 50 + "max": 200 } } }, @@ -2031,7 +2355,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 50 + "max": 200 } } }, @@ -2086,11 +2410,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.marketplacecatalog#TagValue": { "type": "string", @@ -2110,7 +2440,7 @@ } }, "traits": { - "smithy.api#documentation": "Too many requests.
", + "smithy.api#documentation": "Too many requests.
\nHTTP status code: 429
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2166,11 +2496,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.marketplacecatalog#ValidationException": { "type": "structure", @@ -2180,7 +2516,7 @@ } }, "traits": { - "smithy.api#documentation": "An error occurred during validation.
", + "smithy.api#documentation": "An error occurred during validation.
\nHTTP status code: 422
", "smithy.api#error": "client", "smithy.api#httpError": 422 } diff --git a/codegen/sdk-codegen/aws-models/mediaconvert.json b/codegen/sdk-codegen/aws-models/mediaconvert.json index d142771b65a..a84298d45b3 100644 --- a/codegen/sdk-codegen/aws-models/mediaconvert.json +++ b/codegen/sdk-codegen/aws-models/mediaconvert.json @@ -12425,7 +12425,7 @@ "target": "com.amazonaws.mediaconvert#__integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 1440 minutes, inclusive.", + "smithy.api#documentation": "Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 4320 minutes, inclusive.", "smithy.api#jsonName": "waitMinutes" } } @@ -13272,6 +13272,13 @@ "smithy.api#jsonName": "billingTagsSource" } }, + "ClientRequestToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.", + "smithy.api#jsonName": "clientRequestToken" + } + }, "CreatedAt": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -13424,6 +13431,13 @@ "smithy.api#documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", "smithy.api#jsonName": "userMetadata" } + }, + "Warnings": { + "target": "com.amazonaws.mediaconvert#__listOfWarningGroup", + "traits": { + "smithy.api#documentation": "Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html", + "smithy.api#jsonName": "warnings" + } } }, "traits": { @@ -16953,25 +16967,6 @@ }, "type": "endpoint" }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-west-1" - ] - } - ], - "endpoint": { - "url": "https://mediaconvert.us-gov-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, { "conditions": [], "endpoint": { @@ -17006,8 +17001,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "ap-northeast-1" } }, @@ -17019,8 +17014,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "ap-northeast-2" } }, @@ -17032,8 +17027,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "ap-south-1" } }, @@ -17045,8 +17040,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-1" } }, @@ -17058,8 +17053,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-2" } }, @@ -17071,8 +17066,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "ca-central-1" } }, @@ -17084,8 +17079,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "ca-central-1" } }, @@ -17097,8 +17092,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "eu-central-1" } }, @@ -17110,8 +17105,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "eu-north-1" } }, @@ -17123,8 +17118,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-1" } }, @@ -17136,8 +17131,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-2" } }, @@ -17149,8 +17144,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-3" } }, @@ -17162,8 +17157,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "sa-east-1" } }, @@ -17175,8 +17170,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-east-1" } }, @@ -17188,8 +17183,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-1" } }, @@ -17201,8 +17196,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-east-2" } }, @@ -17214,8 +17209,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-2" } }, @@ -17227,8 +17222,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-west-1" } }, @@ -17240,8 +17235,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-west-1" } }, @@ -17253,8 +17248,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-west-2" } }, @@ -17266,8 +17261,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-west-2" } }, @@ -17279,8 +17274,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": true, + "UseFIPS": true, "Region": "us-east-1" } }, @@ -17292,8 +17287,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-1" } }, @@ -17305,8 +17300,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "cn-northwest-1" } }, @@ -17318,8 +17313,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": true, + "UseFIPS": true, "Region": "cn-north-1" } }, @@ -17331,8 +17326,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "cn-north-1" } }, @@ -17344,8 +17339,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, "Region": "cn-north-1" } }, @@ -17357,8 +17352,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "cn-north-1" } }, @@ -17370,8 +17365,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-gov-west-1" } }, @@ -17383,8 +17378,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-gov-west-1" } }, @@ -17396,8 +17391,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": true, + "UseFIPS": true, "Region": "us-gov-east-1" } }, @@ -17409,8 +17404,8 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-gov-east-1" } }, @@ -17422,8 +17417,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, "Region": "us-gov-east-1" } }, @@ -17435,11 +17430,22 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-gov-east-1" } }, + { + "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": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -17448,8 +17454,19 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "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": { + "UseDualStack": true, + "UseFIPS": false, "Region": "us-iso-east-1" } }, @@ -17461,11 +17478,22 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-iso-east-1" } }, + { + "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": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -17474,8 +17502,19 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "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": { + "UseDualStack": true, + "UseFIPS": false, "Region": "us-isob-east-1" } }, @@ -17487,8 +17526,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-isob-east-1" } }, @@ -17500,8 +17539,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -17514,8 +17553,8 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -17525,8 +17564,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -17537,11 +17576,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-1", "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -23694,6 +23739,32 @@ "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP9." } }, + "com.amazonaws.mediaconvert#WarningGroup": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.mediaconvert#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Warning code that identifies a specific warning in the job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html", + "smithy.api#jsonName": "code", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.mediaconvert#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of times this warning occurred in the job.", + "smithy.api#jsonName": "count", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains any warning codes and their count for the job." + } + }, "com.amazonaws.mediaconvert#WatermarkingStrength": { "type": "enum", "members": { @@ -25937,6 +26008,12 @@ "target": "com.amazonaws.mediaconvert#TeletextPageType" } }, + "com.amazonaws.mediaconvert#__listOfWarningGroup": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconvert#WarningGroup" + } + }, "com.amazonaws.mediaconvert#__listOf__doubleMinNegative60Max6": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/omics.json b/codegen/sdk-codegen/aws-models/omics.json index f7f9987db76..efb0b1c62ed 100644 --- a/codegen/sdk-codegen/aws-models/omics.json +++ b/codegen/sdk-codegen/aws-models/omics.json @@ -8563,9 +8563,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -8576,9 +8576,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -8589,9 +8589,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -8602,9 +8602,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -8615,9 +8615,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "cn-north-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -8628,9 +8628,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "cn-north-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -8641,9 +8641,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "cn-north-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -8654,9 +8654,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "cn-north-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -8665,9 +8665,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -8678,9 +8678,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -8689,9 +8689,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -8702,9 +8702,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -8715,9 +8715,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -8728,9 +8728,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -8741,9 +8741,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -8754,9 +8754,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -8765,9 +8765,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-isob-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -8778,9 +8778,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-isob-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -8789,9 +8789,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-isob-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -8802,9 +8802,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-isob-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -8815,9 +8815,9 @@ } }, "params": { - "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -8827,9 +8827,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -8839,9 +8839,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } } @@ -13512,10 +13512,6 @@ { "name": "FAILED", "value": "FAILED" - }, - { - "name": "INACTIVE", - "value": "INACTIVE" } ], "smithy.api#length": { @@ -13543,10 +13539,6 @@ { "name": "PRIVATE", "value": "PRIVATE" - }, - { - "name": "SERVICE", - "value": "SERVICE" } ], "smithy.api#length": { diff --git a/codegen/sdk-codegen/aws-models/rekognition.json b/codegen/sdk-codegen/aws-models/rekognition.json index e89c0483c92..4dc36eaf8b0 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.json +++ b/codegen/sdk-codegen/aws-models/rekognition.json @@ -148,6 +148,41 @@ "target": "com.amazonaws.rekognition#AudioMetadata" } }, + "com.amazonaws.rekognition#AuditImage": { + "type": "structure", + "members": { + "Bytes": { + "target": "com.amazonaws.rekognition#LivenessImageBlob", + "traits": { + "smithy.api#documentation": "The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.
" + } + }, + "S3Object": { + "target": "com.amazonaws.rekognition#S3Object" + }, + "BoundingBox": { + "target": "com.amazonaws.rekognition#BoundingBox" + } + }, + "traits": { + "smithy.api#documentation": "An image that is picked from the Face Liveness video and returned for audit trail purposes, returned as Base64-encoded bytes.
" + } + }, + "com.amazonaws.rekognition#AuditImages": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#AuditImage" + } + }, + "com.amazonaws.rekognition#AuditImagesLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4 + } + } + }, "com.amazonaws.rekognition#Beard": { "type": "structure", "members": { @@ -540,6 +575,9 @@ "smithy.api#documentation": "A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the\n quality bar. If you specify LOW, MEDIUM, or HIGH,\n filtering removes all faces that don’t meet the chosen quality bar.\n The quality bar is\n based on a variety of common use cases. Low-quality detections can occur for a number of\n reasons. Some examples are an object that's misidentified as a face, a face that's too blurry,\n or a face with a pose that's too extreme to use. If you specify NONE, no\n filtering is performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3\n of the face model or higher.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#CompareFacesResponse": { @@ -575,6 +613,9 @@ "smithy.api#documentation": "The value of TargetImageOrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format\n (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation\n information to perform image correction. The bounding box coordinates are translated to\n represent object locations after the orientation information in the Exif metadata is used to\n correct the image orientation. Images in .png format don't contain Exif metadata.
\nAmazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images\n without orientation information in the image Exif metadata. The bounding box coordinates\n aren't translated and represent the object locations before the image is rotated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#CompareFacesUnmatchList": { @@ -826,7 +867,7 @@ } ], "traits": { - "smithy.api#documentation": "Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n
\nTo copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.
\nFor more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf you are copying a model version to a project in the same AWS account, you don't need to create a project policy.
\nTo copy a model, the destination project, source project, and source model version must already exist.
\nCopying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.
Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n
\nTo copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.
\nFor more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf you are copying a model version to a project in the same AWS account, you don't need to create a project policy.
\nTo copy a model, the destination project, source project, and source model version must already exist.
\nCopying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.
This operation requires permissions to perform the rekognition:CopyProjectVersion action.
The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:GenerateDataKey
\nkms:Decrypt
\nIf you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.
The ARN of the copied model version in the destination project.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#CoversBodyPart": { @@ -964,6 +1011,9 @@ "smithy.api#documentation": "A set of tags (key-value pairs) that you want to attach to the collection.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#CreateCollectionResponse": { @@ -987,6 +1037,9 @@ "smithy.api#documentation": "Version number of the face detection model associated with the collection you are\n creating.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#CreateDataset": { @@ -1053,6 +1106,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#CreateDatasetResponse": { @@ -1064,6 +1120,100 @@ "smithy.api#documentation": "\nThe ARN of the created Amazon Rekognition Custom Labels dataset.\n
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rekognition#CreateFaceLivenessSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#CreateFaceLivenessSessionRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#CreateFaceLivenessSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API operation initiates a Face Liveness session. It returns a SessionId,\n which you can use to start streaming Face Liveness video and get the results for a Face\n Liveness session. You can use the OutputConfig option in the Settings parameter\n to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and\n audit images. You can use AuditImagesLimit to limit of audit images returned.\n This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based\n on the duration of the selfie-video.
The identifier for your AWS Key Management Service key (AWS KMS key). \n Used to encrypt audit images and reference images.
" + } + }, + "Settings": { + "target": "com.amazonaws.rekognition#CreateFaceLivenessSessionRequestSettings", + "traits": { + "smithy.api#documentation": "A session settings object. It contains settings for the operation to be performed. For\n Face Liveness, it accepts OutputConfig and AuditImagesLimit.
Idempotent token is used to recognize the Face Liveness request. If the same token is used\n with multiple CreateFaceLivenessSession requests, the same session is returned.\n This token is employed to avoid unintentionally creating the same session multiple\n times.
Can specify the location of an Amazon S3 bucket, where reference and audit images will be\n stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the same\n region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by\n the Face Liveness system.
" + } + }, + "AuditImagesLimit": { + "target": "com.amazonaws.rekognition#AuditImagesLimit", + "traits": { + "smithy.api#documentation": "Number of audit images to be returned back. Takes an integer between 0-4. Any integer less\n than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it\n is set to 0. The limit is best effort and is based on the actual duration of the\n selfie-video.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A session settings object. It contains settings for the operation \n to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.
" + } + }, + "com.amazonaws.rekognition#CreateFaceLivenessSessionResponse": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.rekognition#LivenessSessionId", + "traits": { + "smithy.api#documentation": "A unique 128-bit UUID identifying a Face Liveness session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#CreateProject": { @@ -1111,6 +1261,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#CreateProjectResponse": { @@ -1122,6 +1275,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new project. You can use the ARN to \n configure IAM access to the project.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#CreateProjectVersion": { @@ -1213,6 +1369,9 @@ "smithy.api#documentation": "The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training and test images copied into the service for model training.\n Your source images are unaffected. The key is also used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:GenerateDataKey
\nkms:Decrypt
\nIf you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.
The ARN of the model version that was created. Use DescribeProjectVersion\n to get the current status of the training operation.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.
\nAmazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.
\nIf you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the\n face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to\n stop processing.
If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an\n Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.\n You specify what you want to detect in ConnectedHomeSettings, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. \n When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.
\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.
This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.
\nAmazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.
\nIf you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream\n (Input) and a Kinesis data stream (Output) stream for receiving\n the output. You must use the FaceSearch option in\n Settings, specifying the collection that contains the faces you\n want to recognize. After you have finished analyzing a streaming video, use\n StopStreamProcessor to stop processing.
If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream\n (Input), Amazon S3 bucket information (Output), and an\n Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS\n key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want\n to detect by using the ConnectedHome option in settings, and\n selecting one of the following: PERSON, PET,\n PACKAGE, ALL You can also specify where in the\n frame you want Amazon Rekognition to monitor with RegionsOfInterest. When\n you run the StartStreamProcessor operation on a label\n detection stream processor, you input start and stop information to determine\n the length of the processing time.
\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.
This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.
\n Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.\n Note that if you opt out at the account level this setting is ignored on individual streams.\n
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#CreateStreamProcessorResponse": { @@ -1340,6 +1505,9 @@ "smithy.api#documentation": "Amazon Resource Number for the newly created stream processor.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#CustomLabel": { @@ -1767,6 +1935,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DeleteCollectionResponse": { @@ -1778,6 +1949,9 @@ "smithy.api#documentation": "HTTP status code that indicates the result of the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DeleteDataset": { @@ -1828,11 +2002,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DeleteDatasetResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#DeleteFaces": { "type": "operation", @@ -1883,6 +2063,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DeleteFacesResponse": { @@ -1894,6 +2077,9 @@ "smithy.api#documentation": "An array of strings (face IDs) of the faces that were deleted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DeleteProject": { @@ -1963,7 +2149,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing project policy.
\nTo get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.
" + "smithy.api#documentation": "Deletes an existing project policy.
\nTo get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.
\nThis operation requires permissions to perform the rekognition:DeleteProjectPolicy action.
The ID of the project policy revision that you want to delete.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DeleteProjectPolicyResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#DeleteProjectRequest": { "type": "structure", @@ -2005,6 +2197,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DeleteProjectResponse": { @@ -2016,6 +2211,9 @@ "smithy.api#documentation": "The current status of the delete project operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DeleteProjectVersion": { @@ -2063,6 +2261,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DeleteProjectVersionResponse": { @@ -2074,6 +2275,9 @@ "smithy.api#documentation": "The status of the deletion operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DeleteStreamProcessor": { @@ -2121,11 +2325,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DeleteStreamProcessorResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#DescribeCollection": { "type": "operation", @@ -2169,6 +2379,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DescribeCollectionResponse": { @@ -2198,6 +2411,9 @@ "smithy.api#documentation": "The number of milliseconds since the Unix epoch time until the creation of the collection.\n The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DescribeDataset": { @@ -2242,6 +2458,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DescribeDatasetResponse": { @@ -2253,6 +2472,9 @@ "smithy.api#documentation": "\nThe description for the dataset.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DescribeProjectVersions": { @@ -2378,6 +2600,9 @@ "smithy.api#documentation": "The maximum number of results to return per paginated call. \n The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DescribeProjectVersionsResponse": { @@ -2395,6 +2620,9 @@ "smithy.api#documentation": "If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DescribeProjects": { @@ -2456,6 +2684,9 @@ "smithy.api#documentation": "A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, \n the response includes descriptions for all the projects in your AWS account.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DescribeProjectsResponse": { @@ -2473,6 +2704,9 @@ "smithy.api#documentation": "If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DescribeStreamProcessor": { @@ -2517,6 +2751,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DescribeStreamProcessorResponse": { @@ -2603,6 +2840,9 @@ "smithy.api#documentation": "\n Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.\n Note that if you opt out at the account level this setting is ignored on individual streams.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DetectCustomLabels": { @@ -2680,6 +2920,9 @@ "smithy.api#documentation": "Specifies the minimum confidence level for the labels to return. \n DetectCustomLabels doesn't return any labels with a confidence value that's lower than\n this specified value. If you specify a\n value of 0, DetectCustomLabels returns all labels, regardless of the assumed \n threshold applied to each label.\n If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.
An array of custom labels detected in the input image.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DetectFaces": { @@ -2747,6 +2993,9 @@ "smithy.api#documentation": "An array of facial attributes you want to be returned. This can be the default list of\n attributes or all attributes. If you don't specify a value for Attributes or if\n you specify [\"DEFAULT\"], the API returns the following subset of facial\n attributes: BoundingBox, Confidence, Pose,\n Quality, and Landmarks. If you provide [\"ALL\"], all\n facial attributes are returned, but the operation takes longer to complete.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes).
The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format\n (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation\n information to perform image correction. The bounding box coordinates are translated to\n represent object locations after the orientation information in the Exif metadata is used to\n correct the image orientation. Images in .png format don't contain Exif metadata.
\nAmazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images\n without orientation information in the image Exif metadata. The bounding box coordinates\n aren't translated and represent the object locations before the image is rotated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DetectLabels": { @@ -2801,7 +3053,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information regarding labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
\nBackground - Information about the sharpness, brightness, and dominant colors of the input image’s background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information about labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
\nBackground - Information about the sharpness, brightness, and dominant colors of the input image’s background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation that doesn't return any data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
A list of the filters to be applied to returned detected labels and image properties. Specified \n filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual \n labels or label categories. The exact label names or label categories must be supplied. For \n a full list of labels and label categories, see LINK HERE.
" + "smithy.api#documentation": "A list of the filters to be applied to returned detected labels and image properties. Specified \n filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual \n labels or label categories. The exact label names or label categories must be supplied. For \n a full list of labels and label categories, see Detecting labels.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DetectLabelsResponse": { @@ -3019,6 +3274,9 @@ "smithy.api#documentation": "Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DetectLabelsSettings": { @@ -3104,6 +3362,9 @@ "smithy.api#documentation": "Sets up the configuration for human evaluation, including the FlowDefinition the image\n will be sent to.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DetectModerationLabelsResponse": { @@ -3127,6 +3388,9 @@ "smithy.api#documentation": "Shows the results of the human in the loop evaluation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DetectProtectiveEquipment": { @@ -3183,6 +3447,9 @@ "smithy.api#documentation": "An array of PPE types that you want to summarize.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DetectProtectiveEquipmentResponse": { @@ -3206,6 +3473,9 @@ "smithy.api#documentation": "Summary information for the types of PPE specified in the SummarizationAttributes input\n parameter.
Optional parameters that let you set the criteria that the text must meet to be included\n in your response.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DetectTextResponse": { @@ -3296,6 +3569,9 @@ "smithy.api#documentation": "The model version used to detect text.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#DetectionFilter": { @@ -3384,11 +3660,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#DistributeDatasetEntriesResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#DistributeDatasetMetadataList": { "type": "list", @@ -4073,7 +4355,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains filters for the object labels returned by DetectLabels. Filters can be inclusive, \n exclusive, or a combination of both and can be applied to individual l\n abels or entire label categories.
" + "smithy.api#documentation": "Contains filters for the object labels returned by DetectLabels. Filters can be inclusive, \n exclusive, or a combination of both and can be applied to individual labels or entire label categories.\n To see a list of label categories, see Detecting Labels.
" } }, "com.amazonaws.rekognition#Geometry": { @@ -4138,6 +4420,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#GetCelebrityInfoResponse": { @@ -4161,6 +4446,9 @@ "smithy.api#documentation": "Retrieves the known gender for the celebrity.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#GetCelebrityRecognition": { @@ -4231,6 +4519,9 @@ "smithy.api#documentation": "Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier,\n specify TIMESTAMP to sort by the time the celebrity was recognized.
Array of celebrities recognized in the video.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#GetContentModeration": { @@ -4336,6 +4630,9 @@ "smithy.api#documentation": "Sort to use for elements in the ModerationLabelDetections array.\n Use TIMESTAMP to sort array elements by the time labels are detected.\n Use NAME to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by TIMESTAMP.
Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#GetFaceDetection": { @@ -4441,6 +4741,9 @@ "smithy.api#documentation": "If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of faces.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#GetFaceDetectionResponse": { @@ -4476,6 +4779,96 @@ "smithy.api#documentation": "An array of faces detected in the video. Each element contains a detected face's details and the time,\n in milliseconds from the start of the video, the face was detected.
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rekognition#GetFaceLivenessSessionResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#GetFaceLivenessSessionResultsRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#GetFaceLivenessSessionResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#SessionNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the results of a specific Face Liveness session. It requires the\n sessionId as input, which was created using\n CreateFaceLivenessSession. Returns the corresponding Face Liveness confidence\n score, a reference image that includes a face bounding box, and audit images that also contain\n face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference\n image can optionally be returned.
A unique 128-bit UUID. This is used to uniquely identify the session and also acts as an\n idempotency token for all operations associated with the session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rekognition#GetFaceLivenessSessionResultsResponse": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.rekognition#LivenessSessionId", + "traits": { + "smithy.api#documentation": "The sessionId for which this request was called.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.rekognition#LivenessSessionStatus", + "traits": { + "smithy.api#documentation": "Represents a status corresponding to the state of the session. Possible statuses are:\n CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.
", + "smithy.api#required": {} + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "Probabalistic confidence score for if the person in the given video was live, represented as a\n float value between 0 to 100.
" + } + }, + "ReferenceImage": { + "target": "com.amazonaws.rekognition#AuditImage", + "traits": { + "smithy.api#documentation": "A high-quality image from the Face Liveness video that can be used for face comparison or\n search. It includes a bounding box of the face and the Base64-encoded bytes that return an\n image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image\n will be uploaded to an S3Object specified in the output configuration. In case the reference\n image is not returned, it's recommended to retry the Liveness check.
" + } + }, + "AuditImages": { + "target": "com.amazonaws.rekognition#AuditImages", + "traits": { + "smithy.api#documentation": "A set of images from the Face Liveness video that can be used for audit purposes. It\n includes a bounding box of the face and the Base64-encoded bytes that return an image. If the\n CreateFaceLivenessSession request included an OutputConfig argument, the image will be\n uploaded to an S3Object specified in the output configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#GetFaceSearch": { @@ -4546,6 +4939,9 @@ "smithy.api#documentation": "Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time\n that they are recognized. Use INDEX to sort by recognized faces.
An array of persons, PersonMatch,\n in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information\n for when persons are matched in the video.\n You specify the input collection in an initial call to StartFaceSearch.\n Each Persons element includes a time the person was matched,\n face match details (FaceMatches) for matching faces in the collection,\n and person information (Person) for the matched person.
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#GetLabelDetectionResponse": { @@ -4698,6 +5100,9 @@ "smithy.api#documentation": "Version number of the label detection model that was used to detect labels.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#GetPersonTracking": { @@ -4768,6 +5173,9 @@ "smithy.api#documentation": "Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements\n by the time persons are detected. Use INDEX to sort by the tracked persons.\n If you sort by INDEX, the array elements for each person are sorted by detection confidence.\n The default sort is by TIMESTAMP.
An array of the persons detected in the video and the time(s) their path was tracked throughout the video.\n An array element will exist for each time a person's path is tracked.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#GetSegmentDetection": { @@ -4867,6 +5278,9 @@ "smithy.api#documentation": "If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent \n request to retrieve the next set of text.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#GetSegmentDetectionResponse": { @@ -4914,6 +5328,9 @@ "smithy.api#documentation": "An array containing the segment types requested in the call to StartSegmentDetection.\n
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns \n a pagination token in the response. You can use this pagination token to retrieve the next set of text.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#GetTextDetectionResponse": { @@ -5016,6 +5436,9 @@ "smithy.api#documentation": "Version number of the text detection model that was used to detect text.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#GroundTruthBlob": { @@ -5209,7 +5632,7 @@ "Bytes": { "target": "com.amazonaws.rekognition#ImageBlob", "traits": { - "smithy.api#documentation": "Blob of image bytes up to 5 MBs.
" + "smithy.api#documentation": "Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to \n DetectCustomLabels is 4MB.
Provides the input image either as bytes or an S3 object.
\nYou pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System\n in the Amazon Rekognition Developer Guide.
\n You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\nIf you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.
\nFor Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Provides the input image either as bytes or an S3 object.
\nYou pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System\n in the Amazon Rekognition Developer Guide.
\n You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\nIf you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the\n Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and\n then call the operation using the S3Object property.
\nFor Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.
" } }, "com.amazonaws.rekognition#ImageBlob": { @@ -5370,6 +5793,9 @@ "smithy.api#documentation": "A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality\n bar. If you specify LOW, MEDIUM, or HIGH, filtering\n removes all faces that don’t meet the chosen quality bar. The default value is\n AUTO. \n The quality bar is based on a variety of common use cases. Low-quality detections can occur\n for a number of reasons. Some examples are an object that's misidentified as a face, a face\n that's too blurry, or a face with a pose that's too extreme to use. If you specify\n NONE, no filtering is performed.
To use quality filtering, the collection you are using must be associated with version 3\n of the face model or higher.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#IndexFacesResponse": { @@ -5399,6 +5825,9 @@ "smithy.api#documentation": "An array of faces that were detected in the image but weren't indexed. They weren't\n indexed because the quality filter identified them as low quality, or the\n MaxFaces request parameter filtered them out. To use the quality filter, you\n specify the QualityFilter request parameter.
Maximum number of collection IDs to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#ListCollectionsResponse": { @@ -6236,6 +6668,9 @@ "smithy.api#documentation": "Version numbers of the face detection models associated with the collections in the\n array CollectionIds. For example, the value of FaceModelVersions[2]\n is the version number for the face detection model used by the collection in\n CollectionId[2].
The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#ListDatasetEntriesResponse": { @@ -6357,6 +6795,9 @@ "smithy.api#documentation": "If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#ListDatasetLabels": { @@ -6437,6 +6878,9 @@ "smithy.api#documentation": "The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#ListDatasetLabelsResponse": { @@ -6454,6 +6898,9 @@ "smithy.api#documentation": "If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#ListFaces": { @@ -6519,6 +6966,9 @@ "smithy.api#documentation": "Maximum number of faces to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#ListFacesResponse": { @@ -6542,6 +6992,9 @@ "smithy.api#documentation": "Version number of the face detection model associated with the input collection\n (CollectionId).
Gets a list of the project policies attached to a project.
\nTo attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.
", + "smithy.api#documentation": "Gets a list of the project policies attached to a project.
\nTo attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.
\nThis operation requires permissions to perform the rekognition:ListProjectPolicies action.
The maximum number of results to return per paginated call. The largest value you can\n specify is 5. If you specify a value greater than 5, a ValidationException error\n occurs. The default value is 5.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#ListProjectPoliciesResponse": { @@ -6633,6 +7089,9 @@ "smithy.api#documentation": "If the response is truncated, Amazon Rekognition returns this token that you can use in the\n subsequent request to retrieve the next set of project policies.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#ListStreamProcessors": { @@ -6687,6 +7146,9 @@ "smithy.api#documentation": "Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#ListStreamProcessorsResponse": { @@ -6704,6 +7166,9 @@ "smithy.api#documentation": "List of stream processors that you have created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#ListTagsForResource": { @@ -6738,25 +7203,111 @@ "smithy.api#documentation": "Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels\n model.
\nThis operation requires permissions to perform the\n rekognition:ListTagsForResource action.
Amazon Resource Name (ARN) of the model, collection, or stream processor that contains\n the tags that you want a list of.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rekognition#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.rekognition#TagMap", + "traits": { + "smithy.api#documentation": "A list of key-value tags assigned to the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rekognition#LivenessImageBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 204800 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.rekognition#LivenessOutputConfig": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.rekognition#S3Bucket", + "traits": { + "smithy.api#documentation": "The path to an AWS Amazon S3 bucket used to store Face Liveness session results.
", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.rekognition#LivenessS3KeyPrefix", + "traits": { + "smithy.api#documentation": "The prefix appended to the output files for the Face Liveness session results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains settings that specify the location of an Amazon S3 bucket used \n to store the output of a Face Liveness session. Note that the S3 bucket must be located \n in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are \n auto-generated by the Face Liveness system.
" + } + }, + "com.amazonaws.rekognition#LivenessS3KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 950 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.rekognition#LivenessSessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "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.rekognition#LivenessSessionStatus": { + "type": "enum", "members": { - "ResourceArn": { - "target": "com.amazonaws.rekognition#ResourceArn", + "CREATED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the model, collection, or stream processor that contains\n the tags that you want a list of.
", - "smithy.api#required": {} + "smithy.api#enumValue": "CREATED" } - } - } - }, - "com.amazonaws.rekognition#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.rekognition#TagMap", + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of key-value tags assigned to the resource.
" + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } } } @@ -7782,7 +8333,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.
\nFor more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nThe response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.
To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.
\nYou copy a model version by calling CopyProjectVersion.
" + "smithy.api#documentation": "Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.
\nFor more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nThe response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.
To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.
\nYou copy a model version by calling CopyProjectVersion.
\nThis operation requires permissions to perform the rekognition:PutProjectPolicy action.
The ID of the project policy.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#QualityFilter": { @@ -7974,6 +8531,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#RecognizeCelebritiesResponse": { @@ -7997,6 +8557,9 @@ "smithy.api#documentation": "Support for estimating image orientation using the the OrientationCorrection field\n has ceased as of August 2021. Any returned values for this field included in an API response\n will always be NULL.
\nThe orientation of the input image (counterclockwise direction). If your application\n displays the image, you can use this value to correct the orientation. The bounding box\n coordinates returned in CelebrityFaces and UnrecognizedFaces\n represent face locations before the image orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable image (Exif)\n metadata that includes the image's orientation. If so, and the Exif metadata for the input\n image populates the orientation field, the value of OrientationCorrection is\n null. The CelebrityFaces and UnrecognizedFaces bounding box\n coordinates represent face locations after Exif metadata is used to correct the image\n orientation. Images in .png format don't contain Exif metadata.
A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't searched for in the collection. If you specify AUTO,\n Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or\n HIGH, filtering removes all faces that don’t meet the chosen quality bar.\n The quality bar is\n based on a variety of common use cases. Low-quality detections can occur for a number of\n reasons. Some examples are an object that's misidentified as a face, a face that's too blurry,\n or a face with a pose that's too extreme to use. If you specify NONE, no\n filtering is performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3\n of the face model or higher.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#SearchFacesByImageResponse": { @@ -9420,6 +10042,9 @@ "smithy.api#documentation": "Version number of the face detection model associated with the input collection\n (CollectionId).
Optional value specifying the minimum confidence in the face match to return. For\n example, don't return any matches where confidence in matches is less than 70%. The default\n value is 80%.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#SearchFacesResponse": { @@ -9474,6 +10102,9 @@ "smithy.api#documentation": "Version number of the face detection model associated with the input collection\n (CollectionId).
A universally unique identifier (UUID) for the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Occurs when a given sessionId is not found.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.rekognition#ShotSegment": { "type": "structure", "members": { @@ -9759,6 +10411,9 @@ "smithy.api#documentation": "An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.
The identifier for the celebrity recognition analysis job. Use JobId to identify the job in\n a subsequent call to GetCelebrityRecognition.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.
The identifier for the content analysis job. Use JobId to identify the job in\n a subsequent call to GetContentModeration.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.
The identifier for the face detection job. Use JobId to identify the job in\n a subsequent call to GetFaceDetection.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.
The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.
The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. \n Settings can include filters for GENERAL_LABELS.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#StartLabelDetectionResponse": { @@ -10148,6 +10827,9 @@ "smithy.api#documentation": "The identifier for the label detection job. Use JobId to identify the job in\n a subsequent call to GetLabelDetection.
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.
The identifier for the person detection job. Use JobId to identify the job in\n a subsequent call to GetPersonTracking.
The maximum number of inference units to use for auto-scaling the model. If you don't\n specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#StartProjectVersionResponse": { @@ -10305,6 +10996,9 @@ "smithy.api#documentation": "The current running status of the model.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#StartSegmentDetection": { @@ -10409,6 +11103,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#StartSegmentDetectionResponse": { @@ -10420,6 +11117,9 @@ "smithy.api#documentation": "Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.\n
\n Specifies when to stop processing the stream. You can specify a \n maximum amount of time to process the video. \n
\nThis is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#StartStreamProcessorResponse": { @@ -10504,6 +11207,9 @@ "smithy.api#documentation": "\n A unique identifier for the stream processing session. \n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#StartStreamProcessorSessionId": { @@ -10621,6 +11327,9 @@ "smithy.api#documentation": "Optional parameters that let you set criteria the text must meet to be included in your response.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#StartTextDetectionResponse": { @@ -10632,6 +11341,9 @@ "smithy.api#documentation": "Identifier for the text detection job. Use JobId to identify the job in a subsequent call to GetTextDetection.
Stops a running model. The operation might take a while to complete. To\n check the current status, call DescribeProjectVersions.
" + "smithy.api#documentation": "Stops a running model. The operation might take a while to complete. To\n check the current status, call DescribeProjectVersions.
\nThis operation requires permissions to perform the rekognition:StopProjectVersion action.
The current status of the stop operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rekognition#StopStreamProcessor": { @@ -10740,11 +11458,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#StopStreamProcessorResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#StreamProcessingStartSelector": { "type": "structure", @@ -11110,11 +11834,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#TagValue": { "type": "string", @@ -11495,11 +12225,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#UpdateDatasetEntries": { "type": "operation", @@ -11556,11 +12292,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#UpdateDatasetEntriesResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#UpdateStreamProcessor": { "type": "operation", @@ -11583,6 +12325,9 @@ { "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" }, + { + "target": "com.amazonaws.rekognition#ResourceInUseException" + }, { "target": "com.amazonaws.rekognition#ResourceNotFoundException" }, @@ -11628,11 +12373,17 @@ "smithy.api#documentation": "\n A list of parameters you want to delete from the stream processor.\n
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rekognition#UpdateStreamProcessorResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.rekognition#Url": { "type": "string"